git.sesse.net Git - vlc/blob - modules/control/http/http.h

   1 /*****************************************************************************
   2  * http.h: Headers for the HTTP interface
   3  *****************************************************************************
   4  * Copyright (C) 2001-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *          Christophe Massiot <massiot@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef _HTTP_H_
  27 #define _HTTP_H_
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #include <stdlib.h>
  33 #include <strings.h>
  34 #include <ctype.h>
  35 #include <vlc/vlc.h>
  36 #include <vlc_interface.h>
  37 #include <vlc_playlist.h>
  38
  39 #include <vlc_aout.h>
  40 #include <vlc_vout.h> /* for fullscreen */
  41
  42 #include "vlc_httpd.h"
  43 #include "vlc_vlm.h"
  44 #include "vlc_tls.h"
  45 #include "vlc_acl.h"
  46 #include "vlc_charset.h"
  47
  48 #ifdef HAVE_SYS_STAT_H
  49 #   include <sys/stat.h>
  50 #endif
  51 #ifdef HAVE_ERRNO_H
  52 #   include <errno.h>
  53 #endif
  54 #ifdef HAVE_FCNTL_H
  55 #   include <fcntl.h>
  56 #endif
  57
  58 #ifdef HAVE_UNISTD_H
  59 #   include <unistd.h>
  60 #elif defined( WIN32 ) && !defined( UNDER_CE )
  61 #   include <io.h>
  62 #endif
  63
  64 #ifdef HAVE_DIRENT_H
  65 #   include <dirent.h>
  66 #endif
  67
  68 /* stat() support for large files on win32 */
  69 #if defined( WIN32 ) && !defined( UNDER_CE )
  70 #   define stat _stati64
  71 #endif
  72
  73 /** \defgroup http_intf HTTP Interface
  74  * This is the HTTP remote control interface. It is fully customizable
  75  * by writing HTML pages using custom <vlc> tags.
  76  *
  77  * These tags use so-called macros.
  78  *
  79  * These macros can manipulate variables. For more complex operations,
  80  * a custom RPN evaluator with many built-in functions is provided.
  81  * @{
  82  */
  83
  84 /*****************************************************************************
  85  * Local defines
  86  *****************************************************************************/
  87 #define MAX_DIR_SIZE 2560
  88 #define STACK_MAX 100        //< Maximum RPN stack size
  89
  90
  91 /*****************************************************************************
  92  * Utility functions
  93  *****************************************************************************/
  94
  95 /** \defgroup http_utils Utilities
  96  * \ingroup http_intf
  97  * Utilities
  98  * @{
  99  */
 100
 101 /* File and directory functions */
 102
 103 /** This function recursively parses a directory and adds all files */
 104 int E_(ParseDirectory)( intf_thread_t *p_intf, char *psz_root,
 105                         char *psz_dir );
 106 /** This function loads a file into a buffer */
 107 int E_(FileLoad)( FILE *f, char **pp_data, int *pi_data );
 108 /** This function creates a suitable URL for a filename */
 109 char *E_(FileToUrl)( char *name, vlc_bool_t *pb_index );
 110 /** This function returns the real path of a file or directory */
 111 char *E_(RealPath)( intf_thread_t *p_intf, const char *psz_src );
 112
 113 /* Locale handling functions */
 114
 115 /** This fuction converts a locale string to UTF-8 */
 116 char *E_(FromUTF8)( intf_thread_t *p_intf, char *psz_utf8 );
 117 /** This function converts an UTF-8 to locale */
 118 char *E_(ToUTF8)( intf_thread_t *p_intf, char *psz_local );
 119
 120 /** This command parses the "seek" command for the HTTP interface
 121  * and performs the requested action */
 122 void E_(HandleSeek)( intf_thread_t *p_intf, char *p_value );
 123
 124 /* URI Handling functions */
 125
 126 /** This function extracts the value for a given argument name
 127  * from an HTTP request */
 128 char *E_(ExtractURIValue)( char *psz_uri, const char *psz_name,
 129                              char *psz_value, int i_value_max );
 130 /** \todo Describe this function */
 131 int E_(TestURIParam)( char *psz_uri, const char *psz_name );
 132
 133 /** This function parses a MRL */
 134 input_item_t *E_(MRLParse)( intf_thread_t *, char *psz, char *psz_name );
 135
 136 /** Return the first word from a string (works in-place) */
 137 char *E_(FirstWord)( char *psz, char *new );
 138
 139 /**@}*/
 140
 141 /****************************************************************************
 142  * Variable handling functions
 143  ****************************************************************************/
 144
 145 /** \defgroup http_vars Macro variables
 146  * \ingroup http_intf
 147  * These variables can be used in the <vlc> macros and in the RPN evaluator.
 148  * The variables make a tree: each variable can have an arbitrary
 149  * number of "children" variables.
 150  * A number of helper functions are provided to manipulate the main variable
 151  * structure
 152  * @{
 153  */
 154
 155 /**
 156  * \struct mvar_t
 157  * This structure defines a macro variable
 158  */
 159 typedef struct mvar_s
 160 {
 161     char *name;                 ///< Variable name
 162     char *value;                ///< Variable value
 163
 164     int           i_field;      ///< Number of children variables
 165     struct mvar_s **field;      ///< Children variables array
 166 } mvar_t;
 167
 168
 169 /** This function creates a new variable */
 170 mvar_t  *E_(mvar_New)( const char *name, const char *value );
 171 /** This function deletes a variable */
 172 void     E_(mvar_Delete)( mvar_t *v );
 173 /** This function adds f to the children variables of v, at last position */
 174 void     E_(mvar_AppendVar)( mvar_t *v, mvar_t *f );
 175 /** This function duplicates a variable */
 176 mvar_t  *E_(mvar_Duplicate)( const mvar_t *v );
 177 /** This function adds f to the children variables of v, at fist position */
 178 void     E_(mvar_PushVar)( mvar_t *v, mvar_t *f );
 179 /** This function removes f from the children variables of v */
 180 void     E_(mvar_RemoveVar)( mvar_t *v, mvar_t *f );
 181 /** This function retrieves the child variable named "name" */
 182 mvar_t  *E_(mvar_GetVar)( mvar_t *s, const char *name );
 183 /** This function retrieves the value of the child variable named "field" */
 184 char    *E_(mvar_GetValue)( mvar_t *v, char *field );
 185 /** This function creates a variable with the given name and value and
 186  * adds it as first child of vars */
 187 void     E_(mvar_PushNewVar)( mvar_t *vars, const char *name,
 188                               const char *value );
 189 /** This function creates a variable with the given name and value and
 190  * adds it as last child of vars */
 191 void     E_(mvar_AppendNewVar)( mvar_t *vars, const char *name,
 192                                 const char *value );
 193 /** @} */
 194
 195 /** \defgroup http_sets Sets *
 196  * \ingroup http_intf
 197  * Sets are an application of the macro variables. There are a number of
 198  * predefined functions that will give you variables whose children represent
 199  * VLC internal data (playlist, stream info, ...)
 200  * @{
 201  */
 202
 203 /** This function creates a set variable which represents a series of integer
 204  * The arg parameter must be of the form "start[:stop[:step]]"  */
 205 mvar_t *E_(mvar_IntegerSetNew)( const char *name, const char *arg );
 206
 207 /** This function creates a set variable with a list of VLC objects */
 208 mvar_t *E_(mvar_ObjectSetNew)( intf_thread_t *p_intf, char *name, char *arg );
 209
 210 /** This function creates a set variable with the contents of the playlist */
 211 mvar_t *E_(mvar_PlaylistSetNew)( intf_thread_t *p_intf, char *name,
 212                                  playlist_t *p_pl );
 213 /** This function creates a set variable with the contents of the Stream
 214  * and media info box */
 215 mvar_t *E_(mvar_InfoSetNew)( intf_thread_t *p_intf, char *name,
 216                              input_thread_t *p_input );
 217 /** This function creates a set variable with the input parameters */
 218 mvar_t *E_(mvar_InputVarSetNew)( intf_thread_t *p_intf, char *name,
 219                                  input_thread_t *p_input,
 220                                  const char *psz_variable );
 221 /** This function creates a set variable representing the files of the psz_dir
 222  * directory */
 223 mvar_t *E_(mvar_FileSetNew)( intf_thread_t *p_intf, char *name,
 224                              char *psz_dir );
 225 /** This function creates a set variable representing the VLM streams */
 226 mvar_t *E_(mvar_VlmSetNew)( char *name, vlm_t *vlm );
 227
 228 /** This function converts the listing of a playlist node into a mvar set */
 229 void E_(PlaylistListNode)( intf_thread_t *p_intf, playlist_t *p_pl,
 230                            playlist_item_t *p_node, char *name, mvar_t *s,
 231                            int i_depth );
 232
 233 /**@}*/
 234
 235 /*****************************************************************************
 236  * RPN Evaluator
 237  *****************************************************************************/
 238
 239 /** \defgroup http_rpn RPN Evaluator
 240  * \ingroup http_intf
 241  * @{
 242  */
 243
 244 /**
 245  * \struct rpn_stack_t
 246  * This structure represents a stack of RPN commands for the HTTP interface
 247  * It is attached to a request
 248  */
 249 typedef struct
 250 {
 251     char *stack[STACK_MAX];
 252     int  i_stack;
 253 } rpn_stack_t;
 254
 255 /** This function creates the RPN evaluator stack */
 256 void E_(SSInit)( rpn_stack_t * );
 257 /** This function cleans the evaluator stack */
 258 void E_(SSClean)( rpn_stack_t * );
 259 /* Evaluate and execute the RPN Stack */
 260 void  E_(EvaluateRPN)( intf_thread_t *p_intf, mvar_t  *vars,
 261                        rpn_stack_t *st, char *exp );
 262
 263 /* Push an operand on top of the RPN stack */
 264 void E_(SSPush)  ( rpn_stack_t *, const char * );
 265 /* Remove the first operand from the RPN Stack */
 266 char *E_(SSPop)  ( rpn_stack_t * );
 267 /* Pushes an operand at a given position in the stack */
 268 void E_(SSPushN) ( rpn_stack_t *, int );
 269 /* Removes an operand at the given position in the stack */
 270 int  E_(SSPopN)  ( rpn_stack_t *, mvar_t  * );
 271
 272 /**@}*/
 273
 274
 275 /****************************************************************************
 276  * Macro handling (<vlc ... stuff)
 277  ****************************************************************************/
 278
 279 /** \defgroup http_macros <vlc> Macros Handling
 280  * \ingroup http_intf
 281  * A macro is a code snippet in the HTML page looking like
 282  * <vlc id="macro_id" param1="value1" param2="value2">
 283  * Macros string ids are mapped to macro types, and specific handling code
 284  * must be written for each macro type
 285  * @{
 286  */
 287
 288
 289 /** \struct macro_t
 290  * This structure represents a HTTP Interface macro.
 291  */
 292 typedef struct
 293 {
 294     char *id;           ///< Macro ID string
 295     char *param1;       ///< First parameter
 296     char *param2;       ///< Second parameter
 297 } macro_t;
 298
 299 /** This function creates a macro from a <vlc ....> tag */
 300 int E_(MacroParse)( macro_t *m, char *psz_src );
 301 /** This function cleans a macro */
 302 void E_(MacroClean)( macro_t *m );
 303
 304 /** This function returns the macro type identifier from its id= string value
 305  * It uses the StrToMacroTypeTab mapping array for this */
 306 int E_(StrToMacroType)( char *name );
 307 /** This function actually executes the macro */
 308 void E_(MacroDo)( httpd_file_sys_t *p_args, macro_t *m,
 309                   char *p_request, int i_request, char **pp_data,
 310                   int *pi_data, char **pp_dst );
 311 /** This function looks for macros in a string */
 312 char *E_(MacroSearch)( char *src, char *end,
 313                    int i_mvlc, vlc_bool_t b_after );
 314
 315 /** This function parses a file for macros */
 316 void E_(Execute)( httpd_file_sys_t *p_args,
 317                   char *p_request, int i_request,
 318                   char **pp_data, int *pi_data,
 319                   char **pp_dst,
 320                   char *_src, char *_end );
 321
 322 /**@}*/
 323
 324 /**
 325  * Core stuff
 326  */
 327 /** \struct
 328  * This structure represent a single HTML file to be parsed by the macros
 329  * handling engine */
 330 struct httpd_file_sys_t
 331 {
 332     intf_thread_t    *p_intf;
 333     httpd_file_t     *p_file;
 334     httpd_redirect_t *p_redir;
 335     httpd_redirect_t *p_redir2;
 336
 337     char          *file;
 338     char          *name;
 339
 340     vlc_bool_t    b_html, b_handler;
 341
 342     /* inited for each access */
 343     rpn_stack_t   stack;
 344     mvar_t        *vars;
 345 };
 346
 347 /** \struct
 348  * Structure associating an extension to an external program
 349  */
 350 typedef struct http_association_t
 351 {
 352     char                *psz_ext;
 353     int                 i_argc;
 354     char                **ppsz_argv;
 355 } http_association_t;
 356
 357 /** \struct
 358  * This structure represent a single CGI file to be parsed by the macros
 359  * handling engine */
 360 struct httpd_handler_sys_t
 361 {
 362     httpd_file_sys_t file;
 363
 364     /* HACK ALERT: this is added below so that casting httpd_handler_sys_t
 365      * to httpd_file_sys_t works */
 366     httpd_handler_t  *p_handler;
 367     http_association_t *p_association;
 368 };
 369
 370 /** \struct
 371  * Internal service structure for the HTTP interface
 372  */
 373 struct intf_sys_t
 374 {
 375     httpd_host_t        *p_httpd_host;
 376
 377     int                 i_files;
 378     httpd_file_sys_t    **pp_files;
 379
 380     int                 i_handlers;
 381     http_association_t  **pp_handlers;
 382
 383     playlist_t          *p_playlist;
 384     input_thread_t      *p_input;
 385     vlm_t               *p_vlm;
 386     char                *psz_html_type;
 387     char                *psz_charset;
 388     vlc_iconv_t         iconv_from_utf8, iconv_to_utf8;
 389
 390     char                *psz_address;
 391     unsigned short      i_port;
 392 };
 393
 394 /** This function is the main HTTPD Callback used by the HTTP Interface */
 395 int E_(HttpCallback)( httpd_file_sys_t *p_args,
 396                       httpd_file_t *,
 397                       uint8_t *p_request,
 398                       uint8_t **pp_data, int *pi_data );
 399 /** This function is the HTTPD Callback used for CGIs */
 400 int  E_(HandlerCallback)( httpd_handler_sys_t *p_args,
 401                           httpd_handler_t *p_handler, char *_p_url,
 402                           uint8_t *_p_request, int i_type,
 403                           uint8_t *_p_in, int i_in,
 404                           char *psz_remote_addr, char *psz_remote_host,
 405                           uint8_t **_pp_data, int *pi_data );
 406 /**@}*/
 407
 408 #endif
 409