modules/lua/intf.c

   1 /*****************************************************************************
   2  * intf.c: Generic lua interface functions
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  *
   6  * Authors: Antoine Cellerier <dionoea at videolan tod org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 /*****************************************************************************
  24  * Preamble
  25  *****************************************************************************/
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <unistd.h>
  33
  34 #include <vlc_common.h>
  35 #include <vlc_interface.h>
  36 #include <vlc_fs.h>
  37
  38 #include "vlc.h"
  39 #include "libs.h"
  40
  41 /*****************************************************************************
  42  * Prototypes
  43  *****************************************************************************/
  44 static void *Run( void * );
  45
  46 static const char * const ppsz_intf_options[] = { "intf", "config", NULL };
  47
  48 /*****************************************************************************
  49  * Local structures
  50  *****************************************************************************/
  51 struct intf_sys_t
  52 {
  53     char *psz_filename;
  54     lua_State *L;
  55     vlc_thread_t thread;
  56     vlclua_dtable_t dtable;
  57 };
  58 /*****************************************************************************
  59  *
  60  *****************************************************************************/
  61
  62 static char *MakeConfig( intf_thread_t *p_intf, const char *name )
  63 {
  64     char *psz_config = NULL;
  65
  66     if( !strcmp( name, "http" ) )
  67     {
  68         char *psz_http_src = var_InheritString( p_intf, "http-src" );
  69         bool b_http_index = var_InheritBool( p_intf, "http-index" );
  70         if( psz_http_src )
  71         {
  72             char *psz_esc = config_StringEscape( psz_http_src );
  73
  74             if( asprintf( &psz_config, "http={dir='%s',no_index=%s}", psz_esc,
  75                           b_http_index ? "true" : "false" ) == -1 )
  76                 psz_config = NULL;
  77             free( psz_esc );
  78             free( psz_http_src );
  79         }
  80         else
  81         {
  82             if( asprintf( &psz_config, "http={no_index=%s}",
  83                           b_http_index ? "true" : "false" ) == -1 )
  84                 psz_config = NULL;
  85         }
  86     }
  87     else if( !strcmp( name, "telnet" ) )
  88     {
  89         char *psz_host = var_InheritString( p_intf, "telnet-host" );
  90         if( !strcmp( psz_host, "*console" ) )
  91             ;
  92         else
  93         {
  94             vlc_url_t url;
  95             vlc_UrlParse( &url, psz_host );
  96             unsigned i_port = var_InheritInteger( p_intf, "telnet-port" );
  97             if ( url.i_port != 0 )
  98             {
  99                 if ( i_port == TELNETPORT_DEFAULT )
 100                     i_port = url.i_port;
 101                 else if ( url.i_port != i_port )
 102                     msg_Warn( p_intf, "ignoring port %d (using %d)",
 103                               url.i_port, i_port );
 104             }
 105
 106             char *psz_esc_host = config_StringEscape( url.psz_host );
 107             free( psz_host );
 108             vlc_UrlClean( &url );
 109
 110             if( asprintf( &psz_host, "telnet://%s:%d",
 111                           psz_esc_host ? psz_esc_host : "", i_port ) == -1 )
 112                 psz_host = NULL;
 113             free( psz_esc_host );
 114         }
 115
 116         char *psz_passwd = var_InheritString( p_intf, "telnet-password" );
 117
 118         char *psz_esc_passwd = config_StringEscape( psz_passwd );
 119
 120         if( asprintf( &psz_config, "telnet={host='%s',password='%s'}",
 121                       psz_host, psz_esc_passwd ) == -1 )
 122             psz_config = NULL;
 123
 124         free( psz_esc_passwd );
 125         free( psz_passwd );
 126         free( psz_host );
 127     }
 128
 129     return psz_config;
 130 }
 131
 132 static char *StripPasswords( const char *psz_config )
 133 {
 134     unsigned n = 0;
 135     const char *p = psz_config;
 136     while ((p = strstr(p, "password=")) != NULL)
 137     {
 138         n++;
 139         p++;
 140     }
 141     if (n == 0)
 142         return strdup(psz_config);
 143
 144     char *psz_log = malloc(strlen(psz_config) + n * strlen("******") + 1);
 145     if (psz_log == NULL)
 146         return NULL;
 147     psz_log[0] = '\0';
 148
 149     for (p = psz_config; ; )
 150     {
 151         const char *pwd = strstr(p, "password=");
 152         if (pwd == NULL)
 153         {
 154             /* Copy the last, ending bit */
 155             strcat(psz_log, p);
 156             break;
 157         }
 158         pwd += strlen("password=");
 159
 160         char delim[3] = ",}";
 161         if (*pwd == '\'' || *pwd == '"')
 162         {
 163             delim[0] = *pwd++;
 164             delim[1] = '\0';
 165         }
 166
 167         strncat(psz_log, p, pwd - p);
 168         strcat(psz_log, "******");
 169
 170         /* Advance to the delimiter at the end of the password */
 171         p = pwd - 1;
 172         do
 173         {
 174             p = strpbrk(p + 1, delim);
 175             if (p == NULL)
 176                 /* Oops, unbalanced quotes or brackets */
 177                 return psz_log;
 178         }
 179         while (*(p - 1) == '\\');
 180     }
 181     return psz_log;
 182 }
 183
 184 static const luaL_Reg p_reg[] = { { NULL, NULL } };
 185
 186 static int Start_LuaIntf( vlc_object_t *p_this, const char *name )
 187 {
 188     if( lua_Disabled( p_this ) )
 189         return VLC_EGENERIC;
 190
 191     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 192     struct vlc_logger *logger = p_intf->obj.logger;
 193     lua_State *L;
 194     char *namebuf = NULL;
 195
 196     config_ChainParse( p_intf, "lua-", ppsz_intf_options, p_intf->p_cfg );
 197
 198     if( name == NULL )
 199     {
 200         namebuf = var_InheritString( p_this, "lua-intf" );
 201         if( unlikely(namebuf == NULL) )
 202             return VLC_EGENERIC;
 203         name = namebuf;
 204     }
 205
 206     intf_sys_t *p_sys = malloc( sizeof(*p_sys) );
 207     if( unlikely(p_sys == NULL) )
 208     {
 209         free( namebuf );
 210         return VLC_ENOMEM;
 211     }
 212     p_intf->p_sys = p_sys;
 213
 214     p_intf->obj.logger = vlc_LogHeaderCreate( logger, name );
 215     if( p_intf->obj.logger == NULL )
 216     {
 217         p_intf->obj.logger = logger;
 218         free( p_sys );
 219         free( namebuf );
 220         return VLC_ENOMEM;
 221     }
 222
 223     p_sys->psz_filename = vlclua_find_file( "intf", name );
 224     if( !p_sys->psz_filename )
 225     {
 226         msg_Err( p_intf, "Couldn't find lua interface script \"%s\".",
 227                  name );
 228         goto error;
 229     }
 230     msg_Dbg( p_intf, "Found lua interface script: %s", p_sys->psz_filename );
 231
 232     L = luaL_newstate();
 233     if( !L )
 234     {
 235         msg_Err( p_intf, "Could not create new Lua State" );
 236         goto error;
 237     }
 238
 239     vlclua_set_this( L, p_intf );
 240     vlc_playlist_t *playlist = vlc_intf_GetMainPlaylist(p_intf);
 241     vlclua_set_playlist_internal(L, playlist);
 242
 243     luaL_openlibs( L );
 244
 245     /* register our functions */
 246     luaL_register_namespace( L, "vlc", p_reg );
 247
 248     /* register submodules */
 249     luaopen_config( L );
 250     luaopen_httpd( L );
 251     luaopen_input( L );
 252     luaopen_msg( L );
 253     luaopen_misc( L );
 254     if( vlclua_fd_init( L, &p_sys->dtable ) )
 255     {
 256         lua_close( L );
 257         goto error;
 258     }
 259     luaopen_object( L );
 260     luaopen_osd( L );
 261     luaopen_playlist( L );
 262     luaopen_stream( L );
 263     luaopen_strings( L );
 264     luaopen_variables( L );
 265     luaopen_video( L );
 266     luaopen_vlm( L );
 267     luaopen_volume( L );
 268     luaopen_gettext( L );
 269     luaopen_xml( L );
 270     luaopen_equalizer( L );
 271     luaopen_vlcio( L );
 272     luaopen_errno( L );
 273     luaopen_rand( L );
 274     luaopen_rd( L );
 275 #if defined(_WIN32) && !VLC_WINSTORE_APP
 276     luaopen_win( L );
 277 #endif
 278
 279     /* clean up */
 280     lua_pop( L, 1 );
 281
 282     /* Setup the module search path */
 283     if( vlclua_add_modules_path( L, p_sys->psz_filename ) )
 284     {
 285         msg_Warn( p_intf, "Error while setting the module search path for %s",
 286                   p_sys->psz_filename );
 287         lua_close( L );
 288         goto error;
 289     }
 290
 291     /*
 292      * Get the lua-config string.
 293      * If the string is empty, try with the old http-* or telnet-* options
 294      * and build the right configuration line
 295      */
 296     bool b_config_set = false;
 297     char *psz_config = var_InheritString( p_intf, "lua-config" );
 298     if( !psz_config )
 299         psz_config = MakeConfig( p_intf, name );
 300
 301     if( psz_config )
 302     {
 303         char *psz_buffer;
 304         if( asprintf( &psz_buffer, "config={%s}", psz_config ) != -1 )
 305         {
 306             char *psz_log = StripPasswords( psz_buffer );
 307             if( psz_log != NULL )
 308             {
 309                 msg_Dbg( p_intf, "Setting config variable: %s", psz_log );
 310                 free( psz_log );
 311             }
 312
 313             if( luaL_dostring( L, psz_buffer ) == 1 )
 314                 msg_Err( p_intf, "Error while parsing \"lua-config\"." );
 315             free( psz_buffer );
 316             lua_getglobal( L, "config" );
 317             if( lua_istable( L, -1 ) )
 318             {
 319                 if( !strcmp( name, "cli" ) )
 320                 {
 321                     lua_getfield( L, -1, "rc" );
 322                     if( lua_istable( L, -1 ) )
 323                     {
 324                         /* msg_Warn( p_intf, "The `rc' lua interface script "
 325                                           "was renamed `cli', please update "
 326                                           "your configuration!" ); */
 327                         lua_setfield( L, -2, "cli" );
 328                     }
 329                     else
 330                         lua_pop( L, 1 );
 331                 }
 332                 lua_getfield( L, -1, name );
 333                 if( lua_istable( L, -1 ) )
 334                 {
 335                     lua_setglobal( L, "config" );
 336                     b_config_set = true;
 337                 }
 338             }
 339         }
 340         free( psz_config );
 341     }
 342
 343     if( !b_config_set )
 344     {
 345         lua_newtable( L );
 346         lua_setglobal( L, "config" );
 347     }
 348
 349     /* Wrapper for legacy telnet config */
 350     if ( !strcmp( name, "telnet" ) )
 351     {
 352         /* msg_Warn( p_intf, "The `telnet' lua interface script was replaced "
 353                           "by `cli', please update your configuration!" ); */
 354
 355         char *wrapped_file = vlclua_find_file( "intf", "cli" );
 356         if( !wrapped_file )
 357         {
 358             msg_Err( p_intf, "Couldn't find lua interface script \"cli\", "
 359                              "needed by telnet wrapper" );
 360             lua_close( p_sys->L );
 361             goto error;
 362         }
 363         lua_pushstring( L, wrapped_file );
 364         lua_setglobal( L, "wrapped_file" );
 365         free( wrapped_file );
 366     }
 367
 368     p_sys->L = L;
 369
 370     if( vlc_clone( &p_sys->thread, Run, p_intf, VLC_THREAD_PRIORITY_LOW ) )
 371     {
 372         vlclua_fd_cleanup( &p_sys->dtable );
 373         lua_close( p_sys->L );
 374         goto error;
 375     }
 376     free( namebuf );
 377     return VLC_SUCCESS;
 378 error:
 379     free( p_sys->psz_filename );
 380     free( p_sys );
 381     vlc_LogDestroy( p_intf->obj.logger );
 382     p_intf->obj.logger = logger;
 383     free( namebuf );
 384     return VLC_EGENERIC;
 385 }
 386
 387 void Close_LuaIntf( vlc_object_t *p_this )
 388 {
 389     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 390     intf_sys_t *p_sys = p_intf->p_sys;
 391
 392     vlclua_fd_interrupt( &p_sys->dtable );
 393     vlc_join( p_sys->thread, NULL );
 394
 395     lua_close( p_sys->L );
 396     vlclua_fd_cleanup( &p_sys->dtable );
 397     free( p_sys->psz_filename );
 398     free( p_sys );
 399     vlc_LogDestroy( p_intf->obj.logger );
 400 }
 401
 402 static void *Run( void *data )
 403 {
 404     intf_thread_t *p_intf = data;
 405     intf_sys_t *p_sys = p_intf->p_sys;
 406     lua_State *L = p_sys->L;
 407
 408     if( vlclua_dofile( VLC_OBJECT(p_intf), L, p_sys->psz_filename ) )
 409     {
 410         msg_Err( p_intf, "Error loading script %s: %s", p_sys->psz_filename,
 411                  lua_tostring( L, lua_gettop( L ) ) );
 412         lua_pop( L, 1 );
 413     }
 414     return NULL;
 415 }
 416
 417 int Open_LuaIntf( vlc_object_t *p_this )
 418 {
 419     return Start_LuaIntf( p_this, NULL );
 420 }
 421
 422 int Open_LuaHTTP( vlc_object_t *p_this )
 423 {
 424     return Start_LuaIntf( p_this, "http" );
 425 }
 426
 427 int Open_LuaCLI( vlc_object_t *p_this )
 428 {
 429     return Start_LuaIntf( p_this, "cli" );
 430 }
 431
 432 int Open_LuaTelnet( vlc_object_t *p_this )
 433 {
 434     char *pw = var_CreateGetNonEmptyString( p_this, "telnet-password" );
 435     if( pw == NULL )
 436     {
 437         msg_Err( p_this, "password not configured" );
 438         msg_Info( p_this, "Please specify the password in the preferences." );
 439         return VLC_EGENERIC;
 440     }
 441     free( pw );
 442     return Start_LuaIntf( p_this, "telnet" );
 443 }