rc: header inclusion fix
[vlc.git] / 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     p_intf->pf_run = Run;
111     return VLC_SUCCESS;
112 }
113
114 /*****************************************************************************
115  * Close: destroy interface
116  *****************************************************************************/
117 void Close( vlc_object_t *p_this )
118 {
119     (void)p_this;
120 }
121
122 /*****************************************************************************
123  * Run: interface thread
124  *****************************************************************************/
125 static void Run( intf_thread_t *p_intf )
126 {
127     intf_sys_t sys;
128     intf_thread_t *p_extraintf;
129     SERVICE_TABLE_ENTRY dispatchTable[] =
130     {
131         { VLCSERVICENAME, &ServiceDispatch },
132         { NULL, NULL }
133     };
134
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);
141
142     if( config_GetInt( p_intf, "ntservice-install" ) )
143     {
144         NTServiceInstall( p_intf );
145         return;
146     }
147
148     if( config_GetInt( p_intf, "ntservice-uninstall" ) )
149     {
150         NTServiceUninstall( p_intf );
151         return;
152     }
153
154     if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
155     {
156         msg_Err( p_intf, "StartServiceCtrlDispatcher failed" ); /* str review */
157     }
158
159     free( p_intf->p_sys->psz_service );
160
161     /* Make sure we exit (In case other interfaces have been spawned) */
162     libvlc_Quit( p_intf->p_libvlc );
163     vlc_restorecancel( canc );
164 }
165
166 /*****************************************************************************
167  * NT Service utility functions
168  *****************************************************************************/
169 static int NTServiceInstall( intf_thread_t *p_intf )
170 {
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 );
174     if( handle == NULL )
175     {
176         msg_Err( p_intf,
177                  "could not connect to Services Control Manager database" );
178         return VLC_EGENERIC;
179     }
180
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 );
185
186     psz_extra = config_GetPsz( p_intf, "ntservice-extraintf" );
187     if( psz_extra && *psz_extra )
188     {
189         strcat( psz_path, " --ntservice-extraintf " );
190         strcat( psz_path, psz_extra );
191     }
192     free( psz_extra );
193
194     psz_extra = config_GetPsz( p_intf, "ntservice-options" );
195     if( psz_extra && *psz_extra )
196     {
197         strcat( psz_path, " " );
198         strcat( psz_path, psz_extra );
199     }
200     free( psz_extra );
201
202     SC_HANDLE service =
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 )
209     {
210         if( GetLastError() != ERROR_SERVICE_EXISTS )
211         {
212             msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
213                      p_sys->psz_service ,psz_path );
214             CloseServiceHandle( handle );
215             return VLC_EGENERIC;
216         }
217         else
218         {
219             msg_Warn( p_intf, "service \"%s\" already exists",
220                       p_sys->psz_service );
221         }
222     }
223     else
224     {
225         msg_Warn( p_intf, "service successfuly created" );
226     }
227
228     if( service ) CloseServiceHandle( service );
229     CloseServiceHandle( handle );
230
231     return VLC_SUCCESS;
232 }
233
234 static int NTServiceUninstall( intf_thread_t *p_intf )
235 {
236     intf_sys_t *p_sys  = p_intf->p_sys;
237
238     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
239     if( handle == NULL )
240     {
241         msg_Err( p_intf,
242                  "could not connect to Services Control Manager database" );
243         return VLC_EGENERIC;
244     }
245
246     /* First, open a handle to the service */
247     SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
248     if( service == NULL )
249     {
250         msg_Err( p_intf, "could not open service" );
251         CloseServiceHandle( handle );
252         return VLC_EGENERIC;
253     }
254
255     /* Remove the service */
256     if( !DeleteService( service ) )
257     {
258         msg_Err( p_intf, "could not delete service \"%s\"",
259                  p_sys->psz_service );
260     }
261     else
262     {
263         msg_Dbg( p_intf, "service deleted successfuly" );
264     }
265
266     CloseServiceHandle( service );
267     CloseServiceHandle( handle );
268
269     return VLC_SUCCESS;
270 }
271
272 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
273 {
274     (void)numArgs;
275     (void)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;
279
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;
285
286     p_sys->hStatus =
287         RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
288     if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
289     {
290         msg_Err( p_intf, "failed to register service control handler" );
291         return;
292     }
293
294     /*
295      * Load background interfaces
296      */
297     psz_modules = config_GetPsz( p_intf, "ntservice-extraintf" );
298     psz_parser = psz_modules;
299     while( psz_parser && *psz_parser )
300     {
301         char *psz_module, *psz_temp;
302         psz_module = psz_parser;
303         psz_parser = strchr( psz_module, ',' );
304         if( psz_parser )
305         {
306             *psz_parser = '\0';
307             psz_parser++;
308         }
309
310         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1 )
311         {
312             /* Try to create the interface */
313             if( intf_Create( p_intf, psz_temp ) )
314             {
315                 msg_Err( p_intf, "interface \"%s\" initialization failed",
316                          psz_temp );
317                 free( psz_temp );
318                 continue;
319             }
320             free( psz_temp );
321         }
322     }
323     free( psz_modules );
324
325     /* Initialization complete - report running status */
326     p_sys->status.dwCurrentState = SERVICE_RUNNING;
327     p_sys->status.dwCheckPoint   = 0;
328     p_sys->status.dwWaitHint     = 0;
329
330     SetServiceStatus( p_sys->hStatus, &p_sys->status );
331 }
332
333 static void WINAPI ServiceCtrlHandler( DWORD control )
334 {
335     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
336     intf_sys_t    *p_sys  = p_intf->p_sys;
337
338     switch( control )
339     {
340     case SERVICE_CONTROL_SHUTDOWN:
341     case SERVICE_CONTROL_STOP:
342         p_sys->status.dwCurrentState = SERVICE_STOPPED;
343         p_sys->status.dwWin32ExitCode = 0;
344         p_sys->status.dwCheckPoint = 0;
345         p_sys->status.dwWaitHint = 0;
346         break;
347     case SERVICE_CONTROL_INTERROGATE:
348         /* just set the current state to whatever it is... */
349         break;
350     }
351
352     SetServiceStatus( p_sys->hStatus, &p_sys->status );
353 }