]> git.sesse.net Git - vlc/blobdiff - modules/control/telnet.c
Ooops (?)
[vlc] / modules / control / telnet.c
index 2547c10025c131628aaef5455b38c92e10dc76ea..bca7940fce65f8cecb628506560032b81aafb664 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * telnet.c: VLM interface plugin
  *****************************************************************************
- * Copyright (C) 2000-2005 VideoLAN
+ * Copyright (C) 2000-2006 the VideoLAN team
  * $Id$
  *
  * Authors: Simon Latapie <garf@videolan.org>
@@ -19,7 +19,7 @@
  *
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -28,9 +28,8 @@
 #include <stdlib.h>                                      /* malloc(), free() */
 
 #include <vlc/vlc.h>
-#include <vlc/intf.h>
-
-#include <vlc/input.h>
+#include <vlc_interface.h>
+#include <vlc_input.h>
 
 #include <sys/stat.h>
 
 #   include <unistd.h>
 #endif
 
-#if defined( UNDER_CE )
-#   include <winsock.h>
-#elif defined( WIN32 )
-#   include <winsock2.h>
-#else
-#   include <sys/socket.h>
-#endif
-
-#include "network.h"
-
-#include "vlc_vlm.h"
+#include <vlc_network.h>
+#include <vlc_url.h>
+#include <vlc_vlm.h>
 
 #define READ_MODE_PWD 1
 #define READ_MODE_CMD 2
 static int  Open ( vlc_object_t * );
 static void Close( vlc_object_t * );
 
-#define TELNETHOST_TEXT N_( "Telnet Interface host" )
-#define TELNETHOST_LONGTEXT N_( "Default to listen on all network interfaces" )
-#define TELNETHOST_DEFAULT "0.0.0.0"
-#define TELNETPORT_TEXT N_( "Telnet Interface port" )
-#define TELNETPORT_LONGTEXT N_( "Default to 4212" )
+#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_( "Telnet Interface password" )
-#define TELNETPWD_LONGTEXT N_( "Default to admin" )
+#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_string( "telnet-host", TELNETHOST_DEFAULT, NULL, TELNETHOST_TEXT,
+    set_subcategory( SUBCAT_INTERFACE_CONTROL );
+    add_string( "telnet-host", "", NULL, TELNETHOST_TEXT,
                  TELNETHOST_LONGTEXT, VLC_TRUE );
     add_integer( "telnet-port", TELNETPORT_DEFAULT, NULL, TELNETPORT_TEXT,
                  TELNETPORT_LONGTEXT, VLC_TRUE );
@@ -111,10 +106,10 @@ 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
 
@@ -131,33 +126,32 @@ struct intf_sys_t
    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 
+ * 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 && 
+        i_port != TELNETPORT_DEFAULT &&
         url.i_port != i_port )
     {
-           msg_Err( p_intf, "ignoring port %d and using %d", url.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;
+        return i_port;
     }
     if (url.i_port != 0)
     {
-           return url.i_port;
+         return url.i_port;
     }
-    // return default
     return i_port;
 }
 
@@ -178,7 +172,7 @@ 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" );
@@ -194,18 +188,22 @@ static int Open( vlc_object_t *p_this )
                 == 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 interface %s %d",
-             url.psz_host, url.i_port );
+    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;
 }
 
@@ -221,9 +219,9 @@ 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 );
 
@@ -245,7 +243,7 @@ static void Run( intf_thread_t *p_intf )
 
     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;
@@ -255,7 +253,7 @@ static void Run( intf_thread_t *p_intf )
         fd = net_Accept( p_intf, p_sys->pi_fd, p_sys->i_clients > 0 ? 0 : -1 );
         if( fd > 0 )
         {
-            telnet_client_t *cl;
+            telnet_client_t *cl = NULL;
 
             /* to be non blocking */
 #if defined( WIN32 ) || defined( UNDER_CE )
@@ -267,13 +265,32 @@ static void Run( intf_thread_t *p_intf )
             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 );
+            if( cl )
+            {
+                char   *psz_pwd = strdup( _("Password") );
+                char   *psz_tmp = NULL;
+                size_t ctrl_len = strlen( ": \xff\xfb\x01" );
+                size_t passwd_len = strlen( psz_pwd );
+
+                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;
+                psz_tmp = malloc( passwd_len + ctrl_len + 1 );
+                if( !psz_tmp )
+                {
+                    free( psz_pwd );
+                    continue;
+                }
+                memset( psz_tmp, 0, passwd_len + ctrl_len + 1 );
+                memcpy( psz_tmp, psz_pwd, passwd_len );
+                memcpy( psz_tmp + passwd_len, ": \xff\xfb\x01", ctrl_len );
+                Write_message( cl, NULL, psz_tmp, WRITE_MODE_PWD );
+                TAB_APPEND( p_sys->i_clients, p_sys->clients, cl );
+                free( psz_pwd );
+                free( psz_tmp );
+            }
         }
 
         /* to do a proper select */
@@ -284,7 +301,7 @@ static void Run( intf_thread_t *p_intf )
         {
             telnet_client_t *cl = p_sys->clients[i];
 
-            if( cl->i_mode == WRITE_MODE_PWD || cl->i_mode == WRITE_MODE_CMD )
+            if( (cl->i_mode == WRITE_MODE_PWD) || (cl->i_mode == WRITE_MODE_CMD) )
             {
                 FD_SET( cl->fd , &fds_write );
             }
@@ -299,7 +316,7 @@ static void Run( intf_thread_t *p_intf )
         timeout.tv_usec = 500*1000;
 
         i_ret = select( i_handle_max + 1, &fds_read, &fds_write, 0, &timeout );
-        if( i_ret == -1 && errno != EINTR )
+        if( (i_ret == -1) && (errno != EINTR) )
         {
             msg_Warn( p_intf, "cannot select sockets" );
             msleep( 1000 );
@@ -315,10 +332,10 @@ static void Run( intf_thread_t *p_intf )
         {
             telnet_client_t *cl = p_sys->clients[i];
 
-            if( FD_ISSET(cl->fd , &fds_write) && cl->i_buffer_write > 0 )
+            if( FD_ISSET(cl->fd , &fds_write) && (cl->i_buffer_write > 0) )
             {
-                i_len = send( cl->fd , cl->p_buffer_write ,
-                              cl->i_buffer_write , 0 );
+                i_len = send( cl->fd, cl->p_buffer_write ,
+                              cl->i_buffer_write, 0 );
                 if( i_len > 0 )
                 {
                     cl->p_buffer_write += i_len;
@@ -330,13 +347,13 @@ static void Run( intf_thread_t *p_intf )
                 int i_end = 0;
                 int 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;
@@ -354,7 +371,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:
@@ -376,13 +393,13 @@ static void Run( intf_thread_t *p_intf )
                     if( i_end != 0 ) 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",
+                    Write_message( cl, NULL, _( "Line too long\r\n" ),
                                    cl->i_mode + 2 );
                 }
 
-                if (i_recv == 0)
+                if( i_recv == 0 )
                 {
                     net_Close( cl->fd );
                     TAB_REMOVE( p_intf->p_sys->i_clients ,
@@ -397,29 +414,46 @@ static void Run( intf_thread_t *p_intf )
         {
             telnet_client_t *cl = p_sys->clients[i];
 
-            if( cl->i_mode >= WRITE_MODE_PWD && cl->i_buffer_write == 0 )
+            if( (cl->i_mode >= WRITE_MODE_PWD) && (cl->i_buffer_write == 0) )
             {
                // we have finished to send
                cl->i_mode -= 2; // corresponding READ MODE
             }
-            else if( cl->i_mode == READ_MODE_PWD &&
-                     *cl->p_buffer_read == '\n' )
+            else if( (cl->i_mode == READ_MODE_PWD) &&
+                     (*cl->p_buffer_read == '\n') )
             {
                 *cl->p_buffer_read = '\0';
                 if( strcmp( psz_password, cl->buffer_read ) == 0 )
                 {
-                    Write_message( cl, NULL, "\xff\xfc\x01\r\nWelcome, "
-                                   "Master\r\n> ", WRITE_MODE_CMD );
+                    char *psz_welcome = strdup( _("Welcome, Master") );
+                    char *psz_tmp = NULL;
+                    size_t welcome_len = strlen( psz_welcome );
+                    size_t ctrl_len = strlen("\xff\xfc\x01\r\n");
+
+                    psz_tmp = malloc( welcome_len + ctrl_len + 4 + 1 );
+                    if( !psz_tmp )
+                    {
+                        free( psz_welcome );
+                        continue;
+                    }
+                    memset( psz_tmp, 0, welcome_len + ctrl_len + 4 + 1 );
+                    memcpy( psz_tmp, "\xff\xfc\x01\r\n", ctrl_len );
+                    memcpy( psz_tmp + ctrl_len, psz_welcome, welcome_len );
+                    memcpy( psz_tmp + ctrl_len + welcome_len, "\r\n> ", 4 );
+                    Write_message( cl, NULL, psz_tmp, WRITE_MODE_CMD );
+                    free( psz_welcome );
+                    free( psz_tmp );
                 }
                 else
                 {
                     /* wrong password */
-                    Write_message( cl, NULL, "\r\nWrong password. ",
+                    Write_message( cl, NULL,
+                                   _( "\r\nWrong password.\r\nPassword: " ),
                                    WRITE_MODE_PWD );
                 }
             }
-            else if( cl->i_mode == READ_MODE_CMD &&
-                     *cl->p_buffer_read == '\n' )
+            else if( (cl->i_mode == READ_MODE_CMD) &&
+                     (*cl->p_buffer_read == '\n') )
             {
                 /* ok, here is a command line */
                 if( !strncmp( cl->buffer_read, "logout", 6 ) ||
@@ -434,7 +468,7 @@ 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;
+                    p_intf->p_libvlc->b_die = VLC_TRUE;
                 }
                 else
                 {
@@ -445,8 +479,19 @@ 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( message, p_my_help );
+                    }
                     Write_message( cl, message, NULL, WRITE_MODE_CMD );
                     vlm_MessageDelete( message );
+
                 }
             }
         }
@@ -496,11 +541,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 );