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 struct intf_sys_t
  54 {
  55     char *psz_filename;
  56     lua_State *L;
  57 };
  58
  59 static void Run( intf_thread_t *p_intf );
  60
  61 /*****************************************************************************
  62  *
  63  *****************************************************************************/
  64 static char *FindFile( const char *psz_name )
  65 {
  66     char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
  67     char **ppsz_dir;
  68     vlclua_dir_list( "intf", ppsz_dir_list );
  69     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
  70     {
  71         char *psz_filename;
  72         FILE *fp;
  73         if( asprintf( &psz_filename, "%s"DIR_SEP"%s.lua", *ppsz_dir,
  74                       psz_name ) < 0 )
  75         {
  76             return NULL;
  77         }
  78         fp = fopen( psz_filename, "r" );
  79         if( fp )
  80         {
  81             fclose( fp );
  82             return psz_filename;
  83         }
  84         free( psz_filename );
  85     }
  86     return NULL;
  87 }
  88
  89 static inline void luaL_register_submodule( lua_State *L, const char *psz_name,
  90                                             const luaL_Reg *l )
  91 {
  92     lua_newtable( L );
  93     luaL_register( L, NULL, l );
  94     lua_setfield( L, -2, psz_name );
  95 }
  96
  97 static struct
  98 {
  99     const char *psz_shortcut;
 100     const char *psz_name;
 101 } pp_shortcuts[] = {
 102     { "luarc", "rc" },
 103     /* { "rc", "rc" }, */
 104     { "luahotkeys", "hotkeys" },
 105     /* { "hotkeys", "hotkeys" }, */
 106     { "luatelnet", "telnet" },
 107     /* { "telnet", "telnet" }, */
 108     { "luahttp", "http" },
 109     /* { "http", "http" }, */
 110     { NULL, NULL } };
 111
 112 static bool WordInList( const char *psz_list, const char *psz_word )
 113 {
 114     const char *psz_str = strstr( psz_list, psz_word );
 115     int i_len = strlen( psz_word );
 116     while( psz_str )
 117     {
 118         if( (psz_str == psz_list || *(psz_str-1) == ',' )
 119          /* it doesn't start in middle of a word */
 120          /* it doest end in middle of a word */
 121          && ( psz_str[i_len] == '\0' || psz_str[i_len] == ',' ) )
 122             return true;
 123         psz_str = strstr( psz_str, psz_word );
 124     }
 125     return false;
 126 }
 127
 128 static char *GetModuleName( intf_thread_t *p_intf )
 129 {
 130     int i;
 131     const char *psz_intf;
 132     if( *p_intf->psz_intf == '$' )
 133         psz_intf = var_GetString( p_intf, p_intf->psz_intf+1 );
 134     else
 135         psz_intf = p_intf->psz_intf;
 136     for( i = 0; pp_shortcuts[i].psz_name; i++ )
 137     {
 138         if( WordInList( psz_intf, pp_shortcuts[i].psz_shortcut ) )
 139             return strdup( pp_shortcuts[i].psz_name );
 140     }
 141
 142     return config_GetPsz( p_intf, "lua-intf" );
 143 }
 144
 145 static luaL_Reg p_reg[] = { { NULL, NULL } };
 146
 147 int Open_LuaIntf( vlc_object_t *p_this )
 148 {
 149     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 150     intf_sys_t *p_sys;
 151     lua_State *L;
 152
 153     char *psz_name = GetModuleName( p_intf );
 154     const 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( 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( psz_name );
 181         free( p_sys );
 182         return VLC_EGENERIC;
 183     }
 184
 185     luaL_openlibs( L );
 186
 187     /* register our functions */
 188     luaL_register( L, "vlc", p_reg );
 189
 190     /* store a pointer to p_intf (FIXME: user could overwrite this) */
 191     lua_pushlightuserdata( L, p_intf );
 192     lua_setfield( L, -2, "private" );
 193
 194     /* register submodules */
 195     luaopen_acl( L );
 196     luaopen_config( L );
 197     luaopen_volume( L );
 198     luaopen_httpd( L );
 199     luaopen_input( L );
 200     luaopen_msg( L );
 201     luaopen_misc( L );
 202     luaopen_net( L );
 203     luaopen_object( L );
 204     luaopen_osd( L );
 205     luaopen_playlist( L );
 206     luaopen_sd( L );
 207     luaopen_stream( L );
 208     luaopen_strings( L );
 209     luaopen_variables( L );
 210     luaopen_video( L );
 211     luaopen_vlm( L );
 212     luaopen_volume( L );
 213
 214     /* clean up */
 215     lua_pop( L, 1 );
 216
 217     /* <gruik> */
 218     /* Setup the module search path */
 219     {
 220     char *psz_command;
 221     char *psz_char = strrchr(p_sys->psz_filename,DIR_SEP_CHAR);
 222     *psz_char = '\0';
 223     /* FIXME: don't use luaL_dostring */
 224     if( asprintf( &psz_command,
 225                   "package.path = \"%s"DIR_SEP"modules"DIR_SEP"?.lua;\"..package.path",
 226                   p_sys->psz_filename ) < 0 )
 227         return VLC_EGENERIC;
 228     *psz_char = DIR_SEP_CHAR;
 229     if( luaL_dostring( L, psz_command ) )
 230         return VLC_EGENERIC;
 231     }
 232     /* </gruik> */
 233
 234     psz_config = config_GetPsz( p_intf, "lua-config" );
 235     if( psz_config && *psz_config )
 236     {
 237         char *psz_buffer;
 238         if( asprintf( &psz_buffer, "config={%s}", psz_config ) != -1 )
 239         {
 240             printf("%s\n", psz_buffer);
 241             if( luaL_dostring( L, psz_buffer ) == 1 )
 242                 msg_Err( p_intf, "Error while parsing \"lua-config\"." );
 243             free( psz_buffer );
 244             lua_getglobal( L, "config" );
 245             if( lua_istable( L, -1 ) )
 246             {
 247                 lua_getfield( L, -1, psz_name );
 248                 if( lua_istable( L, -1 ) )
 249                 {
 250                     lua_setglobal( L, "config" );
 251                     b_config_set = true;
 252                 }
 253             }
 254         }
 255     }
 256     if( b_config_set == false )
 257     {
 258         lua_newtable( L );
 259         lua_setglobal( L, "config" );
 260     }
 261
 262     p_sys->L = L;
 263
 264     p_intf->pf_run = Run;
 265     p_intf->psz_header = strdup( psz_name ); /* Do I need to clean that up myself in Close_LuaIntf? */
 266
 267     free( psz_name );
 268     return VLC_SUCCESS;
 269 }
 270
 271 void Close_LuaIntf( vlc_object_t *p_this )
 272 {
 273     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 274
 275     lua_close( p_intf->p_sys->L );
 276     free( p_intf->p_sys );
 277 }
 278
 279 static void Run( intf_thread_t *p_intf )
 280 {
 281     lua_State *L = p_intf->p_sys->L;
 282
 283     if( luaL_dofile( L, p_intf->p_sys->psz_filename ) )
 284     {
 285         msg_Err( p_intf, "Error loading script %s: %s",
 286                  p_intf->p_sys->psz_filename,
 287                  lua_tostring( L, lua_gettop( L ) ) );
 288         lua_pop( L, 1 );
 289         p_intf->b_die = true;
 290         return;
 291     }
 292     p_intf->b_die = true;
 293 }