A new GUI for Maemo based on Hildon framework
[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     /* Stop and destroy the interfaces we spawned */
162     while( (p_extraintf = vlc_object_find(p_intf, VLC_OBJECT_INTF, FIND_CHILD)))
163     {
164         intf_StopThread( p_extraintf );
165         vlc_object_detach( p_extraintf );
166         vlc_object_release( p_extraintf );
167         vlc_object_release( p_extraintf );
168     }
169
170     /* Make sure we exit (In case other interfaces have been spawned) */
171     vlc_object_kill( p_intf->p_libvlc );
172     vlc_restorecancel( canc );
173 }
174
175 /*****************************************************************************
176  * NT Service utility functions
177  *****************************************************************************/
178 static int NTServiceInstall( intf_thread_t *p_intf )
179 {
180     intf_sys_t *p_sys  = p_intf->p_sys;
181     char psz_path[10*MAX_PATH], psz_pathtmp[MAX_PATH], *psz_extra;
182     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
183     if( handle == NULL )
184     {
185         msg_Err( p_intf,
186                  "could not connect to Services Control Manager database" );
187         return VLC_EGENERIC;
188     }
189
190     /* Find out the filename of ourselves so we can install it to the
191      * service control manager */
192     GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
193     sprintf( psz_path, "\"%s\" -I "MODULE_STRING, psz_pathtmp );
194
195     psz_extra = config_GetPsz( p_intf, "ntservice-extraintf" );
196     if( psz_extra && *psz_extra )
197     {
198         strcat( psz_path, " --ntservice-extraintf " );
199         strcat( psz_path, psz_extra );
200     }
201     free( psz_extra );
202
203     psz_extra = config_GetPsz( p_intf, "ntservice-options" );
204     if( psz_extra && *psz_extra )
205     {
206         strcat( psz_path, " " );
207         strcat( psz_path, psz_extra );
208     }
209     free( psz_extra );
210
211     SC_HANDLE service =
212         CreateService( handle, p_sys->psz_service, p_sys->psz_service,
213                        GENERIC_READ | GENERIC_EXECUTE,
214                        SERVICE_WIN32_OWN_PROCESS,
215                        SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
216                        psz_path, NULL, NULL, NULL, NULL, NULL );
217     if( service == NULL )
218     {
219         if( GetLastError() != ERROR_SERVICE_EXISTS )
220         {
221             msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
222                      p_sys->psz_service ,psz_path );
223             CloseServiceHandle( handle );
224             return VLC_EGENERIC;
225         }
226         else
227         {
228             msg_Warn( p_intf, "service \"%s\" already exists",
229                       p_sys->psz_service );
230         }
231     }
232     else
233     {
234         msg_Warn( p_intf, "service successfuly created" );
235     }
236
237     if( service ) CloseServiceHandle( service );
238     CloseServiceHandle( handle );
239
240     return VLC_SUCCESS;
241 }
242
243 static int NTServiceUninstall( intf_thread_t *p_intf )
244 {
245     intf_sys_t *p_sys  = p_intf->p_sys;
246
247     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
248     if( handle == NULL )
249     {
250         msg_Err( p_intf,
251                  "could not connect to Services Control Manager database" );
252         return VLC_EGENERIC;
253     }
254
255     /* First, open a handle to the service */
256     SC_HANDLE service = OpenService( handle, p_sys->psz_service, DELETE );
257     if( service == NULL )
258     {
259         msg_Err( p_intf, "could not open service" );
260         CloseServiceHandle( handle );
261         return VLC_EGENERIC;
262     }
263
264     /* Remove the service */
265     if( !DeleteService( service ) )
266     {
267         msg_Err( p_intf, "could not delete service \"%s\"",
268                  p_sys->psz_service );
269     }
270     else
271     {
272         msg_Dbg( p_intf, "service deleted successfuly" );
273     }
274
275     CloseServiceHandle( service );
276     CloseServiceHandle( handle );
277
278     return VLC_SUCCESS;
279 }
280
281 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
282 {
283     (void)numArgs;
284     (void)args;
285     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
286     intf_sys_t    *p_sys  = p_intf->p_sys;
287     char *psz_modules, *psz_parser;
288
289     /* We have to initialize the service-specific stuff */
290     memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
291     p_sys->status.dwServiceType = SERVICE_WIN32;
292     p_sys->status.dwCurrentState = SERVICE_START_PENDING;
293     p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
294
295     p_sys->hStatus =
296         RegisterServiceCtrlHandler( p_sys->psz_service, &ServiceCtrlHandler );
297     if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
298     {
299         msg_Err( p_intf, "failed to register service control handler" );
300         return;
301     }
302
303     /*
304      * Load background interfaces
305      */
306     psz_modules = config_GetPsz( p_intf, "ntservice-extraintf" );
307     psz_parser = psz_modules;
308     while( psz_parser && *psz_parser )
309     {
310         char *psz_module, *psz_temp;
311         psz_module = psz_parser;
312         psz_parser = strchr( psz_module, ',' );
313         if( psz_parser )
314         {
315             *psz_parser = '\0';
316             psz_parser++;
317         }
318
319         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1 )
320         {
321             intf_thread_t *p_new_intf;
322
323             /* Try to create the interface */
324             p_new_intf = intf_Create( p_intf, psz_temp );
325             if( p_new_intf == NULL )
326             {
327                 msg_Err( p_intf, "interface \"%s\" initialization failed",
328                          psz_temp );
329                 free( psz_temp );
330                 continue;
331             }
332
333             /* Try to run the interface */
334             if( intf_RunThread( p_new_intf ) )
335             {
336                 vlc_object_detach( p_new_intf );
337                 vlc_object_release( p_new_intf );
338                 msg_Err( p_intf, "interface \"%s\" cannot run", psz_temp );
339             }
340
341             free( psz_temp );
342         }
343     }
344     free( psz_modules );
345
346     /* Initialization complete - report running status */
347     p_sys->status.dwCurrentState = SERVICE_RUNNING;
348     p_sys->status.dwCheckPoint   = 0;
349     p_sys->status.dwWaitHint     = 0;
350
351     SetServiceStatus( p_sys->hStatus, &p_sys->status );
352 }
353
354 static void WINAPI ServiceCtrlHandler( DWORD control )
355 {
356     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
357     intf_sys_t    *p_sys  = p_intf->p_sys;
358
359     switch( control )
360     {
361     case SERVICE_CONTROL_SHUTDOWN:
362     case SERVICE_CONTROL_STOP:
363         p_sys->status.dwCurrentState = SERVICE_STOPPED;
364         p_sys->status.dwWin32ExitCode = 0;
365         p_sys->status.dwCheckPoint = 0;
366         p_sys->status.dwWaitHint = 0;
367         break;
368     case SERVICE_CONTROL_INTERROGATE:
369         /* just set the current state to whatever it is... */
370         break;
371     }
372
373     SetServiceStatus( p_sys->hStatus, &p_sys->status );
374 }