1 /*****************************************************************************
2 * ntservice.c: Windows NT/2K/XP service interface
3 *****************************************************************************
4 * Copyright (C) 2004 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #define VLCSERVICENAME "VLC media player"
33 /*****************************************************************************
35 *****************************************************************************/
36 static int Activate( vlc_object_t * );
37 static void Close ( vlc_object_t * );
39 #define INSTALL_TEXT N_( "Install Windows Service" )
40 #define INSTALL_LONGTEXT N_( \
41 "Install the Service and exit." )
42 #define UNINSTALL_TEXT N_( "Uninstall Windows Service" )
43 #define UNINSTALL_LONGTEXT N_( \
44 "Uninstall the Service and exit." )
45 #define NAME_TEXT N_( "Display name of the Service" )
46 #define NAME_LONGTEXT N_( \
47 "Change the display name of the Service." )
48 #define OPTIONS_TEXT N_("Configuration options")
49 #define OPTIONS_LONGTEXT N_( \
50 "Configuration options that will be " \
51 "used by the Service (eg. --foo=bar --no-foobar). It should be specified "\
52 "at install time so the Service is properly configured.")
53 #define EXTRAINTF_TEXT N_("Extra interface modules")
54 #define EXTRAINTF_LONGTEXT N_( \
55 "Additional interfaces spawned by the " \
56 "Service. It should be specified at install time so the Service is " \
57 "properly configured. Use a comma separated list of interface modules. " \
58 "(common values are: logger, sap, rc, http)")
61 set_shortname( _("NT Service"));
62 set_description( _("Windows Service interface") );
63 set_category( CAT_INTERFACE );
64 set_subcategory( SUBCAT_INTERFACE_CONTROL );
65 add_bool( "ntservice-install", 0, NULL,
66 INSTALL_TEXT, INSTALL_LONGTEXT, VLC_TRUE );
67 add_bool( "ntservice-uninstall", 0, NULL,
68 UNINSTALL_TEXT, UNINSTALL_LONGTEXT, VLC_TRUE );
69 add_string ( "ntservice-name", VLCSERVICENAME, NULL,
70 NAME_TEXT, NAME_LONGTEXT, VLC_TRUE );
71 add_string ( "ntservice-options", NULL, NULL,
72 OPTIONS_TEXT, OPTIONS_LONGTEXT, VLC_TRUE );
73 add_string ( "ntservice-extraintf", NULL, NULL,
74 EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
76 set_capability( "interface", 0 );
77 set_callbacks( Activate, Close );
82 SERVICE_STATUS_HANDLE hStatus;
83 SERVICE_STATUS status;
87 /*****************************************************************************
89 *****************************************************************************/
90 static void Run( intf_thread_t *p_intf );
91 static int NTServiceInstall( intf_thread_t *p_intf );
92 static int NTServiceUninstall( intf_thread_t *p_intf );
93 static void WINAPI ServiceDispatch( DWORD numArgs, char **args );
94 static void WINAPI ServiceCtrlHandler( DWORD control );
96 /* We need this global */
97 static intf_thread_t *p_global_intf;
99 /*****************************************************************************
100 * Activate: initialize and create stuff
101 *****************************************************************************/
102 static int Activate( vlc_object_t *p_this )
104 intf_thread_t *p_intf = (intf_thread_t*)p_this;
106 /* Only works on NT/2K/XP */
107 if( !IS_WINNT ) return VLC_EGENERIC;
109 p_intf->pf_run = Run;
113 /*****************************************************************************
114 * Close: destroy interface
115 *****************************************************************************/
116 void Close( vlc_object_t *p_this )
120 /*****************************************************************************
121 * Run: interface thread
122 *****************************************************************************/
123 static void Run( intf_thread_t *p_intf )
125 intf_thread_t *p_extraintf;
126 SERVICE_TABLE_ENTRY dispatchTable[] =
128 { VLCSERVICENAME, &ServiceDispatch },
132 p_global_intf = p_intf;
133 p_intf->p_sys = alloca( sizeof( intf_sys_t ) );
134 p_intf->p_sys->psz_service = config_GetPsz( p_intf, "ntservice-name" );
135 p_intf->p_sys->psz_service = p_intf->p_sys->psz_service ?
136 p_intf->p_sys->psz_service : strdup(VLCSERVICENAME);
138 if( config_GetInt( p_intf, "ntservice-install" ) )
140 NTServiceInstall( p_intf );
144 if( config_GetInt( p_intf, "ntservice-uninstall" ) )
146 NTServiceUninstall( p_intf );
150 if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
152 msg_Err( p_intf, "StartServiceCtrlDispatcher failed" ); /* str review */
155 free( p_intf->p_sys->psz_service );
157 /* Stop and destroy the interfaces we spawned */
158 while( (p_extraintf = vlc_object_find(p_intf, VLC_OBJECT_INTF, FIND_CHILD)))
160 intf_StopThread( p_extraintf );
161 vlc_object_detach( p_extraintf );
162 vlc_object_release( p_extraintf );
163 intf_Destroy( p_extraintf );
166 /* Make sure we exit (In case other interfaces have been spawned) */
167 p_intf->p_libvlc->b_die = VLC_TRUE;
170 /*****************************************************************************
171 * NT Service utility functions
172 *****************************************************************************/
173 static int NTServiceInstall( intf_thread_t *p_intf )
175 intf_sys_t *p_sys = p_intf->p_sys;
176 char psz_path[10*MAX_PATH], psz_pathtmp[MAX_PATH], *psz_extra;
177 SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
181 "could not connect to Services Control Manager database" );
185 /* Find out the filename of ourselves so we can install it to the
186 * service control manager */
187 GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
188 sprintf( psz_path, "\"%s\" -I "MODULE_STRING, psz_pathtmp );
190 psz_extra = config_GetPsz( p_intf, "ntservice-extraintf" );
191 if( psz_extra && *psz_extra )
193 strcat( psz_path, " --ntservice-extraintf " );
194 strcat( psz_path, psz_extra );
196 if( psz_extra ) free( psz_extra );
198 psz_extra = config_GetPsz( p_intf, "ntservice-options" );
199 if( psz_extra && *psz_extra )
201 strcat( psz_path, " " );
202 strcat( psz_path, psz_extra );
204 if( psz_extra ) free( psz_extra );
207 CreateService( handle, p_sys->psz_service, p_sys->psz_service,
208 GENERIC_READ | GENERIC_EXECUTE,
209 SERVICE_WIN32_OWN_PROCESS,
210 SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
211 psz_path, NULL, NULL, NULL, NULL, NULL );
212 if( service == NULL )
214 if( GetLastError() != ERROR_SERVICE_EXISTS )
216 msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
217 p_sys->psz_service ,psz_path );
218 CloseServiceHandle( handle );
223 msg_Warn( p_intf, "service \"%s\" already exists",
224 p_sys->psz_service );
229 msg_Warn( p_intf, "service successfuly created" );
232 if( service ) CloseServiceHandle( service );
233 CloseServiceHandle( handle );
238 static int NTServiceUninstall( intf_thread_t *p_intf )
240 intf_sys_t *p_sys = p_intf->p_sys;
242 SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
246 "could not connect to Services Control Manager database" );
250 /* First, open a handle to the service */
251 SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
252 if( service == NULL )
254 msg_Err( p_intf, "could not open service" );
255 CloseServiceHandle( handle );
259 /* Remove the service */
260 if( !DeleteService( service ) )
262 msg_Err( p_intf, "could not delete service \"%s\"",
263 p_sys->psz_service );
267 msg_Dbg( p_intf, "service deleted successfuly" );
270 CloseServiceHandle( service );
271 CloseServiceHandle( handle );
276 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
278 intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
279 intf_sys_t *p_sys = p_intf->p_sys;
280 char *psz_modules, *psz_parser;
282 /* We have to initialize the service-specific stuff */
283 memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
284 p_sys->status.dwServiceType = SERVICE_WIN32;
285 p_sys->status.dwCurrentState = SERVICE_START_PENDING;
286 p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
289 RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
290 if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
292 msg_Err( p_intf, "failed to register service control handler" );
297 * Load background interfaces
299 psz_modules = config_GetPsz( p_intf, "ntservice-extraintf" );
300 psz_parser = psz_modules;
301 while( psz_parser && *psz_parser )
303 char *psz_module, *psz_temp;
304 psz_module = psz_parser;
305 psz_parser = strchr( psz_module, ',' );
311 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
314 intf_thread_t *p_new_intf;
315 sprintf( psz_temp, "%s,none", psz_module );
317 /* Try to create the interface */
318 p_new_intf = intf_Create( p_intf, psz_temp, 0, NULL );
319 if( p_new_intf == NULL )
321 msg_Err( p_intf, "interface \"%s\" initialization failed",
327 /* Try to run the interface */
328 p_new_intf->b_block = VLC_FALSE;
329 if( intf_RunThread( p_new_intf ) )
331 vlc_object_detach( p_new_intf );
332 intf_Destroy( p_new_intf );
333 msg_Err( p_intf, "interface \"%s\" cannot run", psz_temp );
344 /* Initialization complete - report running status */
345 p_sys->status.dwCurrentState = SERVICE_RUNNING;
346 p_sys->status.dwCheckPoint = 0;
347 p_sys->status.dwWaitHint = 0;
349 SetServiceStatus( p_sys->hStatus, &p_sys->status );
352 static void WINAPI ServiceCtrlHandler( DWORD control )
354 intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
355 intf_sys_t *p_sys = p_intf->p_sys;
359 case SERVICE_CONTROL_SHUTDOWN:
360 case SERVICE_CONTROL_STOP:
361 p_sys->status.dwCurrentState = SERVICE_STOPPED;
362 p_sys->status.dwWin32ExitCode = 0;
363 p_sys->status.dwCheckPoint = 0;
364 p_sys->status.dwWaitHint = 0;
366 case SERVICE_CONTROL_INTERROGATE:
367 /* just set the current state to whatever it is... */
371 SetServiceStatus( p_sys->hStatus, &p_sys->status );