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 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_interface.h>
35 #define VLCSERVICENAME "VLC media player"
37 /*****************************************************************************
39 *****************************************************************************/
40 static int Activate( vlc_object_t * );
41 static void Close ( vlc_object_t * );
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)")
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 )
80 set_capability( "interface", 0 )
81 set_callbacks( Activate, Close )
86 SERVICE_STATUS_HANDLE hStatus;
87 SERVICE_STATUS status;
91 /*****************************************************************************
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 );
100 /* We need this global */
101 static intf_thread_t *p_global_intf;
103 /*****************************************************************************
104 * Activate: initialize and create stuff
105 *****************************************************************************/
106 static int Activate( vlc_object_t *p_this )
108 intf_thread_t *p_intf = (intf_thread_t*)p_this;
110 p_intf->pf_run = Run;
114 /*****************************************************************************
115 * Close: destroy interface
116 *****************************************************************************/
117 void Close( vlc_object_t *p_this )
122 /*****************************************************************************
123 * Run: interface thread
124 *****************************************************************************/
125 static void Run( intf_thread_t *p_intf )
128 intf_thread_t *p_extraintf;
129 SERVICE_TABLE_ENTRY dispatchTable[] =
131 { VLCSERVICENAME, &ServiceDispatch },
135 int canc = vlc_savecancel();
136 p_global_intf = p_intf;
137 p_intf->p_sys = &sys;
138 p_intf->p_sys->psz_service = config_GetPsz( p_intf, "ntservice-name" );
139 p_intf->p_sys->psz_service = p_intf->p_sys->psz_service ?
140 p_intf->p_sys->psz_service : strdup(VLCSERVICENAME);
142 if( config_GetInt( p_intf, "ntservice-install" ) )
144 NTServiceInstall( p_intf );
148 if( config_GetInt( p_intf, "ntservice-uninstall" ) )
150 NTServiceUninstall( p_intf );
154 if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
156 msg_Err( p_intf, "StartServiceCtrlDispatcher failed" ); /* str review */
159 free( p_intf->p_sys->psz_service );
161 /* Make sure we exit (In case other interfaces have been spawned) */
162 libvlc_Quit( p_intf->p_libvlc );
163 vlc_restorecancel( canc );
166 /*****************************************************************************
167 * NT Service utility functions
168 *****************************************************************************/
169 static int NTServiceInstall( intf_thread_t *p_intf )
171 intf_sys_t *p_sys = p_intf->p_sys;
172 char psz_path[10*MAX_PATH], psz_pathtmp[MAX_PATH], *psz_extra;
173 SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
177 "could not connect to Services Control Manager database" );
181 /* Find out the filename of ourselves so we can install it to the
182 * service control manager */
183 GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
184 sprintf( psz_path, "\"%s\" -I "MODULE_STRING, psz_pathtmp );
186 psz_extra = config_GetPsz( p_intf, "ntservice-extraintf" );
187 if( psz_extra && *psz_extra )
189 strcat( psz_path, " --ntservice-extraintf " );
190 strcat( psz_path, psz_extra );
194 psz_extra = config_GetPsz( p_intf, "ntservice-options" );
195 if( psz_extra && *psz_extra )
197 strcat( psz_path, " " );
198 strcat( psz_path, psz_extra );
203 CreateService( handle, p_sys->psz_service, p_sys->psz_service,
204 GENERIC_READ | GENERIC_EXECUTE,
205 SERVICE_WIN32_OWN_PROCESS,
206 SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
207 psz_path, NULL, NULL, NULL, NULL, NULL );
208 if( service == NULL )
210 if( GetLastError() != ERROR_SERVICE_EXISTS )
212 msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
213 p_sys->psz_service ,psz_path );
214 CloseServiceHandle( handle );
219 msg_Warn( p_intf, "service \"%s\" already exists",
220 p_sys->psz_service );
225 msg_Warn( p_intf, "service successfuly created" );
228 if( service ) CloseServiceHandle( service );
229 CloseServiceHandle( handle );
234 static int NTServiceUninstall( intf_thread_t *p_intf )
236 intf_sys_t *p_sys = p_intf->p_sys;
238 SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
242 "could not connect to Services Control Manager database" );
246 /* First, open a handle to the service */
247 SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
248 if( service == NULL )
250 msg_Err( p_intf, "could not open service" );
251 CloseServiceHandle( handle );
255 /* Remove the service */
256 if( !DeleteService( service ) )
258 msg_Err( p_intf, "could not delete service \"%s\"",
259 p_sys->psz_service );
263 msg_Dbg( p_intf, "service deleted successfuly" );
266 CloseServiceHandle( service );
267 CloseServiceHandle( handle );
272 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
276 intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
277 intf_sys_t *p_sys = p_intf->p_sys;
278 char *psz_modules, *psz_parser;
280 /* We have to initialize the service-specific stuff */
281 memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
282 p_sys->status.dwServiceType = SERVICE_WIN32;
283 p_sys->status.dwCurrentState = SERVICE_START_PENDING;
284 p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
287 RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
288 if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
290 msg_Err( p_intf, "failed to register service control handler" );
295 * Load background interfaces
297 psz_modules = config_GetPsz( p_intf, "ntservice-extraintf" );
298 psz_parser = psz_modules;
299 while( psz_parser && *psz_parser )
301 char *psz_module, *psz_temp;
302 psz_module = psz_parser;
303 psz_parser = strchr( psz_module, ',' );
310 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1 )
312 intf_thread_t *p_new_intf;
314 /* Try to create the interface */
315 p_new_intf = intf_Create( p_intf, psz_temp );
316 if( p_new_intf == NULL )
318 msg_Err( p_intf, "interface \"%s\" initialization failed",
324 /* Try to run the interface */
325 if( intf_RunThread( p_new_intf ) )
327 vlc_object_detach( p_new_intf );
328 vlc_object_release( p_new_intf );
329 msg_Err( p_intf, "interface \"%s\" cannot run", psz_temp );
337 /* Initialization complete - report running status */
338 p_sys->status.dwCurrentState = SERVICE_RUNNING;
339 p_sys->status.dwCheckPoint = 0;
340 p_sys->status.dwWaitHint = 0;
342 SetServiceStatus( p_sys->hStatus, &p_sys->status );
345 static void WINAPI ServiceCtrlHandler( DWORD control )
347 intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
348 intf_sys_t *p_sys = p_intf->p_sys;
352 case SERVICE_CONTROL_SHUTDOWN:
353 case SERVICE_CONTROL_STOP:
354 p_sys->status.dwCurrentState = SERVICE_STOPPED;
355 p_sys->status.dwWin32ExitCode = 0;
356 p_sys->status.dwCheckPoint = 0;
357 p_sys->status.dwWaitHint = 0;
359 case SERVICE_CONTROL_INTERROGATE:
360 /* just set the current state to whatever it is... */
364 SetServiceStatus( p_sys->hStatus, &p_sys->status );