]> git.sesse.net Git - vlc/blob - include/vlc_httpd.h
Display IP of client in debug
[vlc] / include / vlc_httpd.h
1 /*****************************************************************************
2  * vlc_httpd.h: builtin HTTP/RTSP server.
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef _VLC_HTTPD_H
25 #define _VLC_HTTPD_H 1
26
27 /* NEVER touch that, it's here only because src/misc/objects.c
28  * need sizeof(httpd_t) */
29 struct httpd_t
30 {
31     VLC_COMMON_MEMBERS
32
33     int          i_host;
34     httpd_host_t **host;
35 };
36
37 enum
38 {
39     HTTPD_MSG_NONE,
40
41     /* answer */
42     HTTPD_MSG_ANSWER,
43
44     /* channel communication */
45     HTTPD_MSG_CHANNEL,
46
47     /* http request */
48     HTTPD_MSG_GET,
49     HTTPD_MSG_HEAD,
50     HTTPD_MSG_POST,
51
52     /* rtsp request */
53     HTTPD_MSG_OPTIONS,
54     HTTPD_MSG_DESCRIBE,
55     HTTPD_MSG_SETUP,
56     HTTPD_MSG_PLAY,
57     HTTPD_MSG_PAUSE,
58     HTTPD_MSG_TEARDOWN,
59
60     /* just to track the count of MSG */
61     HTTPD_MSG_MAX
62 };
63
64 /* each host run in his own thread */
65 struct httpd_host_t
66 {
67     VLC_COMMON_MEMBERS
68
69     httpd_t     *httpd;
70
71     /* ref count */
72     int         i_ref;
73
74     /* address/port and socket for listening at connections */
75     char        *psz_hostname;
76     int         i_port;
77     int         *fd;
78
79     vlc_mutex_t lock;
80
81     /* all registered url (becarefull that 2 httpd_url_t could point at the same url)
82      * This will slow down the url research but make my live easier
83      * All url will have their cb trigger, but only the first one can answer
84      * */
85     int         i_url;
86     httpd_url_t **url;
87
88     int            i_client;
89     httpd_client_t **client;
90
91     /* TLS data */
92     tls_server_t *p_tls;
93 };
94
95
96
97 enum
98 {
99     HTTPD_PROTO_NONE,
100     HTTPD_PROTO_HTTP,
101     HTTPD_PROTO_RTSP,
102 };
103
104 struct httpd_message_t
105 {
106     httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
107
108     int     i_type;
109     int     i_proto;
110     int     i_version;
111
112     /* for an answer */
113     int     i_status;
114     char    *psz_status;
115
116     /* for a query */
117     char    *psz_url;
118     /* FIXME find a clean way to handle GET(psz_args)
119        and POST(body) through the same code */
120     uint8_t *psz_args;
121
122     /* for rtp over rtsp */
123     int     i_channel;
124
125     /* options */
126     int     i_name;
127     char    **name;
128     int     i_value;
129     char    **value;
130
131     /* body */
132     int64_t i_body_offset;
133     int     i_body;
134     uint8_t *p_body;
135
136 };
137
138 /* create a new host */
139 VLC_EXPORT( httpd_host_t *, httpd_HostNew, ( vlc_object_t *, const char *psz_host, int i_port ) );
140 VLC_EXPORT( httpd_host_t *, httpd_TLSHostNew, ( vlc_object_t *, const char *, int, const char *, const char *, const char *, const char * ) );
141
142 /* delete a host */
143 VLC_EXPORT( void,           httpd_HostDelete, ( httpd_host_t * ) );
144
145 /* register a new url */
146 VLC_EXPORT( httpd_url_t *,  httpd_UrlNew, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
147 VLC_EXPORT( httpd_url_t *,  httpd_UrlNewUnique, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
148 /* register callback on a url */
149 VLC_EXPORT( int,            httpd_UrlCatch, ( httpd_url_t *, int i_msg, httpd_callback_t, httpd_callback_sys_t * ) );
150 /* delete an url */
151 VLC_EXPORT( void,           httpd_UrlDelete, ( httpd_url_t * ) );
152
153 /* Default client mode is FILE, use these to change it */
154 VLC_EXPORT( void,           httpd_ClientModeStream, ( httpd_client_t *cl ) );
155 VLC_EXPORT( void,           httpd_ClientModeBidir, ( httpd_client_t *cl ) );
156 VLC_EXPORT( char*,          httpd_ClientIP, ( const httpd_client_t *cl, char *psz_ip ) );
157 VLC_EXPORT( char*,          httpd_ServerIP, ( const httpd_client_t *cl, char *psz_ip ) );
158
159 /* High level */
160
161 VLC_EXPORT( httpd_file_t *, httpd_FileNew, ( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl, httpd_file_callback_t pf_fill, httpd_file_sys_t * ) );
162 VLC_EXPORT( void,           httpd_FileDelete, ( httpd_file_t * ) );
163
164
165 VLC_EXPORT( httpd_handler_t *, httpd_HandlerNew, ( httpd_host_t *, const char *psz_url, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl, httpd_handler_callback_t pf_fill, httpd_handler_sys_t * ) );
166 VLC_EXPORT( void,           httpd_HandlerDelete, ( httpd_handler_t * ) );
167
168
169 VLC_EXPORT( httpd_redirect_t *, httpd_RedirectNew, ( httpd_host_t *, const char *psz_url_dst, const char *psz_url_src ) );
170 VLC_EXPORT( void,               httpd_RedirectDelete, ( httpd_redirect_t * ) );
171
172
173 VLC_EXPORT( httpd_stream_t *, httpd_StreamNew,    ( httpd_host_t *, const char *psz_url, const char *psz_mime, const char *psz_user, const char *psz_password, const vlc_acl_t *p_acl ) );
174 VLC_EXPORT( void,             httpd_StreamDelete, ( httpd_stream_t * ) );
175 VLC_EXPORT( int,              httpd_StreamHeader, ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
176 VLC_EXPORT( int,              httpd_StreamSend,   ( httpd_stream_t *, uint8_t *p_data, int i_data ) );
177
178
179 /* Msg functions facilities */
180 VLC_EXPORT( void,         httpd_MsgInit, ( httpd_message_t * )  );
181 VLC_EXPORT( void,         httpd_MsgAdd, ( httpd_message_t *, char *psz_name, char *psz_value, ... ) );
182 /* return "" if not found. The string is not allocated */
183 VLC_EXPORT( char *,       httpd_MsgGet, ( httpd_message_t *, char *psz_name ) );
184 VLC_EXPORT( void,         httpd_MsgClean, ( httpd_message_t * ) );
185
186 #endif /* _VLC_HTTPD_H */