git.sesse.net Git - vlc/blob - 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 #ifndef __VLC_URL_H
  26 # define __VLC_URL_H
  27
  28 typedef struct
  29 {
  30     char *psz_protocol;
  31     char *psz_username;
  32     char *psz_password;
  33     char *psz_host;
  34     int  i_port;
  35
  36     char *psz_path;
  37
  38     char *psz_option;
  39
  40     char *psz_buffer; /* to be freed */
  41 } vlc_url_t;
  42
  43 /*****************************************************************************
  44  * vlc_UrlParse:
  45  *****************************************************************************
  46  * option : if != 0 then path is split at this char
  47  *
  48  * format [protocol://[login[:password]@]][host[:port]]/path[OPTIONoption]
  49  *****************************************************************************/
  50 static inline void vlc_UrlParse( vlc_url_t *url, const char *psz_url,
  51                                  char option )
  52 {
  53     char *psz_dup;
  54     char *psz_parse;
  55     char *p;
  56
  57     url->psz_protocol = NULL;
  58     url->psz_username = NULL;
  59     url->psz_password = NULL;
  60     url->psz_host     = NULL;
  61     url->i_port       = 0;
  62     url->psz_path     = NULL;
  63     url->psz_option   = NULL;
  64
  65     if( psz_url == NULL )
  66     {
  67         url->psz_buffer = NULL;
  68         return;
  69     }
  70     url->psz_buffer = psz_parse = psz_dup = strdup( psz_url );
  71
  72     p  = strstr( psz_parse, ":/" );
  73     if( p != NULL )
  74     {
  75         /* we have a protocol */
  76
  77         /* skip :// */
  78         *p++ = '\0';
  79         if( p[1] == '/' )
  80             p += 2;
  81         url->psz_protocol = psz_parse;
  82         psz_parse = p;
  83     }
  84     p = strchr( psz_parse, '@' );
  85     if( p != NULL )
  86     {
  87         /* We have a login */
  88         url->psz_username = psz_parse;
  89         *p++ = '\0';
  90
  91         psz_parse = strchr( psz_parse, ':' );
  92         if( psz_parse != NULL )
  93         {
  94             /* We have a password */
  95             *psz_parse++ = '\0';
  96             url->psz_password = psz_parse;
  97         }
  98
  99         psz_parse = p;
 100     }
 101
 102     p = strchr( psz_parse, '/' );
 103     if( !p || psz_parse < p )
 104     {
 105         char *p2;
 106
 107         /* We have a host[:port] */
 108         url->psz_host = strdup( psz_parse );
 109         if( p )
 110         {
 111             url->psz_host[p - psz_parse] = '\0';
 112         }
 113
 114         if( *url->psz_host == '[' )
 115         {
 116             /* Ipv6 address */
 117             p2 = strchr( url->psz_host, ']' );
 118             if( p2 )
 119             {
 120                 p2 = strchr( p2, ':' );
 121             }
 122         }
 123         else
 124         {
 125             p2 = strchr( url->psz_host, ':' );
 126         }
 127         if( p2 )
 128         {
 129             *p2++ = '\0';
 130             url->i_port = atoi( p2 );
 131         }
 132     }
 133     psz_parse = p;
 134
 135     /* Now parse psz_path and psz_option */
 136     if( psz_parse )
 137     {
 138         url->psz_path = psz_parse;
 139         if( option != '\0' )
 140         {
 141             p = strchr( url->psz_path, option );
 142             if( p )
 143             {
 144                 *p++ = '\0';
 145                 url->psz_option = p;
 146             }
 147         }
 148     }
 149 }
 150
 151 /*****************************************************************************
 152  * vlc_UrlClean:
 153  *****************************************************************************/
 154 static inline void vlc_UrlClean( vlc_url_t *url )
 155 {
 156     if( url->psz_buffer ) free( url->psz_buffer );
 157     if( url->psz_host )   free( url->psz_host );
 158
 159     url->psz_protocol = NULL;
 160     url->psz_username = NULL;
 161     url->psz_password = NULL;
 162     url->psz_host     = NULL;
 163     url->i_port       = 0;
 164     url->psz_path     = NULL;
 165     url->psz_option   = NULL;
 166
 167     url->psz_buffer   = NULL;
 168 }
 169
 170 VLC_EXPORT( char *, unescape_URI_duplicate, ( const char *psz ) );
 171 VLC_EXPORT( void, unescape_URI, ( char *psz ) );
 172 VLC_EXPORT( char *, decode_URI_duplicate, ( const char *psz ) );
 173 VLC_EXPORT( void, decode_URI, ( char *psz ) );
 174 VLC_EXPORT( char *, encode_URI_component, ( const char *psz ) );
 175
 176 static inline char *vlc_UrlEncode( const char *psz_url )
 177 {
 178     /* FIXME: do not encode / : ? and & _when_ not needed */
 179     return encode_URI_component( psz_url );
 180 }
 181
 182 #include <ctype.h>
 183
 184 /** Check whether a given string is not a valid URL and must hence be
 185  *  encoded */
 186 static inline int vlc_UrlIsNotEncoded( const char *psz_url )
 187 {
 188     const char *ptr;
 189
 190     for( ptr = psz_url; *ptr; ptr++ )
 191     {
 192         char c = *ptr;
 193
 194         if( c == '%' )
 195         {
 196             if( !isxdigit( ptr[1] ) || !isxdigit( ptr[2] ) )
 197                 return 1; /* not encoded */
 198             ptr += 2;
 199         }
 200         else
 201         if(  ( (unsigned char)( c - 'a' ) < 26 )
 202           || ( (unsigned char)( c - 'A' ) < 26 )
 203           || ( (unsigned char)( c - '0' ) < 10 )
 204           || ( strchr( "-_.", c ) != NULL ) )
 205             return 1;
 206     }
 207     return 0; /* looks fine - but maybe it is not encoded */
 208 }
 209
 210 /* Base64 encoding */
 211 static inline char *vlc_b64_encode( const char *src )
 212 {
 213     static const char b64[] =
 214            "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 215     size_t len = strlen( src );
 216     const uint8_t *in = (const uint8_t *)src;
 217
 218     char *ret;
 219     char *dst = (char *)malloc( ( len + 4 ) * 4 / 3 );
 220     if( dst == NULL )
 221         return NULL;
 222
 223     ret = dst;
 224
 225     while( len > 0 )
 226     {
 227         /* pops (up to) 3 bytes of input, push 4 bytes */
 228         uint32_t v = *in++ << 24; // 1/3
 229         *dst++ = b64[v >> 26]; // 1/4
 230         v = v << 6;
 231
 232         if( len >= 2 )
 233             v |= *in++ << 22; // 2/3
 234         *dst++ = b64[v >> 26]; // 2/4
 235         v = v << 6;
 236
 237         if( len >= 3 )
 238             v |= *in++ << 20; // 3/3
 239         *dst++ = ( len >= 2 ) ? b64[v >> 26] : '='; // 3/4
 240         v = v << 6;
 241
 242         *dst++ = ( len >= 3 ) ? b64[v >> 26] : '='; // 4/4
 243
 244         len--;
 245         if( len > 0 )
 246         {
 247             len--;
 248             if( len > 0 )
 249                 len--;
 250         }
 251     }
 252
 253     *dst = '\0';
 254
 255     return ret;
 256 }
 257 #endif