1 /*****************************************************************************
2 * services_discovery.c : Services discovery using lua scripts
3 *****************************************************************************
4 * Copyright (C) 2010 VideoLAN and AUTHORS
6 * Authors: Fabio Ritrovato <sephiroth87 at videolan dot org>
7 * RĂ©mi Duraffort <ivoire at videolan -dot- 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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include <vlc_services_discovery.h>
34 /*****************************************************************************
36 *****************************************************************************/
37 static void *Run( void * );
38 static int DoSearch( services_discovery_t *p_sd, const char *psz_query );
39 static int FillDescriptor( services_discovery_t *, services_discovery_descriptor_t * );
40 static int Control( services_discovery_t *p_sd, int i_command, va_list args );
42 static const char * const ppsz_sd_options[] = { "sd", "longname", NULL };
44 /*****************************************************************************
46 *****************************************************************************/
47 struct services_discovery_sys_t
60 static const luaL_Reg p_reg[] = { { NULL, NULL } };
62 /*****************************************************************************
63 * Open: initialize and create stuff
64 *****************************************************************************/
65 int Open_LuaSD( vlc_object_t *p_this )
67 services_discovery_t *p_sd = ( services_discovery_t * )p_this;
68 services_discovery_sys_t *p_sys;
72 if( !strcmp( p_sd->psz_name, "lua" ) )
74 // We want to load the module name "lua"
75 // This module can be used to load lua script not registered
76 // as builtin lua SD modules.
77 config_ChainParse( p_sd, "lua-", ppsz_sd_options, p_sd->p_cfg );
78 psz_name = var_GetString( p_sd, "lua-sd" );
82 // We are loading a builtin lua sd module.
83 psz_name = strdup(p_sd->psz_name);
86 if( !( p_sys = malloc( sizeof( services_discovery_sys_t ) ) ) )
92 p_sd->pf_control = Control;
93 p_sys->psz_filename = vlclua_find_file( p_this, "sd", psz_name );
94 if( !p_sys->psz_filename )
96 msg_Err( p_sd, "Couldn't find lua services discovery script \"%s\".",
105 msg_Err( p_sd, "Could not create new Lua State" );
108 vlclua_set_this( L, p_sd );
110 luaL_register( L, "vlc", p_reg );
116 luaopen_strings( L );
117 luaopen_variables( L );
119 luaopen_gettext( L );
124 if( vlclua_add_modules_path( p_sd, L, p_sys->psz_filename ) )
126 msg_Warn( p_sd, "Error while setting the module search path for %s",
127 p_sys->psz_filename );
130 if( luaL_dofile( L, p_sys->psz_filename ) )
132 msg_Err( p_sd, "Error loading script %s: %s", p_sys->psz_filename,
133 lua_tostring( L, lua_gettop( L ) ) );
138 vlc_mutex_init( &p_sys->lock );
139 vlc_cond_init( &p_sys->cond );
140 p_sys->b_exiting = false;
141 TAB_INIT( p_sys->i_query, p_sys->ppsz_query );
143 if( vlc_clone( &p_sys->thread, Run, p_sd, VLC_THREAD_PRIORITY_LOW ) )
145 TAB_CLEAN( p_sys->i_query, p_sys->ppsz_query );
146 vlc_cond_destroy( &p_sys->cond );
147 vlc_mutex_destroy( &p_sys->lock );
155 free( p_sys->psz_filename );
160 /*****************************************************************************
162 *****************************************************************************/
163 void Close_LuaSD( vlc_object_t *p_this )
165 services_discovery_t *p_sd = ( services_discovery_t * )p_this;
166 services_discovery_sys_t *p_sys = p_sd->p_sys;
168 vlc_mutex_lock( &p_sys->lock );
169 p_sys->b_exiting = true;
170 vlc_mutex_unlock( &p_sys->lock );
172 vlc_cancel( p_sys->thread );
173 vlc_join( p_sys->thread, NULL );
175 for( int i = 0; i < p_sys->i_query; i++ )
176 free( p_sys->ppsz_query[i] );
177 TAB_CLEAN( p_sys->i_query, p_sys->ppsz_query );
179 vlc_cond_destroy( &p_sys->cond );
180 vlc_mutex_destroy( &p_sys->lock );
181 free( p_sys->psz_filename );
182 lua_close( p_sys->L );
186 /*****************************************************************************
187 * Run: Thread entry-point
188 ****************************************************************************/
189 static void* Run( void *data )
191 services_discovery_t *p_sd = ( services_discovery_t * )data;
192 services_discovery_sys_t *p_sys = p_sd->p_sys;
193 lua_State *L = p_sys->L;
195 int cancel = vlc_savecancel();
197 lua_getglobal( L, "main" );
198 if( !lua_isfunction( L, lua_gettop( L ) ) || lua_pcall( L, 0, 1, 0 ) )
200 msg_Err( p_sd, "Error while running script %s, "
201 "function main(): %s", p_sys->psz_filename,
202 lua_tostring( L, lua_gettop( L ) ) );
204 vlc_restorecancel( cancel );
207 msg_Dbg( p_sd, "LuaSD script loaded: %s", p_sys->psz_filename );
209 /* Force garbage collection, because the core will keep the SD
210 * open, but lua will never gc until lua_close(). */
211 lua_gc( L, LUA_GCCOLLECT, 0 );
213 vlc_restorecancel( cancel );
215 /* Main loop to handle search requests */
216 vlc_mutex_lock( &p_sys->lock );
217 mutex_cleanup_push( &p_sys->lock );
218 while( !p_sys->b_exiting )
220 /* Wait for a request */
221 while( !p_sys->i_query )
222 vlc_cond_wait( &p_sys->cond, &p_sys->lock );
224 /* Execute every query each one protected against cancelation */
225 cancel = vlc_savecancel();
226 while( !p_sys->b_exiting && p_sys->i_query )
228 char *psz_query = p_sys->ppsz_query[p_sys->i_query - 1];
229 REMOVE_ELEM( p_sys->ppsz_query, p_sys->i_query, p_sys->i_query - 1 );
231 vlc_mutex_unlock( &p_sys->lock );
232 DoSearch( p_sd, psz_query );
234 vlc_mutex_lock( &p_sys->lock );
236 /* Force garbage collection, because the core will keep the SD
237 * open, but lua will never gc until lua_close(). */
238 lua_gc( L, LUA_GCCOLLECT, 0 );
240 vlc_restorecancel( cancel );
247 /*****************************************************************************
248 * Control: services discrovery control
249 ****************************************************************************/
250 static int Control( services_discovery_t *p_sd, int i_command, va_list args )
252 services_discovery_sys_t *p_sys = p_sd->p_sys;
258 const char *psz_query = va_arg( args, const char * );
259 vlc_mutex_lock( &p_sys->lock );
260 TAB_APPEND( p_sys->i_query, p_sys->ppsz_query, strdup( psz_query ) );
261 vlc_cond_signal( &p_sys->cond );
262 vlc_mutex_unlock( &p_sys->lock );
266 case SD_CMD_DESCRIPTOR:
268 services_discovery_descriptor_t *p_desc = va_arg( args,
269 services_discovery_descriptor_t * );
270 return FillDescriptor( p_sd, p_desc );
277 /*****************************************************************************
278 * DoSearch: search for a given query
279 ****************************************************************************/
280 static int DoSearch( services_discovery_t *p_sd, const char *psz_query )
282 services_discovery_sys_t *p_sys = p_sd->p_sys;
283 lua_State *L = p_sys->L;
285 /* Lookup for the 'search' function */
286 lua_getglobal( L, "search" );
287 if( !lua_isfunction( L, lua_gettop( L ) ) )
289 msg_Err( p_sd, "The script '%s' does not define any 'search' function",
290 p_sys->psz_filename );
296 lua_pushstring( L, psz_query );
298 /* Call the 'search' function */
299 if( lua_pcall( L, 1, 0, 0 ) )
301 msg_Err( p_sd, "Error while running the script '%s': %s",
302 p_sys->psz_filename, lua_tostring( L, lua_gettop( L ) ) );
310 /** List of capabilities */
311 static const char *const ppsz_capabilities[] = {
316 /*****************************************************************************
317 * FillDescriptor: call the descriptor function and fill the structure
318 ****************************************************************************/
319 static int FillDescriptor( services_discovery_t *p_sd,
320 services_discovery_descriptor_t *p_desc )
322 services_discovery_sys_t *p_sys = p_sd->p_sys;
323 int i_ret = VLC_EGENERIC;
325 /* Create a new lua thread */
326 lua_State *L = luaL_newstate();
327 if( luaL_dofile( L, p_sys->psz_filename ) )
329 msg_Err( p_sd, "Error loading script %s: %s", p_sys->psz_filename,
330 lua_tostring( L, -1 ) );
334 /* Call the "descriptor" function */
335 lua_getglobal( L, "descriptor" );
336 if( !lua_isfunction( L, -1 ) || lua_pcall( L, 0, 1, 0 ) )
338 msg_Warn( p_sd, "Error getting the descriptor in '%s': %s",
339 p_sys->psz_filename, lua_tostring( L, -1 ) );
343 /* Get the different fields of the returned table */
344 lua_getfield( L, -1, "short_description" );
345 p_desc->psz_short_desc = luaL_strdupornull( L, -1 );
348 lua_getfield( L, -1, "icon" );
349 p_desc->psz_icon_url = luaL_strdupornull( L, -1 );
352 lua_getfield( L, -1, "url" );
353 p_desc->psz_url = luaL_strdupornull( L, -1 );
356 lua_getfield( L, -1, "capabilities" );
357 p_desc->i_capabilities = 0;
358 if( lua_istable( L, -1 ) )
360 /* List all table entries */
362 while( lua_next( L, -2 ) != 0 )
364 /* Key is at index -2 and value at index -1 */
365 const char *psz_cap = luaL_checkstring( L, -1 );
367 const char *psz_iter;
368 for( psz_iter = *ppsz_capabilities; psz_iter;
369 psz_iter = ppsz_capabilities[ ++i_cap ] )
371 if( !strcmp( psz_iter, psz_cap ) )
373 p_desc->i_capabilities |= 1 << i_cap;
378 msg_Warn( p_sd, "Services discovery capability '%s' unknown in "
379 "script '%s'", psz_cap, p_sys->psz_filename );