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

   1 /*****************************************************************************
   2  * meta.c: Get meta/artwork using lua scripts
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
   8  *          Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #ifndef  _GNU_SOURCE
  29 #   define  _GNU_SOURCE
  30 #endif
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #include <vlc_common.h>
  37 #include <vlc_input.h>
  38 #include <vlc_meta.h>
  39 #include <vlc_demux.h>
  40 #include <vlc_art_finder.h>
  41 #include <vlc_url.h>
  42 #include <vlc_strings.h>
  43 #include <vlc_stream.h>
  44
  45 #include "vlc.h"
  46 #include "libs.h"
  47
  48 /*****************************************************************************
  49  * Init lua
  50  *****************************************************************************/
  51 static const luaL_Reg p_reg[] = { { NULL, NULL } };
  52
  53 static lua_State * init( vlc_object_t *p_this, input_item_t * p_item, const char *psz_filename )
  54 {
  55     lua_State * L = luaL_newstate();
  56     if( !L )
  57     {
  58         msg_Err( p_this, "Could not create new Lua State" );
  59         return NULL;
  60     }
  61
  62     vlclua_set_this( L, p_this );
  63
  64     /* Load Lua libraries */
  65     luaL_openlibs( L ); /* XXX: Don't open all the libs? */
  66
  67     luaL_register( L, "vlc", p_reg );
  68
  69     luaopen_msg( L );
  70     luaopen_stream( L );
  71     luaopen_strings( L );
  72     luaopen_variables( L );
  73     luaopen_object( L );
  74     luaopen_misc( L );
  75     luaopen_xml( L );
  76     luaopen_md5( L );
  77     luaopen_input_item( L, p_item );
  78
  79     if( vlclua_add_modules_path( p_this, L, psz_filename ) )
  80     {
  81         msg_Warn( p_this, "Error while setting the module search path for %s",
  82                   psz_filename );
  83         lua_close( L );
  84         return NULL;
  85     }
  86
  87     return L;
  88 }
  89
  90 /*****************************************************************************
  91  * Run a lua entry point function
  92  *****************************************************************************/
  93 static int run( vlc_object_t *p_this, const char * psz_filename,
  94                 lua_State * L, const char *luafunction )
  95 {
  96     /* Ugly hack to delete previous versions of the fetchart()
  97      * functions. */
  98     lua_pushnil( L );
  99     lua_setglobal( L, luafunction );
 100
 101     /* Load and run the script(s) */
 102     if( luaL_dofile( L, psz_filename ) )
 103     {
 104         msg_Warn( p_this, "Error loading script %s: %s", psz_filename,
 105                  lua_tostring( L, lua_gettop( L ) ) );
 106         goto error;
 107     }
 108
 109     lua_getglobal( L, luafunction );
 110
 111     if( !lua_isfunction( L, lua_gettop( L ) ) )
 112     {
 113         msg_Warn( p_this, "Error while running script %s, "
 114                  "function %s() not found", psz_filename, luafunction );
 115         goto error;
 116     }
 117
 118     if( lua_pcall( L, 0, 1, 0 ) )
 119     {
 120         msg_Warn( p_this, "Error while running script %s, "
 121                  "function %s(): %s", psz_filename, luafunction,
 122                  lua_tostring( L, lua_gettop( L ) ) );
 123         goto error;
 124     }
 125     return VLC_SUCCESS;
 126
 127 error:
 128     lua_pop( L, 1 );
 129     return VLC_EGENERIC;
 130 }
 131
 132 /*****************************************************************************
 133  * Called through lua_scripts_batch_execute to call 'fetch_art' on the script
 134  * pointed by psz_filename.
 135  *****************************************************************************/
 136 static int fetch_art( vlc_object_t *p_this, const char * psz_filename,
 137                       void * user_data )
 138 {
 139     input_item_t * p_item = user_data;
 140
 141     lua_State *L = init( p_this, p_item, psz_filename );
 142     if( !L )
 143         return VLC_EGENERIC;
 144
 145     int i_ret = run(p_this, psz_filename, L, "fetch_art");
 146     if(i_ret != VLC_SUCCESS)
 147     {
 148         lua_close( L );
 149         return i_ret;
 150     }
 151
 152     if(lua_gettop( L ))
 153     {
 154         const char * psz_value;
 155
 156         if( lua_isstring( L, -1 ) )
 157         {
 158             psz_value = lua_tostring( L, -1 );
 159             if( psz_value && *psz_value != 0 )
 160             {
 161                 lua_Dbg( p_this, "setting arturl: %s", psz_value );
 162                 input_item_SetArtURL ( p_item, psz_value );
 163                 lua_close( L );
 164                 return VLC_SUCCESS;
 165             }
 166         }
 167         else if( !lua_isnoneornil( L, -1 ) )
 168         {
 169             msg_Err( p_this, "Lua art fetcher script %s: "
 170                  "didn't return a string", psz_filename );
 171         }
 172     }
 173     else
 174     {
 175         msg_Err( p_this, "Script went completely foobar" );
 176     }
 177
 178     lua_close( L );
 179     return VLC_EGENERIC;
 180 }
 181
 182 /*****************************************************************************
 183  * Called through lua_scripts_batch_execute to call 'read_meta' on the script
 184  * pointed by psz_filename.
 185  *****************************************************************************/
 186 static int read_meta( vlc_object_t *p_this, const char * psz_filename,
 187                       void * user_data )
 188 {
 189     input_item_t * p_item = user_data;
 190     lua_State *L = init( p_this, p_item, psz_filename );
 191     if( !L )
 192         return VLC_EGENERIC;
 193
 194     int i_ret = run(p_this, psz_filename, L, "read_meta");
 195     lua_close( L );
 196
 197     // Continue even if an error occured: all "meta reader" are always run.
 198     return i_ret == VLC_SUCCESS ? VLC_EGENERIC : i_ret;
 199 }
 200
 201
 202 /*****************************************************************************
 203  * Called through lua_scripts_batch_execute to call 'fetch_meta' on the script
 204  * pointed by psz_filename.
 205  *****************************************************************************/
 206 static int fetch_meta( vlc_object_t *p_this, const char * psz_filename,
 207                        void * user_data )
 208 {
 209     input_item_t * p_item = user_data;
 210     lua_State *L = init( p_this, p_item, psz_filename );
 211     if( !L )
 212         return VLC_EGENERIC;
 213
 214     int ret = run(p_this, psz_filename, L, "fetch_meta");
 215     lua_close( L );
 216
 217     return ret;
 218 }
 219
 220 /*****************************************************************************
 221  * Read meta.
 222  *****************************************************************************/
 223
 224 int ReadMeta( vlc_object_t *p_this )
 225 {
 226     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 227     input_item_t *p_item = p_demux_meta->p_item;
 228
 229     return vlclua_scripts_batch_execute( p_this, "meta"DIR_SEP"reader",
 230                                          &read_meta, p_item );
 231 }
 232
 233
 234 /*****************************************************************************
 235  * Read meta.
 236  *****************************************************************************/
 237
 238 int FetchMeta( vlc_object_t *p_this )
 239 {
 240     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 241     input_item_t *p_item = p_demux_meta->p_item;
 242
 243     return vlclua_scripts_batch_execute( p_this, "meta"DIR_SEP"fetcher",
 244                                          &fetch_meta, p_item );
 245 }
 246
 247
 248 /*****************************************************************************
 249  * Module entry point for art.
 250  *****************************************************************************/
 251 int FindArt( vlc_object_t *p_this )
 252 {
 253     art_finder_t *p_finder = (art_finder_t *)p_this;
 254     input_item_t *p_item = p_finder->p_item;
 255
 256     return vlclua_scripts_batch_execute( p_this, "meta"DIR_SEP"art",
 257                                          &fetch_art, p_item );
 258 }
 259