1 /*****************************************************************************
2 * vlc.c: Generic lua interface functions
3 *****************************************************************************
4 * Copyright (C) 2007-2008 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea at videolan tod org>
8 * Pierre d'Herbemont <pdherbemont # videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
38 #include <vlc_common.h>
39 #include <vlc_plugin.h>
41 #include <vlc_charset.h>
44 #include <vlc_services_discovery.h>
47 #include <lua.h> /* Low level lua C API */
48 #include <lauxlib.h> /* Higher level C API */
49 #include <lualib.h> /* Lua libs */
53 /*****************************************************************************
55 *****************************************************************************/
56 #define INTF_TEXT N_("Lua interface")
57 #define INTF_LONGTEXT N_("Lua interface module to load")
59 #define CONFIG_TEXT N_("Lua interface configuration")
60 #define CONFIG_LONGTEXT N_("Lua interface configuration string. Format is: '[\"<interface module name>\"] = { <option> = <value>, ...}, ...'.")
62 static int vlc_sd_probe_Open( vlc_object_t * );
65 set_shortname( N_( "Lua Art" ) )
66 set_description( N_("Fetch artwork using lua scripts") )
67 set_capability( "art finder", 10 )
68 set_callbacks( FindArt, NULL )
71 set_shortname( N_( "Lua Meta Fetcher" ) )
72 set_description( N_("Fetch meta data using lua scripts") )
73 set_capability( "meta fetcher", 10 )
74 set_callbacks( FetchMeta, NULL )
77 set_shortname( N_( "Lua Meta Reader" ) )
78 set_description( N_("Read meta data using lua scripts") )
79 set_capability( "meta reader", 10 )
80 set_callbacks( ReadMeta, NULL )
83 add_shortcut( "luaplaylist" )
84 set_category( CAT_INPUT )
85 set_subcategory( SUBCAT_INPUT_DEMUX )
86 set_shortname( N_("Lua Playlist") )
87 set_description( N_("Lua Playlist Parser Interface") )
88 set_capability( "demux", 2 )
89 set_callbacks( Import_LuaPlaylist, Close_LuaPlaylist )
92 set_description( N_("Lua Interface Module (shortcuts)") )
93 add_shortcut( "luarc" )
95 set_capability( "interface", 25 )
96 set_callbacks( Open_LuaIntf, Close_LuaIntf )
99 set_description( N_("Lua Interface Module") )
100 add_shortcut( "luaintf" )
101 add_shortcut( "luahttp" )
102 add_shortcut( "http" )
103 add_shortcut( "luatelnet" )
104 add_shortcut( "telnet" )
105 add_shortcut( "luahotkeys" )
106 /* add_shortcut( "hotkeys" ) */
107 set_capability( "interface", 0 )
108 add_string( "lua-intf", "dummy", NULL,
109 INTF_TEXT, INTF_LONGTEXT, false )
110 add_string( "lua-config", "", NULL,
111 CONFIG_TEXT, CONFIG_LONGTEXT, false )
112 set_callbacks( Open_LuaIntf, Close_LuaIntf )
115 set_shortname( N_("Lua Extension") )
116 add_shortcut( "luaextension" )
117 set_capability( "extension", 1 )
118 set_callbacks( Open_Extension, Close_Extension )
121 set_description( N_("Lua SD Module") )
122 add_shortcut( "luasd" )
123 set_capability( "services_discovery", 0 )
124 add_string( "lua-sd", "", NULL, "", "", false )
125 set_callbacks( Open_LuaSD, Close_LuaSD )
128 set_description( N_("Freebox TV") )
129 add_shortcut( "freebox" )
130 set_capability( "services_discovery", 0 )
131 set_callbacks( Open_LuaSD, Close_LuaSD )
134 set_description( N_("French TV") )
135 add_shortcut( "frenchtv" )
136 set_capability( "services_discovery", 0 )
137 set_callbacks( Open_LuaSD, Close_LuaSD )
139 VLC_SD_PROBE_SUBMODULE
143 /*****************************************************************************
145 *****************************************************************************/
146 static const char *ppsz_lua_exts[] = { ".luac", ".lua", NULL };
147 static int file_select( const char *file )
149 int i = strlen( file );
151 for( j = 0; ppsz_lua_exts[j]; j++ )
153 int l = strlen( ppsz_lua_exts[j] );
154 if( i >= l && !strcmp( file+i-l, ppsz_lua_exts[j] ) )
160 static int file_compare( const char **a, const char **b )
162 return strcmp( *a, *b );
165 int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname,
166 char ***pppsz_dir_list )
168 #define MAX_DIR_LIST_SIZE 5
169 *pppsz_dir_list = malloc(MAX_DIR_LIST_SIZE*sizeof(char *));
170 if (!*pppsz_dir_list)
172 char **ppsz_dir_list = *pppsz_dir_list;
175 char *datadir = config_GetUserDir( VLC_DATA_DIR );
177 if( likely(datadir != NULL)
178 && likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
179 datadir, luadirname ) != -1) )
183 #if !(defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32))
184 if( likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
185 config_GetLibDir(), luadirname ) != -1) )
189 char *psz_datapath = config_GetDataDir( p_this );
190 if( likely(psz_datapath != NULL) )
192 if( likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
193 psz_datapath, luadirname ) != -1) )
196 #if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
197 if( likely(asprintf( &ppsz_dir_list[i],
198 "%s"DIR_SEP"share"DIR_SEP"lua"DIR_SEP"%s",
199 psz_datapath, luadirname ) != -1) )
202 free( psz_datapath );
205 ppsz_dir_list[i] = NULL;
207 assert( i < MAX_DIR_LIST_SIZE);
212 void vlclua_dir_list_free( char **ppsz_dir_list )
215 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
217 free( ppsz_dir_list );
220 /*****************************************************************************
221 * Will execute func on all scripts in luadirname, and stop if func returns
223 *****************************************************************************/
224 int vlclua_scripts_batch_execute( vlc_object_t *p_this,
225 const char * luadirname,
226 int (*func)(vlc_object_t *, const char *, void *),
229 char **ppsz_dir_list = NULL;
231 int i_ret = vlclua_dir_list( p_this, luadirname, &ppsz_dir_list );
232 if( i_ret != VLC_SUCCESS )
234 i_ret = VLC_EGENERIC;
236 for( char **ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
238 char **ppsz_filelist;
241 msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
242 i_files = vlc_scandir( *ppsz_dir, &ppsz_filelist, file_select,
247 char **ppsz_file = ppsz_filelist;
248 char **ppsz_fileend = ppsz_filelist + i_files;
250 while( ppsz_file < ppsz_fileend )
254 if( asprintf( &psz_filename,
255 "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) == -1 )
257 free( *(ppsz_file++) );
259 if( likely(psz_filename != NULL) )
261 msg_Dbg( p_this, "Trying Lua playlist script %s",
263 i_ret = func( p_this, psz_filename, user_data );
264 free( psz_filename );
265 if( i_ret == VLC_SUCCESS )
270 while( ppsz_file < ppsz_fileend )
271 free( *(ppsz_file++) );
272 free( ppsz_filelist );
274 if( i_ret == VLC_SUCCESS )
277 vlclua_dir_list_free( ppsz_dir_list );
281 char *vlclua_find_file( vlc_object_t *p_this, const char *psz_luadirname, const char *psz_name )
283 char **ppsz_dir_list = NULL;
285 vlclua_dir_list( p_this, psz_luadirname, &ppsz_dir_list );
286 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
288 for( const char **ppsz_ext = ppsz_lua_exts; *ppsz_ext; ppsz_ext++ )
293 if( asprintf( &psz_filename, "%s"DIR_SEP"%s%s", *ppsz_dir,
294 psz_name, *ppsz_ext ) < 0 )
296 vlclua_dir_list_free( ppsz_dir_list );
300 if( vlc_stat( psz_filename, &st ) == 0
301 && S_ISREG( st.st_mode ) )
303 vlclua_dir_list_free( ppsz_dir_list );
306 free( psz_filename );
309 vlclua_dir_list_free( ppsz_dir_list );
313 /*****************************************************************************
314 * Meta data setters utility.
315 * Playlist item table should be on top of the stack when these are called
316 *****************************************************************************/
317 void __vlclua_read_meta_data( vlc_object_t *p_this, lua_State *L,
318 input_item_t *p_input )
320 #define TRY_META( a, b ) \
321 lua_getfield( L, -1, a ); \
322 if( lua_isstring( L, -1 ) ) \
324 char *psz_value = strdup( lua_tostring( L, -1 ) ); \
325 EnsureUTF8( psz_value ); \
326 msg_Dbg( p_this, #b ": %s", psz_value ); \
327 input_item_Set ## b ( p_input, psz_value ); \
330 lua_pop( L, 1 ); /* pop a */
331 TRY_META( "title", Title );
332 TRY_META( "artist", Artist );
333 TRY_META( "genre", Genre );
334 TRY_META( "copyright", Copyright );
335 TRY_META( "album", Album );
336 TRY_META( "tracknum", TrackNum );
337 TRY_META( "description", Description );
338 TRY_META( "rating", Rating );
339 TRY_META( "date", Date );
340 TRY_META( "setting", Setting );
341 TRY_META( "url", URL );
342 TRY_META( "language", Language );
343 TRY_META( "nowplaying", NowPlaying );
344 TRY_META( "publisher", Publisher );
345 TRY_META( "encodedby", EncodedBy );
346 TRY_META( "arturl", ArtURL );
347 TRY_META( "trackid", TrackID );
350 void __vlclua_read_custom_meta_data( vlc_object_t *p_this, lua_State *L,
351 input_item_t *p_input )
354 lua_getfield( L, -1, "meta" );
356 if( lua_istable( L, -1 ) )
359 /* ... item meta nil */
360 while( lua_next( L, -2 ) )
362 /* ... item meta key value */
363 if( !lua_isstring( L, -2 ) )
365 msg_Warn( p_this, "Custom meta data category name must be "
368 else if( !lua_istable( L, -1 ) )
370 msg_Warn( p_this, "Custom meta data category contents "
375 const char *psz_meta_category = lua_tostring( L, -2 );
376 msg_Dbg( p_this, "Found custom meta data category: %s",
379 /* ... item meta key value nil */
380 while( lua_next( L, -2 ) )
382 /* ... item meta key value key2 value2 */
383 if( !lua_isstring( L, -2 ) )
385 msg_Warn( p_this, "Custom meta category item name "
386 "must be a string." );
388 else if( !lua_isstring( L, -1 ) )
390 msg_Warn( p_this, "Custom meta category item value "
391 "must be a string." );
395 const char *psz_meta_name =
396 lua_tostring( L, -2 );
397 const char *psz_meta_value =
398 lua_tostring( L, -1 );
399 msg_Dbg( p_this, "Custom meta %s, %s: %s",
400 psz_meta_category, psz_meta_name,
402 input_item_AddInfo( p_input, psz_meta_category,
403 psz_meta_name, "%s", psz_meta_value );
405 lua_pop( L, 1 ); /* pop item */
406 /* ... item meta key value key2 */
408 /* ... item meta key value */
410 lua_pop( L, 1 ); /* pop category */
411 /* ... item meta key */
415 lua_pop( L, 1 ); /* pop "meta" */
416 /* ... item -> back to original stack */
419 /*****************************************************************************
421 ****************************************************************************/
423 * Playlist item table should be on top of the stack when this is called
425 void __vlclua_read_options( vlc_object_t *p_this, lua_State *L,
426 int *pi_options, char ***pppsz_options )
428 lua_getfield( L, -1, "options" );
429 if( lua_istable( L, -1 ) )
432 while( lua_next( L, -2 ) )
434 if( lua_isstring( L, -1 ) )
436 char *psz_option = strdup( lua_tostring( L, -1 ) );
437 msg_Dbg( p_this, "Option: %s", psz_option );
438 INSERT_ELEM( *pppsz_options, *pi_options, *pi_options,
443 msg_Warn( p_this, "Option should be a string" );
445 lua_pop( L, 1 ); /* pop option */
448 lua_pop( L, 1 ); /* pop "options" */
451 int __vlclua_playlist_add_internal( vlc_object_t *p_this, lua_State *L,
452 playlist_t *p_playlist,
453 input_item_t *p_parent, bool b_play )
456 input_item_node_t *p_parent_node = NULL;
458 assert( p_parent || p_playlist );
461 if( lua_istable( L, -1 ) )
463 if( p_parent ) p_parent_node = input_item_node_Create( p_parent );
466 while( lua_next( L, -2 ) )
468 /* playlist key item */
469 /* <Parse playlist item> */
470 if( lua_istable( L, -1 ) )
472 lua_getfield( L, -1, "path" );
473 /* playlist key item path */
474 if( lua_isstring( L, -1 ) )
476 const char *psz_path = NULL;
477 const char *psz_name = NULL;
478 char **ppsz_options = NULL;
480 mtime_t i_duration = -1;
481 input_item_t *p_input;
483 /* Read path and name */
484 psz_path = lua_tostring( L, -1 );
485 msg_Dbg( p_this, "Path: %s", psz_path );
486 lua_getfield( L, -2, "name" );
487 /* playlist key item path name */
488 if( lua_isstring( L, -1 ) )
490 psz_name = lua_tostring( L, -1 );
491 msg_Dbg( p_this, "Name: %s", psz_name );
495 if( !lua_isnil( L, -1 ) )
496 msg_Warn( p_this, "Playlist item name should be a string." );
501 lua_getfield( L, -3, "duration" );
502 /* playlist key item path name duration */
503 if( lua_isnumber( L, -1 ) )
505 i_duration = (mtime_t)(lua_tonumber( L, -1 )*1e6);
507 else if( !lua_isnil( L, -1 ) )
509 msg_Warn( p_this, "Playlist item duration should be a number (in seconds)." );
511 lua_pop( L, 1 ); /* pop "duration" */
513 /* playlist key item path name */
515 /* Read options: item must be on top of stack */
516 lua_pushvalue( L, -3 );
517 /* playlist key item path name item */
518 vlclua_read_options( p_this, L, &i_options, &ppsz_options );
520 /* Create input item */
521 p_input = input_item_NewExt( p_playlist, psz_path,
523 (const char **)ppsz_options,
524 VLC_INPUT_OPTION_TRUSTED,
526 lua_pop( L, 3 ); /* pop "path name item" */
527 /* playlist key item */
529 /* Read meta data: item must be on top of stack */
530 vlclua_read_meta_data( p_this, L, p_input );
532 /* Read custom meta data: item must be on top of stack*/
533 vlclua_read_custom_meta_data( p_this, L, p_input );
535 /* Append item to playlist */
536 if( p_parent ) /* Add to node */
538 input_item_node_AppendItem( p_parent_node, p_input );
540 else /* Play or Enqueue (preparse) */
541 /* FIXME: playlist_AddInput() can fail */
542 playlist_AddInput( p_playlist, p_input,
544 ( b_play ? PLAYLIST_GO : PLAYLIST_PREPARSE ),
545 PLAYLIST_END, true, false );
546 i_count ++; /* increment counter */
547 vlc_gc_decref( p_input );
548 while( i_options > 0 )
549 free( ppsz_options[--i_options] );
550 free( ppsz_options );
554 lua_pop( L, 1 ); /* pop "path" */
556 "Playlist item's path should be a string" );
558 /* playlist key item */
562 msg_Warn( p_this, "Playlist item should be a table" );
564 /* <Parse playlist item> */
565 lua_pop( L, 1 ); /* pop the value, keep the key for
566 * the next lua_next() call */
572 if( i_count ) input_item_node_PostAndDelete( p_parent_node );
573 else input_item_node_Delete( p_parent_node );
578 msg_Warn( p_this, "Playlist should be a table." );
583 static int vlc_sd_probe_Open( vlc_object_t *obj )
585 vlc_probe_t *probe = (vlc_probe_t *)obj;
586 char **ppsz_filelist = NULL;
587 char **ppsz_fileend = NULL;
590 char **ppsz_dir_list = NULL;
593 vlclua_dir_list( obj, "sd", &ppsz_dir_list );
594 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
599 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
602 free( ppsz_filelist );
603 ppsz_filelist = NULL;
605 i_files = vlc_scandir( *ppsz_dir, &ppsz_filelist, file_select,
607 if( i_files < 1 ) continue;
608 ppsz_fileend = ppsz_filelist + i_files;
609 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
612 if( asprintf( &psz_filename,
613 "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) < 0 )
620 msg_Err( probe, "Could not create new Lua State" );
624 if( vlclua_add_modules_path( probe, L, psz_filename ) )
626 msg_Err( probe, "Error while setting the module search path for %s",
630 if( luaL_dofile( L, psz_filename ) )
633 msg_Err( probe, "Error loading script %s: %s", psz_filename,
634 lua_tostring( L, lua_gettop( L ) ) );
639 char *temp = strchr( *ppsz_file, '.' );
642 lua_getglobal( L, "descriptor" );
643 if( !lua_isfunction( L, lua_gettop( L ) ) || lua_pcall( L, 0, 1, 0 ) )
646 if( !( psz_longname = strdup( *ppsz_file ) ) )
648 free( psz_filename );
654 lua_getfield( L, -1, "title" );
655 if( !lua_isstring( L, -1 ) ||
656 !( psz_longname = strdup( lua_tostring( L, -1 ) ) ) )
658 free( psz_filename );
662 if( asprintf( &psz_name, "lua{sd=%s,longname=%s}",
663 *ppsz_file, psz_longname ) < 0 )
665 free( psz_filename );
666 free( psz_longname );
669 vlc_sd_probe_Add( probe, psz_name, psz_longname, SD_CAT_INTERNET );
671 free( psz_longname );
672 free( psz_filename );
678 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
681 free( ppsz_filelist );
683 vlclua_dir_list_free( ppsz_dir_list );
684 return VLC_PROBE_CONTINUE;
688 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
691 free( ppsz_filelist );
695 vlclua_dir_list_free( ppsz_dir_list );
699 static int vlclua_add_modules_path_inner( lua_State *L, const char *psz_path )
701 /* FIXME: don't use luaL_dostring */
702 char *psz_command = NULL;
703 if( asprintf( &psz_command,
704 "package.path =[[%s"DIR_SEP"modules"DIR_SEP"?.lua;]]..package.path",
710 if( luaL_dostring( L, psz_command ) )
720 int __vlclua_add_modules_path( vlc_object_t *obj, lua_State *L, const char *psz_filename )
722 /* Setup the module search path:
723 * * "The script's directory"/modules
724 * * "The script's parent directory"/modules
725 * * and so on for all the next directories in the directory list
728 char *psz_path = strdup( psz_filename );
732 char *psz_char = strrchr( psz_path, DIR_SEP_CHAR );
740 /* psz_path now holds the file's directory */
741 psz_char = strrchr( psz_path, DIR_SEP_CHAR );
749 /* psz_path now holds the file's parent directory */
750 if( vlclua_add_modules_path_inner( L, psz_path ) )
755 *psz_char = DIR_SEP_CHAR;
757 /* psz_path now holds the file's directory */
758 if( vlclua_add_modules_path_inner( L, psz_path ) )
764 char **ppsz_dir_list = NULL;
765 vlclua_dir_list( obj, psz_char+1/* gruik? */, &ppsz_dir_list );
766 char **ppsz_dir = ppsz_dir_list;
768 for( ; *ppsz_dir && strcmp( *ppsz_dir, psz_path ); ppsz_dir++ );
771 for( ; *ppsz_dir; ppsz_dir++ )
773 psz_path = *ppsz_dir;
774 psz_char = strrchr( psz_path, DIR_SEP_CHAR );
779 if( vlclua_add_modules_path_inner( L, psz_path ) )
781 *psz_char = DIR_SEP_CHAR;
783 if( vlclua_add_modules_path_inner( L, psz_path ) )
787 vlclua_dir_list_free( ppsz_dir_list );
791 vlclua_dir_list_free( ppsz_dir_list );