X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=modules%2Fcontrol%2Ftelnet.c;h=e7bb2e19c9d60fd35d1c61b92dbf5e718f3bfbda;hb=75a1834d394b6a89a6ead139d57c097704d3943a;hp=00b41b378e1be699513bdb3505e55bc21576f6e2;hpb=6bafce691a90555b93314ed5276daf68ffe261c3;p=vlc diff --git a/modules/control/telnet.c b/modules/control/telnet.c index 00b41b378e..e7bb2e19c9 100644 --- a/modules/control/telnet.c +++ b/modules/control/telnet.c @@ -1,7 +1,7 @@ /***************************************************************************** * telnet.c: VLM interface plugin ***************************************************************************** - * Copyright (C) 2000, 2001 VideoLAN + * Copyright (C) 2000-2006 the VideoLAN team * $Id$ * * Authors: Simon Latapie @@ -19,19 +19,23 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ /***************************************************************************** * Preamble *****************************************************************************/ -#include /* malloc(), free() */ -#include -#include +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif -#include +#include +#include +#include +#include +#include #include #include @@ -44,18 +48,13 @@ #ifdef HAVE_UNISTD_H # include #endif - -#if defined( UNDER_CE ) -# include -#elif defined( WIN32 ) -# include -#else -# include +#ifdef HAVE_POLL +# include #endif -#include "network.h" - -#include "vlc_vlm.h" +#include +#include +#include #define READ_MODE_PWD 1 #define READ_MODE_CMD 2 @@ -76,20 +75,32 @@ static int Open ( vlc_object_t * ); static void Close( vlc_object_t * ); -#define TELNETPORT_TEXT N_( "Telnet Interface port" ) -#define TELNETPORT_LONGTEXT N_( "Default to 4212" ) -#define TELNETPWD_TEXT N_( "Telnet Interface password" ) -#define TELNETPWD_LONGTEXT N_( "Default to admin" ) +#define TELNETHOST_TEXT N_( "Host" ) +#define TELNETHOST_LONGTEXT N_( "This is the host on which the " \ + "interface will listen. It defaults to all network interfaces (0.0.0.0)." \ + " If you want this interface to be available only on the local " \ + "machine, enter \"127.0.0.1\"." ) +#define TELNETPORT_TEXT N_( "Port" ) +#define TELNETPORT_LONGTEXT N_( "This is the TCP port on which this " \ + "interface will listen. It defaults to 4212." ) +#define TELNETPORT_DEFAULT 4212 +#define TELNETPWD_TEXT N_( "Password" ) +#define TELNETPWD_LONGTEXT N_( "A single administration password is used " \ + "to protect this interface. The default value is \"admin\"." ) +#define TELNETPWD_DEFAULT "admin" vlc_module_begin(); + set_shortname( "Telnet" ); set_category( CAT_INTERFACE ); - set_subcategory( SUBCAT_INTERFACE_GENERAL ); - add_integer( "telnet-port", 4212, NULL, TELNETPORT_TEXT, - TELNETPORT_LONGTEXT, VLC_TRUE ); - add_string( "telnet-password", "admin", NULL, TELNETPWD_TEXT, - TELNETPWD_LONGTEXT, VLC_TRUE ); - set_description( _("Telnet remote control interface") ); - add_category_hint( "VLM", NULL, VLC_FALSE ); + set_subcategory( SUBCAT_INTERFACE_CONTROL ); + add_string( "telnet-host", "", NULL, TELNETHOST_TEXT, + TELNETHOST_LONGTEXT, true ); + add_integer( "telnet-port", TELNETPORT_DEFAULT, NULL, TELNETPORT_TEXT, + TELNETPORT_LONGTEXT, true ); + add_password( "telnet-password", TELNETPWD_DEFAULT, NULL, TELNETPWD_TEXT, + TELNETPWD_LONGTEXT, true ); + set_description( N_("VLM remote control interface") ); + add_category_hint( "VLM", NULL, false ); set_capability( "interface", 0 ); set_callbacks( Open , Close ); vlc_module_end(); @@ -103,26 +114,55 @@ typedef struct { int i_mode; /* read or write */ int fd; - uint8_t buffer_read[1000]; // 1000 byte per command should be sufficient + char buffer_read[1000]; // 1000 byte per command should be sufficient char *buffer_write; - uint8_t *p_buffer_read; - uint8_t *p_buffer_write; // the position in the buffer + char *p_buffer_read; + char *p_buffer_write; // the position in the buffer int i_buffer_write; // the number of byte we still have to send int i_tel_cmd; // for specific telnet commands } telnet_client_t; static char *MessageToString( vlm_message_t *, int ); -static void Write_message( telnet_client_t *, vlm_message_t *, char *, int ); +static void Write_message( telnet_client_t *, vlm_message_t *, const char *, int ); struct intf_sys_t { telnet_client_t **clients; int i_clients; - int fd; + int *pi_fd; vlm_t *mediatheque; }; +/* + * getPort: Decide which port to use. There are two possibilities to + * specify a port: integrated in the --telnet-host option with :PORT + * or using the --telnet-port option. The --telnet-port option has + * precedence. + * This code relies upon the fact the url.i_port is 0 if the :PORT + * option is missing from --telnet-host. + */ +static int getPort(intf_thread_t *p_intf, vlc_url_t url, int i_port) +{ + // Print error if two different ports have been specified + if (url.i_port != 0 && + i_port != TELNETPORT_DEFAULT && + url.i_port != i_port ) + { + msg_Err( p_intf, "ignoring port %d and using %d", url.i_port, + i_port); + } + if (i_port != TELNETPORT_DEFAULT) + { + return i_port; + } + if (url.i_port != 0) + { + return url.i_port; + } + return i_port; +} + /***************************************************************************** * Open: initialize dummy interface *****************************************************************************/ @@ -130,6 +170,8 @@ static int Open( vlc_object_t *p_this ) { intf_thread_t *p_intf = (intf_thread_t*) p_this; vlm_t *mediatheque; + char *psz_address; + vlc_url_t url; int i_telnetport; if( !(mediatheque = vlm_New( p_intf )) ) @@ -138,24 +180,38 @@ static int Open( vlc_object_t *p_this ) return VLC_EGENERIC; } - msg_Info( p_intf, "Using the VLM interface plugin..." ); + msg_Info( p_intf, "using the VLM interface plugin..." ); i_telnetport = config_GetInt( p_intf, "telnet-port" ); + psz_address = config_GetPsz( p_intf, "telnet-host" ); + + vlc_UrlParse(&url, psz_address, 0); + + // There might be two ports given, resolve any potentially + // conflict + url.i_port = getPort(p_intf, url, i_telnetport); p_intf->p_sys = malloc( sizeof( intf_sys_t ) ); - if( ( p_intf->p_sys->fd = net_ListenTCP( p_intf , "", i_telnetport ) ) < 0 ) + if( ( p_intf->p_sys->pi_fd = net_ListenTCP( p_intf, url.psz_host, url.i_port ) ) + == NULL ) { msg_Err( p_intf, "cannot listen for telnet" ); + vlc_UrlClean(&url); + free( psz_address ); free( p_intf->p_sys ); return VLC_EGENERIC; } - msg_Info( p_intf, "Telnet interface started on port: %d", i_telnetport ); + msg_Info( p_intf, + "telnet interface started on interface %s %d", + url.psz_host, url.i_port ); p_intf->p_sys->i_clients = 0; p_intf->p_sys->clients = NULL; p_intf->p_sys->mediatheque = mediatheque; p_intf->pf_run = Run; + vlc_UrlClean(&url); + free( psz_address ); return VLC_SUCCESS; } @@ -171,13 +227,13 @@ static void Close( vlc_object_t *p_this ) for( i = 0; i < p_sys->i_clients; i++ ) { telnet_client_t *cl = p_sys->clients[i]; - net_Close( cl->fd ); free( cl ); + p_sys->clients[i] = NULL; } - if( p_sys->clients != NULL ) free( p_sys->clients ); + free( p_sys->clients ); - net_Close( p_sys->fd ); + net_ListenClose( p_sys->pi_fd ); vlm_Delete( p_sys->mediatheque ); @@ -190,109 +246,97 @@ static void Close( vlc_object_t *p_this ) static void Run( intf_thread_t *p_intf ) { intf_sys_t *p_sys = p_intf->p_sys; - struct timeval timeout; char *psz_password; + unsigned nlisten = 0; + + for (const int *pfd = p_sys->pi_fd; *pfd != -1; pfd++) + nlisten++; /* How many listening sockets do we have? */ psz_password = config_GetPsz( p_intf, "telnet-password" ); - while( !p_intf->b_die ) + while( !intf_ShouldDie( p_intf ) ) { - fd_set fds_read, fds_write; - int i_handle_max = 0; - int i_ret, i_len, fd, i; + unsigned ncli = p_sys->i_clients; + struct pollfd ufd[ncli + nlisten]; - /* if a new client wants to communicate */ - fd = net_Accept( p_intf, p_sys->fd, p_sys->i_clients > 0 ? 0 : -1 ); - if( fd > 0 ) - { - telnet_client_t *cl; - - /* to be non blocking */ -#if defined( WIN32 ) || defined( UNDER_CE ) - { - unsigned long i_dummy = 1; - ioctlsocket( fd, FIONBIO, &i_dummy ); - } -#else - fcntl( fd, F_SETFL, O_NONBLOCK ); -#endif - cl = malloc( sizeof( telnet_client_t )); - cl->i_tel_cmd = 0; - cl->fd = fd; - cl->buffer_write = NULL; - cl->p_buffer_write = cl->buffer_write; - Write_message( cl, NULL, "Password:\xff\xfb\x01", WRITE_MODE_PWD ); - - TAB_APPEND( p_sys->i_clients, p_sys->clients, cl ); - } - - /* to do a proper select */ - FD_ZERO( &fds_read ); - FD_ZERO( &fds_write ); - - for( i = 0 ; i < p_sys->i_clients ; i++ ) + for (unsigned i = 0; i < ncli; i++) { telnet_client_t *cl = p_sys->clients[i]; - if( cl->i_mode == WRITE_MODE_PWD || cl->i_mode == WRITE_MODE_CMD ) - { - FD_SET( cl->fd , &fds_write ); - } + ufd[i].fd = cl->fd; + if( (cl->i_mode == WRITE_MODE_PWD) || (cl->i_mode == WRITE_MODE_CMD) ) + ufd[i].events = POLLOUT; else - { - FD_SET( cl->fd , &fds_read ); - } - i_handle_max = __MAX( i_handle_max, cl->fd ); + ufd[i].events = POLLIN; + ufd[i].revents = 0; } - timeout.tv_sec = 0; - timeout.tv_usec = 500*1000; - - i_ret = select( i_handle_max + 1, &fds_read, &fds_write, 0, &timeout ); - if( i_ret == -1 && errno != EINTR ) + for (unsigned i = 0; i < nlisten; i++) { - msg_Warn( p_intf, "cannot select sockets" ); - msleep( 1000 ); - continue; + ufd[ncli + i].fd = p_sys->pi_fd[i]; + ufd[ncli + i].events = POLLIN; + ufd[ncli + i].revents = 0; } - else if( i_ret <= 0 ) + + /* FIXME: arbitrary tick */ + switch (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), 500)) { - continue; + case -1: + if (net_errno != EINTR) + { + msg_Err (p_intf, "network poll error"); + msleep (1000); + continue; + } + case 0: + continue; } /* check if there is something to do with the socket */ - for( i = 0 ; i < p_sys->i_clients ; i++ ) + for (unsigned i = 0; i < ncli; i++) { telnet_client_t *cl = p_sys->clients[i]; - if( FD_ISSET(cl->fd , &fds_write) && cl->i_buffer_write > 0 ) + if (ufd[i].revents & (POLLERR|POLLHUP)) { - i_len = send( cl->fd , cl->p_buffer_write , - cl->i_buffer_write , 0 ); + drop: + net_Close( cl->fd ); + TAB_REMOVE( p_intf->p_sys->i_clients , + p_intf->p_sys->clients , cl ); + free( cl ); + continue; + } + + if (ufd[i].revents & POLLOUT && (cl->i_buffer_write > 0)) + { + ssize_t i_len; + + i_len = send( cl->fd, cl->p_buffer_write , + cl->i_buffer_write, 0 ); if( i_len > 0 ) { cl->p_buffer_write += i_len; cl->i_buffer_write -= i_len; } } - else if( FD_ISSET( cl->fd, &fds_read) ) + if (ufd[i].revents & POLLIN) { - int i_end = 0; - int i_recv; + bool end = false; + ssize_t i_recv; - while( (i_recv=recv( cl->fd, cl->p_buffer_read, 1, 0 )) > 0 && - cl->p_buffer_read - cl->buffer_read < 999 ) + while( ((i_recv=recv( cl->fd, cl->p_buffer_read, 1, 0 )) > 0) && + ((cl->p_buffer_read - cl->buffer_read) < 999) ) { switch( cl->i_tel_cmd ) { case 0: - switch( *cl->p_buffer_read ) + switch( *(uint8_t *)cl->p_buffer_read ) { case '\r': break; case '\n': *cl->p_buffer_read = '\n'; - i_end = 1; + end = true; break; case TEL_IAC: // telnet specific command cl->i_tel_cmd = 1; @@ -304,7 +348,7 @@ static void Run( intf_thread_t *p_intf ) } break; case 1: - switch( *cl->p_buffer_read ) + switch( *(uint8_t *)cl->p_buffer_read ) { case TEL_WILL: case TEL_WONT: case TEL_DO: case TEL_DONT: @@ -323,27 +367,22 @@ static void Run( intf_thread_t *p_intf ) break; } - if( i_end != 0 ) break; + if( end ) break; } - if( cl->p_buffer_read - cl->buffer_read == 999 ) + if( (cl->p_buffer_read - cl->buffer_read) == 999 ) { Write_message( cl, NULL, "Line too long\r\n", cl->i_mode + 2 ); } - if (i_recv == 0) - { - net_Close( cl->fd ); - TAB_REMOVE( p_intf->p_sys->i_clients , - p_intf->p_sys->clients , cl ); - free( cl ); - } + if (i_recv <= 0 && ( end || errno != EAGAIN ) ) + goto drop; } } /* and now we should bidouille the data we received / send */ - for( i = 0 ; i < p_sys->i_clients ; i++ ) + for(int i = 0 ; i < p_sys->i_clients ; i++ ) { telnet_client_t *cl = p_sys->clients[i]; @@ -356,7 +395,7 @@ static void Run( intf_thread_t *p_intf ) *cl->p_buffer_read == '\n' ) { *cl->p_buffer_read = '\0'; - if( strcmp( psz_password, cl->buffer_read ) == 0 ) + if( !psz_password || !strcmp( psz_password, cl->buffer_read ) ) { Write_message( cl, NULL, "\xff\xfc\x01\r\nWelcome, " "Master\r\n> ", WRITE_MODE_CMD ); @@ -364,7 +403,8 @@ static void Run( intf_thread_t *p_intf ) else { /* wrong password */ - Write_message( cl, NULL, "\r\nTry again, you polio:", + Write_message( cl, NULL, + "\r\nWrong password.\r\nPassword: ", WRITE_MODE_PWD ); } } @@ -384,7 +424,39 @@ static void Run( intf_thread_t *p_intf ) else if( !strncmp( cl->buffer_read, "shutdown", 8 ) ) { msg_Err( p_intf, "shutdown requested" ); - p_intf->p_vlc->b_die = VLC_TRUE; + vlc_object_kill( p_intf->p_libvlc ); + } + else if( *cl->buffer_read == '@' + && strchr( cl->buffer_read, ' ' ) ) + { + /* Module specific commands (use same syntax as in the + * rc interface) */ + char *psz_name = cl->buffer_read + 1; + char *psz_cmd, *psz_arg, *psz_msg; + int i_ret; + + psz_cmd = strchr( cl->buffer_read, ' ' ); + *psz_cmd = '\0'; psz_cmd++; + if( ( psz_arg = strchr( psz_cmd, '\n' ) ) ) *psz_arg = '\0'; + if( ( psz_arg = strchr( psz_cmd, '\r' ) ) ) *psz_arg = '\0'; + if( ( psz_arg = strchr( psz_cmd, ' ' ) ) + && *psz_arg ) + { + *psz_arg = '\0'; + psz_arg++; + } + + i_ret = var_Command( p_intf, psz_name, psz_cmd, psz_arg, + &psz_msg ); + + if( psz_msg ) + { + vlm_message_t *message; + message = vlm_MessageNew( "Module command", psz_msg ); + Write_message( cl, message, NULL, WRITE_MODE_CMD ); + vlm_MessageDelete( message ); + free( psz_msg ); + } } else { @@ -395,22 +467,66 @@ static void Run( intf_thread_t *p_intf ) vlm_ExecuteCommand( p_sys->mediatheque, cl->buffer_read, &message ); + if( !strncmp( cl->buffer_read, "help", 4 ) ) + { + vlm_message_t *p_my_help = + vlm_MessageNew( "Telnet Specific Commands:", NULL ); + vlm_MessageAdd( p_my_help, + vlm_MessageNew( "logout, quit, exit" , NULL ) ); + vlm_MessageAdd( p_my_help, + vlm_MessageNew( "shutdown" , NULL ) ); + vlm_MessageAdd( p_my_help, + vlm_MessageNew( "@moduleinstance command argument", + NULL) ); + vlm_MessageAdd( message, p_my_help ); + } Write_message( cl, message, NULL, WRITE_MODE_CMD ); vlm_MessageDelete( message ); + } } } + + /* handle new connections */ + for (unsigned i = 0; i < nlisten; i++) + { + int fd; + + if (ufd[ncli + i].revents == 0) + continue; + + fd = net_AcceptSingle (VLC_OBJECT(p_intf), ufd[ncli + i].fd); + if (fd == -1) + continue; + + telnet_client_t *cl = malloc( sizeof( telnet_client_t )); + if (cl == NULL) + { + net_Close (fd); + continue; + } + + memset( cl, 0, sizeof(telnet_client_t) ); + cl->i_tel_cmd = 0; + cl->fd = fd; + cl->buffer_write = NULL; + cl->p_buffer_write = cl->buffer_write; + Write_message( cl, NULL, + "Password: \xff\xfb\x01" , WRITE_MODE_PWD ); + TAB_APPEND( p_sys->i_clients, p_sys->clients, cl ); + } } + free( psz_password ); } static void Write_message( telnet_client_t *client, vlm_message_t *message, - char *string_message, int i_mode ) + const char *string_message, int i_mode ) { char *psz_message; client->p_buffer_read = client->buffer_read; (client->p_buffer_read)[0] = 0; // if (cl->p_buffer_read)[0] = '\n' - if( client->buffer_write ) free( client->buffer_write ); + free( client->buffer_write ); /* generate the psz_message string */ if( message ) @@ -446,11 +562,12 @@ static char *MessageToString( vlm_message_t *message, int i_level ) else if( !i_level && !message->i_child && !message->psz_value ) { /* A command is successful. Don't write anything */ - return strdup( STRING_CR STRING_TAIL ); + return strdup( /*STRING_CR*/ STRING_TAIL ); } i_message += strlen( message->psz_name ) + i_level * sizeof( " " ) + 1; - psz_message = malloc( i_message ); *psz_message = 0; + psz_message = malloc( i_message ); + *psz_message = 0; for( i = 0; i < i_level; i++ ) strcat( psz_message, " " ); strcat( psz_message, message->psz_name );