mosaic: use vlc_picture_chain_HasNext to check if we can drop a picture
[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  *
6  * Authors: Gildas Bazin <gbazin@videolan.org>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_interface.h>
34 #include <vlc_charset.h>
35 #include <vlc_memstream.h>
36
37 #define VLCSERVICENAME "VLC media player"
38
39 /*****************************************************************************
40  * Module descriptor
41  *****************************************************************************/
42 static int  Activate( vlc_object_t * );
43 static void Close   ( vlc_object_t * );
44
45 #define INSTALL_TEXT N_( "Install Windows Service" )
46 #define INSTALL_LONGTEXT N_( \
47     "Install the Service and exit." )
48 #define UNINSTALL_TEXT N_( "Uninstall Windows Service" )
49 #define UNINSTALL_LONGTEXT N_( \
50     "Uninstall the Service and exit." )
51 #define NAME_TEXT N_( "Display name of the Service" )
52 #define NAME_LONGTEXT N_( \
53     "Change the display name of the Service." )
54 #define OPTIONS_TEXT N_("Configuration options")
55 #define OPTIONS_LONGTEXT N_( \
56     "Configuration options that will be " \
57     "used by the Service (eg. --foo=bar --no-foobar). It should be specified "\
58     "at install time so the Service is properly configured.")
59 #define EXTRAINTF_TEXT N_("Extra interface modules")
60 #define EXTRAINTF_LONGTEXT N_( \
61     "Additional interfaces spawned by the " \
62     "Service. It should be specified at install time so the Service is " \
63     "properly configured. Use a comma separated list of interface modules. " \
64     "(common values are: logger, sap, rc, http)")
65
66 vlc_module_begin ()
67     set_shortname( N_("NT Service"))
68     set_description( N_("Windows Service interface") )
69     set_category( CAT_INTERFACE )
70     set_subcategory( SUBCAT_INTERFACE_CONTROL )
71     add_bool( "ntservice-install", false,
72               INSTALL_TEXT, INSTALL_LONGTEXT, true )
73     add_bool( "ntservice-uninstall", false,
74               UNINSTALL_TEXT, UNINSTALL_LONGTEXT, true )
75     add_string ( "ntservice-name", VLCSERVICENAME,
76                  NAME_TEXT, NAME_LONGTEXT, true )
77     add_string ( "ntservice-options", NULL,
78                  OPTIONS_TEXT, OPTIONS_LONGTEXT, true )
79     add_string ( "ntservice-extraintf", NULL,
80                  EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, true )
81
82     set_capability( "interface", 0 )
83     set_callbacks( Activate, Close )
84 vlc_module_end ()
85
86 struct intf_sys_t
87 {
88     SERVICE_STATUS_HANDLE hStatus;
89     SERVICE_STATUS status;
90     char *psz_service;
91     vlc_thread_t thread;
92 };
93
94 /*****************************************************************************
95  * Local prototypes
96  *****************************************************************************/
97 static void *Run( void * );
98 static int NTServiceInstall( intf_thread_t *p_intf );
99 static int NTServiceUninstall( intf_thread_t *p_intf );
100 static void WINAPI ServiceDispatch( DWORD numArgs, char **args );
101 static void WINAPI ServiceCtrlHandler( DWORD control );
102
103 /* We need this global */
104 static intf_thread_t *p_global_intf;
105
106 /*****************************************************************************
107  * Activate: initialize and create stuff
108  *****************************************************************************/
109 static int Activate( vlc_object_t *p_this )
110 {
111     intf_thread_t *p_intf = (intf_thread_t*)p_this;
112     intf_sys_t *p_sys = malloc( sizeof( *p_sys ) );
113     if( unlikely(p_sys == NULL) )
114         return VLC_ENOMEM;
115
116     p_intf->p_sys = p_sys;
117
118     if( vlc_clone( &p_sys->thread, Run, p_intf, VLC_THREAD_PRIORITY_LOW ) )
119         return VLC_ENOMEM;
120
121     return VLC_SUCCESS;
122 }
123
124 /*****************************************************************************
125  * Close: destroy interface
126  *****************************************************************************/
127 void Close( vlc_object_t *p_this )
128 {
129     intf_thread_t *p_intf = (intf_thread_t*)p_this;
130     intf_sys_t *p_sys = p_intf->p_sys;
131
132     vlc_join( p_sys->thread, NULL );
133     free( p_sys );
134 }
135
136 /*****************************************************************************
137  * Run: interface thread
138  *****************************************************************************/
139 static void *Run( void *data )
140 {
141     intf_thread_t *p_intf = data;
142     SERVICE_TABLE_ENTRY dispatchTable[] =
143     {
144         { (WCHAR*) TEXT(VLCSERVICENAME), (LPSERVICE_MAIN_FUNCTION) &ServiceDispatch },
145         { NULL, NULL }
146     };
147
148     p_global_intf = p_intf;
149     p_intf->p_sys->psz_service = var_InheritString( p_intf, "ntservice-name" );
150     p_intf->p_sys->psz_service = p_intf->p_sys->psz_service ?
151         p_intf->p_sys->psz_service : strdup(VLCSERVICENAME);
152
153     if( var_InheritBool( p_intf, "ntservice-install" ) )
154     {
155         NTServiceInstall( p_intf );
156         return NULL;
157     }
158
159     if( var_InheritBool( p_intf, "ntservice-uninstall" ) )
160     {
161         NTServiceUninstall( p_intf );
162         return NULL;
163     }
164
165     if( StartServiceCtrlDispatcher( dispatchTable ) == 0 )
166     {
167         msg_Err( p_intf, "StartServiceCtrlDispatcher failed" ); /* str review */
168     }
169
170     free( p_intf->p_sys->psz_service );
171
172     /* Make sure we exit (In case other interfaces have been spawned) */
173     libvlc_Quit( vlc_object_instance(p_intf) );
174     return NULL;
175 }
176
177 /*****************************************************************************
178  * NT Service utility functions
179  *****************************************************************************/
180 static int NTServiceInstall( intf_thread_t *p_intf )
181 {
182     intf_sys_t *p_sys  = p_intf->p_sys;
183     char *psz_extra;
184     struct vlc_memstream path_stream;
185     WCHAR psz_pathtmp[MAX_PATH];
186
187     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
188     if( handle == NULL )
189     {
190         msg_Err( p_intf,
191                  "could not connect to Services Control Manager database" );
192         return VLC_EGENERIC;
193     }
194
195     if( vlc_memstream_open(&path_stream) != 0 )
196     {
197         CloseServiceHandle( handle );
198         return VLC_ENOMEM;
199     }
200
201     /* Find out the filename of ourselves so we can install it to the
202      * service control manager */
203     GetModuleFileName( NULL, psz_pathtmp, MAX_PATH );
204     vlc_memstream_printf( &path_stream, "\"%ls\" -I ntservice", psz_pathtmp );
205
206     psz_extra = var_InheritString( p_intf, "ntservice-extraintf" );
207     if( psz_extra && *psz_extra )
208         vlc_memstream_printf( &path_stream, " --ntservice-extraintf %s", psz_extra );
209     free( psz_extra );
210
211     psz_extra = var_InheritString( p_intf, "ntservice-options" );
212     if( psz_extra && *psz_extra )
213         vlc_memstream_printf( &path_stream, " %s", psz_extra );
214     free( psz_extra );
215
216     if ( vlc_memstream_close( &path_stream ) != 0 )
217     {
218         CloseServiceHandle( handle );
219         return VLC_ENOMEM;
220     }
221
222     SC_HANDLE service =
223         CreateServiceA( handle, p_sys->psz_service, p_sys->psz_service,
224                        GENERIC_READ | GENERIC_EXECUTE,
225                        SERVICE_WIN32_OWN_PROCESS,
226                        SERVICE_AUTO_START, SERVICE_ERROR_IGNORE,
227                        path_stream.ptr, NULL, NULL, NULL, NULL, NULL );
228     if( service == NULL )
229     {
230         if( GetLastError() != ERROR_SERVICE_EXISTS )
231         {
232             msg_Err( p_intf, "could not create new service: \"%s\" (%s)",
233                      p_sys->psz_service, path_stream.ptr );
234             free( path_stream.ptr );
235             CloseServiceHandle( handle );
236             return VLC_EGENERIC;
237         }
238         else
239         {
240             msg_Warn( p_intf, "service \"%s\" already exists",
241                       p_sys->psz_service );
242         }
243     }
244     else
245     {
246         msg_Warn( p_intf, "service successfuly created" );
247     }
248
249     free( path_stream.ptr );
250
251     if( service ) CloseServiceHandle( service );
252     CloseServiceHandle( handle );
253
254     return VLC_SUCCESS;
255 }
256
257 static int NTServiceUninstall( intf_thread_t *p_intf )
258 {
259     intf_sys_t *p_sys  = p_intf->p_sys;
260
261     SC_HANDLE handle = OpenSCManager( NULL, NULL, SC_MANAGER_ALL_ACCESS );
262     if( handle == NULL )
263     {
264         msg_Err( p_intf,
265                  "could not connect to Services Control Manager database" );
266         return VLC_EGENERIC;
267     }
268
269     /* First, open a handle to the service */
270     SC_HANDLE service = OpenServiceA( handle, p_sys->psz_service, DELETE );
271     if( service == NULL )
272     {
273         msg_Err( p_intf, "could not open service" );
274         CloseServiceHandle( handle );
275         return VLC_EGENERIC;
276     }
277
278     /* Remove the service */
279     if( !DeleteService( service ) )
280     {
281         msg_Err( p_intf, "could not delete service \"%s\"",
282                  p_sys->psz_service );
283     }
284     else
285     {
286         msg_Dbg( p_intf, "service deleted successfuly" );
287     }
288
289     CloseServiceHandle( service );
290     CloseServiceHandle( handle );
291
292     return VLC_SUCCESS;
293 }
294
295 static void WINAPI ServiceDispatch( DWORD numArgs, char **args )
296 {
297     (void)numArgs;
298     (void)args;
299     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
300     intf_sys_t    *p_sys  = p_intf->p_sys;
301     char *psz_modules, *psz_parser;
302
303     /* We have to initialize the service-specific stuff */
304     memset( &p_sys->status, 0, sizeof(SERVICE_STATUS) );
305     p_sys->status.dwServiceType = SERVICE_WIN32;
306     p_sys->status.dwCurrentState = SERVICE_START_PENDING;
307     p_sys->status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
308
309     p_sys->hStatus =
310         RegisterServiceCtrlHandlerA( p_sys->psz_service, &ServiceCtrlHandler );
311     if( p_sys->hStatus == (SERVICE_STATUS_HANDLE)0 )
312     {
313         msg_Err( p_intf, "failed to register service control handler" );
314         return;
315     }
316
317     /*
318      * Load background interfaces
319      */
320     psz_modules = var_InheritString( p_intf, "ntservice-extraintf" );
321     psz_parser = psz_modules;
322     while( psz_parser && *psz_parser )
323     {
324         char *psz_module, *psz_temp;
325         psz_module = psz_parser;
326         psz_parser = strchr( psz_module, ',' );
327         if( psz_parser )
328         {
329             *psz_parser = '\0';
330             psz_parser++;
331         }
332
333         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1 )
334         {
335             /* Try to create the interface */
336             if( intf_Create( vlc_object_instance(p_intf), psz_temp ) )
337             {
338                 msg_Err( p_intf, "interface \"%s\" initialization failed",
339                          psz_temp );
340                 free( psz_temp );
341                 continue;
342             }
343             free( psz_temp );
344         }
345     }
346     free( psz_modules );
347
348     /* Initialization complete - report running status */
349     p_sys->status.dwCurrentState = SERVICE_RUNNING;
350     p_sys->status.dwCheckPoint   = 0;
351     p_sys->status.dwWaitHint     = 0;
352
353     SetServiceStatus( p_sys->hStatus, &p_sys->status );
354 }
355
356 static void WINAPI ServiceCtrlHandler( DWORD control )
357 {
358     intf_thread_t *p_intf = (intf_thread_t *)p_global_intf;
359     intf_sys_t    *p_sys  = p_intf->p_sys;
360
361     switch( control )
362     {
363     case SERVICE_CONTROL_SHUTDOWN:
364     case SERVICE_CONTROL_STOP:
365         p_sys->status.dwCurrentState = SERVICE_STOPPED;
366         p_sys->status.dwWin32ExitCode = 0;
367         p_sys->status.dwCheckPoint = 0;
368         p_sys->status.dwWaitHint = 0;
369         break;
370     case SERVICE_CONTROL_INTERROGATE:
371         /* just set the current state to whatever it is... */
372         break;
373     }
374
375     SetServiceStatus( p_sys->hStatus, &p_sys->status );
376 }