c6fb311775d9f92d78a58d12cd4819b751a8a0cc
[vlc.git] / modules / meta_engine / luameta.c
1 /*****************************************************************************
2  * luameta.c: Get meta/artwork using lua scripts
3  *****************************************************************************
4  * Copyright (C) 2006 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 #include <stdlib.h>                                      /* malloc(), free() */
32 #include <stdio.h>                                       /*asprintf()*/
33
34 #include <vlc/vlc.h>
35 #include <vlc_input.h>
36 #include <vlc_playlist.h>
37 #include <vlc_meta.h>
38 #include <vlc_url.h>
39 #include <vlc_strings.h>
40 #include <vlc_stream.h>
41 #include <vlc_charset.h>
42
43 #ifdef HAVE_SYS_STAT_H
44 #   include <sys/stat.h>
45 #endif
46
47 #include <lua.h>        /* Low level lua C API */
48 #include <lauxlib.h>    /* Higher level C API */
49 #include <lualib.h>     /* Lua libs */
50
51 /*****************************************************************************
52  * Local prototypes
53  *****************************************************************************/
54 static int FindArt( vlc_object_t * );
55 static int FindMeta( vlc_object_t *p_this );
56
57 /*****************************************************************************
58  * Module descriptor
59  *****************************************************************************/
60
61 vlc_module_begin();
62     set_shortname( N_( "Lua Meta" ) );
63     set_description( _("Fetch Artwork using lua scripts") );
64     set_capability( "meta fetcher", 10 );
65     set_callbacks( FindMeta, NULL );
66     add_submodule();
67         set_capability( "art finder", 10 );
68         set_callbacks( FindArt, NULL );
69 vlc_module_end();
70
71 /*****************************************************************************
72  * Lua function bridge
73  *****************************************************************************/
74 static vlc_object_t * vlclua_get_this( lua_State *p_state )
75 {
76     vlc_object_t * p_this;
77     lua_getglobal( p_state, "vlc" );
78     lua_getfield( p_state, lua_gettop( p_state ), "private" );
79     p_this = (vlc_object_t*)lua_topointer( p_state, lua_gettop( p_state ) );
80     lua_pop( p_state, 2 );
81     return p_this;
82 }
83
84 static int vlclua_stream_new( lua_State *p_state )
85 {
86     vlc_object_t * p_this = vlclua_get_this( p_state );
87     int i = lua_gettop( p_state );
88     stream_t * p_stream;
89     const char * psz_url;
90     if( !i ) return 0;
91     psz_url = lua_tostring( p_state, 1 );
92     lua_pop( p_state, i );
93     p_stream = stream_UrlNew( p_this, psz_url );
94     lua_pushlightuserdata( p_state, p_stream );
95     return 1;
96 }
97
98 static int vlclua_stream_read( lua_State *p_state )
99 {
100     int i = lua_gettop( p_state );
101     stream_t * p_stream;
102     int n;
103     byte_t *p_read;
104     int i_read;
105     if( !i ) return 0;
106     p_stream = (stream_t *)lua_topointer( p_state, 1 );
107     n = lua_tonumber( p_state, 2 );
108     lua_pop( p_state, i );
109     p_read = malloc( n );
110     if( !p_read ) return 0;
111     i_read = stream_Read( p_stream, p_read, n );
112     lua_pushlstring( p_state, (const char *)p_read, i_read );
113     free( p_read );
114     return 1;
115 }
116
117 static int vlclua_stream_readline( lua_State *p_state )
118 {
119     int i = lua_gettop( p_state );
120     stream_t * p_stream;
121     if( !i ) return 0;
122     p_stream = (stream_t *)lua_topointer( p_state, 1 );
123     lua_pop( p_state, i );
124     char *psz_line = stream_ReadLine( p_stream );
125     if( psz_line )
126     {
127         lua_pushstring( p_state, psz_line );
128         free( psz_line );
129     }
130     else
131     {
132         lua_pushnil( p_state );
133     }
134     return 1;
135 }
136
137 static int vlclua_stream_delete( lua_State *p_state )
138 {
139     int i = lua_gettop( p_state );
140     stream_t * p_stream;
141     if( !i ) return 0;
142     p_stream = (stream_t *)lua_topointer( p_state, 1 );
143     lua_pop( p_state, i );
144     stream_Delete( p_stream );
145     return 1;
146 }
147
148 static int vlclua_decode_uri( lua_State *p_state )
149 {
150     int i = lua_gettop( p_state );
151     if( !i ) return 0;
152     const char *psz_cstring = lua_tostring( p_state, 1 );
153     if( !psz_cstring ) return 0;
154     char *psz_string = strdup( psz_cstring );
155     lua_pop( p_state, i );
156     decode_URI( psz_string );
157     lua_pushstring( p_state, psz_string );
158     free( psz_string );
159     return 1;
160 }
161
162 static int vlclua_resolve_xml_special_chars( lua_State *p_state )
163 {
164     int i = lua_gettop( p_state );
165     if( !i ) return 0;
166     const char *psz_cstring = lua_tostring( p_state, 1 );
167     if( !psz_cstring ) return 0;
168     char *psz_string = strdup( psz_cstring );
169     lua_pop( p_state, i );
170     resolve_xml_special_chars( psz_string );
171     lua_pushstring( p_state, psz_string );
172     free( psz_string );
173     return 1;
174 }
175
176 static int vlclua_msg_dbg( lua_State *p_state )
177 {
178     vlc_object_t *p_this = vlclua_get_this( p_state );
179     int i = lua_gettop( p_state );
180     if( !i ) return 0;
181     const char *psz_cstring = lua_tostring( p_state, 1 );
182     if( !psz_cstring ) return 0;
183     msg_Dbg( p_this, "%s", psz_cstring );
184     return 0;
185 }
186 static int vlclua_msg_warn( lua_State *p_state )
187 {
188     vlc_object_t *p_this = vlclua_get_this( p_state );
189     int i = lua_gettop( p_state );
190     if( !i ) return 0;
191     const char *psz_cstring = lua_tostring( p_state, 1 );
192     if( !psz_cstring ) return 0;
193     msg_Warn( p_this, "%s", psz_cstring );
194     return 0;
195 }
196 static int vlclua_msg_err( lua_State *p_state )
197 {
198     vlc_object_t *p_this = vlclua_get_this( p_state );
199     int i = lua_gettop( p_state );
200     if( !i ) return 0;
201     const char *psz_cstring = lua_tostring( p_state, 1 );
202     if( !psz_cstring ) return 0;
203     msg_Err( p_this, "%s", psz_cstring );
204     return 0;
205 }
206 static int vlclua_msg_info( lua_State *p_state )
207 {
208     vlc_object_t *p_this = vlclua_get_this( p_state );
209     int i = lua_gettop( p_state );
210     if( !i ) return 0;
211     const char *psz_cstring = lua_tostring( p_state, 1 );
212     if( !psz_cstring ) return 0;
213     msg_Info( p_this, "%s", psz_cstring );
214     return 0;
215 }
216
217 /* Functions to register */
218 static luaL_Reg p_reg[] =
219 {
220     { "stream_new", vlclua_stream_new },
221     { "stream_read", vlclua_stream_read },
222     { "stream_readline", vlclua_stream_readline },
223     { "stream_delete", vlclua_stream_delete },
224     { "decode_uri", vlclua_decode_uri },
225     { "resolve_xml_special_chars", vlclua_resolve_xml_special_chars },
226     { "msg_dbg", vlclua_msg_dbg },
227     { "msg_warn", vlclua_msg_warn },
228     { "msg_err", vlclua_msg_err },
229     { "msg_info", vlclua_msg_info },
230     { NULL, NULL }
231 };
232 /*****************************************************************************
233  *
234  *****************************************************************************/
235 static int file_select( const char *file )
236 {
237     int i = strlen( file );
238     return i > 4 && !strcmp( file+i-4, ".lua" );
239 }
240
241 static int file_compare( const char **a, const char **b )
242 {
243     return strcmp( *a, *b );
244 }
245
246 /*****************************************************************************
247  * Init lua
248  *****************************************************************************/
249 static lua_State * vlclua_meta_init( vlc_object_t *p_this, input_item_t * p_item )
250 {
251     lua_State * p_state = luaL_newstate();
252     if( !p_state )
253     {
254         msg_Err( p_this, "Could not create new Lua State" );
255         return NULL;
256     }
257     char *psz_meta;
258
259     /* Load Lua libraries */
260     luaL_openlibs( p_state ); /* XXX: Don't open all the libs? */
261     
262     luaL_register( p_state, "vlc", p_reg );
263     
264     lua_pushlightuserdata( p_state, p_this );
265     lua_setfield( p_state, lua_gettop( p_state ) - 1, "private" );
266    
267     psz_meta = input_item_GetName( p_item );
268     lua_pushstring( p_state, psz_meta );
269     lua_setfield( p_state, lua_gettop( p_state ) - 1, "name" );
270     free( psz_meta );
271    
272     psz_meta = input_item_GetTitle( p_item ) ;
273     lua_pushstring( p_state, psz_meta );
274     lua_setfield( p_state, lua_gettop( p_state ) - 1, "title" );
275     free( psz_meta );
276    
277     psz_meta = input_item_GetAlbum( p_item );
278     lua_pushstring( p_state, psz_meta );
279     lua_setfield( p_state, lua_gettop( p_state ) - 1, "album" );
280     free( psz_meta );
281
282     psz_meta = input_item_GetArtURL( p_item );
283     lua_pushstring( p_state, psz_meta );
284     lua_setfield( p_state, lua_gettop( p_state ) - 1, "arturl" );
285     free( psz_meta );
286     /* XXX: all should be passed ( could use macro ) */
287
288     return p_state;
289 }
290
291 /*****************************************************************************
292  * Will execute func on all scripts in luadirname, and stop if func returns
293  * success.
294  *****************************************************************************/
295 static int vlclua_scripts_batch_execute( vlc_object_t *p_this,
296                                          const char * luadirname,
297                                          int (*func)(vlc_object_t *, const char *, lua_State *, void *),
298                                          lua_State * p_state,
299                                          void * user_data)
300 {
301     int i_ret = VLC_EGENERIC;
302
303     DIR   *dir           = NULL;
304     char **ppsz_filelist = NULL;
305     char **ppsz_fileend  = NULL;
306     char **ppsz_file;
307
308     char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
309     char **ppsz_dir;
310
311     if( asprintf( &ppsz_dir_list[0], "%s" DIR_SEP CONFIG_DIR DIR_SEP "%s", p_this->p_libvlc->psz_homedir,
312             luadirname ) < 0 )
313         return VLC_ENOMEM;
314
315 #   if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
316     {
317         const char *psz_vlcpath = config_GetDataDir();
318         if( asprintf( &ppsz_dir_list[1], "%s" DIR_SEP "%s", psz_vlcpath, luadirname )  < 0 )
319             return VLC_ENOMEM;
320
321         if( asprintf( &ppsz_dir_list[2], "%s" DIR_SEP "share" DIR_SEP "%s", psz_vlcpath, luadirname )  < 0 )
322             return VLC_ENOMEM;
323     }
324 #   else
325     {
326 #   ifdef HAVE_SYS_STAT_H
327         struct stat stat_info;
328         if( ( utf8_stat( "share/luaplaylist", &stat_info ) == -1 )
329             || !S_ISDIR( stat_info.st_mode ) )
330         {
331             if( asprintf( &ppsz_dir_list[1], 
332                           DATA_PATH DIR_SEP "%s", luadirname ) < 0 )
333                 return VLC_ENOMEM;
334         }
335         else
336 #   endif
337         {
338             if( asprintf( &ppsz_dir_list[1], 
339                           "share" DIR_SEP "%s", luadirname ) < 0 )
340                 return VLC_ENOMEM;
341         }
342     }
343 #   endif
344
345     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
346     {
347         int i_files;
348
349         if( ppsz_filelist )
350         {
351             for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
352                  ppsz_file++ )
353                 free( *ppsz_file );
354             free( ppsz_filelist );
355             ppsz_filelist = NULL;
356         }
357
358         if( dir )
359         {
360             closedir( dir );
361         }
362
363         msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
364         dir = utf8_opendir( *ppsz_dir );
365
366         if( !dir ) continue;
367         i_files = utf8_loaddir( dir, &ppsz_filelist, file_select, file_compare );
368         if( i_files < 1 ) continue;
369         ppsz_fileend = ppsz_filelist + i_files;
370
371         for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
372         {
373             char  *psz_filename;
374             asprintf( &psz_filename, "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file );
375             msg_Dbg( p_this, "Trying Lua playlist script %s", psz_filename );
376             
377             i_ret = func( p_this, psz_filename, p_state, user_data );
378             
379             free( psz_filename );
380
381             if( i_ret == VLC_SUCCESS ) break;
382         }
383         if( i_ret == VLC_SUCCESS ) break;
384     }
385
386     if( ppsz_filelist )
387     {
388         for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
389              ppsz_file++ )
390             free( *ppsz_file );
391         free( ppsz_filelist );
392     }
393     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
394         free( *ppsz_dir );
395
396     if( dir ) closedir( dir );
397
398     return i_ret;
399 }
400
401 /*****************************************************************************
402  * Meta data setters utility.
403  *****************************************************************************/
404 static inline void read_meta_data( vlc_object_t *p_this,
405                                    lua_State *p_state, int o, int t,
406                                    input_item_t *p_input )
407 {
408     const char *psz_value;
409 #define TRY_META( a, b )                                    \
410     lua_getfield( p_state, o, a );                          \
411     if( lua_isstring( p_state, t ) )                        \
412     {                                                       \
413         psz_value = lua_tostring( p_state, t );             \
414         msg_Dbg( p_this, #b ": %s", psz_value );           \
415         input_item_Set ## b ( p_input, psz_value );   \
416     }                                                       \
417     lua_pop( p_state, 1 ); /* pop a */
418     TRY_META( "title", Title );
419     TRY_META( "artist", Artist );
420     TRY_META( "genre", Genre );
421     TRY_META( "copyright", Copyright );
422     TRY_META( "album", Album );
423     TRY_META( "tracknum", TrackNum );
424     TRY_META( "description", Description );
425     TRY_META( "rating", Rating );
426     TRY_META( "date", Date );
427     TRY_META( "setting", Setting );
428     TRY_META( "url", URL );
429     TRY_META( "language", Language );
430     TRY_META( "nowplaying", NowPlaying );
431     TRY_META( "publisher", Publisher );
432     TRY_META( "encodedby", EncodedBy );
433     TRY_META( "arturl", ArtURL );
434     TRY_META( "trackid", TrackID );
435 }
436
437 static inline void read_custom_meta_data( vlc_object_t *p_this,
438                                           lua_State *p_state, int o, int t,
439                                           input_item_t *p_input )
440 {
441     lua_getfield( p_state, o, "meta" );
442     if( lua_istable( p_state, t ) )
443     {
444         lua_pushnil( p_state );
445         while( lua_next( p_state, t ) )
446         {
447             if( !lua_isstring( p_state, t+1 ) )
448             {
449                 msg_Warn( p_this, "Custom meta data category name must be "
450                                    "a string" );
451             }
452             else if( !lua_istable( p_state, t+2 ) )
453             {
454                 msg_Warn( p_this, "Custom meta data category contents "
455                                    "must be a table" );
456             }
457             else
458             {
459                 const char *psz_meta_category = lua_tostring( p_state, t+1 );
460                 msg_Dbg( p_this, "Found custom meta data category: %s",
461                          psz_meta_category );
462                 lua_pushnil( p_state );
463                 while( lua_next( p_state, t+2 ) )
464                 {
465                     if( !lua_isstring( p_state, t+3 ) )
466                     {
467                         msg_Warn( p_this, "Custom meta category item name "
468                                            "must be a string." );
469                     }
470                     else if( !lua_isstring( p_state, t+4 ) )
471                     {
472                         msg_Warn( p_this, "Custom meta category item value "
473                                            "must be a string." );
474                     }
475                     else
476                     {
477                         const char *psz_meta_name =
478                             lua_tostring( p_state, t+3 );
479                         const char *psz_meta_value =
480                             lua_tostring( p_state, t+4 );
481                         msg_Dbg( p_this, "Custom meta %s, %s: %s",
482                                  psz_meta_category, psz_meta_name,
483                                  psz_meta_value );
484                         input_ItemAddInfo( p_input, psz_meta_category,
485                                            psz_meta_name, psz_meta_value );
486                     }
487                     lua_pop( p_state, 1 ); /* pop item */
488                 }
489             }
490             lua_pop( p_state, 1 ); /* pop category */
491         }
492     }
493     lua_pop( p_state, 1 ); /* pop "meta" */
494 }
495
496 /*****************************************************************************
497  * Called through lua_scripts_batch_execute to call 'fetch_art' on the script
498  * pointed by psz_filename.
499  *****************************************************************************/
500 static int fetch_art( vlc_object_t *p_this, const char * psz_filename,
501                       lua_State * p_state, void * user_data )
502 {
503     int i_ret = VLC_EGENERIC;
504     input_item_t * p_input = user_data;
505     int s;
506
507     /* Ugly hack to delete previous versions of the fetchart()
508     * functions. */
509     lua_pushnil( p_state );
510     lua_setglobal( p_state, "fetch_art" );
511     
512     /* Load and run the script(s) */
513     if( luaL_dofile( p_state, psz_filename ) )
514     {
515         msg_Warn( p_this, "Error loading script %s: %s", psz_filename,
516                   lua_tostring( p_state, lua_gettop( p_state ) ) );
517         lua_pop( p_state, 1 );
518         return VLC_EGENERIC;
519     }
520
521     lua_getglobal( p_state, "fetch_art" );
522
523     if( !lua_isfunction( p_state, lua_gettop( p_state ) ) )
524     {
525         msg_Warn( p_this, "Error while runing script %s, "
526                   "function fetch_art() not found", psz_filename );
527         lua_pop( p_state, 1 );
528         return VLC_EGENERIC;
529     }
530
531     if( lua_pcall( p_state, 0, 1, 0 ) )
532     {
533         msg_Warn( p_this, "Error while runing script %s, "
534                   "function fetch_art(): %s", psz_filename,
535                   lua_tostring( p_state, lua_gettop( p_state ) ) );
536         lua_pop( p_state, 1 );
537         return VLC_EGENERIC;
538     }
539
540     if((s = lua_gettop( p_state )))
541     {
542         const char * psz_value;
543
544         if( lua_isstring( p_state, s ) )
545         {
546             psz_value = lua_tostring( p_state, s );
547             if( psz_value && *psz_value != 0 )
548             {
549                 msg_Dbg( p_this, "setting arturl: %s", psz_value );
550                 input_item_SetArtURL ( p_input, psz_value );
551                 i_ret = VLC_SUCCESS;
552             }
553         }
554         else
555         {
556             msg_Err( p_this, "Lua playlist script %s: "
557                  "didn't return a string", psz_filename );
558         }
559     }
560     else
561     {
562         msg_Err( p_this, "Script went completely foobar" );
563     }
564
565     return i_ret;
566 }
567
568 /*****************************************************************************
569  * Called through lua_scripts_batch_execute to call 'fetch_meta' on the script
570  * pointed by psz_filename.
571  *****************************************************************************/
572 static int fetch_meta( vlc_object_t *p_this, const char * psz_filename,
573                        lua_State * p_state, void * user_data )
574 {
575     input_item_t * p_input = user_data;
576     int t;
577
578     /* Ugly hack to delete previous versions of the fetchmeta()
579     * functions. */
580     lua_pushnil( p_state );
581     lua_setglobal( p_state, "fetch_meta" );
582     
583     /* Load and run the script(s) */
584     if( luaL_dofile( p_state, psz_filename ) )
585     {
586         msg_Warn( p_this, "Error loading script %s: %s", psz_filename,
587                   lua_tostring( p_state, lua_gettop( p_state ) ) );
588         lua_pop( p_state, 1 );
589         return VLC_EGENERIC;
590     }
591     
592     lua_getglobal( p_state, "fetch_meta" );
593     
594     if( !lua_isfunction( p_state, lua_gettop( p_state ) ) )
595     {
596         msg_Warn( p_this, "Error while runing script %s, "
597                   "function fetch_meta() not found", psz_filename );
598         lua_pop( p_state, 1 );
599         return VLC_EGENERIC;
600     }
601     
602     if( lua_pcall( p_state, 0, 1, 0 ) )
603     {
604         msg_Warn( p_this, "Error while runing script %s, "
605                   "function fetch_meta(): %s", psz_filename,
606                   lua_tostring( p_state, lua_gettop( p_state ) ) );
607         lua_pop( p_state, 1 );
608         return VLC_EGENERIC;
609     }
610     
611
612     if((t = lua_gettop( p_state )))
613     {
614         if( lua_istable( p_state, t ) )
615         {
616             read_meta_data( p_this, p_state, t, t+1, p_input );
617             read_custom_meta_data( p_this, p_state, t, t+1, p_input );
618         }
619         else
620         {
621             msg_Err( p_this, "Lua playlist script %s: "
622                  "didn't return a table", psz_filename );
623         }
624     }
625     else
626     {
627         msg_Err( p_this, "Script went completely foobar" );
628     }
629
630     /* We tell the batch thing to continue, hence all script
631      * will get the change to add its meta. This behaviour could
632      * be changed. */
633     return VLC_EGENERIC;
634 }
635
636 /*****************************************************************************
637  * Module entry point for meta.
638  *****************************************************************************/
639 static int FindMeta( vlc_object_t *p_this )
640 {
641     meta_engine_t *p_me = (meta_engine_t *)p_this;
642     input_item_t *p_item = p_me->p_item;
643     lua_State *p_state = vlclua_meta_init( p_this, p_item );
644     
645     int i_ret = vlclua_scripts_batch_execute( p_this, "luameta", &fetch_meta, p_state, p_item );
646     lua_close( p_state );
647     return i_ret;
648 }
649
650 /*****************************************************************************
651  * Module entry point for art.
652  *****************************************************************************/
653 static int FindArt( vlc_object_t *p_this )
654 {
655     playlist_t *p_playlist = (playlist_t *)p_this;
656     input_item_t *p_item = (input_item_t *)(p_playlist->p_private);
657     lua_State *p_state = vlclua_meta_init( p_this, p_item );
658     
659     int i_ret = vlclua_scripts_batch_execute( p_this, "luameta", &fetch_art, p_state, p_item );
660     lua_close( p_state );
661     return i_ret;
662 }
663