url: remove vlc_UrlParse() option parameter
[vlc.git] / modules / lua / libs / net.c
1 /*****************************************************************************
2  * net.c: Network related 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 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <assert.h>
32 #include <errno.h>
33 #ifdef _WIN32
34 #include <io.h>
35 #endif
36 #ifdef HAVE_POLL
37 #include <poll.h>       /* poll structures and defines */
38 #endif
39 #include <sys/stat.h>
40
41 #include <vlc_common.h>
42 #include <vlc_network.h>
43 #include <vlc_url.h>
44 #include <vlc_fs.h>
45 #include <vlc_interrupt.h>
46
47 #include "../vlc.h"
48 #include "../libs.h"
49 #include "misc.h"
50
51 static vlclua_dtable_t *vlclua_get_dtable( lua_State *L )
52 {
53     return vlclua_get_object( L, vlclua_get_dtable );
54 }
55
56 vlc_interrupt_t *vlclua_set_interrupt( lua_State *L )
57 {
58     vlclua_dtable_t *dt = vlclua_get_dtable( L );
59     return vlc_interrupt_set( dt->interrupt );
60 }
61
62 /** Maps an OS file descriptor to a VLC Lua file descriptor */
63 static int vlclua_fd_map( lua_State *L, int fd )
64 {
65     vlclua_dtable_t *dt = vlclua_get_dtable( L );
66
67     if( (unsigned)fd < 3u )
68         return -1;
69
70 #ifndef NDEBUG
71     for( unsigned i = 0; i < dt->fdc; i++ )
72         assert( dt->fdv[i] != fd );
73 #endif
74
75     for( unsigned i = 0; i < dt->fdc; i++ )
76     {
77         if( dt->fdv[i] == -1 )
78         {
79             dt->fdv[i] = fd;
80             return 3 + i;
81         }
82     }
83
84     if( dt->fdc >= 64 )
85         return -1;
86
87     int *fdv = realloc( dt->fdv, (dt->fdc + 1) * sizeof (dt->fdv[0]) );
88     if( unlikely(fdv == NULL) )
89         return -1;
90
91     dt->fdv = fdv;
92     dt->fdv[dt->fdc] = fd;
93     fd = 3 + dt->fdc;
94     dt->fdc++;
95     return fd;
96 }
97
98 static int vlclua_fd_map_safe( lua_State *L, int fd )
99 {
100     int luafd = vlclua_fd_map( L, fd );
101     if( luafd == -1 )
102         net_Close( fd );
103     return luafd;
104 }
105
106 /** Gets the OS file descriptor mapped to a VLC Lua file descriptor */
107 static int vlclua_fd_get( lua_State *L, unsigned idx )
108 {
109     vlclua_dtable_t *dt = vlclua_get_dtable( L );
110
111     if( idx < 3u )
112         return idx;
113     idx -= 3;
114     return (idx < dt->fdc) ? dt->fdv[idx] : -1;
115 }
116
117 /** Gets the VLC Lua file descriptor mapped from an OS file descriptor */
118 static int vlclua_fd_get_lua( lua_State *L, int fd )
119 {
120     vlclua_dtable_t *dt = vlclua_get_dtable( L );
121
122     if( (unsigned)fd < 3u )
123         return fd;
124     for( unsigned i = 0; i < dt->fdc; i++ )
125         if( dt->fdv[i] == fd )
126             return 3 + i;
127     return -1;
128 }
129
130 /** Unmaps an OS file descriptor from VLC Lua */
131 static void vlclua_fd_unmap( lua_State *L, unsigned idx )
132 {
133     vlclua_dtable_t *dt = vlclua_get_dtable( L );
134     int fd = -1;
135
136     if( idx < 3u )
137         return; /* Never close stdin/stdout/stderr. */
138
139     idx -= 3;
140     if( idx >= dt->fdc )
141         return;
142
143     fd = dt->fdv[idx];
144     dt->fdv[idx] = -1;
145     while( dt->fdc > 0 && dt->fdv[dt->fdc - 1] == -1 )
146         dt->fdc--;
147     /* realloc() not really needed */
148 #ifndef NDEBUG
149     for( unsigned i = 0; i < dt->fdc; i++ )
150         assert( dt->fdv[i] != fd );
151 #endif
152 }
153
154 static void vlclua_fd_unmap_safe( lua_State *L, unsigned idx )
155 {
156     int fd = vlclua_fd_get( L, idx );
157
158     vlclua_fd_unmap( L, idx );
159     if( fd != -1 )
160         net_Close( fd );
161 }
162
163 /*****************************************************************************
164  *
165  *****************************************************************************/
166 static int vlclua_url_parse( lua_State *L )
167 {
168     const char *psz_url = luaL_checkstring( L, 1 );
169     vlc_url_t url;
170
171     vlc_UrlParse( &url, psz_url );
172
173     lua_newtable( L );
174     lua_pushstring( L, url.psz_protocol );
175     lua_setfield( L, -2, "protocol" );
176     lua_pushstring( L, url.psz_username );
177     lua_setfield( L, -2, "username" );
178     lua_pushstring( L, url.psz_password );
179     lua_setfield( L, -2, "password" );
180     lua_pushstring( L, url.psz_host );
181     lua_setfield( L, -2, "host" );
182     lua_pushinteger( L, url.i_port );
183     lua_setfield( L, -2, "port" );
184     lua_pushstring( L, url.psz_path );
185     lua_setfield( L, -2, "path" );
186     lua_pushstring( L, url.psz_option );
187     lua_setfield( L, -2, "option" );
188
189     vlc_UrlClean( &url );
190
191     return 1;
192 }
193
194 /*****************************************************************************
195  * Net listen
196  *****************************************************************************/
197 static int vlclua_net_listen_close( lua_State * );
198 static int vlclua_net_accept( lua_State * );
199 static int vlclua_net_fds( lua_State * );
200
201 static const luaL_Reg vlclua_net_listen_reg[] = {
202     { "accept", vlclua_net_accept },
203     { "fds", vlclua_net_fds },
204     { NULL, NULL }
205 };
206
207 static int vlclua_net_listen_tcp( lua_State *L )
208 {
209     vlc_object_t *p_this = vlclua_get_this( L );
210     const char *psz_host = luaL_checkstring( L, 1 );
211     int i_port = luaL_checkint( L, 2 );
212     int *pi_fd = net_ListenTCP( p_this, psz_host, i_port );
213     if( pi_fd == NULL )
214         return luaL_error( L, "Cannot listen on %s:%d", psz_host, i_port );
215
216     for( unsigned i = 0; pi_fd[i] != -1; i++ )
217         if( vlclua_fd_map( L, pi_fd[i] ) == -1 )
218         {
219             while( i > 0 )
220                 vlclua_fd_unmap( L, vlclua_fd_get_lua( L, pi_fd[--i] ) );
221
222             net_ListenClose( pi_fd );
223             return luaL_error( L, "Cannot listen on %s:%d", psz_host, i_port );
224         }
225
226     int **ppi_fd = lua_newuserdata( L, sizeof( int * ) );
227     *ppi_fd = pi_fd;
228
229     if( luaL_newmetatable( L, "net_listen" ) )
230     {
231         lua_newtable( L );
232         luaL_register( L, NULL, vlclua_net_listen_reg );
233         lua_setfield( L, -2, "__index" );
234         lua_pushcfunction( L, vlclua_net_listen_close );
235         lua_setfield( L, -2, "__gc" );
236     }
237
238     lua_setmetatable( L, -2 );
239     return 1;
240 }
241
242 static int vlclua_net_listen_close( lua_State *L )
243 {
244     int **ppi_fd = (int**)luaL_checkudata( L, 1, "net_listen" );
245     int *pi_fd = *ppi_fd;
246
247     for( unsigned i = 0; pi_fd[i] != -1; i++ )
248         vlclua_fd_unmap( L, vlclua_fd_get_lua( L, pi_fd[i] ) );
249
250     net_ListenClose( pi_fd );
251     return 0;
252 }
253
254 static int vlclua_net_fds( lua_State *L )
255 {
256     int **ppi_fd = (int**)luaL_checkudata( L, 1, "net_listen" );
257     int *pi_fd = *ppi_fd;
258
259     int i_count = 0;
260     while( pi_fd[i_count] != -1 )
261         lua_pushinteger( L, vlclua_fd_get_lua( L, pi_fd[i_count++] ) );
262
263     return i_count;
264 }
265
266 static int vlclua_net_accept( lua_State *L )
267 {
268     vlc_object_t *p_this = vlclua_get_this( L );
269     int **ppi_fd = (int**)luaL_checkudata( L, 1, "net_listen" );
270     int i_fd = net_Accept( p_this, *ppi_fd );
271
272     lua_pushinteger( L, vlclua_fd_map_safe( L, i_fd ) );
273     return 1;
274 }
275
276 /*****************************************************************************
277  *
278  *****************************************************************************/
279 static int vlclua_net_connect_tcp( lua_State *L )
280 {
281     vlc_object_t *p_this = vlclua_get_this( L );
282     const char *psz_host = luaL_checkstring( L, 1 );
283     int i_port = luaL_checkint( L, 2 );
284     int i_fd = net_Connect( p_this, psz_host, i_port, SOCK_STREAM, IPPROTO_TCP );
285     lua_pushinteger( L, vlclua_fd_map_safe( L, i_fd ) );
286     return 1;
287 }
288
289 static int vlclua_net_close( lua_State *L )
290 {
291     int i_fd = luaL_checkint( L, 1 );
292     vlclua_fd_unmap_safe( L, i_fd );
293     return 0;
294 }
295
296 static int vlclua_net_send( lua_State *L )
297 {
298     int fd = vlclua_fd_get( L, luaL_checkint( L, 1 ) );
299     size_t i_len;
300     const char *psz_buffer = luaL_checklstring( L, 2, &i_len );
301
302     i_len = luaL_optint( L, 3, i_len );
303     lua_pushinteger( L,
304         (fd != -1) ? send( fd, psz_buffer, i_len, MSG_NOSIGNAL ) : -1 );
305     return 1;
306 }
307
308 static int vlclua_net_recv( lua_State *L )
309 {
310     int fd = vlclua_fd_get( L, luaL_checkint( L, 1 ) );
311     size_t i_len = luaL_optint( L, 2, 1 );
312     char psz_buffer[i_len];
313
314     ssize_t i_ret = (fd != -1) ? recv( fd, psz_buffer, i_len, 0 ) : -1;
315     if( i_ret > 0 )
316         lua_pushlstring( L, psz_buffer, i_ret );
317     else
318         lua_pushnil( L );
319     return 1;
320 }
321
322 /*****************************************************************************
323  *
324  *****************************************************************************/
325 /* Takes a { fd : events } table as first arg and modifies it to { fd : revents } */
326 static int vlclua_net_poll( lua_State *L )
327 {
328     luaL_checktype( L, 1, LUA_TTABLE );
329
330     int i_fds = 0;
331     lua_pushnil( L );
332     while( lua_next( L, 1 ) )
333     {
334         i_fds++;
335         lua_pop( L, 1 );
336     }
337
338     struct pollfd *p_fds = xmalloc( i_fds * sizeof( *p_fds ) );
339     int *luafds = xmalloc( i_fds * sizeof( *luafds ) );
340
341     lua_pushnil( L );
342     for( int i = 0; lua_next( L, 1 ); i++ )
343     {
344         luafds[i] = luaL_checkinteger( L, -2 );
345         p_fds[i].fd = vlclua_fd_get( L, luafds[i] );
346         p_fds[i].events = luaL_checkinteger( L, -1 );
347         p_fds[i].events &= POLLIN | POLLOUT | POLLPRI;
348         lua_pop( L, 1 );
349     }
350
351     vlc_interrupt_t *oint = vlclua_set_interrupt( L );
352     int ret = 1, val = -1;
353
354     do
355     {
356         if( vlc_killed() )
357         {
358             ret = luaL_error( L, "Interrupted." );
359             break;
360         }
361         val = vlc_poll_i11e( p_fds, i_fds, -1 );
362     }
363     while( val == -1 && errno == EINTR );
364
365     vlc_interrupt_set( oint );
366
367     for( int i = 0; i < i_fds; i++ )
368     {
369         lua_pushinteger( L, luafds[i] );
370         lua_pushinteger( L, p_fds[i].revents );
371         lua_settable( L, 1 );
372     }
373     lua_pushinteger( L, val );
374
375     free( luafds );
376     free( p_fds );
377     return ret;
378 }
379
380 /*****************************************************************************
381  *
382  *****************************************************************************/
383 /*
384 static int vlclua_fd_open( lua_State *L )
385 {
386 }
387 */
388
389 #ifndef _WIN32
390 static int vlclua_fd_write( lua_State *L )
391 {
392     int fd = vlclua_fd_get( L, luaL_checkint( L, 1 ) );
393     size_t i_len;
394     const char *psz_buffer = luaL_checklstring( L, 2, &i_len );
395
396     i_len = luaL_optint( L, 3, i_len );
397     lua_pushinteger( L, (fd != -1) ? vlc_write( fd, psz_buffer, i_len ) : -1 );
398     return 1;
399 }
400
401 static int vlclua_fd_read( lua_State *L )
402 {
403     int fd = vlclua_fd_get( L, luaL_checkint( L, 1 ) );
404     size_t i_len = luaL_optint( L, 2, 1 );
405     char psz_buffer[i_len];
406
407     ssize_t i_ret = (fd != -1) ? read( fd, psz_buffer, i_len ) : -1;
408     if( i_ret > 0 )
409         lua_pushlstring( L, psz_buffer, i_ret );
410     else
411         lua_pushnil( L );
412     return 1;
413 }
414 #endif
415
416 /*****************************************************************************
417  *
418  *****************************************************************************/
419 static int vlclua_stat( lua_State *L )
420 {
421     const char *psz_path = luaL_checkstring( L, 1 );
422     struct stat s;
423     if( vlc_stat( psz_path, &s ) )
424         return 0;
425         //return luaL_error( L, "Couldn't stat %s.", psz_path );
426     lua_newtable( L );
427     if( S_ISREG( s.st_mode ) )
428         lua_pushliteral( L, "file" );
429     else if( S_ISDIR( s.st_mode ) )
430         lua_pushliteral( L, "dir" );
431 #ifdef S_ISCHR
432     else if( S_ISCHR( s.st_mode ) )
433         lua_pushliteral( L, "character device" );
434 #endif
435 #ifdef S_ISBLK
436     else if( S_ISBLK( s.st_mode ) )
437         lua_pushliteral( L, "block device" );
438 #endif
439 #ifdef S_ISFIFO
440     else if( S_ISFIFO( s.st_mode ) )
441         lua_pushliteral( L, "fifo" );
442 #endif
443 #ifdef S_ISLNK
444     else if( S_ISLNK( s.st_mode ) )
445         lua_pushliteral( L, "symbolic link" );
446 #endif
447 #ifdef S_ISSOCK
448     else if( S_ISSOCK( s.st_mode ) )
449         lua_pushliteral( L, "socket" );
450 #endif
451     else
452         lua_pushliteral( L, "unknown" );
453     lua_setfield( L, -2, "type" );
454     lua_pushinteger( L, s.st_mode );
455     lua_setfield( L, -2, "mode" );
456     lua_pushinteger( L, s.st_uid );
457     lua_setfield( L, -2, "uid" );
458     lua_pushinteger( L, s.st_gid );
459     lua_setfield( L, -2, "gid" );
460     lua_pushinteger( L, s.st_size );
461     lua_setfield( L, -2, "size" );
462     lua_pushinteger( L, s.st_atime );
463     lua_setfield( L, -2, "access_time" );
464     lua_pushinteger( L, s.st_mtime );
465     lua_setfield( L, -2, "modification_time" );
466     lua_pushinteger( L, s.st_ctime );
467     lua_setfield( L, -2, "creation_time" );
468     return 1;
469 }
470
471 static int vlclua_opendir( lua_State *L )
472 {
473     const char *psz_dir = luaL_checkstring( L, 1 );
474     DIR *p_dir;
475     int i = 0;
476
477     if( ( p_dir = vlc_opendir( psz_dir ) ) == NULL )
478         return luaL_error( L, "cannot open directory `%s'.", psz_dir );
479
480     lua_newtable( L );
481     for( ;; )
482     {
483         const char *psz_filename = vlc_readdir( p_dir );
484         if( !psz_filename ) break;
485         i++;
486         lua_pushstring( L, psz_filename );
487         lua_rawseti( L, -2, i );
488     }
489     closedir( p_dir );
490     return 1;
491 }
492
493 /*****************************************************************************
494  *
495  *****************************************************************************/
496 static const luaL_Reg vlclua_net_intf_reg[] = {
497     { "listen_tcp", vlclua_net_listen_tcp },
498     { "connect_tcp", vlclua_net_connect_tcp },
499     { "close", vlclua_net_close },
500     { "send", vlclua_net_send },
501     { "recv", vlclua_net_recv },
502     { "poll", vlclua_net_poll },
503 #ifndef _WIN32
504     { "read", vlclua_fd_read },
505     { "write", vlclua_fd_write },
506 #endif
507     /* The following functions do not depend on intf_thread_t and do not really
508      * belong in net.* but are left here for backward compatibility: */
509     { "url_parse", vlclua_url_parse },
510     { "stat", vlclua_stat }, /* Not really "net" */
511     { "opendir", vlclua_opendir }, /* Not really "net" */
512     { NULL, NULL }
513 };
514
515 static void luaopen_net_intf( lua_State *L )
516 {
517     lua_newtable( L );
518     luaL_register( L, NULL, vlclua_net_intf_reg );
519 #define ADD_CONSTANT( value )    \
520     lua_pushinteger( L, POLL##value ); \
521     lua_setfield( L, -2, "POLL"#value );
522     ADD_CONSTANT( IN )
523     ADD_CONSTANT( PRI )
524     ADD_CONSTANT( OUT )
525     ADD_CONSTANT( ERR )
526     ADD_CONSTANT( HUP )
527     ADD_CONSTANT( NVAL )
528     lua_setfield( L, -2, "net" );
529 }
530
531 int vlclua_fd_init( lua_State *L, vlclua_dtable_t *dt )
532 {
533     dt->interrupt = vlc_interrupt_create();
534     if( unlikely(dt->interrupt == NULL) )
535         return -1;
536     dt->fdv = NULL;
537     dt->fdc = 0;
538     vlclua_set_object( L, vlclua_get_dtable, dt );
539     luaopen_net_intf( L );
540     return 0;
541 }
542
543 void vlclua_fd_interrupt( vlclua_dtable_t *dt )
544 {
545     vlc_interrupt_kill( dt->interrupt );
546 }
547
548 /** Releases all (leaked) VLC Lua file descriptors. */
549 void vlclua_fd_cleanup( vlclua_dtable_t *dt )
550 {
551     for( unsigned i = 0; i < dt->fdc; i++ )
552         if( dt->fdv[i] != -1 )
553             net_Close( dt->fdv[i] );
554     free( dt->fdv );
555     vlc_interrupt_destroy(dt->interrupt);
556 }