git.sesse.net Git - vlc/blob - modules/control/telnet.c

   1 /*****************************************************************************
   2  * telnet.c: VLM interface plugin
   3  *****************************************************************************
   4  * Copyright (C) 2000-2006 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
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_interface.h>
  36 #include <vlc_input.h>
  37
  38 #include <stdbool.h>
  39 #include <sys/stat.h>
  40
  41 #include <errno.h>
  42 #include <fcntl.h>
  43
  44 #ifdef HAVE_SYS_TIME_H
  45 #    include <sys/time.h>
  46 #endif
  47
  48 #ifdef HAVE_UNISTD_H
  49 #   include <unistd.h>
  50 #endif
  51 #ifdef HAVE_POLL
  52 #   include <poll.h>
  53 #endif
  54
  55 #include <vlc_network.h>
  56 #include <vlc_url.h>
  57 #include <vlc_vlm.h>
  58
  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
  63
  64 /* telnet commands */
  65 #define TEL_WILL    251
  66 #define TEL_WONT    252
  67 #define TEL_DO      253
  68 #define TEL_DONT    254
  69 #define TEL_IAC     255
  70 #define TEL_ECHO    1
  71
  72 /*****************************************************************************
  73  * Module descriptor
  74  *****************************************************************************/
  75 static int  Open ( vlc_object_t * );
  76 static void Close( vlc_object_t * );
  77
  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"
  91
  92 vlc_module_begin ()
  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 )
 106 vlc_module_end ()
 107
 108 /*****************************************************************************
 109  * Local prototypes.
 110  *****************************************************************************/
 111 static void Run( intf_thread_t * );
 112
 113 typedef struct
 114 {
 115     int        i_mode; /* read or write */
 116     int        fd;
 117     char       buffer_read[1000]; // 1000 byte per command should be sufficient
 118     char      *buffer_write;
 119     char      *p_buffer_read;
 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
 123
 124 } telnet_client_t;
 125
 126 static char *MessageToString( vlm_message_t *, int );
 127 static void Write_message( telnet_client_t *, vlm_message_t *, const char *, int );
 128
 129 struct intf_sys_t
 130 {
 131    telnet_client_t **clients;
 132    int             i_clients;
 133    int             *pi_fd;
 134    vlm_t           *mediatheque;
 135 };
 136
 137 /*
 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
 141  * precedence.
 142  * This code relies upon the fact the url.i_port is 0 if the :PORT
 143  * option is missing from --telnet-host.
 144  */
 145 static int getPort(intf_thread_t *p_intf, const vlc_url_t *url, int i_port)
 146 {
 147     if (i_port == TELNETPORT_DEFAULT && url->i_port != 0)
 148         i_port = url->i_port;
 149     if (url->i_port != 0 && url->i_port != i_port)
 150         // Print error if two different ports have been specified
 151         msg_Warn( p_intf, "ignoring port %d (using %d)", url->i_port, i_port );
 152     return i_port;
 153 }
 154
 155 /*****************************************************************************
 156  * Open: initialize dummy interface
 157  *****************************************************************************/
 158 static int Open( vlc_object_t *p_this )
 159 {
 160     intf_thread_t *p_intf = (intf_thread_t*) p_this;
 161     vlm_t *mediatheque;
 162     char *psz_address;
 163     vlc_url_t url;
 164     int i_telnetport;
 165
 166     if( !(mediatheque = vlm_New( p_intf )) )
 167     {
 168         msg_Err( p_intf, "cannot start VLM" );
 169         return VLC_EGENERIC;
 170     }
 171
 172     msg_Info( p_intf, "using the VLM interface plugin..." );
 173
 174     i_telnetport = var_InheritInteger( p_intf, "telnet-port" );
 175     psz_address  = var_InheritString( p_intf, "telnet-host" );
 176     vlc_UrlParse(&url, psz_address, 0);
 177     free( psz_address );
 178
 179     // There might be two ports given, resolve any potentially
 180     // conflict
 181     url.i_port = getPort(p_intf, &url, i_telnetport);
 182
 183     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
 184     if( !p_intf->p_sys )
 185     {
 186         vlm_Delete( mediatheque );
 187         vlc_UrlClean( &url );
 188         return VLC_ENOMEM;
 189     }
 190     if( ( p_intf->p_sys->pi_fd = net_ListenTCP( p_intf, url.psz_host, url.i_port ) ) == NULL )
 191     {
 192         msg_Err( p_intf, "cannot listen for telnet" );
 193         vlm_Delete( mediatheque );
 194         vlc_UrlClean( &url );
 195         free( p_intf->p_sys );
 196         return VLC_EGENERIC;
 197     }
 198     msg_Info( p_intf,
 199               "telnet interface started on interface %s %d",
 200               url.psz_host, url.i_port );
 201
 202     p_intf->p_sys->i_clients   = 0;
 203     p_intf->p_sys->clients     = NULL;
 204     p_intf->p_sys->mediatheque = mediatheque;
 205     p_intf->pf_run = Run;
 206
 207     vlc_UrlClean( &url );
 208     return VLC_SUCCESS;
 209 }
 210
 211 /*****************************************************************************
 212  * Close:
 213  *****************************************************************************/
 214 static void Close( vlc_object_t *p_this )
 215 {
 216     intf_thread_t *p_intf = (intf_thread_t*)p_this;
 217     intf_sys_t    *p_sys  = p_intf->p_sys;
 218     int i;
 219
 220     for( i = 0; i < p_sys->i_clients; i++ )
 221     {
 222         telnet_client_t *cl = p_sys->clients[i];
 223         net_Close( cl->fd );
 224         free( cl->buffer_write );
 225         free( cl );
 226     }
 227     free( p_sys->clients );
 228
 229     net_ListenClose( p_sys->pi_fd );
 230
 231     vlm_Delete( p_sys->mediatheque );
 232
 233     free( p_sys );
 234 }
 235
 236 /*****************************************************************************
 237  * Run: main loop
 238  *****************************************************************************/
 239 static void Run( intf_thread_t *p_intf )
 240 {
 241     intf_sys_t     *p_sys = p_intf->p_sys;
 242     char           *psz_password;
 243     unsigned        nlisten = 0;
 244
 245     for (const int *pfd = p_sys->pi_fd; *pfd != -1; pfd++)
 246         nlisten++; /* How many listening sockets do we have? */
 247
 248     /* FIXME: make sure config_* is cancel-safe */
 249     psz_password = var_InheritString( p_intf, "telnet-password" );
 250     vlc_cleanup_push( free, psz_password );
 251
 252     for( ;; )
 253     {
 254         unsigned ncli = p_sys->i_clients;
 255         struct pollfd ufd[ncli + nlisten];
 256
 257         for (unsigned i = 0; i < ncli; i++)
 258         {
 259             telnet_client_t *cl = p_sys->clients[i];
 260
 261             ufd[i].fd = cl->fd;
 262             if( (cl->i_mode == WRITE_MODE_PWD) || (cl->i_mode == WRITE_MODE_CMD) )
 263                 ufd[i].events = POLLOUT;
 264             else
 265                 ufd[i].events = POLLIN;
 266             ufd[i].revents = 0;
 267         }
 268
 269         for (unsigned i = 0; i < nlisten; i++)
 270         {
 271             ufd[ncli + i].fd = p_sys->pi_fd[i];
 272             ufd[ncli + i].events = POLLIN;
 273             ufd[ncli + i].revents = 0;
 274         }
 275
 276         switch (poll (ufd, sizeof (ufd) / sizeof (ufd[0]), -1))
 277         {
 278             case -1:
 279                 if (net_errno != EINTR)
 280                 {
 281                     msg_Err (p_intf, "network poll error");
 282 #ifndef WIN32
 283                     pause ();  /* We are screwed! */
 284 #else
 285                     abort (); /* We are even more screwed! (no pause() in win32) */
 286 #endif
 287                     break;
 288                 }
 289             case 0:
 290                 continue;
 291         }
 292
 293         int canc = vlc_savecancel ();
 294         /* check if there is something to do with the socket */
 295         for (unsigned i = 0; i < ncli; i++)
 296         {
 297             telnet_client_t *cl = p_sys->clients[i];
 298
 299             if (ufd[i].revents & (POLLERR|POLLHUP))
 300             {
 301             drop:
 302                 net_Close( cl->fd );
 303                 TAB_REMOVE( p_intf->p_sys->i_clients ,
 304                             p_intf->p_sys->clients , cl );
 305                 free( cl->buffer_write );
 306                 free( cl );
 307                 continue;
 308             }
 309
 310             if (ufd[i].revents & POLLOUT && (cl->i_buffer_write > 0))
 311             {
 312                 ssize_t i_len;
 313
 314                 i_len = send( cl->fd, cl->p_buffer_write ,
 315                               cl->i_buffer_write, 0 );
 316                 if( i_len > 0 )
 317                 {
 318                     cl->p_buffer_write += i_len;
 319                     cl->i_buffer_write -= i_len;
 320                 }
 321             }
 322             if (ufd[i].revents & POLLIN)
 323             {
 324                 bool end = false;
 325                 ssize_t i_recv;
 326
 327                 while( ((i_recv=recv( cl->fd, cl->p_buffer_read, 1, 0 )) > 0) &&
 328                        ((cl->p_buffer_read - cl->buffer_read) < 999) )
 329                 {
 330                     switch( cl->i_tel_cmd )
 331                     {
 332                     case 0:
 333                         switch( *(uint8_t *)cl->p_buffer_read )
 334                         {
 335                         case '\r':
 336                             break;
 337                         case '\n':
 338                             *cl->p_buffer_read = '\n';
 339                             end = true;
 340                             break;
 341                         case TEL_IAC: // telnet specific command
 342                             cl->i_tel_cmd = 1;
 343                             cl->p_buffer_read++;
 344                             break;
 345                         default:
 346                             cl->p_buffer_read++;
 347                             break;
 348                         }
 349                         break;
 350                     case 1:
 351                         switch( *(uint8_t *)cl->p_buffer_read )
 352                         {
 353                         case TEL_WILL: case TEL_WONT:
 354                         case TEL_DO: case TEL_DONT:
 355                             cl->i_tel_cmd++;
 356                             cl->p_buffer_read++;
 357                             break;
 358                         default:
 359                             cl->i_tel_cmd = 0;
 360                             cl->p_buffer_read--;
 361                             break;
 362                         }
 363                         break;
 364                     case 2:
 365                         cl->i_tel_cmd = 0;
 366                         cl->p_buffer_read -= 2;
 367                         break;
 368                     }
 369
 370                     if( end ) break;
 371                 }
 372
 373                 if( (cl->p_buffer_read - cl->buffer_read) == 999 )
 374                 {
 375                     Write_message( cl, NULL, "Line too long\r\n",
 376                                    cl->i_mode + 2 );
 377                 }
 378
 379 #ifdef WIN32
 380                 if( i_recv <= 0 && WSAGetLastError() == WSAEWOULDBLOCK )
 381                 {
 382                     errno = EAGAIN;
 383                 }
 384 #endif
 385                 if( i_recv == 0 || ( i_recv == -1 && ( end || errno != EAGAIN ) ) )
 386                     goto drop;
 387             }
 388         }
 389
 390         /* and now we should bidouille the data we received / send */
 391         for(int i = 0 ; i < p_sys->i_clients ; i++ )
 392         {
 393             telnet_client_t *cl = p_sys->clients[i];
 394
 395             if( cl->i_mode >= WRITE_MODE_PWD && cl->i_buffer_write == 0 )
 396             {
 397                // we have finished to send
 398                cl->i_mode -= 2; // corresponding READ MODE
 399             }
 400             else if( cl->i_mode == READ_MODE_PWD &&
 401                      *cl->p_buffer_read == '\n' )
 402             {
 403                 *cl->p_buffer_read = '\0';
 404                 if( !psz_password || !strcmp( psz_password, cl->buffer_read ) )
 405                 {
 406                     Write_message( cl, NULL, "\xff\xfc\x01\r\nWelcome, "
 407                                    "Master\r\n> ", WRITE_MODE_CMD );
 408                 }
 409                 else
 410                 {
 411                     /* wrong password */
 412                     Write_message( cl, NULL,
 413                                    "\r\nWrong password.\r\nPassword: ",
 414                                    WRITE_MODE_PWD );
 415                 }
 416             }
 417             else if( cl->i_mode == READ_MODE_CMD &&
 418                      *cl->p_buffer_read == '\n' )
 419             {
 420                 /* ok, here is a command line */
 421                 if( !strncmp( cl->buffer_read, "logout", 6 ) ||
 422                     !strncmp( cl->buffer_read, "quit", 4 )  ||
 423                     !strncmp( cl->buffer_read, "exit", 4 ) )
 424                 {
 425                     net_Close( cl->fd );
 426                     TAB_REMOVE( p_intf->p_sys->i_clients ,
 427                                 p_intf->p_sys->clients , cl );
 428                     free( cl->buffer_write );
 429                     free( cl );
 430                 }
 431                 else if( !strncmp( cl->buffer_read, "shutdown", 8 ) )
 432                 {
 433                     msg_Err( p_intf, "shutdown requested" );
 434                     libvlc_Quit( p_intf->p_libvlc );
 435                 }
 436                 else if( *cl->buffer_read == '@'
 437                           && strchr( cl->buffer_read, ' ' ) )
 438                 {
 439                     /* Module specific commands (use same syntax as in the
 440                      * rc interface) */
 441                     char *psz_name = cl->buffer_read + 1;
 442                     char *psz_cmd, *psz_arg, *psz_msg;
 443                     int i_ret;
 444
 445                     psz_cmd = strchr( cl->buffer_read, ' ' );
 446                     *psz_cmd = '\0';  psz_cmd++;
 447                     if( ( psz_arg = strchr( psz_cmd, '\n' ) ) ) *psz_arg = '\0';
 448                     if( ( psz_arg = strchr( psz_cmd, '\r' ) ) ) *psz_arg = '\0';
 449                     if( ( psz_arg = strchr( psz_cmd, ' ' ) )
 450                         && *psz_arg )
 451                     {
 452                         *psz_arg = '\0';
 453                         psz_arg++;
 454                     }
 455
 456                     i_ret = var_Command( p_intf, psz_name, psz_cmd, psz_arg,
 457                                          &psz_msg );
 458
 459                     if( psz_msg )
 460                     {
 461                         vlm_message_t *message;
 462                         message = vlm_MessageNew( "Module command", "%s", psz_msg );
 463                         Write_message( cl, message, NULL, WRITE_MODE_CMD );
 464                         vlm_MessageDelete( message );
 465                         free( psz_msg );
 466                     }
 467                 }
 468                 else
 469                 {
 470                     vlm_message_t *message;
 471
 472                     /* create a standard string */
 473                     *cl->p_buffer_read = '\0';
 474
 475                     vlm_ExecuteCommand( p_sys->mediatheque, cl->buffer_read,
 476                                         &message );
 477                     if( !strncmp( cl->buffer_read, "help", 4 ) )
 478                     {
 479                         vlm_message_t *p_my_help =
 480                             vlm_MessageSimpleNew( "Telnet Specific Commands:" );
 481                         vlm_MessageAdd( p_my_help,
 482                             vlm_MessageSimpleNew( "logout, quit, exit" ) );
 483                         vlm_MessageAdd( p_my_help,
 484                             vlm_MessageSimpleNew( "shutdown" ) );
 485                         vlm_MessageAdd( p_my_help,
 486                             vlm_MessageSimpleNew( "@moduleinstance command argument" ) );
 487                         vlm_MessageAdd( message, p_my_help );
 488                     }
 489                     Write_message( cl, message, NULL, WRITE_MODE_CMD );
 490                     vlm_MessageDelete( message );
 491                 }
 492             }
 493         }
 494
 495         /* handle new connections */
 496         for (unsigned i = 0; i < nlisten; i++)
 497         {
 498             int fd;
 499
 500             if (ufd[ncli + i].revents == 0)
 501                 continue;
 502
 503             fd = net_AcceptSingle (VLC_OBJECT(p_intf), ufd[ncli + i].fd);
 504             if (fd == -1)
 505                 continue;
 506
 507             telnet_client_t *cl = calloc( 1, sizeof( telnet_client_t ));
 508             if (cl == NULL)
 509             {
 510                 net_Close (fd);
 511                 continue;
 512             }
 513
 514             cl->i_tel_cmd = 0;
 515             cl->fd = fd;
 516             cl->buffer_write = NULL;
 517             cl->p_buffer_write = cl->buffer_write;
 518             Write_message( cl, NULL,
 519                            "Password: \xff\xfb\x01" , WRITE_MODE_PWD );
 520             TAB_APPEND( p_sys->i_clients, p_sys->clients, cl );
 521         }
 522         vlc_restorecancel( canc );
 523     }
 524     vlc_cleanup_run ();
 525 }
 526
 527 static void Write_message( telnet_client_t *client, vlm_message_t *message,
 528                            const char *string_message, int i_mode )
 529 {
 530     char *psz_message;
 531
 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 );
 535
 536     /* generate the psz_message string */
 537     if( message )
 538     {
 539         /* ok, look for vlm_message_t */
 540         psz_message = MessageToString( message, 0 );
 541     }
 542     else
 543     {
 544         /* it is a basic string_message */
 545         psz_message = strdup( string_message );
 546     }
 547
 548     client->buffer_write = client->p_buffer_write = psz_message;
 549     client->i_buffer_write = strlen( psz_message );
 550     client->i_mode = i_mode;
 551 }
 552
 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 )
 556 {
 557 #define STRING_CR "\r\n"
 558 #define STRING_TAIL "> "
 559
 560     char *psz_message;
 561     int i, i_message = sizeof( STRING_TAIL );
 562
 563     if( !message || !message->psz_name )
 564     {
 565         return strdup( STRING_CR STRING_TAIL );
 566     }
 567     else if( !i_level && !message->i_child && !message->psz_value  )
 568     {
 569         /* A command is successful. Don't write anything */
 570         return strdup( /*STRING_CR*/ STRING_TAIL );
 571     }
 572
 573     i_message += strlen( message->psz_name ) + i_level * sizeof( "    " ) + 1;
 574     psz_message = xmalloc( i_message );
 575     *psz_message = 0;
 576     for( i = 0; i < i_level; i++ ) strcat( psz_message, "    " );
 577     strcat( psz_message, message->psz_name );
 578
 579     if( message->psz_value )
 580     {
 581         i_message += sizeof( " : " ) + strlen( message->psz_value ) +
 582             sizeof( STRING_CR );
 583         psz_message = xrealloc( psz_message, i_message );
 584         strcat( psz_message, " : " );
 585         strcat( psz_message, message->psz_value );
 586         strcat( psz_message, STRING_CR );
 587     }
 588     else
 589     {
 590         i_message += sizeof( STRING_CR );
 591         psz_message = xrealloc( psz_message, i_message );
 592         strcat( psz_message, STRING_CR );
 593     }
 594
 595     for( i = 0; i < message->i_child; i++ )
 596     {
 597         char *child_message =
 598             MessageToString( message->child[i], i_level + 1 );
 599
 600         i_message += strlen( child_message );
 601         psz_message = xrealloc( psz_message, i_message );
 602         strcat( psz_message, child_message );
 603         free( child_message );
 604     }
 605
 606     if( i_level == 0 ) strcat( psz_message, STRING_TAIL );
 607
 608     return psz_message;
 609 }