1 /*****************************************************************************
2 * telnet.c: VLM interface plugin
3 *****************************************************************************
4 * Copyright (C) 2000-2006 the VideoLAN team
7 * Authors: Simon Latapie <garf@videolan.org>
8 * Laurent Aimar <fenrir@videolan.org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_interface.h>
36 #include <vlc_input.h>
44 #ifdef HAVE_SYS_TIME_H
45 # include <sys/time.h>
55 #include <vlc_network.h>
59 #define READ_MODE_PWD 1
60 #define READ_MODE_CMD 2
61 #define WRITE_MODE_PWD 3 // when we write the word "Password:"
62 #define WRITE_MODE_CMD 4
72 /*****************************************************************************
74 *****************************************************************************/
75 static int Open ( vlc_object_t * );
76 static void Close( vlc_object_t * );
78 #define TELNETHOST_TEXT N_( "Host" )
79 #define TELNETHOST_LONGTEXT N_( "This is the host on which the " \
80 "interface will listen. It defaults to all network interfaces (0.0.0.0)." \
81 " If you want this interface to be available only on the local " \
82 "machine, enter \"127.0.0.1\"." )
83 #define TELNETPORT_TEXT N_( "Port" )
84 #define TELNETPORT_LONGTEXT N_( "This is the TCP port on which this " \
85 "interface will listen. It defaults to 4212." )
86 #define TELNETPORT_DEFAULT 4212
87 #define TELNETPWD_TEXT N_( "Password" )
88 #define TELNETPWD_LONGTEXT N_( "A single administration password is used " \
89 "to protect this interface. The default value is \"admin\"." )
90 #define TELNETPWD_DEFAULT "admin"
93 set_shortname( "Telnet" );
94 set_category( CAT_INTERFACE );
95 set_subcategory( SUBCAT_INTERFACE_CONTROL );
96 add_string( "telnet-host", "", NULL, TELNETHOST_TEXT,
97 TELNETHOST_LONGTEXT, true );
98 add_integer( "telnet-port", TELNETPORT_DEFAULT, NULL, TELNETPORT_TEXT,
99 TELNETPORT_LONGTEXT, true );
100 add_password( "telnet-password", TELNETPWD_DEFAULT, NULL, TELNETPWD_TEXT,
101 TELNETPWD_LONGTEXT, true );
102 set_description( N_("VLM remote control interface") );
103 add_category_hint( "VLM", NULL, false );
104 set_capability( "interface", 0 );
105 set_callbacks( Open , Close );
108 /*****************************************************************************
110 *****************************************************************************/
111 static void Run( intf_thread_t * );
115 int i_mode; /* read or write */
117 char buffer_read[1000]; // 1000 byte per command should be sufficient
120 char *p_buffer_write; // the position in the buffer
121 int i_buffer_write; // the number of byte we still have to send
122 int i_tel_cmd; // for specific telnet commands
126 static char *MessageToString( vlm_message_t *, int );
127 static void Write_message( telnet_client_t *, vlm_message_t *, const char *, int );
131 telnet_client_t **clients;
138 * getPort: Decide which port to use. There are two possibilities to
139 * specify a port: integrated in the --telnet-host option with :PORT
140 * or using the --telnet-port option. The --telnet-port option has
142 * This code relies upon the fact the url.i_port is 0 if the :PORT
143 * option is missing from --telnet-host.
145 static int getPort(intf_thread_t *p_intf, vlc_url_t url, int i_port)
147 // Print error if two different ports have been specified
148 if (url.i_port != 0 &&
149 i_port != TELNETPORT_DEFAULT &&
150 url.i_port != i_port )
152 msg_Err( p_intf, "ignoring port %d and using %d", url.i_port,
155 if (i_port != TELNETPORT_DEFAULT)
166 /*****************************************************************************
167 * Open: initialize dummy interface
168 *****************************************************************************/
169 static int Open( vlc_object_t *p_this )
171 intf_thread_t *p_intf = (intf_thread_t*) p_this;
177 if( !(mediatheque = vlm_New( p_intf )) )
179 msg_Err( p_intf, "cannot start VLM" );
183 msg_Info( p_intf, "using the VLM interface plugin..." );
185 i_telnetport = config_GetInt( p_intf, "telnet-port" );
186 psz_address = config_GetPsz( p_intf, "telnet-host" );
188 vlc_UrlParse(&url, psz_address, 0);
191 // There might be two ports given, resolve any potentially
193 url.i_port = getPort(p_intf, url, i_telnetport);
195 p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
198 vlm_Delete( mediatheque );
199 vlc_UrlClean( &url );
202 if( ( p_intf->p_sys->pi_fd = net_ListenTCP( p_intf, url.psz_host, url.i_port ) ) == NULL )
204 msg_Err( p_intf, "cannot listen for telnet" );
205 vlm_Delete( mediatheque );
206 vlc_UrlClean( &url );
207 free( p_intf->p_sys );
211 "telnet interface started on interface %s %d",
212 url.psz_host, url.i_port );
214 p_intf->p_sys->i_clients = 0;
215 p_intf->p_sys->clients = NULL;
216 p_intf->p_sys->mediatheque = mediatheque;
217 p_intf->pf_run = Run;
219 vlc_UrlClean( &url );
223 /*****************************************************************************
225 *****************************************************************************/
226 static void Close( vlc_object_t *p_this )
228 intf_thread_t *p_intf = (intf_thread_t*)p_this;
229 intf_sys_t *p_sys = p_intf->p_sys;
232 for( i = 0; i < p_sys->i_clients; i++ )
234 telnet_client_t *cl = p_sys->clients[i];
236 free( cl->buffer_write );
239 free( p_sys->clients );
241 net_ListenClose( p_sys->pi_fd );
243 vlm_Delete( p_sys->mediatheque );
248 /*****************************************************************************
250 *****************************************************************************/
251 static void Run( intf_thread_t *p_intf )
253 intf_sys_t *p_sys = p_intf->p_sys;
255 unsigned nlisten = 0;
257 for (const int *pfd = p_sys->pi_fd; *pfd != -1; pfd++)
258 nlisten++; /* How many listening sockets do we have? */
260 psz_password = config_GetPsz( p_intf, "telnet-password" );
262 while( !intf_ShouldDie( p_intf ) )
264 unsigned ncli = p_sys->i_clients;
265 struct pollfd ufd[ncli + nlisten];
267 for (unsigned i = 0; i < ncli; i++)
269 telnet_client_t *cl = p_sys->clients[i];
272 if( (cl->i_mode == WRITE_MODE_PWD) || (cl->i_mode == WRITE_MODE_CMD) )
273 ufd[i].events = POLLOUT;
275 ufd[i].events = POLLIN;
279 for (unsigned i = 0; i < nlisten; i++)
281 ufd[ncli + i].fd = p_sys->pi_fd[i];
282 ufd[ncli + i].events = POLLIN;
283 ufd[ncli + i].revents = 0;
286 /* FIXME: arbitrary tick */
287 switch (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), 500))
290 if (net_errno != EINTR)
292 msg_Err (p_intf, "network poll error");
300 /* check if there is something to do with the socket */
301 for (unsigned i = 0; i < ncli; i++)
303 telnet_client_t *cl = p_sys->clients[i];
305 if (ufd[i].revents & (POLLERR|POLLHUP))
309 TAB_REMOVE( p_intf->p_sys->i_clients ,
310 p_intf->p_sys->clients , cl );
315 if (ufd[i].revents & POLLOUT && (cl->i_buffer_write > 0))
319 i_len = send( cl->fd, cl->p_buffer_write ,
320 cl->i_buffer_write, 0 );
323 cl->p_buffer_write += i_len;
324 cl->i_buffer_write -= i_len;
327 if (ufd[i].revents & POLLIN)
332 while( ((i_recv=recv( cl->fd, cl->p_buffer_read, 1, 0 )) > 0) &&
333 ((cl->p_buffer_read - cl->buffer_read) < 999) )
335 switch( cl->i_tel_cmd )
338 switch( *(uint8_t *)cl->p_buffer_read )
343 *cl->p_buffer_read = '\n';
346 case TEL_IAC: // telnet specific command
356 switch( *(uint8_t *)cl->p_buffer_read )
358 case TEL_WILL: case TEL_WONT:
359 case TEL_DO: case TEL_DONT:
371 cl->p_buffer_read -= 2;
378 if( (cl->p_buffer_read - cl->buffer_read) == 999 )
380 Write_message( cl, NULL, "Line too long\r\n",
384 if (i_recv <= 0 && ( end || errno != EAGAIN ) )
389 /* and now we should bidouille the data we received / send */
390 for(int i = 0 ; i < p_sys->i_clients ; i++ )
392 telnet_client_t *cl = p_sys->clients[i];
394 if( cl->i_mode >= WRITE_MODE_PWD && cl->i_buffer_write == 0 )
396 // we have finished to send
397 cl->i_mode -= 2; // corresponding READ MODE
399 else if( cl->i_mode == READ_MODE_PWD &&
400 *cl->p_buffer_read == '\n' )
402 *cl->p_buffer_read = '\0';
403 if( !psz_password || !strcmp( psz_password, cl->buffer_read ) )
405 Write_message( cl, NULL, "\xff\xfc\x01\r\nWelcome, "
406 "Master\r\n> ", WRITE_MODE_CMD );
411 Write_message( cl, NULL,
412 "\r\nWrong password.\r\nPassword: ",
416 else if( cl->i_mode == READ_MODE_CMD &&
417 *cl->p_buffer_read == '\n' )
419 /* ok, here is a command line */
420 if( !strncmp( cl->buffer_read, "logout", 6 ) ||
421 !strncmp( cl->buffer_read, "quit", 4 ) ||
422 !strncmp( cl->buffer_read, "exit", 4 ) )
425 TAB_REMOVE( p_intf->p_sys->i_clients ,
426 p_intf->p_sys->clients , cl );
427 free( cl->buffer_write );
430 else if( !strncmp( cl->buffer_read, "shutdown", 8 ) )
432 msg_Err( p_intf, "shutdown requested" );
433 vlc_object_kill( p_intf->p_libvlc );
435 else if( *cl->buffer_read == '@'
436 && strchr( cl->buffer_read, ' ' ) )
438 /* Module specific commands (use same syntax as in the
440 char *psz_name = cl->buffer_read + 1;
441 char *psz_cmd, *psz_arg, *psz_msg;
444 psz_cmd = strchr( cl->buffer_read, ' ' );
445 *psz_cmd = '\0'; psz_cmd++;
446 if( ( psz_arg = strchr( psz_cmd, '\n' ) ) ) *psz_arg = '\0';
447 if( ( psz_arg = strchr( psz_cmd, '\r' ) ) ) *psz_arg = '\0';
448 if( ( psz_arg = strchr( psz_cmd, ' ' ) )
455 i_ret = var_Command( p_intf, psz_name, psz_cmd, psz_arg,
460 vlm_message_t *message;
461 message = vlm_MessageNew( "Module command", psz_msg );
462 Write_message( cl, message, NULL, WRITE_MODE_CMD );
463 vlm_MessageDelete( message );
469 vlm_message_t *message;
471 /* create a standard string */
472 *cl->p_buffer_read = '\0';
474 vlm_ExecuteCommand( p_sys->mediatheque, cl->buffer_read,
476 if( !strncmp( cl->buffer_read, "help", 4 ) )
478 vlm_message_t *p_my_help =
479 vlm_MessageNew( "Telnet Specific Commands:", NULL );
480 vlm_MessageAdd( p_my_help,
481 vlm_MessageNew( "logout, quit, exit" , NULL ) );
482 vlm_MessageAdd( p_my_help,
483 vlm_MessageNew( "shutdown" , NULL ) );
484 vlm_MessageAdd( p_my_help,
485 vlm_MessageNew( "@moduleinstance command argument",
487 vlm_MessageAdd( message, p_my_help );
489 Write_message( cl, message, NULL, WRITE_MODE_CMD );
490 vlm_MessageDelete( message );
495 /* handle new connections */
496 for (unsigned i = 0; i < nlisten; i++)
500 if (ufd[ncli + i].revents == 0)
503 fd = net_AcceptSingle (VLC_OBJECT(p_intf), ufd[ncli + i].fd);
507 telnet_client_t *cl = malloc( sizeof( telnet_client_t ));
514 memset( cl, 0, sizeof(telnet_client_t) );
517 cl->buffer_write = NULL;
518 cl->p_buffer_write = cl->buffer_write;
519 Write_message( cl, NULL,
520 "Password: \xff\xfb\x01" , WRITE_MODE_PWD );
521 TAB_APPEND( p_sys->i_clients, p_sys->clients, cl );
524 free( psz_password );
527 static void Write_message( telnet_client_t *client, vlm_message_t *message,
528 const char *string_message, int i_mode )
532 client->p_buffer_read = client->buffer_read;
533 (client->p_buffer_read)[0] = 0; // if (cl->p_buffer_read)[0] = '\n'
534 free( client->buffer_write );
536 /* generate the psz_message string */
539 /* ok, look for vlm_message_t */
540 psz_message = MessageToString( message, 0 );
544 /* it is a basic string_message */
545 psz_message = strdup( string_message );
548 client->buffer_write = client->p_buffer_write = psz_message;
549 client->i_buffer_write = strlen( psz_message );
550 client->i_mode = i_mode;
553 /* We need the level of the message to put a beautiful indentation.
554 * first level is 0 */
555 static char *MessageToString( vlm_message_t *message, int i_level )
557 #define STRING_CR "\r\n"
558 #define STRING_TAIL "> "
561 int i, i_message = sizeof( STRING_TAIL );
563 if( !message || !message->psz_name )
565 return strdup( STRING_CR STRING_TAIL );
567 else if( !i_level && !message->i_child && !message->psz_value )
569 /* A command is successful. Don't write anything */
570 return strdup( /*STRING_CR*/ STRING_TAIL );
573 i_message += strlen( message->psz_name ) + i_level * sizeof( " " ) + 1;
574 psz_message = malloc( i_message );
576 for( i = 0; i < i_level; i++ ) strcat( psz_message, " " );
577 strcat( psz_message, message->psz_name );
579 if( message->psz_value )
581 i_message += sizeof( " : " ) + strlen( message->psz_value ) +
583 psz_message = realloc( psz_message, i_message );
584 strcat( psz_message, " : " );
585 strcat( psz_message, message->psz_value );
586 strcat( psz_message, STRING_CR );
590 i_message += sizeof( STRING_CR );
591 psz_message = realloc( psz_message, i_message );
592 strcat( psz_message, STRING_CR );
595 for( i = 0; i < message->i_child; i++ )
597 char *child_message =
598 MessageToString( message->child[i], i_level + 1 );
600 i_message += strlen( child_message );
601 psz_message = realloc( psz_message, i_message );
602 strcat( psz_message, child_message );
603 free( child_message );
606 if( i_level == 0 ) strcat( psz_message, STRING_TAIL );