git.sesse.net Git - vlc/blob - modules/control/ntservice.c

   1 /*****************************************************************************
   2  * ntservice.c: Windows NT/2K/XP service interface
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <vlc/vlc.h>
  28 #include <vlc_interface.h>
  29
  30 #define VLCSERVICENAME "VLC media player"
  31
  32 /*****************************************************************************
  33  * Module descriptor
  34  *****************************************************************************/
  35 static int  Activate( vlc_object_t * );
  36 static void Close   ( vlc_object_t * );
  37
  38 #define INSTALL_TEXT N_( "Install Windows Service" )
  39 #define INSTALL_LONGTEXT N_( \
  40     "Install the Service and exit." )
  41 #define UNINSTALL_TEXT N_( "Uninstall Windows Service" )
  42 #define UNINSTALL_LONGTEXT N_( \
  43     "Uninstall the Service and exit." )
  44 #define NAME_TEXT N_( "Display name of the Service" )
  45 #define NAME_LONGTEXT N_( \
  46     "Change the display name of the Service." )
  47 #define OPTIONS_TEXT N_("Configuration options")
  48 #define OPTIONS_LONGTEXT N_( \
  49     "Configuration options that will be " \
  50     "used by the Service (eg. --foo=bar --no-foobar). It should be specified "\
  51     "at install time so the Service is properly configured.")
  52 #define EXTRAINTF_TEXT N_("Extra interface modules")
  53 #define EXTRAINTF_LONGTEXT N_( \
  54     "Additional interfaces spawned by the " \
  55     "Service. It should be specified at install time so the Service is " \
  56     "properly configured. Use a comma separated list of interface modules. " \
  57     "(common values are: logger, sap, rc, http)")
  58
  59 vlc_module_begin();
  60     set_shortname( _("NT Service"));
  61     set_description( _("Windows Service interface") );
  62     set_category( CAT_INTERFACE );
  63     set_subcategory( SUBCAT_INTERFACE_CONTROL );
  64     add_bool( "ntservice-install", 0, NULL,
  65               INSTALL_TEXT, INSTALL_LONGTEXT, VLC_TRUE );
  66     add_bool( "ntservice-uninstall", 0, NULL,
  67               UNINSTALL_TEXT, UNINSTALL_LONGTEXT, VLC_TRUE );
  68     add_string ( "ntservice-name", VLCSERVICENAME, NULL,
  69                  NAME_TEXT, NAME_LONGTEXT, VLC_TRUE );
  70     add_string ( "ntservice-options", NULL, NULL,
  71                  OPTIONS_TEXT, OPTIONS_LONGTEXT, VLC_TRUE );
  72     add_string ( "ntservice-extraintf", NULL, NULL,
  73                  EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
  74
  75     set_capability( "interface", 0 );
  76     set_callbacks( Activate, Close );
  77 vlc_module_end();
  78
  79 struct intf_sys_t
  80 {
  81     SERVICE_STATUS_HANDLE hStatus;
  82     SERVICE_STATUS status;
  83     char *psz_service;
  84 };
  85
  86 /*****************************************************************************
  87  * Local prototypes
  88  *****************************************************************************/
  89 static void Run( intf_thread_t *p_intf );
  90 static int NTServiceInstall( intf_thread_t *p_intf );
  91 static int NTServiceUninstall( intf_thread_t *p_intf );
  92 static void WINAPI ServiceDispatch( DWORD numArgs, char **args );
  93 static void WINAPI ServiceCtrlHandler( DWORD control );
  94
  95 /* We need this global */
  96 static intf_thread_t *p_global_intf;
  97
  98 /*****************************************************************************
  99  * Activate: initialize and create stuff
 100  *****************************************************************************/
 101 static int Activate( vlc_object_t *p_this )
 102 {
 103     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 104
 105     /* Only works on NT/2K/XP */
 106     if( !IS_WINNT ) return VLC_EGENERIC;
 107
 108     p_intf->pf_run = Run;
 109     return VLC_SUCCESS;
 110 }
 111
 112 /*****************************************************************************
 113  * Close: destroy interface
 114  *****************************************************************************/
 115 void Close( vlc_object_t *p_this )
 116 {
 117 }
 118
 119 /*****************************************************************************
 120  * Run: interface thread
 121  *****************************************************************************/
 122 static void Run( intf_thread_t *p_intf )
 123 {
 124     intf_thread_t *p_extraintf;
 125     SERVICE_TABLE_ENTRY dispatchTable[] =
 126     {
 127         { VLCSERVICENAME, &ServiceDispatch },
 128         { NULL, NULL }
 129     };
 130
 131     p_global_intf = p_intf;
 132     p_intf->p_sys = alloca( sizeof( intf_sys_t ) );
 133     p_intf->p_sys->psz_service = config_GetPsz( p_intf, "ntservice-name" );
 134     p_intf->p_sys->psz_service = p_intf->p_sys->psz_service ?
 135         p_intf->p_sys->psz_service : strdup(VLCSERVICENAME);
 136
 137     if( config_GetInt( p_intf, "ntservice-install" ) )
 138     {
 139         NTServiceInstall( p_intf );
 140         return;
 141     }
 142
 143     if( config_GetInt( p_intf, "ntservice-uninstall" ) )
 144     {
 145         NTServiceUninstall( p_intf );
 146         return;
 147     }
 148
 149     if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
 150     {
 151         msg_Err( p_intf, "StartServiceCtrlDispatcher failed" ); /* str review */
 152     }
 153
 154     free( p_intf->p_sys->psz_service );
 155
 156     /* Stop and destroy the interfaces we spawned */
 157     while( (p_extraintf = vlc_object_find(p_intf, VLC_OBJECT_INTF, FIND_CHILD)))
 158     {
 159         intf_StopThread( p_extraintf );
 160         vlc_object_detach( p_extraintf );
 161         vlc_object_release( p_extraintf );
 162         intf_Destroy( p_extraintf );
 163     }
 164
 165     /* Make sure we exit (In case other interfaces have been spawned) */
 166     vlc_object_kill( p_intf->p_libvlc );
 167 }
 168
 169 /*****************************************************************************
 170  * NT Service utility functions
 171  *****************************************************************************/
 172 static int NTServiceInstall( intf_thread_t *p_intf )
 173 {
 174     intf_sys_t *p_sys  = p_intf->p_sys;
 175     char psz_path[10*MAX_PATH], psz_pathtmp[MAX_PATH], *psz_extra;
 176     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
 177     if( handle == NULL )
 178     {
 179         msg_Err( p_intf,
 180                  "could not connect to Services Control Manager database" );
 181         return VLC_EGENERIC;
 182     }
 183
 184     /* Find out the filename of ourselves so we can install it to the
 185      * service control manager */
 186     GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
 187     sprintf( psz_path, "\"%s\" -I "MODULE_STRING, psz_pathtmp );
 188
 189     psz_extra = config_GetPsz( p_intf, "ntservice-extraintf" );
 190     if( psz_extra && *psz_extra )
 191     {
 192         strcat( psz_path, " --ntservice-extraintf " );
 193         strcat( psz_path, psz_extra );
 194     }
 195     if( psz_extra ) free( psz_extra );
 196
 197     psz_extra = config_GetPsz( p_intf, "ntservice-options" );
 198     if( psz_extra && *psz_extra )
 199     {
 200         strcat( psz_path, " " );
 201         strcat( psz_path, psz_extra );
 202     }
 203     if( psz_extra ) free( psz_extra );
 204
 205     SC_HANDLE service =
 206         CreateService( handle, p_sys->psz_service, p_sys->psz_service,
 207                        GENERIC_READ | GENERIC_EXECUTE,
 208                        SERVICE_WIN32_OWN_PROCESS,
 209                        SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
 210                        psz_path, NULL, NULL, NULL, NULL, NULL );
 211     if( service == NULL )
 212     {
 213         if( GetLastError() != ERROR_SERVICE_EXISTS )
 214         {
 215             msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
 216                      p_sys->psz_service ,psz_path );
 217             CloseServiceHandle( handle );
 218             return VLC_EGENERIC;
 219         }
 220         else
 221         {
 222             msg_Warn( p_intf, "service \"%s\" already exists",
 223                       p_sys->psz_service );
 224         }
 225     }
 226     else
 227     {
 228         msg_Warn( p_intf, "service successfuly created" );
 229     }
 230
 231     if( service ) CloseServiceHandle( service );
 232     CloseServiceHandle( handle );
 233
 234     return VLC_SUCCESS;
 235 }
 236
 237 static int NTServiceUninstall( intf_thread_t *p_intf )
 238 {
 239     intf_sys_t *p_sys  = p_intf->p_sys;
 240
 241     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
 242     if( handle == NULL )
 243     {
 244         msg_Err( p_intf,
 245                  "could not connect to Services Control Manager database" );
 246         return VLC_EGENERIC;
 247     }
 248
 249     /* First, open a handle to the service */
 250     SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
 251     if( service == NULL )
 252     {
 253         msg_Err( p_intf, "could not open service" );
 254         CloseServiceHandle( handle );
 255         return VLC_EGENERIC;
 256     }
 257
 258     /* Remove the service */
 259     if( !DeleteService( service ) )
 260     {
 261         msg_Err( p_intf, "could not delete service \"%s\"",
 262                  p_sys->psz_service );
 263     }
 264     else
 265     {
 266         msg_Dbg( p_intf, "service deleted successfuly" );
 267     }
 268
 269     CloseServiceHandle( service );
 270     CloseServiceHandle( handle );
 271
 272     return VLC_SUCCESS;
 273 }
 274
 275 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
 276 {
 277     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
 278     intf_sys_t    *p_sys  = p_intf->p_sys;
 279     char *psz_modules, *psz_parser;
 280
 281     /* We have to initialize the service-specific stuff */
 282     memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
 283     p_sys->status.dwServiceType = SERVICE_WIN32;
 284     p_sys->status.dwCurrentState = SERVICE_START_PENDING;
 285     p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
 286
 287     p_sys->hStatus =
 288         RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
 289     if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
 290     {
 291         msg_Err( p_intf, "failed to register service control handler" );
 292         return;
 293     }
 294
 295     /*
 296      * Load background interfaces
 297      */
 298     psz_modules = config_GetPsz( p_intf, "ntservice-extraintf" );
 299     psz_parser = psz_modules;
 300     while( psz_parser && *psz_parser )
 301     {
 302         char *psz_module, *psz_temp;
 303         psz_module = psz_parser;
 304         psz_parser = strchr( psz_module, ',' );
 305         if( psz_parser )
 306         {
 307             *psz_parser = '\0';
 308             psz_parser++;
 309         }
 310         psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
 311         if( psz_temp )
 312         {
 313             intf_thread_t *p_new_intf;
 314             sprintf( psz_temp, "%s,none", psz_module );
 315
 316             /* Try to create the interface */
 317             p_new_intf = intf_Create( p_intf, psz_temp, 0, NULL );
 318             if( p_new_intf == NULL )
 319             {
 320                 msg_Err( p_intf, "interface \"%s\" initialization failed",
 321                          psz_temp );
 322                 free( psz_temp );
 323                 continue;
 324             }
 325
 326             /* Try to run the interface */
 327             if( intf_RunThread( p_new_intf ) )
 328             {
 329                 vlc_object_detach( p_new_intf );
 330                 intf_Destroy( p_new_intf );
 331                 msg_Err( p_intf, "interface \"%s\" cannot run", psz_temp );
 332             }
 333
 334             free( psz_temp );
 335         }
 336     }
 337     if( psz_modules )
 338     {
 339         free( psz_modules );
 340     }
 341
 342     /* Initialization complete - report running status */
 343     p_sys->status.dwCurrentState = SERVICE_RUNNING;
 344     p_sys->status.dwCheckPoint   = 0;
 345     p_sys->status.dwWaitHint     = 0;
 346
 347     SetServiceStatus( p_sys->hStatus, &p_sys->status );
 348 }
 349
 350 static void WINAPI ServiceCtrlHandler( DWORD control )
 351 {
 352     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
 353     intf_sys_t    *p_sys  = p_intf->p_sys;
 354
 355     switch( control )
 356     {
 357     case SERVICE_CONTROL_SHUTDOWN:
 358     case SERVICE_CONTROL_STOP:
 359         p_sys->status.dwCurrentState = SERVICE_STOPPED;
 360         p_sys->status.dwWin32ExitCode = 0;
 361         p_sys->status.dwCheckPoint = 0;
 362         p_sys->status.dwWaitHint = 0;
 363         break;
 364     case SERVICE_CONTROL_INTERROGATE:
 365         /* just set the current state to whatever it is... */
 366         break;
 367     }
 368
 369     SetServiceStatus( p_sys->hStatus, &p_sys->status );
 370 }