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 )
127 VLC_SD_PROBE_SUBMODULE
131 /*****************************************************************************
133 *****************************************************************************/
134 static const char *ppsz_lua_exts[] = { ".luac", ".lua", NULL };
135 static int file_select( const char *file )
137 int i = strlen( file );
139 for( j = 0; ppsz_lua_exts[j]; j++ )
141 int l = strlen( ppsz_lua_exts[j] );
142 if( i >= l && !strcmp( file+i-l, ppsz_lua_exts[j] ) )
148 static int file_compare( const char **a, const char **b )
150 return strcmp( *a, *b );
153 int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname,
154 char **ppsz_dir_list )
157 char *datadir = config_GetUserDir( VLC_DATA_DIR );
159 if( likely(datadir != NULL)
160 && likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
161 datadir, luadirname ) != -1) )
165 char *psz_datapath = config_GetDataDir( p_this );
166 if( likely(psz_datapath != NULL) )
168 if( likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
169 psz_datapath, luadirname ) != -1) )
172 #if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
173 if( likely(asprintf( &ppsz_dir_list[i],
174 "%s"DIR_SEP"share"DIR_SEP"lua"DIR_SEP"%s",
175 psz_datapath, luadirname ) != -1) )
178 free( psz_datapath );
181 #if !(defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32))
182 if( likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
183 config_GetLibDir(), luadirname ) != -1) )
187 ppsz_dir_list[i] = NULL;
191 void vlclua_dir_list_free( char **ppsz_dir_list )
194 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
198 /*****************************************************************************
199 * Will execute func on all scripts in luadirname, and stop if func returns
201 *****************************************************************************/
202 int vlclua_scripts_batch_execute( vlc_object_t *p_this,
203 const char * luadirname,
204 int (*func)(vlc_object_t *, const char *, void *),
207 char *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
209 int i_ret = vlclua_dir_list( p_this, luadirname, ppsz_dir_list );
210 if( i_ret != VLC_SUCCESS )
212 i_ret = VLC_EGENERIC;
214 for( char **ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
216 char **ppsz_filelist;
219 msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
220 i_files = vlc_scandir( *ppsz_dir, &ppsz_filelist, file_select,
225 char **ppsz_file = ppsz_filelist;
226 char **ppsz_fileend = ppsz_filelist + i_files;
228 while( ppsz_file < ppsz_fileend )
232 if( asprintf( &psz_filename,
233 "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) == -1 )
235 free( *(ppsz_file++) );
237 if( likely(psz_filename != NULL) )
239 msg_Dbg( p_this, "Trying Lua playlist script %s",
241 i_ret = func( p_this, psz_filename, user_data );
242 free( psz_filename );
243 if( i_ret == VLC_SUCCESS )
248 while( ppsz_file < ppsz_fileend )
249 free( *(ppsz_file++) );
250 free( ppsz_filelist );
252 if( i_ret == VLC_SUCCESS )
255 vlclua_dir_list_free( ppsz_dir_list );
259 char *vlclua_find_file( vlc_object_t *p_this, const char *psz_luadirname, const char *psz_name )
261 char *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
263 vlclua_dir_list( p_this, psz_luadirname, ppsz_dir_list );
264 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
266 for( const char **ppsz_ext = ppsz_lua_exts; *ppsz_ext; ppsz_ext++ )
271 if( asprintf( &psz_filename, "%s"DIR_SEP"%s%s", *ppsz_dir,
272 psz_name, *ppsz_ext ) < 0 )
274 vlclua_dir_list_free( ppsz_dir_list );
278 if( vlc_stat( psz_filename, &st ) == 0
279 && S_ISREG( st.st_mode ) )
281 vlclua_dir_list_free( ppsz_dir_list );
284 free( psz_filename );
287 vlclua_dir_list_free( ppsz_dir_list );
291 /*****************************************************************************
292 * Meta data setters utility.
293 * Playlist item table should be on top of the stack when these are called
294 *****************************************************************************/
295 void __vlclua_read_meta_data( vlc_object_t *p_this, lua_State *L,
296 input_item_t *p_input )
298 #define TRY_META( a, b ) \
299 lua_getfield( L, -1, a ); \
300 if( lua_isstring( L, -1 ) ) \
302 char *psz_value = strdup( lua_tostring( L, -1 ) ); \
303 EnsureUTF8( psz_value ); \
304 msg_Dbg( p_this, #b ": %s", psz_value ); \
305 input_item_Set ## b ( p_input, psz_value ); \
308 lua_pop( L, 1 ); /* pop a */
309 TRY_META( "title", Title );
310 TRY_META( "artist", Artist );
311 TRY_META( "genre", Genre );
312 TRY_META( "copyright", Copyright );
313 TRY_META( "album", Album );
314 TRY_META( "tracknum", TrackNum );
315 TRY_META( "description", Description );
316 TRY_META( "rating", Rating );
317 TRY_META( "date", Date );
318 TRY_META( "setting", Setting );
319 TRY_META( "url", URL );
320 TRY_META( "language", Language );
321 TRY_META( "nowplaying", NowPlaying );
322 TRY_META( "publisher", Publisher );
323 TRY_META( "encodedby", EncodedBy );
324 TRY_META( "arturl", ArtURL );
325 TRY_META( "trackid", TrackID );
328 void __vlclua_read_custom_meta_data( vlc_object_t *p_this, lua_State *L,
329 input_item_t *p_input )
332 lua_getfield( L, -1, "meta" );
334 if( lua_istable( L, -1 ) )
337 /* ... item meta nil */
338 while( lua_next( L, -2 ) )
340 /* ... item meta key value */
341 if( !lua_isstring( L, -2 ) )
343 msg_Warn( p_this, "Custom meta data category name must be "
346 else if( !lua_istable( L, -1 ) )
348 msg_Warn( p_this, "Custom meta data category contents "
353 const char *psz_meta_category = lua_tostring( L, -2 );
354 msg_Dbg( p_this, "Found custom meta data category: %s",
357 /* ... item meta key value nil */
358 while( lua_next( L, -2 ) )
360 /* ... item meta key value key2 value2 */
361 if( !lua_isstring( L, -2 ) )
363 msg_Warn( p_this, "Custom meta category item name "
364 "must be a string." );
366 else if( !lua_isstring( L, -1 ) )
368 msg_Warn( p_this, "Custom meta category item value "
369 "must be a string." );
373 const char *psz_meta_name =
374 lua_tostring( L, -2 );
375 const char *psz_meta_value =
376 lua_tostring( L, -1 );
377 msg_Dbg( p_this, "Custom meta %s, %s: %s",
378 psz_meta_category, psz_meta_name,
380 input_item_AddInfo( p_input, psz_meta_category,
381 psz_meta_name, "%s", psz_meta_value );
383 lua_pop( L, 1 ); /* pop item */
384 /* ... item meta key value key2 */
386 /* ... item meta key value */
388 lua_pop( L, 1 ); /* pop category */
389 /* ... item meta key */
393 lua_pop( L, 1 ); /* pop "meta" */
394 /* ... item -> back to original stack */
397 /*****************************************************************************
399 ****************************************************************************/
401 * Playlist item table should be on top of the stack when this is called
403 void __vlclua_read_options( vlc_object_t *p_this, lua_State *L,
404 int *pi_options, char ***pppsz_options )
406 lua_getfield( L, -1, "options" );
407 if( lua_istable( L, -1 ) )
410 while( lua_next( L, -2 ) )
412 if( lua_isstring( L, -1 ) )
414 char *psz_option = strdup( lua_tostring( L, -1 ) );
415 msg_Dbg( p_this, "Option: %s", psz_option );
416 INSERT_ELEM( *pppsz_options, *pi_options, *pi_options,
421 msg_Warn( p_this, "Option should be a string" );
423 lua_pop( L, 1 ); /* pop option */
426 lua_pop( L, 1 ); /* pop "options" */
429 int __vlclua_playlist_add_internal( vlc_object_t *p_this, lua_State *L,
430 playlist_t *p_playlist,
431 input_item_t *p_parent, bool b_play )
434 input_item_node_t *p_parent_node = NULL;
436 assert( p_parent || p_playlist );
439 if( lua_istable( L, -1 ) )
441 if( p_parent ) p_parent_node = input_item_node_Create( p_parent );
444 while( lua_next( L, -2 ) )
446 /* playlist key item */
447 /* <Parse playlist item> */
448 if( lua_istable( L, -1 ) )
450 lua_getfield( L, -1, "path" );
451 /* playlist key item path */
452 if( lua_isstring( L, -1 ) )
454 const char *psz_path = NULL;
455 const char *psz_name = NULL;
456 char **ppsz_options = NULL;
458 mtime_t i_duration = -1;
459 input_item_t *p_input;
461 /* Read path and name */
462 psz_path = lua_tostring( L, -1 );
463 msg_Dbg( p_this, "Path: %s", psz_path );
464 lua_getfield( L, -2, "name" );
465 /* playlist key item path name */
466 if( lua_isstring( L, -1 ) )
468 psz_name = lua_tostring( L, -1 );
469 msg_Dbg( p_this, "Name: %s", psz_name );
473 if( !lua_isnil( L, -1 ) )
474 msg_Warn( p_this, "Playlist item name should be a string." );
479 lua_getfield( L, -3, "duration" );
480 /* playlist key item path name duration */
481 if( lua_isnumber( L, -1 ) )
483 i_duration = (mtime_t)(lua_tonumber( L, -1 )*1e6);
485 else if( !lua_isnil( L, -1 ) )
487 msg_Warn( p_this, "Playlist item duration should be a number (in seconds)." );
489 lua_pop( L, 1 ); /* pop "duration" */
491 /* playlist key item path name */
493 /* Read options: item must be on top of stack */
494 lua_pushvalue( L, -3 );
495 /* playlist key item path name item */
496 vlclua_read_options( p_this, L, &i_options, &ppsz_options );
498 /* Create input item */
499 p_input = input_item_NewExt( p_playlist, psz_path,
501 (const char **)ppsz_options,
502 VLC_INPUT_OPTION_TRUSTED,
504 lua_pop( L, 3 ); /* pop "path name item" */
505 /* playlist key item */
507 /* Read meta data: item must be on top of stack */
508 vlclua_read_meta_data( p_this, L, p_input );
510 /* Read custom meta data: item must be on top of stack*/
511 vlclua_read_custom_meta_data( p_this, L, p_input );
513 /* Append item to playlist */
514 if( p_parent ) /* Add to node */
516 input_item_node_AppendItem( p_parent_node, p_input );
518 else /* Play or Enqueue (preparse) */
519 /* FIXME: playlist_AddInput() can fail */
520 playlist_AddInput( p_playlist, p_input,
522 ( b_play ? PLAYLIST_GO : PLAYLIST_PREPARSE ),
523 PLAYLIST_END, true, false );
524 i_count ++; /* increment counter */
525 vlc_gc_decref( p_input );
526 while( i_options > 0 )
527 free( ppsz_options[--i_options] );
528 free( ppsz_options );
532 lua_pop( L, 1 ); /* pop "path" */
534 "Playlist item's path should be a string" );
536 /* playlist key item */
540 msg_Warn( p_this, "Playlist item should be a table" );
542 /* <Parse playlist item> */
543 lua_pop( L, 1 ); /* pop the value, keep the key for
544 * the next lua_next() call */
550 if( i_count ) input_item_node_PostAndDelete( p_parent_node );
551 else input_item_node_Delete( p_parent_node );
556 msg_Warn( p_this, "Playlist should be a table." );
561 static int vlc_sd_probe_Open( vlc_object_t *obj )
563 vlc_probe_t *probe = (vlc_probe_t *)obj;
564 char **ppsz_filelist = NULL;
565 char **ppsz_fileend = NULL;
568 char *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
570 vlclua_dir_list( obj, "sd", ppsz_dir_list );
571 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
576 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
579 free( ppsz_filelist );
580 ppsz_filelist = NULL;
582 i_files = vlc_scandir( *ppsz_dir, &ppsz_filelist, file_select,
584 if( i_files < 1 ) continue;
585 ppsz_fileend = ppsz_filelist + i_files;
586 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
589 if( asprintf( &psz_filename,
590 "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) < 0 )
594 FILE *fd = vlc_fopen( psz_filename, "r" );
597 char description[256];
598 if( fgets( description, 256, fd ) != NULL )
600 char *temp = strchr( description, '\n' );
603 temp = strchr( *ppsz_file, '.' );
607 if( !strncmp( description, "--SD_Description=", 17 ) )
609 if( !( psz_longname = strdup( description + 17 ) ) )
612 free( psz_filename );
618 if( !( psz_longname = strdup( *ppsz_file ) ) )
621 free( psz_filename );
625 if( asprintf( &psz_name, "lua{sd=%s,longname=%s}",
626 *ppsz_file, psz_longname ) < 0 )
629 free( psz_filename );
630 free( psz_longname );
633 vlc_sd_probe_Add( probe, psz_name, psz_longname, SD_CAT_INTERNET );
635 free( psz_longname );
639 free( psz_filename );
644 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
647 free( ppsz_filelist );
649 vlclua_dir_list_free( ppsz_dir_list );
650 return VLC_PROBE_CONTINUE;
654 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
657 free( ppsz_filelist );
659 vlclua_dir_list_free( ppsz_dir_list );
663 static int vlclua_add_modules_path_inner( lua_State *L, const char *psz_path )
665 /* FIXME: don't use luaL_dostring */
666 char *psz_command = NULL;
667 if( asprintf( &psz_command,
668 "package.path =[[%s"DIR_SEP"modules"DIR_SEP"?.lua;]]..package.path",
674 if( luaL_dostring( L, psz_command ) )
684 int __vlclua_add_modules_path( vlc_object_t *obj, lua_State *L, const char *psz_filename )
686 /* Setup the module search path:
687 * * "The script's directory"/modules
688 * * "The script's parent directory"/modules
689 * * and so on for all the next directories in the directory list
692 char *psz_path = strdup( psz_filename );
696 char *psz_char = strrchr( psz_path, DIR_SEP_CHAR );
704 /* psz_path now holds the file's directory */
705 psz_char = strrchr( psz_path, DIR_SEP_CHAR );
713 /* psz_path now holds the file's parent directory */
714 if( vlclua_add_modules_path_inner( L, psz_path ) )
719 *psz_char = DIR_SEP_CHAR;
721 /* psz_path now holds the file's directory */
722 if( vlclua_add_modules_path_inner( L, psz_path ) )
728 char *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
729 vlclua_dir_list( obj, psz_char+1/* gruik? */, ppsz_dir_list );
730 char **ppsz_dir = ppsz_dir_list;
732 for( ; *ppsz_dir && strcmp( *ppsz_dir, psz_path ); ppsz_dir++ );
735 for( ; *ppsz_dir; ppsz_dir++ )
737 psz_path = *ppsz_dir;
738 psz_char = strrchr( psz_path, DIR_SEP_CHAR );
743 if( vlclua_add_modules_path_inner( L, psz_path ) )
745 *psz_char = DIR_SEP_CHAR;
747 if( vlclua_add_modules_path_inner( L, psz_path ) )
751 vlclua_dir_list_free( ppsz_dir_list );
755 vlclua_dir_list_free( ppsz_dir_list );