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