b38bee2e192efe1c88401fe7945deec841c9d682
[vlc.git] / include / vlc_url.h
1 /*****************************************************************************
2  * vlc_url.h: URL related macros
3  *****************************************************************************
4  * Copyright (C) 2002-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *          RĂ©mi Denis-Courmont <rem # 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 #if !defined( __LIBVLC__ )
26   #error You are not libvlc or one of its plugins. You cannot include this file
27 #endif
28
29 #ifndef __VLC_URL_H
30 # define __VLC_URL_H
31
32 typedef struct
33 {
34     char *psz_protocol;
35     char *psz_username;
36     char *psz_password;
37     char *psz_host;
38     int  i_port;
39
40     char *psz_path;
41
42     char *psz_option;
43
44     char *psz_buffer; /* to be freed */
45 } vlc_url_t;
46
47 VLC_EXPORT( char *, unescape_URI_duplicate, ( const char *psz ) );
48 VLC_EXPORT( void, unescape_URI, ( char *psz ) );
49 VLC_EXPORT( char *, decode_URI_duplicate, ( const char *psz ) );
50 VLC_EXPORT( void, decode_URI, ( char *psz ) );
51 VLC_EXPORT( char *, encode_URI_component, ( const char *psz ) );
52
53 /*****************************************************************************
54  * vlc_UrlParse:
55  *****************************************************************************
56  * option : if != 0 then path is split at this char
57  *
58  * format [protocol://[login[:password]@]][host[:port]]/path[OPTIONoption]
59  *****************************************************************************/
60 static inline void vlc_UrlParse( vlc_url_t *url, const char *psz_url,
61                                  char option )
62 {
63     char *psz_dup;
64     char *psz_parse;
65     char *p;
66     char *p2;
67
68     url->psz_protocol = NULL;
69     url->psz_username = NULL;
70     url->psz_password = NULL;
71     url->psz_host     = NULL;
72     url->i_port       = 0;
73     url->psz_path     = NULL;
74     url->psz_option   = NULL;
75
76     if( psz_url == NULL )
77     {
78         url->psz_buffer = NULL;
79         return;
80     }
81     url->psz_buffer = psz_parse = psz_dup = strdup( psz_url );
82
83     /* Search a valid protocol */
84     p  = strstr( psz_parse, ":/" );
85     if( p != NULL )
86     {
87         char *p2;
88         for( p2 = psz_parse; p2 < p; p2++ )
89         {
90 #define I(i,a,b) ( (a) <= (i) && (i) <= (b) )
91             if( !I(*p2, 'a', 'z' ) && !I(*p2, 'A', 'Z') && !I(*p2, '0', '9') && *p2 != '+' && *p2 != '-' && *p2 != '.' )
92             {
93                 p = NULL;
94                 break;
95             }
96 #undef I
97         }
98     }
99
100     if( p != NULL )
101     {
102         /* we have a protocol */
103
104         /* skip :// */
105         *p++ = '\0';
106         if( p[1] == '/' )
107             p += 2;
108         url->psz_protocol = psz_parse;
109         psz_parse = p;
110     }
111     p = strchr( psz_parse, '@' );
112     p2 = strchr( psz_parse, '/' );
113     if( p != NULL && ( p2 != NULL ? p < p2 : 1 ) )
114     {
115         /* We have a login */
116         url->psz_username = psz_parse;
117         *p++ = '\0';
118
119         psz_parse = strchr( psz_parse, ':' );
120         if( psz_parse != NULL )
121         {
122             /* We have a password */
123             *psz_parse++ = '\0';
124             url->psz_password = psz_parse;
125             decode_URI( url->psz_password );
126         }
127         decode_URI( url->psz_username );
128         psz_parse = p;
129     }
130
131     p = strchr( psz_parse, '/' );
132     if( !p || psz_parse < p )
133     {
134         char *p2;
135
136         /* We have a host[:port] */
137         url->psz_host = strdup( psz_parse );
138         if( p )
139         {
140             url->psz_host[p - psz_parse] = '\0';
141         }
142
143         if( *url->psz_host == '[' )
144         {
145             /* Ipv6 address */
146             p2 = strchr( url->psz_host, ']' );
147             if( p2 )
148             {
149                 p2 = strchr( p2, ':' );
150             }
151         }
152         else
153         {
154             p2 = strchr( url->psz_host, ':' );
155         }
156         if( p2 )
157         {
158             *p2++ = '\0';
159             url->i_port = atoi( p2 );
160         }
161     }
162     psz_parse = p;
163
164     /* Now parse psz_path and psz_option */
165     if( psz_parse )
166     {
167         url->psz_path = psz_parse;
168         if( option != '\0' )
169         {
170             p = strchr( url->psz_path, option );
171             if( p )
172             {
173                 *p++ = '\0';
174                 url->psz_option = p;
175             }
176         }
177     }
178 }
179
180 /*****************************************************************************
181  * vlc_UrlClean:
182  *****************************************************************************/
183 static inline void vlc_UrlClean( vlc_url_t *url )
184 {
185     if( url->psz_buffer ) free( url->psz_buffer );
186     if( url->psz_host )   free( url->psz_host );
187
188     url->psz_protocol = NULL;
189     url->psz_username = NULL;
190     url->psz_password = NULL;
191     url->psz_host     = NULL;
192     url->i_port       = 0;
193     url->psz_path     = NULL;
194     url->psz_option   = NULL;
195
196     url->psz_buffer   = NULL;
197 }
198
199
200 static inline char *vlc_UrlEncode( const char *psz_url )
201 {
202     /* FIXME: do not encode / : ? and & _when_ not needed */
203     return encode_URI_component( psz_url );
204 }
205
206 #include <ctype.h>
207
208 /** Check whether a given string is not a valid URL and must hence be
209  *  encoded */
210 static inline int vlc_UrlIsNotEncoded( const char *psz_url )
211 {
212     const char *ptr;
213
214     for( ptr = psz_url; *ptr; ptr++ )
215     {
216         char c = *ptr;
217
218         if( c == '%' )
219         {
220             if( !isxdigit( ptr[1] ) || !isxdigit( ptr[2] ) )
221                 return 1; /* not encoded */
222             ptr += 2;
223         }
224         else
225         if(  ( (unsigned char)( c - 'a' ) < 26 )
226           || ( (unsigned char)( c - 'A' ) < 26 )
227           || ( (unsigned char)( c - '0' ) < 10 )
228           || ( strchr( "-_.", c ) != NULL ) )
229             return 1;
230     }
231     return 0; /* looks fine - but maybe it is not encoded */
232 }
233
234
235 #endif