git.sesse.net Git - vlc/blob - modules/lua/services_discovery.c

   1 /*****************************************************************************
   2  * services_discovery.c : Services discovery using lua scripts
   3  *****************************************************************************
   4  * Copyright (C) 2010 VideoLAN and AUTHORS
   5  *
   6  * Authors: Fabio Ritrovato <sephiroth87 at videolan dot org>
   7  *          Rémi Duraffort <ivoire at videolan -dot- 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 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include <vlc_services_discovery.h>
  30
  31 #include "vlc.h"
  32 #include "libs.h"
  33
  34 /*****************************************************************************
  35  * Local prototypes
  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 );
  41
  42 static const char * const ppsz_sd_options[] = { "sd", "longname", NULL };
  43
  44 /*****************************************************************************
  45  * Local structures
  46  *****************************************************************************/
  47 struct services_discovery_sys_t
  48 {
  49     lua_State *L;
  50     char *psz_filename;
  51
  52     vlc_thread_t thread;
  53     vlc_mutex_t lock;
  54     vlc_cond_t cond;
  55     bool b_exiting;
  56
  57     char **ppsz_query;
  58     int i_query;
  59 };
  60 static const luaL_Reg p_reg[] = { { NULL, NULL } };
  61
  62 /*****************************************************************************
  63  * Open: initialize and create stuff
  64  *****************************************************************************/
  65 int Open_LuaSD( vlc_object_t *p_this )
  66 {
  67     services_discovery_t *p_sd = ( services_discovery_t * )p_this;
  68     services_discovery_sys_t *p_sys;
  69     lua_State *L = NULL;
  70     char *psz_name;
  71
  72     if( !strcmp( p_sd->psz_name, "lua" ) )
  73     {
  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" );
  79     }
  80     else
  81     {
  82         // We are loading a builtin lua sd module.
  83         psz_name = strdup(p_sd->psz_name);
  84     }
  85
  86     if( !( p_sys = malloc( sizeof( services_discovery_sys_t ) ) ) )
  87     {
  88         free( psz_name );
  89         return VLC_ENOMEM;
  90     }
  91     p_sd->p_sys = p_sys;
  92     p_sd->pf_control = Control;
  93     p_sys->psz_filename = vlclua_find_file( "sd", psz_name );
  94     if( !p_sys->psz_filename )
  95     {
  96         msg_Err( p_sd, "Couldn't find lua services discovery script \"%s\".",
  97                  psz_name );
  98         free( psz_name );
  99         goto error;
 100     }
 101     free( psz_name );
 102     L = luaL_newstate();
 103     if( !L )
 104     {
 105         msg_Err( p_sd, "Could not create new Lua State" );
 106         goto error;
 107     }
 108     vlclua_set_this( L, p_sd );
 109     luaL_openlibs( L );
 110     luaL_register( L, "vlc", p_reg );
 111     luaopen_input( L );
 112     luaopen_msg( L );
 113     luaopen_object( L );
 114     luaopen_sd( L );
 115     luaopen_strings( L );
 116     luaopen_variables( L );
 117     luaopen_stream( L );
 118     luaopen_gettext( L );
 119     luaopen_xml( L );
 120     lua_pop( L, 1 );
 121
 122     if( vlclua_add_modules_path( L, p_sys->psz_filename ) )
 123     {
 124         msg_Warn( p_sd, "Error while setting the module search path for %s",
 125                   p_sys->psz_filename );
 126         goto error;
 127     }
 128     if( luaL_dofile( L, p_sys->psz_filename ) )
 129     {
 130         msg_Err( p_sd, "Error loading script %s: %s", p_sys->psz_filename,
 131                   lua_tostring( L, lua_gettop( L ) ) );
 132         lua_pop( L, 1 );
 133         goto error;
 134     }
 135     p_sys->L = L;
 136     vlc_mutex_init( &p_sys->lock );
 137     vlc_cond_init( &p_sys->cond );
 138     p_sys->b_exiting = false;
 139     TAB_INIT( p_sys->i_query, p_sys->ppsz_query );
 140
 141     if( vlc_clone( &p_sys->thread, Run, p_sd, VLC_THREAD_PRIORITY_LOW ) )
 142     {
 143         TAB_CLEAN( p_sys->i_query, p_sys->ppsz_query );
 144         vlc_cond_destroy( &p_sys->cond );
 145         vlc_mutex_destroy( &p_sys->lock );
 146         goto error;
 147     }
 148     return VLC_SUCCESS;
 149
 150 error:
 151     if( L )
 152         lua_close( L );
 153     free( p_sys->psz_filename );
 154     free( p_sys );
 155     return VLC_EGENERIC;
 156 }
 157
 158 /*****************************************************************************
 159  * Close: cleanup
 160  *****************************************************************************/
 161 void Close_LuaSD( vlc_object_t *p_this )
 162 {
 163     services_discovery_t *p_sd = ( services_discovery_t * )p_this;
 164     services_discovery_sys_t *p_sys = p_sd->p_sys;
 165
 166     vlc_mutex_lock( &p_sys->lock );
 167     p_sys->b_exiting = true;
 168     vlc_mutex_unlock( &p_sys->lock );
 169
 170     vlc_cancel( p_sys->thread );
 171     vlc_join( p_sys->thread, NULL );
 172
 173     for( int i = 0; i < p_sys->i_query; i++ )
 174         free( p_sys->ppsz_query[i] );
 175     TAB_CLEAN( p_sys->i_query, p_sys->ppsz_query );
 176
 177     vlc_cond_destroy( &p_sys->cond );
 178     vlc_mutex_destroy( &p_sys->lock );
 179     free( p_sys->psz_filename );
 180     lua_close( p_sys->L );
 181     free( p_sys );
 182 }
 183
 184 /*****************************************************************************
 185  * Run: Thread entry-point
 186  ****************************************************************************/
 187 static void* Run( void *data )
 188 {
 189     services_discovery_t *p_sd = ( services_discovery_t * )data;
 190     services_discovery_sys_t *p_sys = p_sd->p_sys;
 191     lua_State *L = p_sys->L;
 192
 193     int cancel = vlc_savecancel();
 194
 195     lua_getglobal( L, "main" );
 196     if( !lua_isfunction( L, lua_gettop( L ) ) || lua_pcall( L, 0, 1, 0 ) )
 197     {
 198         msg_Err( p_sd, "Error while running script %s, "
 199                   "function main(): %s", p_sys->psz_filename,
 200                   lua_tostring( L, lua_gettop( L ) ) );
 201         lua_pop( L, 1 );
 202         vlc_restorecancel( cancel );
 203         return NULL;
 204     }
 205     msg_Dbg( p_sd, "LuaSD script loaded: %s", p_sys->psz_filename );
 206
 207     /* Force garbage collection, because the core will keep the SD
 208      * open, but lua will never gc until lua_close(). */
 209     lua_gc( L, LUA_GCCOLLECT, 0 );
 210
 211     vlc_restorecancel( cancel );
 212
 213     /* Main loop to handle search requests */
 214     vlc_mutex_lock( &p_sys->lock );
 215     mutex_cleanup_push( &p_sys->lock );
 216     while( !p_sys->b_exiting )
 217     {
 218         /* Wait for a request */
 219         while( !p_sys->i_query )
 220             vlc_cond_wait( &p_sys->cond, &p_sys->lock );
 221
 222         /* Execute every query each one protected against cancelation */
 223         cancel = vlc_savecancel();
 224         while( !p_sys->b_exiting && p_sys->i_query )
 225         {
 226             char *psz_query = p_sys->ppsz_query[p_sys->i_query - 1];
 227             REMOVE_ELEM( p_sys->ppsz_query, p_sys->i_query, p_sys->i_query - 1 );
 228
 229             vlc_mutex_unlock( &p_sys->lock );
 230             DoSearch( p_sd, psz_query );
 231             free( psz_query );
 232             vlc_mutex_lock( &p_sys->lock );
 233         }
 234         /* Force garbage collection, because the core will keep the SD
 235          * open, but lua will never gc until lua_close(). */
 236         lua_gc( L, LUA_GCCOLLECT, 0 );
 237
 238         vlc_restorecancel( cancel );
 239     }
 240     vlc_cleanup_run();
 241
 242     return NULL;
 243 }
 244
 245 /*****************************************************************************
 246  * Control: services discrovery control
 247  ****************************************************************************/
 248 static int Control( services_discovery_t *p_sd, int i_command, va_list args )
 249 {
 250     services_discovery_sys_t *p_sys = p_sd->p_sys;
 251
 252     switch( i_command )
 253     {
 254     case SD_CMD_SEARCH:
 255     {
 256         const char *psz_query = va_arg( args, const char * );
 257         vlc_mutex_lock( &p_sys->lock );
 258         TAB_APPEND( p_sys->i_query, p_sys->ppsz_query, strdup( psz_query ) );
 259         vlc_cond_signal( &p_sys->cond );
 260         vlc_mutex_unlock( &p_sys->lock );
 261         break;
 262     }
 263
 264     case SD_CMD_DESCRIPTOR:
 265     {
 266         services_discovery_descriptor_t *p_desc = va_arg( args,
 267                                 services_discovery_descriptor_t * );
 268         return FillDescriptor( p_sd, p_desc );
 269     }
 270     }
 271
 272     return VLC_SUCCESS;
 273 }
 274
 275 /*****************************************************************************
 276  * DoSearch: search for a given query
 277  ****************************************************************************/
 278 static int DoSearch( services_discovery_t *p_sd, const char *psz_query )
 279 {
 280     services_discovery_sys_t *p_sys = p_sd->p_sys;
 281     lua_State *L = p_sys->L;
 282
 283     /* Lookup for the 'search' function */
 284     lua_getglobal( L, "search" );
 285     if( !lua_isfunction( L, lua_gettop( L ) ) )
 286     {
 287         msg_Err( p_sd, "The script '%s' does not define any 'search' function",
 288                  p_sys->psz_filename );
 289         lua_pop( L, 1 );
 290         return VLC_EGENERIC;
 291     }
 292
 293     /* Push the query */
 294     lua_pushstring( L, psz_query );
 295
 296     /* Call the 'search' function */
 297     if( lua_pcall( L, 1, 0, 0 ) )
 298     {
 299         msg_Err( p_sd, "Error while running the script '%s': %s",
 300                  p_sys->psz_filename, lua_tostring( L, lua_gettop( L ) ) );
 301         lua_pop( L, 1 );
 302         return VLC_EGENERIC;
 303     }
 304
 305     return VLC_SUCCESS;
 306 }
 307
 308 /** List of capabilities */
 309 static const char *const ppsz_capabilities[] = {
 310     "search",
 311     NULL
 312 };
 313
 314 /*****************************************************************************
 315  * FillDescriptor: call the descriptor function and fill the structure
 316  ****************************************************************************/
 317 static int FillDescriptor( services_discovery_t *p_sd,
 318                            services_discovery_descriptor_t *p_desc )
 319 {
 320     services_discovery_sys_t *p_sys = p_sd->p_sys;
 321     int i_ret = VLC_EGENERIC;
 322
 323     /* Create a new lua thread */
 324     lua_State *L = luaL_newstate();
 325     if( luaL_dofile( L, p_sys->psz_filename ) )
 326     {
 327         msg_Err( p_sd, "Error loading script %s: %s", p_sys->psz_filename,
 328                  lua_tostring( L, -1 ) );
 329         goto end;
 330     }
 331
 332     /* Call the "descriptor" function */
 333     lua_getglobal( L, "descriptor" );
 334     if( !lua_isfunction( L, -1 ) || lua_pcall( L, 0, 1, 0 ) )
 335     {
 336         msg_Warn( p_sd, "Error getting the descriptor in '%s': %s",
 337                   p_sys->psz_filename, lua_tostring( L, -1 ) );
 338         goto end;
 339     }
 340
 341     /* Get the different fields of the returned table */
 342     lua_getfield( L, -1, "short_description" );
 343     p_desc->psz_short_desc = luaL_strdupornull( L, -1 );
 344     lua_pop( L, 1 );
 345
 346     lua_getfield( L, -1, "icon" );
 347     p_desc->psz_icon_url = luaL_strdupornull( L, -1 );
 348     lua_pop( L, 1 );
 349
 350     lua_getfield( L, -1, "url" );
 351     p_desc->psz_url = luaL_strdupornull( L, -1 );
 352     lua_pop( L, 1 );
 353
 354     lua_getfield( L, -1, "capabilities" );
 355     p_desc->i_capabilities = 0;
 356     if( lua_istable( L, -1 ) )
 357     {
 358         /* List all table entries */
 359         lua_pushnil( L );
 360         while( lua_next( L, -2 ) != 0 )
 361         {
 362             /* Key is at index -2 and value at index -1 */
 363             const char *psz_cap = luaL_checkstring( L, -1 );
 364             int i_cap = 0;
 365             const char *psz_iter;
 366             for( psz_iter = *ppsz_capabilities; psz_iter;
 367                  psz_iter = ppsz_capabilities[ ++i_cap ] )
 368             {
 369                 if( !strcmp( psz_iter, psz_cap ) )
 370                 {
 371                     p_desc->i_capabilities |= 1 << i_cap;
 372                     break;
 373                 }
 374             }
 375             if( !psz_iter )
 376                 msg_Warn( p_sd, "Services discovery capability '%s' unknown in "
 377                                 "script '%s'", psz_cap, p_sys->psz_filename );
 378         }
 379     }
 380     lua_pop( L, 1 );
 381     i_ret = VLC_SUCCESS;
 382
 383 end:
 384     lua_close( L );
 385     return i_ret;
 386
 387 }