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