]> git.sesse.net Git - vlc/blobdiff - modules/control/http/http.h
Remove useless <dirent.h> check
[vlc] / modules / control / http / http.h
index 0557ab91ef2d9472c03a20e7c9ad82b378b26b93..ebf1efa4e9336fd42762627eac19f0d702864b5f 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * http.h: Headers for the HTTP interface
  *****************************************************************************
- * Copyright (C) 2001-2005 the VideoLAN team
+ * Copyright (C) 2001-2007 the VideoLAN team
  * $Id$
  *
  * Authors: Gildas Bazin <gbazin@netcourrier.com>
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
+#include <vlc_common.h>
 #include <stdlib.h>
 #include <strings.h>
-#include <ctype.h>
-#include <vlc/vlc.h>
 #include <vlc_interface.h>
 #include <vlc_playlist.h>
 
 #include <vlc_aout.h>
 #include <vlc_vout.h> /* for fullscreen */
 
-#include "vlc_httpd.h"
-#include "vlc_vlm.h"
-#include "vlc_tls.h"
-#include "vlc_acl.h"
-#include "vlc_charset.h"
-
-#ifdef HAVE_SYS_STAT_H
-#   include <sys/stat.h>
-#endif
-#ifdef HAVE_ERRNO_H
-#   include <errno.h>
-#endif
-#ifdef HAVE_FCNTL_H
-#   include <fcntl.h>
-#endif
+#include <vlc_httpd.h>
+#include <vlc_vlm.h>
+#include <vlc_network.h>
+#include <vlc_acl.h>
 
 #ifdef HAVE_UNISTD_H
 #   include <unistd.h>
 #   include <io.h>
 #endif
 
-#ifdef HAVE_DIRENT_H
-#   include <dirent.h>
-#endif
-
 /* stat() support for large files on win32 */
 #if defined( WIN32 ) && !defined( UNDER_CE )
 #   define stat _stati64
 /* File and directory functions */
 
 /** This function recursively parses a directory and adds all files */
-int E_(ParseDirectory)( intf_thread_t *p_intf, char *psz_root,
+int ParseDirectory( intf_thread_t *p_intf, char *psz_root,
                         char *psz_dir );
 /** This function loads a file into a buffer */
-int E_(FileLoad)( FILE *f, char **pp_data, int *pi_data );
-/** This function creates a suitable URL for a filename */
-char *E_(FileToUrl)( char *name, vlc_bool_t *pb_index );
+int FileLoad( FILE *f, char **pp_data, int *pi_data );
 /** This function returns the real path of a file or directory */
-char *E_(RealPath)( intf_thread_t *p_intf, const char *psz_src );
-
-/* Locale handling functions */
-
-/** This fuction converts a locale string to UTF-8 */
-char *E_(FromUTF8)( intf_thread_t *p_intf, char *psz_utf8 );
-/** This function converts an UTF-8 to locale */
-char *E_(ToUTF8)( intf_thread_t *p_intf, char *psz_local );
+char *RealPath( const char *psz_src );
 
 /** This command parses the "seek" command for the HTTP interface
  * and performs the requested action */
-void E_(HandleSeek)( intf_thread_t *p_intf, char *p_value );
+void HandleSeek( intf_thread_t *p_intf, char *p_value );
 
 /* URI Handling functions */
 
 /** This function extracts the value for a given argument name
  * from an HTTP request */
-char *E_(ExtractURIValue)( char *psz_uri, const char *psz_name,
-                             char *psz_value, int i_value_max );
+const char *ExtractURIValue( const char *restrict psz_uri,
+                           const char *restrict psz_name,
+                           char *restrict psz_value, size_t i_value_max );
+char *ExtractURIString( const char *restrict psz_uri,
+                            const char *restrict psz_name );
 /** \todo Describe this function */
-int E_(TestURIParam)( char *psz_uri, const char *psz_name );
+int TestURIParam( char *psz_uri, const char *psz_name );
 
 /** This function parses a MRL */
-input_item_t *E_(MRLParse)( intf_thread_t *, char *psz, char *psz_name );
+input_item_t *MRLParse( intf_thread_t *, const char *psz, char *psz_name );
 
 /** Return the first word from a string (works in-place) */
-char *E_(FirstWord)( char *psz, char *new );
+char *FirstWord( char *psz, char *new );
 
 /**@}*/
 
@@ -167,28 +145,28 @@ typedef struct mvar_s
 
 
 /** This function creates a new variable */
-mvar_t  *E_(mvar_New)( const char *name, const char *value );
+mvar_t  *mvar_New( const char *name, const char *value );
 /** This function deletes a variable */
-void     E_(mvar_Delete)( mvar_t *v );
+void     mvar_Delete( mvar_t *v );
 /** This function adds f to the children variables of v, at last position */
-void     E_(mvar_AppendVar)( mvar_t *v, mvar_t *f );
+void     mvar_AppendVar( mvar_t *v, mvar_t *f );
 /** This function duplicates a variable */
-mvar_t  *E_(mvar_Duplicate)( const mvar_t *v );
+mvar_t  *mvar_Duplicate( const mvar_t *v );
 /** This function adds f to the children variables of v, at fist position */
-void     E_(mvar_PushVar)( mvar_t *v, mvar_t *f );
+void     mvar_PushVar( mvar_t *v, mvar_t *f );
 /** This function removes f from the children variables of v */
-void     E_(mvar_RemoveVar)( mvar_t *v, mvar_t *f );
+void     mvar_RemoveVar( mvar_t *v, mvar_t *f );
 /** This function retrieves the child variable named "name" */
-mvar_t  *E_(mvar_GetVar)( mvar_t *s, const char *name );
+mvar_t  *mvar_GetVar( mvar_t *s, const char *name );
 /** This function retrieves the value of the child variable named "field" */
-char    *E_(mvar_GetValue)( mvar_t *v, char *field );
+const char *mvar_GetValue( mvar_t *v, const char *field );
 /** This function creates a variable with the given name and value and
  * adds it as first child of vars */
-void     E_(mvar_PushNewVar)( mvar_t *vars, const char *name,
+void     mvar_PushNewVar( mvar_t *vars, const char *name,
                               const char *value );
 /** This function creates a variable with the given name and value and
  * adds it as last child of vars */
-void     E_(mvar_AppendNewVar)( mvar_t *vars, const char *name,
+void     mvar_AppendNewVar( mvar_t *vars, const char *name,
                                 const char *value );
 /** @} */
 
@@ -202,31 +180,31 @@ void     E_(mvar_AppendNewVar)( mvar_t *vars, const char *name,
 
 /** This function creates a set variable which represents a series of integer
  * The arg parameter must be of the form "start[:stop[:step]]"  */
-mvar_t *E_(mvar_IntegerSetNew)( const char *name, const char *arg );
+mvar_t *mvar_IntegerSetNew( const char *name, const char *arg );
 
-/** This function creates a set variable with a list of VLC objects */
-mvar_t *E_(mvar_ObjectSetNew)( intf_thread_t *p_intf, char *name, char *arg );
+/** This function creates a set variable with a list of SD plugins */
+mvar_t *mvar_ServicesSetNew( intf_thread_t *p_intf, char *name );
 
 /** This function creates a set variable with the contents of the playlist */
-mvar_t *E_(mvar_PlaylistSetNew)( intf_thread_t *p_intf, char *name,
+mvar_t *mvar_PlaylistSetNew( intf_thread_t *p_intf, char *name,
                                  playlist_t *p_pl );
 /** This function creates a set variable with the contents of the Stream
  * and media info box */
-mvar_t *E_(mvar_InfoSetNew)( intf_thread_t *p_intf, char *name,
-                             input_thread_t *p_input );
+mvar_t *mvar_InfoSetNew( char *name, input_thread_t *p_input );
 /** This function creates a set variable with the input parameters */
-mvar_t *E_(mvar_InputVarSetNew)( intf_thread_t *p_intf, char *name,
+mvar_t *mvar_InputVarSetNew( intf_thread_t *p_intf, char *name,
                                  input_thread_t *p_input,
                                  const char *psz_variable );
 /** This function creates a set variable representing the files of the psz_dir
  * directory */
-mvar_t *E_(mvar_FileSetNew)( intf_thread_t *p_intf, char *name,
+mvar_t *mvar_FileSetNew( intf_thread_t *p_intf, char *name,
                              char *psz_dir );
 /** This function creates a set variable representing the VLM streams */
-mvar_t *E_(mvar_VlmSetNew)( char *name, vlm_t *vlm );
+mvar_t *mvar_VlmSetNew( char *name, vlm_t *vlm );
 
-/** This function converts the listing of a playlist node into a mvar set */
-void E_(PlaylistListNode)( intf_thread_t *p_intf, playlist_t *p_pl,
+/** This function converts the listing of a playlist node into a mvar set.
+ *  It must be entered WITH playlist lock! */
+void PlaylistListNode( intf_thread_t *p_intf, playlist_t *p_pl,
                            playlist_item_t *p_node, char *name, mvar_t *s,
                            int i_depth );
 
@@ -253,21 +231,21 @@ typedef struct
 } rpn_stack_t;
 
 /** This function creates the RPN evaluator stack */
-void E_(SSInit)( rpn_stack_t * );
+void SSInit( rpn_stack_t * );
 /** This function cleans the evaluator stack */
-void E_(SSClean)( rpn_stack_t * );
+void SSClean( rpn_stack_t * );
 /* Evaluate and execute the RPN Stack */
-void  E_(EvaluateRPN)( intf_thread_t *p_intf, mvar_t  *vars,
+void  EvaluateRPN( intf_thread_t *p_intf, mvar_t  *vars,
                        rpn_stack_t *st, char *exp );
 
 /* Push an operand on top of the RPN stack */
-void E_(SSPush)  ( rpn_stack_t *, const char * );
+void SSPush  ( rpn_stack_t *, const char * );
 /* Remove the first operand from the RPN Stack */
-char *E_(SSPop)  ( rpn_stack_t * );
+char *SSPop  ( rpn_stack_t * );
 /* Pushes an operand at a given position in the stack */
-void E_(SSPushN) ( rpn_stack_t *, int );
+void SSPushN ( rpn_stack_t *, int );
 /* Removes an operand at the given position in the stack */
-int  E_(SSPopN)  ( rpn_stack_t *, mvar_t  * );
+int  SSPopN  ( rpn_stack_t *, mvar_t  * );
 
 /**@}*/
 
@@ -296,35 +274,19 @@ typedef struct
     char *param2;       ///< Second parameter
 } macro_t;
 
-/** This function creates a macro from a <vlc ....> tag */
-int E_(MacroParse)( macro_t *m, char *psz_src );
-/** This function cleans a macro */
-void E_(MacroClean)( macro_t *m );
-
-/** This function returns the macro type identifier from its id= string value
- * It uses the StrToMacroTypeTab mapping array for this */
-int E_(StrToMacroType)( char *name );
-/** This function actually executes the macro */
-void E_(MacroDo)( httpd_file_sys_t *p_args, macro_t *m,
-                  char *p_request, int i_request, char **pp_data,
-                  int *pi_data, char **pp_dst );
-/** This function looks for macros in a string */
-char *E_(MacroSearch)( char *src, char *end,
-                   int i_mvlc, vlc_bool_t b_after );
-
 /** This function parses a file for macros */
-void E_(Execute)( httpd_file_sys_t *p_args,
+void Execute( httpd_file_sys_t *p_args,
                   char *p_request, int i_request,
                   char **pp_data, int *pi_data,
                   char **pp_dst,
-                  char *_src, char *_end );
+                  const char *_src, const char *_end );
 
 /**@}*/
 
 /**
  * Core stuff
  */
-/** \struct
+/** \struct httpd_file_sys_t
  * This structure represent a single HTML file to be parsed by the macros
  * handling engine */
 struct httpd_file_sys_t
@@ -337,14 +299,14 @@ struct httpd_file_sys_t
     char          *file;
     char          *name;
 
-    vlc_bool_t    b_html, b_handler;
+    bool    b_html, b_handler;
 
     /* inited for each access */
     rpn_stack_t   stack;
     mvar_t        *vars;
 };
 
-/** \struct
+/** \struct http_association_t
  * Structure associating an extension to an external program
  */
 typedef struct http_association_t
@@ -354,7 +316,7 @@ typedef struct http_association_t
     char                **ppsz_argv;
 } http_association_t;
 
-/** \struct
+/** \struct httpd_handler_sys_t
  * This structure represent a single CGI file to be parsed by the macros
  * handling engine */
 struct httpd_handler_sys_t
@@ -367,7 +329,7 @@ struct httpd_handler_sys_t
     http_association_t *p_association;
 };
 
-/** \struct
+/** \struct intf_sys_t
  * Internal service structure for the HTTP interface
  */
 struct intf_sys_t
@@ -379,25 +341,23 @@ struct intf_sys_t
 
     int                 i_handlers;
     http_association_t  **pp_handlers;
+    httpd_handler_t     *p_art_handler;
 
     playlist_t          *p_playlist;
     input_thread_t      *p_input;
     vlm_t               *p_vlm;
-    char                *psz_html_type;
-    char                *psz_charset;
-    vlc_iconv_t         iconv_from_utf8, iconv_to_utf8;
 
     char                *psz_address;
     unsigned short      i_port;
 };
 
 /** This function is the main HTTPD Callback used by the HTTP Interface */
-int E_(HttpCallback)( httpd_file_sys_t *p_args,
+int HttpCallback( httpd_file_sys_t *p_args,
                       httpd_file_t *,
                       uint8_t *p_request,
                       uint8_t **pp_data, int *pi_data );
 /** This function is the HTTPD Callback used for CGIs */
-int  E_(HandlerCallback)( httpd_handler_sys_t *p_args,
+int  HandlerCallback( httpd_handler_sys_t *p_args,
                           httpd_handler_t *p_handler, char *_p_url,
                           uint8_t *_p_request, int i_type,
                           uint8_t *_p_in, int i_in,