1 /*****************************************************************************
2 * ntservice.c: Windows NT/2K/XP service interface
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: ntservice.c,v 1.4 2003/12/22 02:24:51 sam Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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., 59 Temple Place - Suite 330, Boston, MA 02111, 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 NT/2K/XP service" )
40 #define INSTALL_LONGTEXT N_( \
41 "If enabled the interface will install the service and exit." )
42 #define UNINSTALL_TEXT N_( "Uninstall NT/2K/XP service" )
43 #define UNINSTALL_LONGTEXT N_( \
44 "If enabled the interface will uninstall the service and exit." )
45 #define NAME_TEXT N_( "Display name of the service" )
46 #define NAME_LONGTEXT N_( \
47 "This allows you to change the display name of the service." )
48 #define EXTRAINTF_TEXT N_("Extra interface modules")
49 #define EXTRAINTF_LONGTEXT N_( \
50 "This option allows you to select additional interfaces spawned by the " \
51 "service. It should be specified at install time so the service is " \
52 "properly configured. Use a comma separated list of interface modules. " \
53 "(common values are: logger, sap, rc, http)")
56 set_description( _("Windows NT/2K/XP service interface") );
57 add_category_hint( N_("NT service"), NULL, VLC_TRUE );
58 add_bool( "ntservice-install", 0, NULL,
59 INSTALL_TEXT, INSTALL_LONGTEXT, VLC_TRUE );
60 add_bool( "ntservice-uninstall", 0, NULL,
61 UNINSTALL_TEXT, UNINSTALL_LONGTEXT, VLC_TRUE );
62 add_string ( "ntservice-name", VLCSERVICENAME, NULL,
63 NAME_TEXT, NAME_LONGTEXT, VLC_TRUE );
64 add_string ( "ntservice-extraintf", NULL, NULL,
65 EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
67 set_capability( "interface", 0 );
68 set_callbacks( Activate, Close );
73 SERVICE_STATUS_HANDLE hStatus;
74 SERVICE_STATUS status;
78 /*****************************************************************************
80 *****************************************************************************/
81 static void Run( intf_thread_t *p_intf );
82 static int NTServiceInstall( intf_thread_t *p_intf );
83 static int NTServiceUninstall( intf_thread_t *p_intf );
84 static void WINAPI ServiceDispatch( DWORD numArgs, char **args );
85 static void WINAPI ServiceCtrlHandler( DWORD control );
87 /* We need this global */
88 static intf_thread_t *p_global_intf;
90 /*****************************************************************************
91 * Activate: initialize and create stuff
92 *****************************************************************************/
93 static int Activate( vlc_object_t *p_this )
95 intf_thread_t *p_intf = (intf_thread_t*)p_this;
97 /* Only works on NT/2K/XP */
98 if( !IS_WINNT ) return VLC_EGENERIC;
100 p_intf->pf_run = Run;
104 /*****************************************************************************
105 * Close: destroy interface
106 *****************************************************************************/
107 void Close( vlc_object_t *p_this )
111 /*****************************************************************************
112 * Run: interface thread
113 *****************************************************************************/
114 static void Run( intf_thread_t *p_intf )
116 SERVICE_TABLE_ENTRY dispatchTable[] =
118 { VLCSERVICENAME, &ServiceDispatch },
122 p_global_intf = p_intf;
123 p_intf->p_sys = alloca( sizeof( intf_sys_t ) );
124 p_intf->p_sys->psz_service = config_GetPsz( p_intf, "ntservice-name" );
125 p_intf->p_sys->psz_service = p_intf->p_sys->psz_service ?
126 p_intf->p_sys->psz_service : strdup(VLCSERVICENAME);
128 if( config_GetInt( p_intf, "ntservice-install" ) )
130 NTServiceInstall( p_intf );
134 if( config_GetInt( p_intf, "ntservice-uninstall" ) )
136 NTServiceUninstall( p_intf );
140 if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
142 msg_Err( p_intf, "StartServiceCtrlDispatcher failed" );
145 free( p_intf->p_sys->psz_service );
147 /* Make sure we exit (In case other interfaces have been spawned) */
148 p_intf->p_vlc->b_die = VLC_TRUE;
151 /*****************************************************************************
152 * NT Service utility functions
153 *****************************************************************************/
154 static int NTServiceInstall( intf_thread_t *p_intf )
156 intf_sys_t *p_sys = p_intf->p_sys;
157 char psz_path[MAX_PATH], psz_pathtmp[MAX_PATH], *psz_extraintf;
158 SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
161 msg_Err( p_intf, "Could not connect to SCM database" );
165 /* Find out the filename of ourselves so we can install it to the
166 * service control manager */
167 GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
168 sprintf( psz_path, "\"%s\" -I "MODULE_STRING, psz_pathtmp );
170 psz_extraintf = config_GetPsz( p_intf, "ntservice-extraintf" );
171 if( psz_extraintf && *psz_extraintf )
173 strcat( psz_path, " --ntservice-extraintf " );
174 strcat( psz_path, psz_extraintf );
176 if( psz_extraintf ) free( psz_extraintf );
179 CreateService( handle, p_sys->psz_service, p_sys->psz_service,
180 GENERIC_READ | GENERIC_EXECUTE,
181 SERVICE_WIN32_OWN_PROCESS,
182 SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
183 psz_path, NULL, NULL, NULL, NULL, NULL );
184 if( service == NULL )
186 if( GetLastError() != ERROR_SERVICE_EXISTS )
188 msg_Err( p_intf, "Could not create new service: \"%s\" (%s)",
189 p_sys->psz_service ,psz_path );
190 CloseServiceHandle( handle );
195 msg_Warn( p_intf, "Service \"%s\" already exists",
196 p_sys->psz_service );
201 msg_Warn( p_intf, "Service successfuly created" );
204 if( service ) CloseServiceHandle( service );
205 CloseServiceHandle( handle );
210 static int NTServiceUninstall( intf_thread_t *p_intf )
212 intf_sys_t *p_sys = p_intf->p_sys;
214 SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
217 msg_Err( p_intf, "Could not connect to SCM database" );
221 /* First, open a handle to the service */
222 SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
223 if( service == NULL )
225 msg_Err( p_intf, "Could not open service" );
226 CloseServiceHandle( handle );
230 /* Remove the service */
231 if( !DeleteService( service ) )
233 msg_Err( p_intf, "Could not delete service \"%s\"",
234 p_sys->psz_service );
238 msg_Dbg( p_intf, "Service deleted successfuly" );
241 CloseServiceHandle( service );
242 CloseServiceHandle( handle );
247 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
249 intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
250 intf_sys_t *p_sys = p_intf->p_sys;
251 char *psz_modules, *psz_parser;
253 /* We have to initialize the service-specific stuff */
254 memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
255 p_sys->status.dwServiceType = SERVICE_WIN32;
256 p_sys->status.dwCurrentState = SERVICE_START_PENDING;
257 p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
260 RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
261 if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
263 msg_Err( p_intf, "Failed to register service control handler" );
268 * Load background interfaces
270 psz_modules = config_GetPsz( p_intf, "ntservice-extraintf" );
271 psz_parser = psz_modules;
272 while( psz_parser && *psz_parser )
274 char *psz_module, *psz_temp;
275 psz_module = psz_parser;
276 psz_parser = strchr( psz_module, ',' );
282 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
285 intf_thread_t *p_new_intf;
286 sprintf( psz_temp, "%s,none", psz_module );
288 /* Try to create the interface */
289 p_new_intf = intf_Create( p_intf, psz_temp );
290 if( p_new_intf == NULL )
292 msg_Err( p_intf, "interface \"%s\" initialization failed",
298 /* Try to run the interface */
299 p_new_intf->b_block = VLC_FALSE;
300 if( intf_RunThread( p_new_intf ) )
302 vlc_object_detach( p_new_intf );
303 intf_Destroy( p_new_intf );
304 msg_Err( p_intf, "interface \"%s\" cannot run", psz_temp );
315 /* Initialization complete - report running status */
316 p_sys->status.dwCurrentState = SERVICE_RUNNING;
317 p_sys->status.dwCheckPoint = 0;
318 p_sys->status.dwWaitHint = 0;
320 SetServiceStatus( p_sys->hStatus, &p_sys->status );
323 static void WINAPI ServiceCtrlHandler( DWORD control )
325 intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
326 intf_sys_t *p_sys = p_intf->p_sys;
330 case SERVICE_CONTROL_SHUTDOWN:
331 case SERVICE_CONTROL_STOP:
332 p_sys->status.dwCurrentState = SERVICE_STOPPED;
333 p_sys->status.dwWin32ExitCode = 0;
334 p_sys->status.dwCheckPoint = 0;
335 p_sys->status.dwWaitHint = 0;
337 case SERVICE_CONTROL_INTERROGATE:
338 /* just set the current state to whatever it is... */
342 SetServiceStatus( p_sys->hStatus, &p_sys->status );