* Remove Advanced/Misc
[vlc.git] / modules / control / telnet.c
1 /*****************************************************************************
2  * telnet.c: VLM interface plugin
3  *****************************************************************************
4  * Copyright (C) 2000-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Simon Latapie <garf@videolan.org>
8  *          Laurent Aimar <fenrir@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 #include <stdlib.h>                                      /* malloc(), free() */
29
30 #include <vlc/vlc.h>
31 #include <vlc/intf.h>
32
33 #include <vlc/input.h>
34
35 #include <sys/stat.h>
36
37 #include <errno.h>
38 #include <fcntl.h>
39
40 #ifdef HAVE_SYS_TIME_H
41 #    include <sys/time.h>
42 #endif
43
44 #ifdef HAVE_UNISTD_H
45 #   include <unistd.h>
46 #endif
47
48 #include "network.h"
49 #include "vlc_url.h"
50
51 #include "vlc_vlm.h"
52
53 #define READ_MODE_PWD 1
54 #define READ_MODE_CMD 2
55 #define WRITE_MODE_PWD 3 // when we write the word "Password:"
56 #define WRITE_MODE_CMD 4
57
58 /* telnet commands */
59 #define TEL_WILL    251
60 #define TEL_WONT    252
61 #define TEL_DO      253
62 #define TEL_DONT    254
63 #define TEL_IAC     255
64 #define TEL_ECHO    1
65
66 /*****************************************************************************
67  * Module descriptor
68  *****************************************************************************/
69 static int  Open ( vlc_object_t * );
70 static void Close( vlc_object_t * );
71
72 #define TELNETHOST_TEXT N_( "Telnet interface listen host" )
73 #define TELNETHOST_LONGTEXT N_( "This is the host on which the telnet " \
74     "interface will listen. It defaults to all network interfaces (0.0.0.0)." \
75     " I you want the telnet interface to be available only on the local " \
76     "machine, enter 127.0.0.1" )
77 #define TELNETPORT_TEXT N_( "Telnet interface port" )
78 #define TELNETPORT_LONGTEXT N_( "This is the TCP port on which the telnet " \
79     "interface will listen. It defaults to 4212" )
80 #define TELNETPORT_DEFAULT 4212
81 #define TELNETPWD_TEXT N_( "Telnet interface password" )
82 #define TELNETPWD_LONGTEXT N_( "The telnet interface uses a single " \
83     "administration password. The default value is \"admin\"." )
84 #define TELNETPWD_DEFAULT "admin"
85
86 vlc_module_begin();
87     set_shortname( "Telnet" );
88     set_category( CAT_INTERFACE );
89     set_subcategory( SUBCAT_INTERFACE_CONTROL );
90     add_string( "telnet-host", "", NULL, TELNETHOST_TEXT,
91                  TELNETHOST_LONGTEXT, VLC_TRUE );
92     add_integer( "telnet-port", TELNETPORT_DEFAULT, NULL, TELNETPORT_TEXT,
93                  TELNETPORT_LONGTEXT, VLC_TRUE );
94     add_string( "telnet-password", TELNETPWD_DEFAULT, NULL, TELNETPWD_TEXT,
95                 TELNETPWD_LONGTEXT, VLC_TRUE );
96     set_description( _("VLM remote control interface") );
97     add_category_hint( "VLM", NULL, VLC_FALSE );
98     set_capability( "interface", 0 );
99     set_callbacks( Open , Close );
100 vlc_module_end();
101
102 /*****************************************************************************
103  * Local prototypes.
104  *****************************************************************************/
105 static void Run( intf_thread_t * );
106
107 typedef struct
108 {
109     int        i_mode; /* read or write */
110     int        fd;
111     char       buffer_read[1000]; // 1000 byte per command should be sufficient
112     char      *buffer_write;
113     char      *p_buffer_read;
114     char      *p_buffer_write; // the position in the buffer
115     int        i_buffer_write; // the number of byte we still have to send
116     int        i_tel_cmd; // for specific telnet commands
117
118 } telnet_client_t;
119
120 static char *MessageToString( vlm_message_t *, int );
121 static void Write_message( telnet_client_t *, vlm_message_t *, char *, int );
122
123 struct intf_sys_t
124 {
125    telnet_client_t **clients;
126    int             i_clients;
127    int             *pi_fd;
128    vlm_t           *mediatheque;
129 };
130
131 /* 
132  * getPort: Decide which port to use. There are two possibilities to
133  * specify a port: integrated in the --telnet-host option with :PORT
134  * or using the --telnet-port option. The --telnet-port option has
135  * precedence. 
136  * This code relies upon the fact the url.i_port is 0 if the :PORT 
137  * option is missing from --telnet-host.
138  */
139 static int getPort(intf_thread_t *p_intf, vlc_url_t url, int i_port)
140     {
141     // Print error if two different ports have been specified
142     if (url.i_port != 0  &&
143         i_port != TELNETPORT_DEFAULT && 
144         url.i_port != i_port )
145     {
146             msg_Err( p_intf, "ignoring port %d and using %d", url.i_port,
147                  i_port);
148     }
149     if (i_port != TELNETPORT_DEFAULT)
150     {
151             return i_port;
152     }
153     if (url.i_port != 0)
154     {
155             return url.i_port;
156     }
157     // return default
158     return i_port;
159 }
160
161 /*****************************************************************************
162  * Open: initialize dummy interface
163  *****************************************************************************/
164 static int Open( vlc_object_t *p_this )
165 {
166     intf_thread_t *p_intf = (intf_thread_t*) p_this;
167     vlm_t *mediatheque;
168     char *psz_address;
169     vlc_url_t url;
170     int i_telnetport;
171
172     if( !(mediatheque = vlm_New( p_intf )) )
173     {
174         msg_Err( p_intf, "cannot start VLM" );
175         return VLC_EGENERIC;
176     }
177
178     msg_Info( p_intf, "Using the VLM interface plugin..." );
179
180     i_telnetport = config_GetInt( p_intf, "telnet-port" );
181     psz_address  = config_GetPsz( p_intf, "telnet-host" );
182
183     vlc_UrlParse(&url, psz_address, 0);
184
185     // There might be two ports given, resolve any potentially
186     // conflict
187     url.i_port = getPort(p_intf, url, i_telnetport);
188
189     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
190     if( ( p_intf->p_sys->pi_fd = net_ListenTCP( p_intf, url.psz_host, url.i_port ) )
191                 == NULL )
192     {
193         msg_Err( p_intf, "cannot listen for telnet" );
194         vlc_UrlClean(&url);
195         free( psz_address );
196         free( p_intf->p_sys );
197         return VLC_EGENERIC;
198     }
199     msg_Info( p_intf, 
200               "Telnet interface started on interface %s %d",
201               url.psz_host, url.i_port );
202
203     p_intf->p_sys->i_clients   = 0;
204     p_intf->p_sys->clients     = NULL;
205     p_intf->p_sys->mediatheque = mediatheque;
206     p_intf->pf_run = Run;
207
208     vlc_UrlClean(&url);
209     free( psz_address );
210     return VLC_SUCCESS;
211 }
212
213 /*****************************************************************************
214  * Close:
215  *****************************************************************************/
216 static void Close( vlc_object_t *p_this )
217 {
218     intf_thread_t *p_intf = (intf_thread_t*)p_this;
219     intf_sys_t    *p_sys  = p_intf->p_sys;
220     int i;
221
222     for( i = 0; i < p_sys->i_clients; i++ )
223     {
224         telnet_client_t *cl = p_sys->clients[i];
225
226         net_Close( cl->fd );
227         free( cl );
228     }
229     if( p_sys->clients != NULL ) free( p_sys->clients );
230
231     net_ListenClose( p_sys->pi_fd );
232
233     vlm_Delete( p_sys->mediatheque );
234
235     free( p_sys );
236 }
237
238 /*****************************************************************************
239  * Run: main loop
240  *****************************************************************************/
241 static void Run( intf_thread_t *p_intf )
242 {
243     intf_sys_t     *p_sys = p_intf->p_sys;
244     struct timeval  timeout;
245     char           *psz_password;
246
247     psz_password = config_GetPsz( p_intf, "telnet-password" );
248
249     while( !p_intf->b_die )
250     {
251         fd_set fds_read, fds_write;
252         int    i_handle_max = 0;
253         int    i_ret, i_len, fd, i;
254
255         /* if a new client wants to communicate */
256         fd = net_Accept( p_intf, p_sys->pi_fd, p_sys->i_clients > 0 ? 0 : -1 );
257         if( fd > 0 )
258         {
259             telnet_client_t *cl;
260
261             /* to be non blocking */
262 #if defined( WIN32 ) || defined( UNDER_CE )
263             {
264                 unsigned long i_dummy = 1;
265                 ioctlsocket( fd, FIONBIO, &i_dummy );
266             }
267 #else
268             fcntl( fd, F_SETFL, O_NONBLOCK );
269 #endif
270             cl = malloc( sizeof( telnet_client_t ));
271             cl->i_tel_cmd = 0;
272             cl->fd = fd;
273             cl->buffer_write = NULL;
274             cl->p_buffer_write = cl->buffer_write;
275             Write_message( cl, NULL, "Password: \xff\xfb\x01", WRITE_MODE_PWD );
276
277             TAB_APPEND( p_sys->i_clients, p_sys->clients, cl );
278         }
279
280         /* to do a proper select */
281         FD_ZERO( &fds_read );
282         FD_ZERO( &fds_write );
283
284         for( i = 0 ; i < p_sys->i_clients ; i++ )
285         {
286             telnet_client_t *cl = p_sys->clients[i];
287
288             if( cl->i_mode == WRITE_MODE_PWD || cl->i_mode == WRITE_MODE_CMD )
289             {
290                 FD_SET( cl->fd , &fds_write );
291             }
292             else
293             {
294                 FD_SET( cl->fd , &fds_read );
295             }
296             i_handle_max = __MAX( i_handle_max, cl->fd );
297         }
298
299         timeout.tv_sec = 0;
300         timeout.tv_usec = 500*1000;
301
302         i_ret = select( i_handle_max + 1, &fds_read, &fds_write, 0, &timeout );
303         if( i_ret == -1 && errno != EINTR )
304         {
305             msg_Warn( p_intf, "cannot select sockets" );
306             msleep( 1000 );
307             continue;
308         }
309         else if( i_ret <= 0 )
310         {
311             continue;
312         }
313
314         /* check if there is something to do with the socket */
315         for( i = 0 ; i < p_sys->i_clients ; i++ )
316         {
317             telnet_client_t *cl = p_sys->clients[i];
318
319             if( FD_ISSET(cl->fd , &fds_write) && cl->i_buffer_write > 0 )
320             {
321                 i_len = send( cl->fd , cl->p_buffer_write ,
322                               cl->i_buffer_write , 0 );
323                 if( i_len > 0 )
324                 {
325                     cl->p_buffer_write += i_len;
326                     cl->i_buffer_write -= i_len;
327                 }
328             }
329             else if( FD_ISSET( cl->fd, &fds_read) )
330             {
331                 int i_end = 0;
332                 int i_recv;
333
334                 while( (i_recv=recv( cl->fd, cl->p_buffer_read, 1, 0 )) > 0 &&
335                        cl->p_buffer_read - cl->buffer_read < 999 )
336                 {
337                     switch( cl->i_tel_cmd )
338                     {
339                     case 0:
340                         switch( *(uint8_t *)cl->p_buffer_read )
341                         {
342                         case '\r':
343                             break;
344                         case '\n':
345                             *cl->p_buffer_read = '\n';
346                             i_end = 1;
347                             break;
348                         case TEL_IAC: // telnet specific command
349                             cl->i_tel_cmd = 1;
350                             cl->p_buffer_read++;
351                             break;
352                         default:
353                             cl->p_buffer_read++;
354                             break;
355                         }
356                         break;
357                     case 1:
358                         switch( *(uint8_t *)cl->p_buffer_read )
359                         {
360                         case TEL_WILL: case TEL_WONT:
361                         case TEL_DO: case TEL_DONT:
362                             cl->i_tel_cmd++;
363                             cl->p_buffer_read++;
364                             break;
365                         default:
366                             cl->i_tel_cmd = 0;
367                             cl->p_buffer_read--;
368                             break;
369                         }
370                         break;
371                     case 2:
372                         cl->i_tel_cmd = 0;
373                         cl->p_buffer_read -= 2;
374                         break;
375                     }
376
377                     if( i_end != 0 ) break;
378                 }
379
380                 if( cl->p_buffer_read - cl->buffer_read == 999 )
381                 {
382                     Write_message( cl, NULL, "Line too long\r\n",
383                                    cl->i_mode + 2 );
384                 }
385
386                 if (i_recv == 0)
387                 {
388                     net_Close( cl->fd );
389                     TAB_REMOVE( p_intf->p_sys->i_clients ,
390                                 p_intf->p_sys->clients , cl );
391                     free( cl );
392                 }
393             }
394         }
395
396         /* and now we should bidouille the data we received / send */
397         for( i = 0 ; i < p_sys->i_clients ; i++ )
398         {
399             telnet_client_t *cl = p_sys->clients[i];
400
401             if( cl->i_mode >= WRITE_MODE_PWD && cl->i_buffer_write == 0 )
402             {
403                // we have finished to send
404                cl->i_mode -= 2; // corresponding READ MODE
405             }
406             else if( cl->i_mode == READ_MODE_PWD &&
407                      *cl->p_buffer_read == '\n' )
408             {
409                 *cl->p_buffer_read = '\0';
410                 if( strcmp( psz_password, cl->buffer_read ) == 0 )
411                 {
412                     Write_message( cl, NULL, "\xff\xfc\x01\r\nWelcome, "
413                                    "Master\r\n> ", WRITE_MODE_CMD );
414                 }
415                 else
416                 {
417                     /* wrong password */
418                     Write_message( cl, NULL,
419                                    "\r\nWrong password.\r\nPassword: ",
420                                    WRITE_MODE_PWD );
421                 }
422             }
423             else if( cl->i_mode == READ_MODE_CMD &&
424                      *cl->p_buffer_read == '\n' )
425             {
426                 /* ok, here is a command line */
427                 if( !strncmp( cl->buffer_read, "logout", 6 ) ||
428                     !strncmp( cl->buffer_read, "quit", 4 )  ||
429                     !strncmp( cl->buffer_read, "exit", 4 ) )
430                 {
431                     net_Close( cl->fd );
432                     TAB_REMOVE( p_intf->p_sys->i_clients ,
433                                 p_intf->p_sys->clients , cl );
434                     free( cl );
435                 }
436                 else if( !strncmp( cl->buffer_read, "shutdown", 8 ) )
437                 {
438                     msg_Err( p_intf, "shutdown requested" );
439                     p_intf->p_vlc->b_die = VLC_TRUE;
440                 }
441                 else
442                 {
443                     vlm_message_t *message;
444
445                     /* create a standard string */
446                     *cl->p_buffer_read = '\0';
447
448                     vlm_ExecuteCommand( p_sys->mediatheque, cl->buffer_read,
449                                         &message );
450                     Write_message( cl, message, NULL, WRITE_MODE_CMD );
451                     vlm_MessageDelete( message );
452                 }
453             }
454         }
455     }
456 }
457
458 static void Write_message( telnet_client_t *client, vlm_message_t *message,
459                            char *string_message, int i_mode )
460 {
461     char *psz_message;
462
463     client->p_buffer_read = client->buffer_read;
464     (client->p_buffer_read)[0] = 0; // if (cl->p_buffer_read)[0] = '\n'
465     if( client->buffer_write ) free( client->buffer_write );
466
467     /* generate the psz_message string */
468     if( message )
469     {
470         /* ok, look for vlm_message_t */
471         psz_message = MessageToString( message, 0 );
472     }
473     else
474     {
475         /* it is a basic string_message */
476         psz_message = strdup( string_message );
477     }
478
479     client->buffer_write = client->p_buffer_write = psz_message;
480     client->i_buffer_write = strlen( psz_message );
481     client->i_mode = i_mode;
482 }
483
484 /* We need the level of the message to put a beautiful indentation.
485  * first level is 0 */
486 static char *MessageToString( vlm_message_t *message, int i_level )
487 {
488 #define STRING_CR "\r\n"
489 #define STRING_TAIL "> "
490
491     char *psz_message;
492     int i, i_message = sizeof( STRING_TAIL );
493
494     if( !message || !message->psz_name )
495     {
496         return strdup( STRING_CR STRING_TAIL );
497     }
498     else if( !i_level && !message->i_child && !message->psz_value  )
499     {
500         /* A command is successful. Don't write anything */
501         return strdup( /*STRING_CR*/ STRING_TAIL );
502     }
503
504     i_message += strlen( message->psz_name ) + i_level * sizeof( "    " ) + 1;
505     psz_message = malloc( i_message );
506     *psz_message = 0;
507     for( i = 0; i < i_level; i++ ) strcat( psz_message, "    " );
508     strcat( psz_message, message->psz_name );
509
510     if( message->psz_value )
511     {
512         i_message += sizeof( " : " ) + strlen( message->psz_value ) +
513             sizeof( STRING_CR );
514         psz_message = realloc( psz_message, i_message );
515         strcat( psz_message, " : " );
516         strcat( psz_message, message->psz_value );
517         strcat( psz_message, STRING_CR );
518     }
519     else
520     {
521         i_message += sizeof( STRING_CR );
522         psz_message = realloc( psz_message, i_message );
523         strcat( psz_message, STRING_CR );
524     }
525
526     for( i = 0; i < message->i_child; i++ )
527     {
528         char *child_message =
529             MessageToString( message->child[i], i_level + 1 );
530
531         i_message += strlen( child_message );
532         psz_message = realloc( psz_message, i_message );
533         strcat( psz_message, child_message );
534         free( child_message );
535     }
536
537     if( i_level == 0 ) strcat( psz_message, STRING_TAIL );
538
539     return psz_message;
540 }