4 * @file gmyth/gmyth_uri.c
6 * @brief <p> GMythURI utils
7 * - Extracts and parses a URI char string, in according with the RFC 2396
8 * [http://www.ietf.org/rfc/rfc2396.txt]
10 * Copyright (C) 2006 INdT - Instituto Nokia de Tecnologia.
11 * @author Rosfran Borges <rosfran.borges@indt.org.br>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU Lesser General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU Lesser General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include "gmyth_uri.h"
40 #include "gmyth_debug.h"
42 static void gmyth_uri_class_init (GMythURIClass *klass);
43 static void gmyth_uri_init (GMythURI *object);
45 static void gmyth_uri_dispose (GObject *object);
46 static void gmyth_uri_finalize (GObject *object);
48 static void gmyth_uri_parser_setup_and_new(GMythURI *uri, const gchar *value);
49 static gchar* gmyth_uri_print_field(const GString* field);
51 G_DEFINE_TYPE(GMythURI, gmyth_uri, G_TYPE_OBJECT)
54 gmyth_uri_class_init (GMythURIClass *klass)
56 GObjectClass *gobject_class;
58 gobject_class = (GObjectClass *) klass;
60 gobject_class->dispose = gmyth_uri_dispose;
61 gobject_class->finalize = gmyth_uri_finalize;
65 gmyth_uri_init (GMythURI *gmyth_uri)
70 gmyth_uri_dispose (GObject *object)
72 GMythURI *gmyth_uri = GMYTH_URI(object);
74 if ( gmyth_uri->host != NULL ) {
75 g_string_free( gmyth_uri->host, TRUE );
76 gmyth_uri->host = NULL;
79 if ( gmyth_uri->protocol != NULL ) {
80 g_string_free( gmyth_uri->protocol, TRUE );
81 gmyth_uri->protocol = NULL;
84 if ( gmyth_uri->path != NULL ) {
85 g_string_free( gmyth_uri->path, TRUE );
86 gmyth_uri->path = NULL;
89 if ( gmyth_uri->fragment != NULL ) {
90 g_string_free( gmyth_uri->fragment, TRUE );
91 gmyth_uri->fragment = NULL;
94 if ( gmyth_uri->user != NULL ) {
95 g_string_free( gmyth_uri->user, TRUE );
96 gmyth_uri->user = NULL;
99 if ( gmyth_uri->password != NULL ) {
100 g_string_free( gmyth_uri->password, TRUE );
101 gmyth_uri->password = NULL;
104 if ( gmyth_uri->query != NULL ) {
105 g_string_free( gmyth_uri->query, TRUE );
106 gmyth_uri->query = NULL;
109 if ( gmyth_uri->uri != NULL ) {
110 g_string_free( gmyth_uri->uri, TRUE );
111 gmyth_uri->uri = NULL;
115 G_OBJECT_CLASS (gmyth_uri_parent_class)->dispose (object);
119 gmyth_uri_finalize (GObject *object)
121 //GMythURI *gmyth_uri = GMYTH_URI(object);
123 g_signal_handlers_destroy (object);
125 G_OBJECT_CLASS (gmyth_uri_parent_class)->finalize (object);
129 * Creates a new instance of GMythURI.
131 * @return a new instance of GMythURI.
136 GMythURI *gmyth_uri = GMYTH_URI (g_object_new (GMYTH_URI_TYPE, NULL));
142 * Creates a new instance of GMythURI.
144 * @param uri_str The URI string representing this URI instance.
146 * @return a new instance of GMythURI.
149 gmyth_uri_new_with_value (const gchar *uri_str)
151 GMythURI *gmyth_uri = GMYTH_URI (g_object_new (GMYTH_URI_TYPE, NULL));
153 gmyth_uri_parser_setup_and_new (gmyth_uri, uri_str);
159 * Gets the starting offset of a substring inside a given string.
161 * @param haystack The given string to be searched for patterns.
162 * @param needle The substring that should be matched over the haystack.
164 * @return The starting offset to the given substring, or <code>-1</code> if the
165 * haystack function parameter doesn't contains the needle string argument.
168 gmyth_strstr (const gchar *haystack, const gchar *needle)
173 if (haystack == NULL || needle == NULL)
175 strPos = strstr(haystack, needle);
179 return (strPos - haystack);
184 * Checks if a URI is absolute.
186 * @param uri The GMythURI instance.
188 * @return <code>true</code>, if the URI is absolute.
191 gmyth_uri_isabsolute (const GMythURI *uri)
193 gboolean ret = FALSE;
195 g_return_val_if_fail( uri != NULL && uri->uri != NULL && uri->protocol != NULL, FALSE );
197 if ( gmyth_strstr( uri->uri->str, GMYTH_URI_PROTOCOL_DELIM ) == 0 || strlen(uri->protocol->str) > 0 )
204 * Searches for the first reverse character occurrence, from a given
205 * list of characters, inside a given string.
207 * @param str The given string to be searched for characters occurrence.
208 * @param chars The characters list. If this string returns 4 on strlen, there are
209 * four possible characters to be matched.
210 * @param nchars The number of characters to be matched, which has at most
213 * @return The starting offset to the first character occurrence,
214 * or <code>-1</code> if the no character of the list could be found.
217 gmyth_strrchr( const gchar *str, const gchar *chars, const gint nchars )
223 if ( str == NULL || chars == NULL )
226 strLen = strlen( str );
227 for ( i= (strLen-1); 0 <= i; i-- ) {
228 for ( j=0; j<nchars; j++ ) {
229 if ( str[i] == chars[j] )
239 gmyth_uri_print_field( const GString* field )
241 if ( field != NULL && field->str != NULL && strlen(field->str) > 0 )
248 * Parses a URI string into a GMythURI instance.
250 * @param uri The GMythURI instance.
251 * @param value The URI string to be parsed.
255 gmyth_uri_parser_setup_and_new( GMythURI *uri, const gchar *value )
274 uriLen = strlen(value);
275 uri->uri = g_string_new( g_strdup (value) );
280 protoIdx = gmyth_strstr (value, GMYTH_URI_PROTOCOL_DELIM);
282 uri->protocol = g_string_new_len (value, protoIdx);
283 currIdx += protoIdx + strlen( GMYTH_URI_PROTOCOL_DELIM );
286 /*** User (Password) ****/
287 atIdx = gmyth_strstr( value+currIdx, GMYTH_URI_USER_DELIM );
289 colonIdx = gmyth_strstr( value+currIdx, GMYTH_URI_COLON_DELIM );
291 if (0 < colonIdx && colonIdx < atIdx) {
292 uri->user = g_string_new_len (value+currIdx, colonIdx);
293 uri->password = g_string_new_len (value+currIdx+colonIdx+1, atIdx - (colonIdx+1));
296 uri->user = g_string_new_len (value+currIdx, atIdx - currIdx);
297 currIdx += atIdx + 1;
300 /*** Host (Port) ****/
301 shashIdx = gmyth_strstr( value+currIdx, GMYTH_URI_SLASH_DELIM );
303 uri->host = g_string_new_len (value+currIdx, shashIdx);
304 else if ( gmyth_uri_isabsolute(uri) == TRUE )
305 uri->host = g_string_new_len (value+currIdx, strlen (value) - currIdx);
307 host = gmyth_uri_get_host(uri);
308 colonIdx = gmyth_strrchr (host, GMYTH_URI_COLON_DELIM, 1);
309 eblacketIdx = gmyth_strrchr (host, GMYTH_URI_EBLACET_DELIM, 1);
310 if ( ( 0 < colonIdx ) && ( eblacketIdx < colonIdx ) ) {
311 GString *portStr = NULL;
312 GString *hostStr = g_string_new (host != NULL ? host : "");
314 hostLen = hostStr->len;
316 uri->host = g_string_erase (uri->host, 0, hostLen);
317 uri->host = g_string_insert_len (uri->host, 0, hostStr->str, colonIdx);
319 if (host[0] == '[' && host[hostLen-1] == ']')
320 uri->host = g_string_new_len (hostStr->str+1, colonIdx-2);
323 portStr = g_string_new_len (hostStr->str+colonIdx+1, hostLen-colonIdx-1);
324 uri->port = (gint)g_ascii_strtoull( portStr->str, NULL, 10 );
325 g_string_free (portStr, TRUE);
326 g_string_free (hostStr, TRUE);
329 const gchar* protocol = gmyth_uri_get_protocol(uri);
330 uri->port = GMYTH_URI_KNKOWN_PORT;
331 if ( strcmp(protocol, GMYTH_URI_PROTOCOL_HTTP) == 0 )
332 uri->port = GMYTH_URI_DEFAULT_HTTP_PORT;
333 if ( strcmp(protocol, GMYTH_URI_PROTOCOL_FTP) == 0 )
334 uri->port = GMYTH_URI_DEFAULT_FTP_PORT;
337 if (shashIdx > 0) currIdx += shashIdx;
342 if (gmyth_uri_isabsolute(uri) == FALSE)
347 /* Add slash delimiter at the beginning of the URL,
350 uri->path = g_string_new( GMYTH_URI_SLASH_DELIM );
352 uri->path = g_string_append( uri->path, value );
355 /* First set path simply to the rest of URI */
356 uri->path = g_string_new_len (value+currIdx, uriLen-currIdx );
359 gmyth_debug( "uri value: %s", value );
360 uri->query = g_string_new ( g_strstr_len( value, strlen(value), GMYTH_URI_QUESTION_DELIM ) );
362 eIdx = gmyth_strstr( value+currIdx, GMYTH_URI_QUESTION_DELIM );
365 uri->query = g_string_new ( g_strstr_len( value, strlen(value), GMYTH_URI_QUESTION_DELIM ) );
366 gmyth_debug( "query = %s", uri->query->str );
369 /**** Path (Query/Fragment) ****/
370 sharpIdx = gmyth_strstr(value+currIdx, GMYTH_URI_E_DELIM);
372 uri->path = g_string_append_len( uri->path, value+currIdx, sharpIdx);
373 uri->fragment = g_string_new_len (value+currIdx+sharpIdx+1, uriLen-(currIdx+sharpIdx+1));
376 gmyth_debug( "[%s] GMythURI: host = %s, port = %d, path = %s, query = %s, fragment = %s, "\
377 "user = %s, password = %s.\n", __FUNCTION__, gmyth_uri_print_field( uri->host ), uri->port,
378 gmyth_uri_print_field( uri->path ), gmyth_uri_print_field( uri->query ), gmyth_uri_print_field( uri->fragment ),
379 gmyth_uri_print_field ( uri->user ), gmyth_uri_print_field( uri->password ) );
384 * Compares 2 URI instances, and checks them for equality.
386 * @param uri The first GMythURI instance for comparison.
387 * @param uri The second GMythURI instance for comparison.
389 * @return <code>true</code>, if these two URI instances are equals.
392 gmyth_uri_is_equals( GMythURI* uri1, GMythURI* uri2 )
394 return ( g_ascii_strcasecmp( gmyth_uri_get_host( uri1 ), gmyth_uri_get_host( uri2 ) ) == 0 &&
395 gmyth_uri_get_port( uri1 ) == gmyth_uri_get_port( uri2 ) );
399 * Checks if the URI instance represents a LiveTV recording.
401 * @param uri The GMythURI instance.
403 * @return <code>true</code>, if the URI points to LiveTV content.
406 gmyth_uri_is_livetv( GMythURI* uri )
408 gboolean ret = FALSE;
410 g_return_val_if_fail( uri != NULL && uri->uri != NULL && uri->uri->str != NULL, FALSE );
412 ret = ( g_strstr_len( uri->uri->str, strlen( uri->uri->str ), "/?" ) != NULL ) ||
413 ( g_strstr_len( uri->uri->str, strlen( uri->uri->str ), "livetv" ) != NULL );
416 gmyth_debug( "This URI is a LiveTV recording..." );
423 * Gets the channel name fro a URI instance.
425 * @param uri The GMythURI instance.
427 * @return The channel name, got from the substring "?channel=[channel_name]"
431 gmyth_uri_get_channel_name( GMythURI* uri )
433 gchar* channel = NULL;
435 g_return_val_if_fail( uri != NULL && uri->uri != NULL && uri->uri->str != NULL, FALSE );
437 gchar *channel_query = g_strstr_len( gmyth_uri_get_query( uri ), strlen( gmyth_uri_get_query( uri ) ), "channel" );
439 if ( channel_query != NULL )
441 gchar **chan_key_value = g_strsplit( gmyth_uri_get_query( uri ), "=", 2 );
443 /* gmyth_debug( "Channel tuple is [ %s, %s ]", chan_key_value[0], chan_key_value[1] ); */
445 if ( chan_key_value[1] != NULL && strlen( chan_key_value[1] ) > 0 )
447 channel = g_strdup( chan_key_value[1] );
450 if ( chan_key_value != NULL )
451 g_strfreev( chan_key_value );
454 gmyth_debug( "Got channel decimal value from the URI: %s", channel );
461 * Gets the channel number from a URI instance.
463 * @param uri The GMythURI instance.
465 * @return The channel number, got from the substring "?channel=[channel_number]"
466 * of the URI string, or <code>-1</code> it if couldn't be converted.
469 gmyth_uri_get_channel_num( GMythURI* uri )
471 gchar *channel_name = gmyth_uri_get_channel_name( uri );
473 if ( channel_name != NULL )
475 return g_ascii_strtoull( channel_name, NULL, 10 );