url: remove vlc_UrlParse() option parameter
[vlc.git] / src / text / url.c
1 /*****************************************************************************
2  * url.c: URL related functions
3  *****************************************************************************
4  * Copyright (C) 2006 VLC authors and VideoLAN
5  * Copyright (C) 2008-2012 Rémi Denis-Courmont
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as published by
9  * the Free Software Foundation; either version 2.1 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20  *****************************************************************************/
21
22 #ifdef HAVE_CONFIG_H
23 # include "config.h"
24 #endif
25
26 #include <errno.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <assert.h>
30 #ifdef _WIN32
31 # include <io.h>
32 #endif
33
34 #include <vlc_common.h>
35 #include <vlc_url.h>
36 #include <vlc_fs.h>
37 #include <ctype.h>
38
39 /**
40  * Decodes an encoded URI component. See also decode_URI().
41  * \return decoded string allocated on the heap, or NULL on error.
42  */
43 char *decode_URI_duplicate (const char *str)
44 {
45     char *buf = strdup (str);
46     if (decode_URI (buf) == NULL)
47     {
48         free (buf);
49         buf = NULL;
50     }
51     return buf;
52 }
53
54 /**
55  * Decodes an encoded URI component in place.
56  * <b>This function does NOT decode entire URIs.</b> Instead, it decodes one
57  * component at a time (e.g. host name, directory, file name).
58  * Decoded URIs do not exist in the real world (see RFC3986 §2.4).
59  * Complete URIs are always "encoded" (or they are syntaxically invalid).
60  *
61  * Note that URI encoding is different from Javascript escaping. Especially,
62  * white spaces and Unicode non-ASCII code points are encoded differently.
63  *
64  * \param str nul-terminated URI component to decode
65  * \return str on success, NULL if it was not properly encoded
66  */
67 char *decode_URI (char *str)
68 {
69     char *in = str, *out = str;
70     if (in == NULL)
71         return NULL;
72
73     char c;
74     while ((c = *(in++)) != '\0')
75     {
76         if (c == '%')
77         {
78             char hex[3];
79
80             if (!(hex[0] = *(in++)) || !(hex[1] = *(in++)))
81                 return NULL;
82             hex[2] = '\0';
83             *(out++) = strtoul (hex, NULL, 0x10);
84         }
85         else
86             *(out++) = c;
87     }
88     *out = '\0';
89     return str;
90 }
91
92 static inline bool isurisafe (int c)
93 {
94     /* These are the _unreserved_ URI characters (RFC3986 §2.3) */
95     return ((unsigned char)(c - 'a') < 26)
96         || ((unsigned char)(c - 'A') < 26)
97         || ((unsigned char)(c - '0') < 10)
98         || (strchr ("-._~", c) != NULL);
99 }
100
101 static char *encode_URI_bytes (const char *str, size_t *restrict lenp)
102 {
103     char *buf = malloc (3 * *lenp + 1);
104     if (unlikely(buf == NULL))
105         return NULL;
106
107     char *out = buf;
108     for (size_t i = 0; i < *lenp; i++)
109     {
110         static const char hex[16] = "0123456789ABCDEF";
111         unsigned char c = str[i];
112
113         if (isurisafe (c))
114             *(out++) = c;
115         /* This is URI encoding, not HTTP forms:
116          * Space is encoded as '%20', not '+'. */
117         else
118         {
119             *(out++) = '%';
120             *(out++) = hex[c >> 4];
121             *(out++) = hex[c & 0xf];
122         }
123     }
124
125     *lenp = out - buf;
126     out = realloc (buf, *lenp + 1);
127     return likely(out != NULL) ? out : buf;
128 }
129
130 /**
131  * Encodes a URI component (RFC3986 §2).
132  *
133  * @param str nul-terminated UTF-8 representation of the component.
134  * @note Obviously, a URI containing nul bytes cannot be passed.
135  * @return encoded string (must be free()'d), or NULL for ENOMEM.
136  */
137 char *encode_URI_component (const char *str)
138 {
139     size_t len = strlen (str);
140     char *ret = encode_URI_bytes (str, &len);
141     if (likely(ret != NULL))
142         ret[len] = '\0';
143     return ret;
144 }
145
146 /**
147  * Builds a URL representation from a local file path.
148  * @param path path to convert (or URI to copy)
149  * @param scheme URI scheme to use (default is auto: "file", "fd" or "smb")
150  * @return a nul-terminated URI string (use free() to release it),
151  * or NULL in case of error (errno will be set accordingly)
152  */
153 char *vlc_path2uri (const char *path, const char *scheme)
154 {
155     if (path == NULL)
156     {
157         errno = EINVAL;
158         return NULL;
159     }
160     if (scheme == NULL && !strcmp (path, "-"))
161         return strdup ("fd://0"); // standard input
162     /* Note: VLC cannot handle URI schemes without double slash after the
163      * scheme name (such as mailto: or news:). */
164
165     char *buf;
166
167 #ifdef __OS2__
168     char p[strlen (path) + 1];
169
170     for (buf = p; *path; buf++, path++)
171         *buf = (*path == '/') ? DIR_SEP_CHAR : *path;
172     *buf = '\0';
173
174     path = p;
175 #endif
176
177 #if defined (_WIN32) || defined (__OS2__)
178     /* Drive letter */
179     if (isalpha ((unsigned char)path[0]) && (path[1] == ':'))
180     {
181         if (asprintf (&buf, "%s:///%c:", scheme ? scheme : "file",
182                       path[0]) == -1)
183             buf = NULL;
184         path += 2;
185 # warning Drive letter-relative path not implemented!
186         if (path[0] != DIR_SEP_CHAR)
187         {
188             errno = ENOTSUP;
189             return NULL;
190         }
191     }
192     else
193     if (!strncmp (path, "\\\\", 2))
194     {   /* Windows UNC paths */
195         /* \\host\share\path -> file://host/share/path */
196         int hostlen = strcspn (path + 2, DIR_SEP);
197
198         if (asprintf (&buf, "file://%.*s", hostlen, path + 2) == -1)
199             buf = NULL;
200         path += 2 + hostlen;
201
202         if (path[0] == '\0')
203             return buf; /* Hostname without path */
204     }
205     else
206 #endif
207     if (path[0] != DIR_SEP_CHAR)
208     {   /* Relative path: prepend the current working directory */
209         char *cwd, *ret;
210
211         if ((cwd = vlc_getcwd ()) == NULL)
212             return NULL;
213         if (asprintf (&buf, "%s"DIR_SEP"%s", cwd, path) == -1)
214             buf = NULL;
215
216         free (cwd);
217         ret = (buf != NULL) ? vlc_path2uri (buf, scheme) : NULL;
218         free (buf);
219         return ret;
220     }
221     else
222     if (asprintf (&buf, "%s://", scheme ? scheme : "file") == -1)
223         buf = NULL;
224     if (buf == NULL)
225         return NULL;
226
227     /* Absolute file path */
228     assert (path[0] == DIR_SEP_CHAR);
229     do
230     {
231         size_t len = strcspn (++path, DIR_SEP);
232         path += len;
233
234         char *component = encode_URI_bytes (path - len, &len);
235         if (unlikely(component == NULL))
236         {
237             free (buf);
238             return NULL;
239         }
240         component[len] = '\0';
241
242         char *uri;
243         int val = asprintf (&uri, "%s/%s", buf, component);
244         free (component);
245         free (buf);
246         if (unlikely(val == -1))
247             return NULL;
248         buf = uri;
249     }
250     while (*path);
251
252     return buf;
253 }
254
255 /**
256  * Tries to convert a URI to a local (UTF-8-encoded) file path.
257  * @param url URI to convert
258  * @return NULL on error, a nul-terminated string otherwise
259  * (use free() to release it)
260  */
261 char *make_path (const char *url)
262 {
263     char *ret = NULL;
264     char *end;
265
266     char *path = strstr (url, "://");
267     if (path == NULL)
268         return NULL; /* unsupported scheme or invalid syntax */
269
270     end = memchr (url, '/', path - url);
271     size_t schemelen = ((end != NULL) ? end : path) - url;
272     path += 3; /* skip "://" */
273
274     /* Remove request parameters and/or HTML anchor if present */
275     end = path + strcspn (path, "?#");
276     path = strndup (path, end - path);
277     if (unlikely(path == NULL))
278         return NULL; /* boom! */
279
280     /* Decode path */
281     decode_URI (path);
282
283     if (schemelen == 4 && !strncasecmp (url, "file", 4))
284     {
285 #if !defined (_WIN32) && !defined (__OS2__)
286         /* Leading slash => local path */
287         if (*path == '/')
288             return path;
289         /* Local path disguised as a remote one */
290         if (!strncasecmp (path, "localhost/", 10))
291             return memmove (path, path + 9, strlen (path + 9) + 1);
292 #else
293         /* cannot start with a space */
294         if (*path == ' ')
295             goto out;
296         for (char *p = strchr (path, '/'); p; p = strchr (p + 1, '/'))
297             *p = '\\';
298
299         /* Leading backslash => local path */
300         if (*path == '\\')
301             return memmove (path, path + 1, strlen (path + 1) + 1);
302         /* Local path disguised as a remote one */
303         if (!strncasecmp (path, "localhost\\", 10))
304             return memmove (path, path + 10, strlen (path + 10) + 1);
305         /* UNC path */
306         if (*path && asprintf (&ret, "\\\\%s", path) == -1)
307             ret = NULL;
308 #endif
309         /* non-local path :-( */
310     }
311     else
312     if (schemelen == 2 && !strncasecmp (url, "fd", 2))
313     {
314         int fd = strtol (path, &end, 0);
315
316         if (*end)
317             goto out;
318
319 #if !defined( _WIN32 ) && !defined( __OS2__ )
320         switch (fd)
321         {
322             case 0:
323                 ret = strdup ("/dev/stdin");
324                 break;
325             case 1:
326                 ret = strdup ("/dev/stdout");
327                 break;
328             case 2:
329                 ret = strdup ("/dev/stderr");
330                 break;
331             default:
332                 if (asprintf (&ret, "/dev/fd/%d", fd) == -1)
333                     ret = NULL;
334         }
335 #else
336         /* XXX: Does this work on WinCE? */
337         if (fd < 2)
338             ret = strdup ("CON");
339 #endif
340     }
341
342 out:
343     free (path);
344     return ret; /* unknown scheme */
345 }
346
347 static char *vlc_idna_to_ascii (const char *);
348
349 /**
350  * Splits an URL into parts.
351  * \param url structure of URL parts [OUT]
352  * \param str nul-terminated URL string to split
353  * \note Use vlc_UrlClean() to free associated resources
354  * \bug Errors cannot be detected.
355  * \return nothing
356  */
357 void vlc_UrlParse (vlc_url_t *restrict url, const char *str)
358 {
359     url->psz_protocol = NULL;
360     url->psz_username = NULL;
361     url->psz_password = NULL;
362     url->psz_host = NULL;
363     url->i_port = 0;
364     url->psz_path = NULL;
365     url->psz_option = NULL;
366     url->psz_buffer = NULL;
367
368     if (str == NULL)
369         return;
370
371     char *buf = strdup (str);
372     if (unlikely(buf == NULL))
373         abort ();
374     url->psz_buffer = buf;
375
376     char *cur = buf, *next;
377
378     /* URL scheme */
379     next = buf;
380     while ((*next >= 'A' && *next <= 'Z') || (*next >= 'a' && *next <= 'z')
381         || (*next >= '0' && *next <= '9') || memchr ("+-.", *next, 3) != NULL)
382         next++;
383     /* This is not strictly correct. In principles, the scheme is always
384      * present in an absolute URL and followed by a colon. Depending on the
385      * URL scheme, the two subsequent slashes are not required.
386      * VLC uses a different scheme for historical compatibility reasons - the
387      * scheme is often implicit. */
388     if (!strncmp (next, "://", 3))
389     {
390         *next = '\0';
391         next += 3;
392         url->psz_protocol = cur;
393         cur = next;
394     }
395
396     /* Query parameters */
397     char *query = strchr (cur, '?');
398     if (query != NULL)
399     {
400         *(query++) = '\0';
401         url->psz_option = query;
402     }
403
404     /* Path */
405     next = strchr (cur, '/');
406     if (next != NULL)
407     {
408         *next = '\0'; /* temporary nul, reset to slash later */
409         url->psz_path = next;
410     }
411     /*else
412         url->psz_path = "/";*/
413
414     /* User name */
415     next = strrchr (cur, '@');
416     if (next != NULL)
417     {
418         *(next++) = '\0';
419         url->psz_username = cur;
420         cur = next;
421
422         /* Password (obsolete) */
423         next = strchr (url->psz_username, ':');
424         if (next != NULL)
425         {
426             *(next++) = '\0';
427             url->psz_password = next;
428             decode_URI (url->psz_password);
429         }
430         decode_URI (url->psz_username);
431     }
432
433     /* Host name */
434     if (*cur == '[' && (next = strrchr (cur, ']')) != NULL)
435     {   /* Try IPv6 numeral within brackets */
436         *(next++) = '\0';
437         url->psz_host = strdup (cur + 1);
438
439         if (*next == ':')
440             next++;
441         else
442             next = NULL;
443     }
444     else
445     {
446         next = strchr (cur, ':');
447         if (next != NULL)
448             *(next++) = '\0';
449
450         url->psz_host = vlc_idna_to_ascii (cur);
451     }
452
453     /* Port number */
454     if (next != NULL)
455         url->i_port = atoi (next);
456
457     if (url->psz_path != NULL)
458         *url->psz_path = '/'; /* restore leading slash */
459 }
460
461 /**
462  * Releases resources allocated by vlc_UrlParse().
463  */
464 void vlc_UrlClean (vlc_url_t *restrict url)
465 {
466     free (url->psz_host);
467     free (url->psz_buffer);
468 }
469
470 #if defined (HAVE_IDN)
471 # include <idna.h>
472 #elif defined (_WIN32)
473 # include <windows.h>
474 # include <vlc_charset.h>
475 #endif
476
477 /**
478  * Converts a UTF-8 nul-terminated IDN to nul-terminated ASCII domain name.
479  * \param idn UTF-8 Internationalized Domain Name to convert
480  * \return a heap-allocated string or NULL on error.
481  */
482 static char *vlc_idna_to_ascii (const char *idn)
483 {
484 #if defined (HAVE_IDN)
485     char *adn;
486
487     if (idna_to_ascii_8z (idn, &adn, IDNA_ALLOW_UNASSIGNED) != IDNA_SUCCESS)
488         return NULL;
489     return adn;
490
491 #elif defined (_WIN32) && (_WIN32_WINNT >= 0x0601)
492     char *ret = NULL;
493
494     wchar_t *wide = ToWide (idn);
495     if (wide == NULL)
496         return NULL;
497
498     int len = IdnToAscii (IDN_ALLOW_UNASSIGNED, wide, -1, NULL, 0);
499     if (len == 0)
500         goto error;
501
502     wchar_t *buf = malloc (sizeof (*buf) * len);
503     if (unlikely(buf == NULL))
504         goto error;
505     if (!IdnToAscii (IDN_ALLOW_UNASSIGNED, wide, -1, buf, len))
506     {
507         free (buf);
508         goto error;
509     }
510     ret = FromWide (buf);
511     free (buf);
512 error:
513     free (wide);
514     return ret;
515
516 #else
517     /* No IDN support, filter out non-ASCII domain names */
518     for (const char *p = idn; *p; p++)
519         if (((unsigned char)*p) >= 0x80)
520             return NULL;
521
522     return strdup (idn);
523
524 #endif
525 }