]> git.sesse.net Git - vlc/blobdiff - modules/control/telnet.c
dbus controler: cosmetics (split the meta: the ones requiered by the
[vlc] / modules / control / telnet.c
index 86af294b4dc7b52686d6c9e8386b26153469b056..0b63fd1b962cd9b8ed11754021f6ac85cecc861c 100644 (file)
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <stdlib.h>                                      /* malloc(), free() */
 
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 #include <vlc_interface.h>
 #include <vlc_input.h>
 
-#include <sys/stat.h>
+#include <stdbool.h>
 
 #include <errno.h>
-#include <fcntl.h>
-
-#ifdef HAVE_SYS_TIME_H
-#    include <sys/time.h>
-#endif
 
 #ifdef HAVE_UNISTD_H
 #   include <unistd.h>
 #endif
+#ifdef HAVE_POLL
+#   include <poll.h>
+#endif
 
 #include <vlc_network.h>
 #include <vlc_url.h>
@@ -81,21 +83,21 @@ static void Close( vlc_object_t * );
     "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_CONTROL );
+vlc_module_begin ()
+    set_shortname( "Telnet" )
+    set_category( CAT_INTERFACE )
+    set_subcategory( SUBCAT_INTERFACE_CONTROL )
     add_string( "telnet-host", "", NULL, TELNETHOST_TEXT,
-                 TELNETHOST_LONGTEXT, VLC_TRUE );
+                 TELNETHOST_LONGTEXT, true )
     add_integer( "telnet-port", TELNETPORT_DEFAULT, NULL, TELNETPORT_TEXT,
-                 TELNETPORT_LONGTEXT, VLC_TRUE );
-    add_string( "telnet-password", TELNETPWD_DEFAULT, NULL, TELNETPWD_TEXT,
-                TELNETPWD_LONGTEXT, VLC_TRUE );
-    set_description( _("VLM remote control interface") );
-    add_category_hint( "VLM", NULL, VLC_FALSE );
-    set_capability( "interface", 0 );
-    set_callbacks( Open , Close );
-vlc_module_end();
+                 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 ()
 
 /*****************************************************************************
  * Local prototypes.
@@ -116,7 +118,7 @@ typedef struct
 } 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
 {
@@ -134,24 +136,13 @@ struct intf_sys_t
  * 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)
+static int getPort(intf_thread_t *p_intf, const 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;
-    }
+    if (i_port == TELNETPORT_DEFAULT && url->i_port != 0)
+        i_port = url->i_port;
+    if (url->i_port != 0 && url->i_port != i_port)
+        // Print error if two different ports have been specified
+        msg_Warn( p_intf, "ignoring port %d (using %d)", url->i_port, i_port );
     return i_port;
 }
 
@@ -174,22 +165,27 @@ static int Open( vlc_object_t *p_this )
 
     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" );
-
+    i_telnetport = var_InheritInteger( p_intf, "telnet-port" );
+    psz_address  = var_InheritString( p_intf, "telnet-host" );
     vlc_UrlParse(&url, psz_address, 0);
+    free( psz_address );
 
     // There might be two ports given, resolve any potentially
     // conflict
-    url.i_port = getPort(p_intf, url, i_telnetport);
+    url.i_port = getPort(p_intf, &url, i_telnetport);
 
     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
-    if( ( p_intf->p_sys->pi_fd = net_ListenTCP( p_intf, url.psz_host, url.i_port ) )
-                == NULL )
+    if( !p_intf->p_sys )
+    {
+        vlm_Delete( mediatheque );
+        vlc_UrlClean( &url );
+        return VLC_ENOMEM;
+    }
+    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 );
+        vlm_Delete( mediatheque );
+        vlc_UrlClean( &url );
         free( p_intf->p_sys );
         return VLC_EGENERIC;
     }
@@ -202,8 +198,7 @@ static int Open( vlc_object_t *p_this )
     p_intf->p_sys->mediatheque = mediatheque;
     p_intf->pf_run = Run;
 
-    vlc_UrlClean(&url);
-    free( psz_address );
+    vlc_UrlClean( &url );
     return VLC_SUCCESS;
 }
 
@@ -220,10 +215,10 @@ static void Close( vlc_object_t *p_this )
     {
         telnet_client_t *cl = p_sys->clients[i];
         net_Close( cl->fd );
+        free( cl->buffer_write );
         free( cl );
-        p_sys->clients[i] = NULL;
     }
-    if( p_sys->clients != NULL ) free( p_sys->clients );
+    free( p_sys->clients );
 
     net_ListenClose( p_sys->pi_fd );
 
@@ -238,82 +233,78 @@ 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;
 
-    psz_password = config_GetPsz( p_intf, "telnet-password" );
+    for (const int *pfd = p_sys->pi_fd; *pfd != -1; pfd++)
+        nlisten++; /* How many listening sockets do we have? */
 
-    while( !intf_ShouldDie( p_intf ) )
-    {
-        fd_set fds_read, fds_write;
-        int    i_handle_max = 0;
-        int    i_ret, i_len, fd, i;
+    /* FIXME: make sure config_* is cancel-safe */
+    psz_password = var_InheritString( p_intf, "telnet-password" );
+    vlc_cleanup_push( free, psz_password );
 
-        /* if a new client wants to communicate */
-        fd = net_Accept( p_intf, p_sys->pi_fd, p_sys->i_clients > 0 ? 0 : -1 );
-        if( fd != -1 )
-        {
-            telnet_client_t *cl = malloc( sizeof( telnet_client_t ));
-            if( cl )
-            {
-                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 );
-            }
-            else
-            {
-                net_Close( fd );
-                continue;
-            }
-        }
-
-        /* to do a proper select */
-        FD_ZERO( &fds_read );
-        FD_ZERO( &fds_write );
+    for( ;; )
+    {
+        unsigned ncli = p_sys->i_clients;
+        struct pollfd ufd[ncli + nlisten];
 
-        for( i = 0 ; i < p_sys->i_clients ; i++ )
+        for (unsigned i = 0; i < ncli; i++)
         {
             telnet_client_t *cl = p_sys->clients[i];
 
+            ufd[i].fd = cl->fd;
             if( (cl->i_mode == WRITE_MODE_PWD) || (cl->i_mode == WRITE_MODE_CMD) )
-            {
-                FD_SET( cl->fd , &fds_write );
-            }
+                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 )
+
+        switch (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1))
         {
-            continue;
+            case -1:
+                if (net_errno != EINTR)
+                {
+                    msg_Err (p_intf, "network poll error");
+#ifndef WIN32
+                    pause ();  /* We are screwed! */
+#else
+                    abort (); /* We are even more screwed! (no pause() in win32) */
+#endif
+                    break;
+                }
+            case 0:
+                continue;
         }
 
+        int canc = vlc_savecancel ();
         /* 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))
             {
+            drop:
+                net_Close( cl->fd );
+                TAB_REMOVE( p_intf->p_sys->i_clients ,
+                            p_intf->p_sys->clients , cl );
+                free( cl->buffer_write );
+                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 )
@@ -322,10 +313,10 @@ static void Run( intf_thread_t *p_intf )
                     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) )
@@ -339,7 +330,7 @@ static void Run( intf_thread_t *p_intf )
                             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;
@@ -370,7 +361,7 @@ 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 )
@@ -379,18 +370,19 @@ static void Run( intf_thread_t *p_intf )
                                    cl->i_mode + 2 );
                 }
 
-                if( i_recv <= 0 )
+#ifdef WIN32
+                if( i_recv <= 0 && WSAGetLastError() == WSAEWOULDBLOCK )
                 {
-                    net_Close( cl->fd );
-                    TAB_REMOVE( p_intf->p_sys->i_clients ,
-                                p_intf->p_sys->clients , cl );
-                    free( cl );
+                    errno = EAGAIN;
                 }
+#endif
+                if( i_recv == 0 || ( i_recv == -1 && ( 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];
 
@@ -403,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 );
@@ -427,12 +419,45 @@ static void Run( intf_thread_t *p_intf )
                     net_Close( cl->fd );
                     TAB_REMOVE( p_intf->p_sys->i_clients ,
                                 p_intf->p_sys->clients , cl );
+                    free( cl->buffer_write );
                     free( cl );
                 }
                 else if( !strncmp( cl->buffer_read, "shutdown", 8 ) )
                 {
                     msg_Err( p_intf, "shutdown requested" );
-                    p_intf->p_libvlc->b_die = VLC_TRUE;
+                    libvlc_Quit( 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", "%s", psz_msg );
+                        Write_message( cl, message, NULL, WRITE_MODE_CMD );
+                        vlm_MessageDelete( message );
+                        free( psz_msg );
+                    }
                 }
                 else
                 {
@@ -446,30 +471,61 @@ static void Run( intf_thread_t *p_intf )
                     if( !strncmp( cl->buffer_read, "help", 4 ) )
                     {
                         vlm_message_t *p_my_help =
-                            vlm_MessageNew( "Telnet Specific Commands:", NULL );
+                            vlm_MessageSimpleNew( "Telnet Specific Commands:" );
                         vlm_MessageAdd( p_my_help,
-                            vlm_MessageNew( "logout, quit, exit" , NULL ) );
+                            vlm_MessageSimpleNew( "logout, quit, exit" ) );
                         vlm_MessageAdd( p_my_help,
-                            vlm_MessageNew( "shutdown" , NULL ) );
+                            vlm_MessageSimpleNew( "shutdown" ) );
+                        vlm_MessageAdd( p_my_help,
+                            vlm_MessageSimpleNew( "@moduleinstance command argument" ) );
                         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 = calloc( 1, sizeof( telnet_client_t ));
+            if (cl == NULL)
+            {
+                net_Close (fd);
+                continue;
+            }
+
+            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 );
+        }
+        vlc_restorecancel( canc );
     }
+    vlc_cleanup_run ();
 }
 
 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 )
@@ -509,7 +565,7 @@ static char *MessageToString( vlm_message_t *message, int i_level )
     }
 
     i_message += strlen( message->psz_name ) + i_level * sizeof( "    " ) + 1;
-    psz_message = malloc( i_message );
+    psz_message = xmalloc( i_message );
     *psz_message = 0;
     for( i = 0; i < i_level; i++ ) strcat( psz_message, "    " );
     strcat( psz_message, message->psz_name );
@@ -518,7 +574,7 @@ static char *MessageToString( vlm_message_t *message, int i_level )
     {
         i_message += sizeof( " : " ) + strlen( message->psz_value ) +
             sizeof( STRING_CR );
-        psz_message = realloc( psz_message, i_message );
+        psz_message = xrealloc( psz_message, i_message );
         strcat( psz_message, " : " );
         strcat( psz_message, message->psz_value );
         strcat( psz_message, STRING_CR );
@@ -526,7 +582,7 @@ static char *MessageToString( vlm_message_t *message, int i_level )
     else
     {
         i_message += sizeof( STRING_CR );
-        psz_message = realloc( psz_message, i_message );
+        psz_message = xrealloc( psz_message, i_message );
         strcat( psz_message, STRING_CR );
     }
 
@@ -536,7 +592,7 @@ static char *MessageToString( vlm_message_t *message, int i_level )
             MessageToString( message->child[i], i_level + 1 );
 
         i_message += strlen( child_message );
-        psz_message = realloc( psz_message, i_message );
+        psz_message = xrealloc( psz_message, i_message );
         strcat( psz_message, child_message );
         free( child_message );
     }