]> git.sesse.net Git - vlc/blobdiff - modules/misc/lua/vlc.c
lua_intf: also provide the --rc-host option for backward compatibility.
[vlc] / modules / misc / lua / vlc.c
index 591206a0e3d6d089bafad760d8448df716a09fe6..ea52557df9eabfaab24ef1ef41497b739f142b84 100644 (file)
@@ -39,6 +39,7 @@
 #include <vlc_plugin.h>
 #include <vlc_meta.h>
 #include <vlc_charset.h>
+#include <vlc_fs.h>
 #include <vlc_aout.h>
 #include <vlc_services_discovery.h>
 #include <sys/stat.h>
 
 #define CONFIG_TEXT N_("Lua interface configuration")
 #define CONFIG_LONGTEXT N_("Lua interface configuration string. Format is: '[\"<interface module name>\"] = { <option> = <value>, ...}, ...'.")
+#define HOST_TEXT N_( "Host address" )
+#define HOST_LONGTEXT N_( \
+    "Address and port the HTTP interface will listen on. It defaults to " \
+    "all network interfaces (0.0.0.0)." \
+    " If you want the HTTP interface to be available only on the local " \
+    "machine, enter 127.0.0.1" )
+#define SRC_TEXT N_( "Source directory" )
+#define SRC_LONGTEXT N_( "Source directory" )
+#define INDEX_TEXT N_( "Directory index" )
+#define INDEX_LONGTEXT N_( "Allow to build directory index" )
+
+#define TELNETHOST_TEXT N_( "Host" )
+#define TELNETHOST_LONGTEXT N_( "This is the host on which the " \
+    "interface will listen. It defaults to all network interfaces (0.0.0.0)." \
+    " If you want this interface to be available only on the local " \
+    "machine, enter \"127.0.0.1\"." )
+#define TELNETPORT_TEXT N_( "Port" )
+#define TELNETPORT_LONGTEXT N_( "This is the TCP port on which this " \
+    "interface will listen. It defaults to 4212." )
+#define TELNETPORT_DEFAULT 4212
+#define TELNETPWD_TEXT N_( "Password" )
+#define TELNETPWD_LONGTEXT N_( "A single administration password is used " \
+    "to protect this interface. The default value is \"admin\"." )
+#define TELNETPWD_DEFAULT "admin"
+#define RCHOST_TEXT N_("TCP command input")
+#define RCHOST_LONGTEXT N_("Accept commands over a socket rather than stdin. " \
+            "You can set the address and port the interface will bind to." )
 
 static int vlc_sd_probe_Open( vlc_object_t * );
 
 vlc_module_begin ()
-        set_shortname( N_( "Lua Art" ) )
-        set_description( N_("Fetch artwork using lua scripts") )
-        set_capability( "art finder", 10 )
-        set_callbacks( FindArt, NULL )
+        set_shortname( N_("Lua Interface Module") )
+        set_description( N_("Interfaces implemented using lua scripts") )
+        add_shortcut( "luaintf" )
+        add_shortcut( "luahttp" )
+        /* add_shortcut( "http" ) */
+        add_shortcut( "luatelnet" )
+        add_shortcut( "telnet" )
+        add_shortcut( "luahotkeys" )
+        /* add_shortcut( "hotkeys" ) */
+        set_capability( "interface", 0 )
+        set_category( CAT_INTERFACE )
+        set_subcategory( SUBCAT_INTERFACE_CONTROL )
+        add_string( "lua-intf", "dummy", NULL,
+                    INTF_TEXT, INTF_LONGTEXT, false )
+        add_string( "lua-config", "", NULL,
+                    CONFIG_TEXT, CONFIG_LONGTEXT, false )
+        set_section( N_("Lua HTTP"), 0 )
+            add_string ( "http-host", NULL, NULL, HOST_TEXT, HOST_LONGTEXT, true )
+            add_string ( "http-src",  NULL, NULL, SRC_TEXT,  SRC_LONGTEXT,  true )
+            add_bool   ( "http-index", false, NULL, INDEX_TEXT, INDEX_LONGTEXT, true )
+        set_section( N_("Lua RC"), 0 )
+            add_string( "rc-host", NULL, NULL, RCHOST_TEXT, RCHOST_LONGTEXT, true )
+        set_section( N_("Lua Telnet"), 0 )
+            add_string( "telnet-host", "localhost", NULL, TELNETHOST_TEXT,
+                        TELNETHOST_LONGTEXT, true )
+            add_integer( "telnet-port", TELNETPORT_DEFAULT, NULL, TELNETPORT_TEXT,
+                         TELNETPORT_LONGTEXT, true )
+            add_password( "telnet-password", TELNETPWD_DEFAULT, NULL, TELNETPWD_TEXT,
+                          TELNETPWD_LONGTEXT, true )
+
+        set_callbacks( Open_LuaIntf, Close_LuaIntf )
 
     add_submodule ()
         set_shortname( N_( "Lua Meta Fetcher" ) )
@@ -80,8 +135,6 @@ vlc_module_begin ()
 
     add_submodule ()
         add_shortcut( "luaplaylist" )
-        set_category( CAT_INPUT )
-        set_subcategory( SUBCAT_INPUT_DEMUX )
         set_shortname( N_("Lua Playlist") )
         set_description( N_("Lua Playlist Parser Interface") )
         set_capability( "demux", 2 )
@@ -95,20 +148,10 @@ vlc_module_begin ()
         set_callbacks( Open_LuaIntf, Close_LuaIntf )
 
     add_submodule ()
-        set_description( N_("Lua Interface Module") )
-        add_shortcut( "luaintf" )
-        add_shortcut( "luahttp" )
-        add_shortcut( "http" )
-        add_shortcut( "luatelnet" )
-        add_shortcut( "telnet" )
-        add_shortcut( "luahotkeys" )
-        /* add_shortcut( "hotkeys" ) */
-        set_capability( "interface", 0 )
-        add_string( "lua-intf", "dummy", NULL,
-                    INTF_TEXT, INTF_LONGTEXT, false )
-        add_string( "lua-config", "", NULL,
-                    CONFIG_TEXT, CONFIG_LONGTEXT, false )
-        set_callbacks( Open_LuaIntf, Close_LuaIntf )
+        set_shortname( N_( "Lua Art" ) )
+        set_description( N_("Fetch artwork using lua scripts") )
+        set_capability( "art finder", 10 )
+        set_callbacks( FindArt, NULL )
 
     add_submodule ()
         set_shortname( N_("Lua Extension") )
@@ -120,7 +163,22 @@ vlc_module_begin ()
         set_description( N_("Lua SD Module") )
         add_shortcut( "luasd" )
         set_capability( "services_discovery", 0 )
-        add_string( "lua-sd", "", NULL, "", "", false )
+        add_string( "lua-sd", "", NULL, NULL, NULL, false )
+            change_volatile()
+        add_string( "lua-longname", "", NULL, NULL, NULL, false )
+            change_volatile()
+        set_callbacks( Open_LuaSD, Close_LuaSD )
+
+    add_submodule ()
+        set_description( N_("Freebox TV") )
+        add_shortcut( "freebox" )
+        set_capability( "services_discovery", 0 )
+        set_callbacks( Open_LuaSD, Close_LuaSD )
+
+    add_submodule ()
+        set_description( N_("French TV") )
+        add_shortcut( "frenchtv" )
+        set_capability( "services_discovery", 0 )
         set_callbacks( Open_LuaSD, Close_LuaSD )
 
     VLC_SD_PROBE_SUBMODULE
@@ -138,7 +196,7 @@ static int file_select( const char *file )
     for( j = 0; ppsz_lua_exts[j]; j++ )
     {
         int l = strlen( ppsz_lua_exts[j] );
-        if( !strcmp( file+i-l, ppsz_lua_exts[j] ) )
+        if( i >= l && !strcmp( file+i-l, ppsz_lua_exts[j] ) )
             return 1;
     }
     return 0;
@@ -149,42 +207,50 @@ static int file_compare( const char **a, const char **b )
     return strcmp( *a, *b );
 }
 
-int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname, char **ppsz_dir_list )
+int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname,
+                     char ***pppsz_dir_list )
 {
+#define MAX_DIR_LIST_SIZE 5
+    *pppsz_dir_list = malloc(MAX_DIR_LIST_SIZE*sizeof(char *));
+    if (!*pppsz_dir_list)
+        return VLC_EGENERIC;
+    char **ppsz_dir_list = *pppsz_dir_list;
+
     int i = 0;
     char *datadir = config_GetUserDir( VLC_DATA_DIR );
-    if( datadir == NULL )
-        return VLC_ENOMEM;
 
-    if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
-                   datadir, luadirname ) < 0 )
-    {
-        free( datadir );
-        return VLC_ENOMEM;
-    }
+    if( likely(datadir != NULL)
+     && likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
+                         datadir, luadirname ) != -1) )
+        i++;
     free( datadir );
-    i++;
+
+#if !(defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32))
+    if( likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
+                         config_GetLibDir(), luadirname ) != -1) )
+            i++;
+#endif
 
     char *psz_datapath = config_GetDataDir( p_this );
-#   if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
+    if( likely(psz_datapath != NULL) )
     {
-        if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
-                      psz_datapath, luadirname )  < 0 )
-            return VLC_ENOMEM;
-        i++;
-        if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "share" DIR_SEP "lua" DIR_SEP "%s",
-                      psz_datapath, luadirname )  < 0 )
-            return VLC_ENOMEM;
-        i++;
-
+        if( likely(asprintf( &ppsz_dir_list[i], "%s"DIR_SEP"lua"DIR_SEP"%s",
+                              psz_datapath, luadirname ) != -1) )
+            i++;
+
+#if defined(__APPLE__) || defined(SYS_BEOS)
+        if( likely(asprintf( &ppsz_dir_list[i],
+                             "%s"DIR_SEP"share"DIR_SEP"lua"DIR_SEP"%s",
+                             psz_datapath, luadirname ) != -1) )
+            i++;
+#endif
+        free( psz_datapath );
     }
-#   else
-    if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
-                  psz_datapath, luadirname ) < 0 )
-        return VLC_ENOMEM;
-    i++;
-#   endif
-    free( psz_datapath );
+
+    ppsz_dir_list[i] = NULL;
+
+    assert( i < MAX_DIR_LIST_SIZE);
+
     return VLC_SUCCESS;
 }
 
@@ -193,6 +259,7 @@ void vlclua_dir_list_free( char **ppsz_dir_list )
     char **ppsz_dir;
     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
         free( *ppsz_dir );
+    free( ppsz_dir_list );
 }
 
 /*****************************************************************************
@@ -201,13 +268,12 @@ void vlclua_dir_list_free( char **ppsz_dir_list )
  *****************************************************************************/
 int vlclua_scripts_batch_execute( vlc_object_t *p_this,
                                   const char * luadirname,
-                                  int (*func)(vlc_object_t *, const char *, lua_State *, void *),
-                                  lua_State * L,
+                                  int (*func)(vlc_object_t *, const char *, void *),
                                   void * user_data)
 {
-    char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
+    char **ppsz_dir_list = NULL;
 
-    int i_ret = vlclua_dir_list( p_this, luadirname, ppsz_dir_list );
+    int i_ret = vlclua_dir_list( p_this, luadirname, &ppsz_dir_list );
     if( i_ret != VLC_SUCCESS )
         return i_ret;
     i_ret = VLC_EGENERIC;
@@ -218,7 +284,7 @@ int vlclua_scripts_batch_execute( vlc_object_t *p_this,
         int i_files;
 
         msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
-        i_files = utf8_scandir( *ppsz_dir, &ppsz_filelist, file_select,
+        i_files = vlc_scandir( *ppsz_dir, &ppsz_filelist, file_select,
                                 file_compare );
         if( i_files < 0 )
             continue;
@@ -239,7 +305,7 @@ int vlclua_scripts_batch_execute( vlc_object_t *p_this,
             {
                 msg_Dbg( p_this, "Trying Lua playlist script %s",
                          psz_filename );
-                i_ret = func( p_this, psz_filename, L, user_data );
+                i_ret = func( p_this, psz_filename, user_data );
                 free( psz_filename );
                 if( i_ret == VLC_SUCCESS )
                     break;
@@ -259,9 +325,9 @@ int vlclua_scripts_batch_execute( vlc_object_t *p_this,
 
 char *vlclua_find_file( vlc_object_t *p_this, const char *psz_luadirname, const char *psz_name )
 {
-    char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
+    char **ppsz_dir_list = NULL;
     char **ppsz_dir;
-    vlclua_dir_list( p_this, psz_luadirname, ppsz_dir_list );
+    vlclua_dir_list( p_this, psz_luadirname, &ppsz_dir_list );
     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
     {
         for( const char **ppsz_ext = ppsz_lua_exts; *ppsz_ext; ppsz_ext++ )
@@ -276,7 +342,7 @@ char *vlclua_find_file( vlc_object_t *p_this, const char *psz_luadirname, const
                 return NULL;
             }
 
-            if( utf8_stat( psz_filename, &st ) == 0
+            if( vlc_stat( psz_filename, &st ) == 0
                 && S_ISREG( st.st_mode ) )
             {
                 vlclua_dir_list_free( ppsz_dir_list );
@@ -298,7 +364,8 @@ void __vlclua_read_meta_data( vlc_object_t *p_this, lua_State *L,
 {
 #define TRY_META( a, b )                                        \
     lua_getfield( L, -1, a );                                   \
-    if( lua_isstring( L, -1 ) )                                 \
+    if( lua_isstring( L, -1 ) &&                                \
+        strcmp( lua_tostring( L, -1 ), "" ) )                   \
     {                                                           \
         char *psz_value = strdup( lua_tostring( L, -1 ) );      \
         EnsureUTF8( psz_value );                                \
@@ -566,9 +633,10 @@ static int vlc_sd_probe_Open( vlc_object_t *obj )
     char **ppsz_fileend  = NULL;
     char **ppsz_file;
     char *psz_name;
-    char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
+    char **ppsz_dir_list = NULL;
     char **ppsz_dir;
-    vlclua_dir_list( obj, "sd", ppsz_dir_list );
+    lua_State *L = NULL;
+    vlclua_dir_list( obj, "sd", &ppsz_dir_list );
     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
     {
         int i_files;
@@ -580,7 +648,7 @@ static int vlc_sd_probe_Open( vlc_object_t *obj )
             free( ppsz_filelist );
             ppsz_filelist = NULL;
         }
-        i_files = utf8_scandir( *ppsz_dir, &ppsz_filelist, file_select,
+        i_files = vlc_scandir( *ppsz_dir, &ppsz_filelist, file_select,
                                 file_compare );
         if( i_files < 1 ) continue;
         ppsz_fileend = ppsz_filelist + i_files;
@@ -592,30 +660,75 @@ static int vlc_sd_probe_Open( vlc_object_t *obj )
             {
                 goto error;
             }
-            FILE *fd = utf8_fopen( psz_filename, "r" );
-            if( fd )
+            L = luaL_newstate();
+            if( !L )
             {
-                char description[256];
-                if( fgets( description, 256, fd ) != NULL )
+                msg_Err( probe, "Could not create new Lua State" );
+                free( psz_filename );
+                goto error;
+            }
+            luaL_openlibs( L );
+            if( vlclua_add_modules_path( probe, L, psz_filename ) )
+            {
+                msg_Err( probe, "Error while setting the module search path for %s",
+                          psz_filename );
+                free( psz_filename );
+                goto error;
+            }
+            if( luaL_dofile( L, psz_filename ) )
+            {
+
+                msg_Err( probe, "Error loading script %s: %s", psz_filename,
+                          lua_tostring( L, lua_gettop( L ) ) );
+                lua_pop( L, 1 );
+                free( psz_filename );
+                lua_close( L );
+                continue;
+            }
+            char *psz_longname;
+            char *temp = strchr( *ppsz_file, '.' );
+            if( temp )
+                *temp = '\0';
+            lua_getglobal( L, "descriptor" );
+            if( !lua_isfunction( L, lua_gettop( L ) ) || lua_pcall( L, 0, 1, 0 ) )
+            {
+                msg_Warn( probe, "No 'descriptor' function in '%s'", psz_filename );
+                lua_pop( L, 1 );
+                if( !( psz_longname = strdup( *ppsz_file ) ) )
                 {
-                    char *temp = strchr( description, '\n' );
-                    if( temp )
-                        *temp = '\0';
-                    *(*ppsz_file + strlen(*ppsz_file) - 4 )= '\0';
-                    if( asprintf( &psz_name, "lua{sd=%s,longname=%s}",
-                                  *ppsz_file, description + 17 ) < 0 )
-                    {
-                        fclose( fd );
-                        free( psz_filename );
-                        goto error;
-                    }
-                    vlc_sd_probe_Add( probe, psz_name,
-                                      description + 17 );
-                    free( psz_name );
+                    free( psz_filename );
+                    goto error;
                 }
-                fclose( fd );
             }
+            else
+            {
+                lua_getfield( L, -1, "title" );
+                if( !lua_isstring( L, -1 ) ||
+                    !( psz_longname = strdup( lua_tostring( L, -1 ) ) ) )
+                {
+                    free( psz_filename );
+                    goto error;
+                }
+            }
+
+            char *psz_file_esc = config_StringEscape( *ppsz_file );
+            char *psz_longname_esc = config_StringEscape( psz_longname );
+            if( asprintf( &psz_name, "lua{sd='%s',longname='%s'}",
+                          psz_file_esc, psz_longname_esc ) < 0 )
+            {
+                free( psz_file_esc );
+                free( psz_longname_esc );
+                free( psz_filename );
+                free( psz_longname );
+                goto error;
+            }
+            free( psz_file_esc );
+            free( psz_longname_esc );
+            vlc_sd_probe_Add( probe, psz_name, psz_longname, SD_CAT_INTERNET );
+            free( psz_name );
+            free( psz_longname );
             free( psz_filename );
+            lua_close( L );
         }
     }
     if( ppsz_filelist )
@@ -635,6 +748,95 @@ error:
             free( *ppsz_file );
         free( ppsz_filelist );
     }
+    if( L )
+        lua_close( L );
     vlclua_dir_list_free( ppsz_dir_list );
     return VLC_ENOMEM;
 }
+
+static int vlclua_add_modules_path_inner( lua_State *L, const char *psz_path )
+{
+    int count = 0;
+    for( const char **ppsz_ext = ppsz_lua_exts; *ppsz_ext; ppsz_ext++ )
+    {
+        lua_pushfstring( L, "%s"DIR_SEP"modules"DIR_SEP"?%s;",
+                         psz_path, *ppsz_ext );
+        count ++;
+    }
+
+    return count;
+}
+
+int __vlclua_add_modules_path( vlc_object_t *obj, lua_State *L, const char *psz_filename )
+{
+    /* Setup the module search path:
+     *   * "The script's directory"/modules
+     *   * "The script's parent directory"/modules
+     *   * and so on for all the next directories in the directory list
+     */
+    char *psz_path = strdup( psz_filename );
+    if( !psz_path )
+        return 1;
+
+    char *psz_char = strrchr( psz_path, DIR_SEP_CHAR );
+    if( !psz_char )
+    {
+        free( psz_path );
+        return 1;
+    }
+    *psz_char = '\0';
+
+    /* psz_path now holds the file's directory */
+    psz_char = strrchr( psz_path, DIR_SEP_CHAR );
+    if( !psz_char )
+    {
+        free( psz_path );
+        return 1;
+    }
+    *psz_char = '\0';
+
+    /* Push package on stack */
+    int count = 0;
+    lua_getglobal( L, "package" );
+
+    /* psz_path now holds the file's parent directory */
+    count += vlclua_add_modules_path_inner( L, psz_path );
+    *psz_char = DIR_SEP_CHAR;
+
+    /* psz_path now holds the file's directory */
+    count += vlclua_add_modules_path_inner( L, psz_path );
+
+    char **ppsz_dir_list = NULL;
+    vlclua_dir_list( obj, psz_char+1/* gruik? */, &ppsz_dir_list );
+    char **ppsz_dir = ppsz_dir_list;
+
+    for( ; *ppsz_dir && strcmp( *ppsz_dir, psz_path ); ppsz_dir++ );
+    free( psz_path );
+
+    for( ; *ppsz_dir; ppsz_dir++ )
+    {
+        psz_path = *ppsz_dir;
+        /* FIXME: doesn't work well with meta/... modules due to the double
+         * directory depth */
+        psz_char = strrchr( psz_path, DIR_SEP_CHAR );
+        if( !psz_char )
+        {
+            vlclua_dir_list_free( ppsz_dir_list );
+            return 1;
+        }
+
+        *psz_char = '\0';
+        count += vlclua_add_modules_path_inner( L, psz_path );
+        *psz_char = DIR_SEP_CHAR;
+        count += vlclua_add_modules_path_inner( L, psz_path );
+    }
+
+    lua_getfield( L, -(count+1), "path" ); /* Get package.path */
+    lua_concat( L, count+1 ); /* Concat vlc module paths and package.path */
+    lua_setfield( L, -2, "path"); /* Set package.path */
+    lua_pop( L, 1 ); /* Pop the package module */
+
+    vlclua_dir_list_free( ppsz_dir_list );
+    return 0;
+}
+