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

   1 /*****************************************************************************
   2  * intf.c: Generic lua interface functions
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan tod 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 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifndef  _GNU_SOURCE
  28 #   define  _GNU_SOURCE
  29 #endif
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34
  35 #include <vlc_common.h>
  36 #include <vlc_meta.h>
  37 #include <vlc_charset.h>
  38
  39 #include <vlc_interface.h>
  40 #include <vlc_playlist.h>
  41 #include <vlc_aout.h>
  42
  43 #include <lua.h>        /* Low level lua C API */
  44 #include <lauxlib.h>    /* Higher level C API */
  45 #include <lualib.h>     /* Lua libs */
  46
  47 #include "vlc.h"
  48 #include "libs.h"
  49
  50 /*****************************************************************************
  51  * Prototypes
  52  *****************************************************************************/
  53 static void *Run( void * );
  54
  55 static const char * const ppsz_intf_options[] = { "intf", "config", NULL };
  56
  57 /*****************************************************************************
  58  *
  59  *****************************************************************************/
  60 static char *FindFile( vlc_object_t *p_this, const char *psz_name )
  61 {
  62     char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
  63     char **ppsz_dir;
  64     vlclua_dir_list( p_this, "intf", ppsz_dir_list );
  65     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
  66     {
  67         char *psz_filename;
  68         FILE *fp;
  69         if( asprintf( &psz_filename, "%s"DIR_SEP"%s.lua", *ppsz_dir,
  70                       psz_name ) < 0 )
  71         {
  72             vlclua_dir_list_free( ppsz_dir_list );
  73             return NULL;
  74         }
  75         fp = fopen( psz_filename, "r" );
  76         if( fp )
  77         {
  78             fclose( fp );
  79             vlclua_dir_list_free( ppsz_dir_list );
  80             return psz_filename;
  81         }
  82         free( psz_filename );
  83     }
  84     vlclua_dir_list_free( ppsz_dir_list );
  85     return NULL;
  86 }
  87
  88 static inline void luaL_register_submodule( lua_State *L, const char *psz_name,
  89                                             const luaL_Reg *l )
  90 {
  91     lua_newtable( L );
  92     luaL_register( L, NULL, l );
  93     lua_setfield( L, -2, psz_name );
  94 }
  95
  96 static const struct
  97 {
  98     const char *psz_shortcut;
  99     const char *psz_name;
 100 } pp_shortcuts[] = {
 101     { "luarc", "rc" },
 102     /* { "rc", "rc" }, */
 103     { "luahotkeys", "hotkeys" },
 104     /* { "hotkeys", "hotkeys" }, */
 105     { "luatelnet", "telnet" },
 106     /* { "telnet", "telnet" }, */
 107     { "luahttp", "http" },
 108     /* { "http", "http" }, */
 109     { NULL, NULL } };
 110
 111 static bool WordInList( const char *psz_list, const char *psz_word )
 112 {
 113     const char *psz_str = strstr( psz_list, psz_word );
 114     int i_len = strlen( psz_word );
 115     while( psz_str )
 116     {
 117         if( (psz_str == psz_list || *(psz_str-1) == ',' )
 118          /* it doesn't start in middle of a word */
 119          /* it doest end in middle of a word */
 120          && ( psz_str[i_len] == '\0' || psz_str[i_len] == ',' ) )
 121             return true;
 122         psz_str = strstr( psz_str, psz_word );
 123     }
 124     return false;
 125 }
 126
 127 static char *GetModuleName( intf_thread_t *p_intf )
 128 {
 129     int i;
 130     const char *psz_intf;
 131     /*if( *p_intf->psz_intf == '$' )
 132         psz_intf = var_GetString( p_intf, p_intf->psz_intf+1 );
 133     else*/
 134         psz_intf = p_intf->psz_intf;
 135     for( i = 0; pp_shortcuts[i].psz_name; i++ )
 136     {
 137         if( WordInList( psz_intf, pp_shortcuts[i].psz_shortcut ) )
 138             return strdup( pp_shortcuts[i].psz_name );
 139     }
 140
 141     return var_CreateGetString( p_intf, "lua-intf" );
 142 }
 143
 144 static const luaL_Reg p_reg[] = { { NULL, NULL } };
 145
 146 int Open_LuaIntf( vlc_object_t *p_this )
 147 {
 148     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 149     intf_sys_t *p_sys;
 150     lua_State *L;
 151
 152     config_ChainParse( p_intf, "lua-", ppsz_intf_options, p_intf->p_cfg );
 153     char *psz_name = GetModuleName( p_intf );
 154     char *psz_config;
 155     bool b_config_set = false;
 156     if( !psz_name ) psz_name = strdup( "dummy" );
 157
 158     p_intf->p_sys = (intf_sys_t*)malloc( sizeof(intf_sys_t) );
 159     if( !p_intf->p_sys )
 160     {
 161         free( psz_name );
 162         return VLC_ENOMEM;
 163     }
 164     p_sys = p_intf->p_sys;
 165     p_sys->psz_filename = FindFile( p_this, psz_name );
 166     if( !p_sys->psz_filename )
 167     {
 168         msg_Err( p_intf, "Couldn't find lua interface script \"%s\".",
 169                  psz_name );
 170         free( psz_name );
 171         free( p_sys );
 172         return VLC_EGENERIC;
 173     }
 174     msg_Dbg( p_intf, "Found lua interface script: %s", p_sys->psz_filename );
 175
 176     L = luaL_newstate();
 177     if( !L )
 178     {
 179         msg_Err( p_intf, "Could not create new Lua State" );
 180         free( p_sys->psz_filename );
 181         free( psz_name );
 182         free( p_sys );
 183         return VLC_EGENERIC;
 184     }
 185
 186     luaL_openlibs( L );
 187
 188     /* register our functions */
 189     luaL_register( L, "vlc", p_reg );
 190
 191     /* store a pointer to p_intf (FIXME: user could overwrite this) */
 192     lua_pushlightuserdata( L, p_intf );
 193     lua_setfield( L, -2, "private" );
 194
 195     /* register submodules */
 196     luaopen_acl( L );
 197     luaopen_config( L );
 198     luaopen_volume( L );
 199     luaopen_httpd( L );
 200     luaopen_input( L );
 201     luaopen_msg( L );
 202     luaopen_misc( L );
 203     luaopen_net( L );
 204     luaopen_object( L );
 205     luaopen_osd( L );
 206     luaopen_playlist( L );
 207     luaopen_sd( L );
 208     luaopen_stream( L );
 209     luaopen_strings( L );
 210     luaopen_variables( L );
 211     luaopen_video( L );
 212     luaopen_vlm( L );
 213     luaopen_volume( L );
 214
 215     /* clean up */
 216     lua_pop( L, 1 );
 217
 218     /* <gruik> */
 219     /* Setup the module search path */
 220     {
 221     char *psz_command;
 222     char *psz_char = strrchr(p_sys->psz_filename,DIR_SEP_CHAR);
 223     *psz_char = '\0';
 224     /* FIXME: don't use luaL_dostring */
 225     if( asprintf( &psz_command,
 226                   "package.path = \"%s"DIR_SEP"modules"DIR_SEP"?.lua;\"..package.path",
 227                   p_sys->psz_filename ) < 0 )
 228     {
 229         free( p_sys->psz_filename );
 230         free( psz_name );
 231         free( p_sys );
 232         return VLC_EGENERIC;
 233     }
 234     *psz_char = DIR_SEP_CHAR;
 235     if( luaL_dostring( L, psz_command ) )
 236     {
 237         free( psz_command );
 238         free( p_sys->psz_filename );
 239         free( psz_name );
 240         free( p_sys );
 241         return VLC_EGENERIC;
 242     }
 243     free( psz_command );
 244     }
 245     /* </gruik> */
 246
 247     psz_config = var_CreateGetString( p_intf, "lua-config" );
 248     if( psz_config && *psz_config )
 249     {
 250         char *psz_buffer;
 251         if( asprintf( &psz_buffer, "config={%s}", psz_config ) != -1 )
 252         {
 253             printf("%s\n", psz_buffer);
 254             if( luaL_dostring( L, psz_buffer ) == 1 )
 255                 msg_Err( p_intf, "Error while parsing \"lua-config\"." );
 256             free( psz_buffer );
 257             lua_getglobal( L, "config" );
 258             if( lua_istable( L, -1 ) )
 259             {
 260                 lua_getfield( L, -1, psz_name );
 261                 if( lua_istable( L, -1 ) )
 262                 {
 263                     lua_setglobal( L, "config" );
 264                     b_config_set = true;
 265                 }
 266             }
 267         }
 268     }
 269     free( psz_config );
 270
 271     if( b_config_set == false )
 272     {
 273         lua_newtable( L );
 274         lua_setglobal( L, "config" );
 275     }
 276
 277     p_sys->L = L;
 278
 279     p_intf->psz_header = psz_name;
 280     /* ^^ Do I need to clean that up myself in Close_LuaIntf? */
 281
 282     vlc_mutex_init( &p_sys->lock );
 283     vlc_cond_init( &p_sys->wait );
 284     p_sys->exiting = false;
 285
 286     if( vlc_clone( &p_sys->thread, Run, p_intf, VLC_THREAD_PRIORITY_LOW ) )
 287     {
 288         p_sys->exiting = true;
 289         Close_LuaIntf( p_this );
 290         return VLC_ENOMEM;
 291     }
 292
 293     return VLC_SUCCESS;
 294 }
 295
 296 void Close_LuaIntf( vlc_object_t *p_this )
 297 {
 298     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 299     intf_sys_t *p_sys = p_intf->p_sys;
 300
 301     vlc_cancel( p_sys->thread );
 302
 303     if( !p_sys->exiting ) /* <- Read-only here and in thread: no locking */
 304     {
 305         vlc_mutex_lock( &p_sys->lock );
 306         p_sys->exiting = true;
 307         vlc_cond_signal( &p_sys->wait );
 308         vlc_mutex_unlock( &p_sys->lock );
 309         vlc_join( p_sys->thread, NULL );
 310     }
 311     vlc_cond_destroy( &p_sys->wait );
 312     vlc_mutex_destroy( &p_sys->lock );
 313
 314     lua_close( p_sys->L );
 315
 316     free( p_sys->psz_filename );
 317     free( p_sys );
 318 }
 319
 320 static void *Run( void *data )
 321 {
 322     intf_thread_t *p_intf = data;
 323     intf_sys_t *p_sys = p_intf->p_sys;
 324     lua_State *L = p_sys->L;
 325
 326     if( luaL_dofile( L, p_sys->psz_filename ) )
 327     {
 328         msg_Err( p_intf, "Error loading script %s: %s", p_sys->psz_filename,
 329                  lua_tostring( L, lua_gettop( L ) ) );
 330         lua_pop( L, 1 );
 331     }
 332     return NULL;
 333 }