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", false,
  70               INSTALL_TEXT, INSTALL_LONGTEXT, true )
  71     add_bool( "ntservice-uninstall", false,
  72               UNINSTALL_TEXT, UNINSTALL_LONGTEXT, true )
  73     add_string ( "ntservice-name", VLCSERVICENAME,
  74                  NAME_TEXT, NAME_LONGTEXT, true )
  75     add_string ( "ntservice-options", NULL,
  76                  OPTIONS_TEXT, OPTIONS_LONGTEXT, true )
  77     add_string ( "ntservice-extraintf", 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     vlc_thread_t thread;
  90 };
  91
  92 /*****************************************************************************
  93  * Local prototypes
  94  *****************************************************************************/
  95 static void *Run( void * );
  96 static int NTServiceInstall( intf_thread_t *p_intf );
  97 static int NTServiceUninstall( intf_thread_t *p_intf );
  98 static void WINAPI ServiceDispatch( DWORD numArgs, char **args );
  99 static void WINAPI ServiceCtrlHandler( DWORD control );
 100
 101 /* We need this global */
 102 static intf_thread_t *p_global_intf;
 103
 104 /*****************************************************************************
 105  * Activate: initialize and create stuff
 106  *****************************************************************************/
 107 static int Activate( vlc_object_t *p_this )
 108 {
 109     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 110     intf_sys_t *p_sys = malloc( sizeof( *p_sys ) );
 111     if( unlikely(p_sys == NULL) )
 112         return VLC_ENOMEM;
 113
 114     p_intf->pf_run = NULL;
 115     p_intf->p_sys = p_sys;
 116
 117     if( vlc_clone( &p_sys->thread, Run, p_intf, VLC_THREAD_PRIORITY_LOW ) )
 118         return VLC_ENOMEM;
 119
 120     return VLC_SUCCESS;
 121 }
 122
 123 /*****************************************************************************
 124  * Close: destroy interface
 125  *****************************************************************************/
 126 void Close( vlc_object_t *p_this )
 127 {
 128     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 129     intf_sys_t *p_sys = p_intf->p_sys;
 130
 131     vlc_join( p_sys->thread, NULL );
 132     free( p_sys );
 133 }
 134
 135 /*****************************************************************************
 136  * Run: interface thread
 137  *****************************************************************************/
 138 static void *Run( void *data )
 139 {
 140     intf_thread_t *p_intf = data;
 141     SERVICE_TABLE_ENTRY dispatchTable[] =
 142     {
 143         { (LPTSTR)VLCSERVICENAME, &ServiceDispatch },
 144         { NULL, NULL }
 145     };
 146
 147     p_global_intf = p_intf;
 148     p_intf->p_sys->psz_service = var_InheritString( p_intf, "ntservice-name" );
 149     p_intf->p_sys->psz_service = p_intf->p_sys->psz_service ?
 150         p_intf->p_sys->psz_service : strdup(VLCSERVICENAME);
 151
 152     if( var_InheritBool( p_intf, "ntservice-install" ) )
 153     {
 154         NTServiceInstall( p_intf );
 155         return NULL;
 156     }
 157
 158     if( var_InheritBool( p_intf, "ntservice-uninstall" ) )
 159     {
 160         NTServiceUninstall( p_intf );
 161         return NULL;
 162     }
 163
 164     if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
 165     {
 166         msg_Err( p_intf, "StartServiceCtrlDispatcher failed" ); /* str review */
 167     }
 168
 169     free( p_intf->p_sys->psz_service );
 170
 171     /* Make sure we exit (In case other interfaces have been spawned) */
 172     libvlc_Quit( p_intf->p_libvlc );
 173     return NULL;
 174 }
 175
 176 /*****************************************************************************
 177  * NT Service utility functions
 178  *****************************************************************************/
 179 static int NTServiceInstall( intf_thread_t *p_intf )
 180 {
 181     intf_sys_t *p_sys  = p_intf->p_sys;
 182     char psz_path[10*MAX_PATH], psz_pathtmp[MAX_PATH], *psz_extra;
 183     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
 184     if( handle == NULL )
 185     {
 186         msg_Err( p_intf,
 187                  "could not connect to Services Control Manager database" );
 188         return VLC_EGENERIC;
 189     }
 190
 191     /* Find out the filename of ourselves so we can install it to the
 192      * service control manager */
 193     GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
 194     sprintf( psz_path, "\"%s\" -I "MODULE_STRING, psz_pathtmp );
 195
 196     psz_extra = var_InheritString( p_intf, "ntservice-extraintf" );
 197     if( psz_extra )
 198     {
 199         strcat( psz_path, " --ntservice-extraintf " );
 200         strcat( psz_path, psz_extra );
 201         free( psz_extra );
 202     }
 203
 204     psz_extra = var_InheritString( p_intf, "ntservice-options" );
 205     if( psz_extra && *psz_extra )
 206     {
 207         strcat( psz_path, " " );
 208         strcat( psz_path, psz_extra );
 209         free( psz_extra );
 210     }
 211
 212     SC_HANDLE service =
 213         CreateService( handle, p_sys->psz_service, p_sys->psz_service,
 214                        GENERIC_READ | GENERIC_EXECUTE,
 215                        SERVICE_WIN32_OWN_PROCESS,
 216                        SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
 217                        psz_path, NULL, NULL, NULL, NULL, NULL );
 218     if( service == NULL )
 219     {
 220         if( GetLastError() != ERROR_SERVICE_EXISTS )
 221         {
 222             msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
 223                      p_sys->psz_service ,psz_path );
 224             CloseServiceHandle( handle );
 225             return VLC_EGENERIC;
 226         }
 227         else
 228         {
 229             msg_Warn( p_intf, "service \"%s\" already exists",
 230                       p_sys->psz_service );
 231         }
 232     }
 233     else
 234     {
 235         msg_Warn( p_intf, "service successfuly created" );
 236     }
 237
 238     if( service ) CloseServiceHandle( service );
 239     CloseServiceHandle( handle );
 240
 241     return VLC_SUCCESS;
 242 }
 243
 244 static int NTServiceUninstall( intf_thread_t *p_intf )
 245 {
 246     intf_sys_t *p_sys  = p_intf->p_sys;
 247
 248     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
 249     if( handle == NULL )
 250     {
 251         msg_Err( p_intf,
 252                  "could not connect to Services Control Manager database" );
 253         return VLC_EGENERIC;
 254     }
 255
 256     /* First, open a handle to the service */
 257     SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
 258     if( service == NULL )
 259     {
 260         msg_Err( p_intf, "could not open service" );
 261         CloseServiceHandle( handle );
 262         return VLC_EGENERIC;
 263     }
 264
 265     /* Remove the service */
 266     if( !DeleteService( service ) )
 267     {
 268         msg_Err( p_intf, "could not delete service \"%s\"",
 269                  p_sys->psz_service );
 270     }
 271     else
 272     {
 273         msg_Dbg( p_intf, "service deleted successfuly" );
 274     }
 275
 276     CloseServiceHandle( service );
 277     CloseServiceHandle( handle );
 278
 279     return VLC_SUCCESS;
 280 }
 281
 282 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
 283 {
 284     (void)numArgs;
 285     (void)args;
 286     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
 287     intf_sys_t    *p_sys  = p_intf->p_sys;
 288     char *psz_modules, *psz_parser;
 289
 290     /* We have to initialize the service-specific stuff */
 291     memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
 292     p_sys->status.dwServiceType = SERVICE_WIN32;
 293     p_sys->status.dwCurrentState = SERVICE_START_PENDING;
 294     p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
 295
 296     p_sys->hStatus =
 297         RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
 298     if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
 299     {
 300         msg_Err( p_intf, "failed to register service control handler" );
 301         return;
 302     }
 303
 304     /*
 305      * Load background interfaces
 306      */
 307     psz_modules = var_InheritString( p_intf, "ntservice-extraintf" );
 308     psz_parser = psz_modules;
 309     while( psz_parser && *psz_parser )
 310     {
 311         char *psz_module, *psz_temp;
 312         psz_module = psz_parser;
 313         psz_parser = strchr( psz_module, ',' );
 314         if( psz_parser )
 315         {
 316             *psz_parser = '\0';
 317             psz_parser++;
 318         }
 319
 320         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1 )
 321         {
 322             /* Try to create the interface */
 323             if( intf_Create( p_intf, psz_temp ) )
 324             {
 325                 msg_Err( p_intf, "interface \"%s\" initialization failed",
 326                          psz_temp );
 327                 free( psz_temp );
 328                 continue;
 329             }
 330             free( psz_temp );
 331         }
 332     }
 333     free( psz_modules );
 334
 335     /* Initialization complete - report running status */
 336     p_sys->status.dwCurrentState = SERVICE_RUNNING;
 337     p_sys->status.dwCheckPoint   = 0;
 338     p_sys->status.dwWaitHint     = 0;
 339
 340     SetServiceStatus( p_sys->hStatus, &p_sys->status );
 341 }
 342
 343 static void WINAPI ServiceCtrlHandler( DWORD control )
 344 {
 345     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
 346     intf_sys_t    *p_sys  = p_intf->p_sys;
 347
 348     switch( control )
 349     {
 350     case SERVICE_CONTROL_SHUTDOWN:
 351     case SERVICE_CONTROL_STOP:
 352         p_sys->status.dwCurrentState = SERVICE_STOPPED;
 353         p_sys->status.dwWin32ExitCode = 0;
 354         p_sys->status.dwCheckPoint = 0;
 355         p_sys->status.dwWaitHint = 0;
 356         break;
 357     case SERVICE_CONTROL_INTERROGATE:
 358         /* just set the current state to whatever it is... */
 359         break;
 360     }
 361
 362     SetServiceStatus( p_sys->hStatus, &p_sys->status );
 363 }