tests/check/: use the new macro
[platform/upstream/gstreamer.git] / gst / gsturi.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gsturi.c: register URI handlers
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library 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 GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 /**
24  * SECTION:gsturihandler
25  * @short_description: Interface to ease URI handling in plugins.
26  *
27  * The URIHandler is an interface that is implemented by Source and Sink 
28  * #GstElement to simplify then handling of URI.
29  *
30  * An application can use the following functions to quickly get an element
31  * that handles the given URI for reading or writing
32  * (gst_element_make_from_uri()).
33  *
34  * Source and Sink plugins should implement this interface when possible.
35  *
36  * Last reviewed on 2005-11-09 (0.9.4)
37  */
38
39 #ifdef HAVE_CONFIG_H
40 #  include "config.h"
41 #endif
42
43 #include "gst_private.h"
44 #include "gsturi.h"
45 #include "gstinfo.h"
46 #include "gstmarshal.h"
47 #include "gstregistry.h"
48
49 #include <string.h>
50
51 GST_DEBUG_CATEGORY_STATIC (gst_uri_handler_debug);
52 #define GST_CAT_DEFAULT gst_uri_handler_debug
53
54 static void gst_uri_handler_base_init (gpointer g_class);
55
56 GType
57 gst_uri_handler_get_type (void)
58 {
59   static GType urihandler_type = 0;
60
61   if (G_UNLIKELY (urihandler_type == 0)) {
62     static const GTypeInfo urihandler_info = {
63       sizeof (GstURIHandlerInterface),
64       gst_uri_handler_base_init,
65       NULL,
66       NULL,
67       NULL,
68       NULL,
69       0,
70       0,
71       NULL,
72       NULL
73     };
74
75     urihandler_type = g_type_register_static (G_TYPE_INTERFACE,
76         "GstURIHandler", &urihandler_info, 0);
77
78     GST_DEBUG_CATEGORY_INIT (gst_uri_handler_debug, "GST_URI", GST_DEBUG_BOLD,
79         "handling of URIs");
80   }
81   return urihandler_type;
82 }
83 static void
84 gst_uri_handler_base_init (gpointer g_class)
85 {
86   static gboolean initialized = FALSE;
87
88   if (!initialized) {
89
90     /**
91      * GstURIHandler::new-uri:
92      * @handler: The #GstURIHandler which emitted the signal
93      * @uri: The new URI, or NULL if the URI was removed
94      *
95      * The URI of the given @handler has changed.
96      */
97
98     g_signal_new ("new-uri", GST_TYPE_URI_HANDLER, G_SIGNAL_RUN_LAST,
99         G_STRUCT_OFFSET (GstURIHandlerInterface, new_uri), NULL, NULL,
100         gst_marshal_VOID__STRING, G_TYPE_NONE, 1, G_TYPE_STRING);
101     initialized = TRUE;
102   }
103 }
104
105 static const guchar acceptable[96] = {  /* X0   X1   X2   X3   X4   X5   X6   X7   X8   X9   XA   XB   XC   XD   XE   XF */
106   0x00, 0x3F, 0x20, 0x20, 0x20, 0x00, 0x2C, 0x3F, 0x3F, 0x3F, 0x3F, 0x22, 0x20, 0x3F, 0x3F, 0x1C,       /* 2X  !"#$%&'()*+,-./   */
107   0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x38, 0x20, 0x20, 0x2C, 0x20, 0x2C,       /* 3X 0123456789:;<=>?   */
108   0x30, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,       /* 4X @ABCDEFGHIJKLMNO   */
109   0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x20, 0x20, 0x20, 0x20, 0x3F,       /* 5X PQRSTUVWXYZ[\]^_   */
110   0x20, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F,       /* 6X `abcdefghijklmno   */
111   0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x3F, 0x20, 0x20, 0x20, 0x3F, 0x20        /* 7X pqrstuvwxyz{|}~DEL */
112 };
113
114 typedef enum
115 {
116   UNSAFE_ALL = 0x1,             /* Escape all unsafe characters   */
117   UNSAFE_ALLOW_PLUS = 0x2,      /* Allows '+'  */
118   UNSAFE_PATH = 0x4,            /* Allows '/' and '?' and '&' and '='  */
119   UNSAFE_DOS_PATH = 0x8,        /* Allows '/' and '?' and '&' and '=' and ':' */
120   UNSAFE_HOST = 0x10,           /* Allows '/' and ':' and '@' */
121   UNSAFE_SLASHES = 0x20         /* Allows all characters except for '/' and '%' */
122 } UnsafeCharacterSet;
123
124 #define HEX_ESCAPE '%'
125
126 /*  Escape undesirable characters using %
127  *  -------------------------------------
128  *
129  * This function takes a pointer to a string in which
130  * some characters may be unacceptable unescaped.
131  * It returns a string which has these characters
132  * represented by a '%' character followed by two hex digits.
133  *
134  * This routine returns a g_malloced string.
135  */
136
137 static const gchar hex[16] = "0123456789ABCDEF";
138
139 static gchar *
140 escape_string_internal (const gchar * string, UnsafeCharacterSet mask)
141 {
142 #define ACCEPTABLE_CHAR(a) ((a)>=32 && (a)<128 && (acceptable[(a)-32] & use_mask))
143
144   const gchar *p;
145   gchar *q;
146   gchar *result;
147   guchar c;
148   gint unacceptable;
149   UnsafeCharacterSet use_mask;
150
151   g_return_val_if_fail (mask == UNSAFE_ALL
152       || mask == UNSAFE_ALLOW_PLUS
153       || mask == UNSAFE_PATH
154       || mask == UNSAFE_DOS_PATH
155       || mask == UNSAFE_HOST || mask == UNSAFE_SLASHES, NULL);
156
157   if (string == NULL) {
158     return NULL;
159   }
160
161   unacceptable = 0;
162   use_mask = mask;
163   for (p = string; *p != '\0'; p++) {
164     c = *p;
165     if (!ACCEPTABLE_CHAR (c)) {
166       unacceptable++;
167     }
168     if ((use_mask == UNSAFE_HOST) && (unacceptable || (c == '/'))) {
169       /* when escaping a host, if we hit something that needs to be escaped, or we finally
170        * hit a path separator, revert to path mode (the host segment of the url is over).
171        */
172       use_mask = UNSAFE_PATH;
173     }
174   }
175
176   result = g_malloc (p - string + unacceptable * 2 + 1);
177
178   use_mask = mask;
179   for (q = result, p = string; *p != '\0'; p++) {
180     c = *p;
181
182     if (!ACCEPTABLE_CHAR (c)) {
183       *q++ = HEX_ESCAPE;        /* means hex coming */
184       *q++ = hex[c >> 4];
185       *q++ = hex[c & 15];
186     } else {
187       *q++ = c;
188     }
189     if ((use_mask == UNSAFE_HOST) && (!ACCEPTABLE_CHAR (c) || (c == '/'))) {
190       use_mask = UNSAFE_PATH;
191     }
192   }
193
194   *q = '\0';
195
196   return result;
197 }
198
199 /**
200  * escape_string:
201  * @string: string to be escaped
202  *
203  * Escapes @string, replacing any and all special characters
204  * with equivalent escape sequences.
205  *
206  * Return value: a newly allocated string equivalent to @string
207  * but with all special characters escaped
208  **/
209 static gchar *
210 escape_string (const gchar * string)
211 {
212   return escape_string_internal (string, UNSAFE_ALL);
213 }
214
215 static int
216 hex_to_int (gchar c)
217 {
218   return c >= '0' && c <= '9' ? c - '0'
219       : c >= 'A' && c <= 'F' ? c - 'A' + 10
220       : c >= 'a' && c <= 'f' ? c - 'a' + 10 : -1;
221 }
222
223 static int
224 unescape_character (const char *scanner)
225 {
226   int first_digit;
227   int second_digit;
228
229   first_digit = hex_to_int (*scanner++);
230   if (first_digit < 0) {
231     return -1;
232   }
233
234   second_digit = hex_to_int (*scanner++);
235   if (second_digit < 0) {
236     return -1;
237   }
238
239   return (first_digit << 4) | second_digit;
240 }
241
242 /**
243  * unescape_string:
244  * @escaped_string: an escaped URI, path, or other string
245  * @illegal_characters: a string containing a sequence of characters
246  * considered "illegal", '\0' is automatically in this list.
247  *
248  * Decodes escaped characters (i.e. PERCENTxx sequences) in @escaped_string.
249  * Characters are encoded in PERCENTxy form, where xy is the ASCII hex code
250  * for character 16x+y.
251  *
252  * Return value: a newly allocated string with the unescaped equivalents,
253  * or %NULL if @escaped_string contained one of the characters
254  * in @illegal_characters.
255  **/
256 static char *
257 unescape_string (const gchar * escaped_string, const gchar * illegal_characters)
258 {
259   const gchar *in;
260   gchar *out, *result;
261   gint character;
262
263   if (escaped_string == NULL) {
264     return NULL;
265   }
266
267   result = g_malloc (strlen (escaped_string) + 1);
268
269   out = result;
270   for (in = escaped_string; *in != '\0'; in++) {
271     character = *in;
272     if (*in == HEX_ESCAPE) {
273       character = unescape_character (in + 1);
274
275       /* Check for an illegal character. We consider '\0' illegal here. */
276       if (character <= 0
277           || (illegal_characters != NULL
278               && strchr (illegal_characters, (char) character) != NULL)) {
279         g_free (result);
280         return NULL;
281       }
282       in += 2;
283     }
284     *out++ = (char) character;
285   }
286
287   *out = '\0';
288   g_assert ((size_t) (out - result) <= strlen (escaped_string));
289   return result;
290
291 }
292
293
294 static void
295 gst_uri_protocol_check_internal (const gchar * uri, gchar ** endptr)
296 {
297   gchar *check = (gchar *) uri;
298
299   g_assert (uri != NULL);
300   g_assert (endptr != NULL);
301
302   if (g_ascii_isalpha (*check)) {
303     check++;
304     while (g_ascii_isalnum (*check))
305       check++;
306   }
307
308   *endptr = check;
309 }
310
311 /**
312  * gst_uri_protocol_is_valid:
313  * @protocol: A string
314  *
315  * Tests if the given string is a valid protocol identifier. Protocols
316  * must consist of alphanumeric characters and not start with a number.
317  *
318  * Returns: TRUE if the string is a valid protocol identifier, FALSE otherwise.
319  */
320 gboolean
321 gst_uri_protocol_is_valid (const gchar * protocol)
322 {
323   gchar *endptr;
324
325   g_return_val_if_fail (protocol != NULL, FALSE);
326
327   gst_uri_protocol_check_internal (protocol, &endptr);
328
329   return *endptr == '\0' && endptr != protocol;
330 }
331
332 /**
333  * gst_uri_is_valid:
334  * @uri: A URI string
335  *
336  * Tests if the given string is a valid URI identifier. URIs start with a valid
337  * protocol followed by "://" and maybe a string identifying the location.
338  *
339  * Returns: TRUE if the string is a valid URI
340  */
341 gboolean
342 gst_uri_is_valid (const gchar * uri)
343 {
344   gchar *endptr;
345
346   g_return_val_if_fail (uri != NULL, FALSE);
347
348   gst_uri_protocol_check_internal (uri, &endptr);
349
350   return (*endptr == ':' && *(endptr + 1) == '/' && *(endptr + 2) == '/');
351 }
352
353 /**
354  * gst_uri_get_protocol:
355  * @uri: A URI string
356  *
357  * Extracts the protocol out of a given valid URI. The returned string must be
358  * freed using g_free().
359  *
360  * Returns: The protocol for this URI.
361  */
362 gchar *
363 gst_uri_get_protocol (const gchar * uri)
364 {
365   gchar *colon;
366
367   g_return_val_if_fail (uri != NULL, NULL);
368   g_return_val_if_fail (gst_uri_is_valid (uri), NULL);
369
370   colon = strstr (uri, "://");
371
372   return g_strndup (uri, colon - uri);
373 }
374
375 /**
376  * gst_uri_has_protocol:
377  * @uri: an URI string
378  * @protocol: a protocol string (e.g. "http")
379  *
380  * Returns TRUE if the protocol of a given valid URI matches @protocol.
381  *
382  * Since: 0.10.4
383  */
384 gboolean
385 gst_uri_has_protocol (const gchar * uri, const gchar * protocol)
386 {
387   gchar *colon;
388
389   g_return_val_if_fail (uri != NULL, FALSE);
390   g_return_val_if_fail (protocol != NULL, FALSE);
391   g_return_val_if_fail (gst_uri_is_valid (uri), FALSE);
392
393   colon = strstr (uri, "://");
394
395   if (colon == NULL)
396     return FALSE;
397
398   return (strncmp (uri, protocol, (size_t) (colon - uri)) == 0);
399 }
400
401 /**
402  * gst_uri_get_location:
403  * @uri: A URI string
404  *
405  * Extracts the location out of a given valid URI. So the protocol and "://"
406  * are stripped from the URI. The returned string must be freed using
407  * g_free().
408  *
409  * Returns: The location for this URI. Returns NULL if the URI isn't valid.
410  */
411 gchar *
412 gst_uri_get_location (const gchar * uri)
413 {
414   gchar *colon;
415   gchar *location, *unescaped;
416
417   g_return_val_if_fail (uri != NULL, NULL);
418   g_return_val_if_fail (gst_uri_is_valid (uri), NULL);
419
420   colon = strstr (uri, "://");
421
422   location = g_strdup (colon + 3);
423
424   unescaped = unescape_string (location, "/");
425   g_free (location);
426
427   return unescaped;
428 }
429
430 /**
431  * gst_uri_construct:
432  * @protocol: Protocol for URI
433  * @location: Location for URI
434  *
435  * Constructs a URI for a given valid protocol and location.
436  *
437  * Returns: a new string for this URI. Returns NULL if the given URI protocol
438  * is not valid, or the given location is NULL.
439  */
440 gchar *
441 gst_uri_construct (const gchar * protocol, const gchar * location)
442 {
443   char *escaped;
444   char *retval;
445
446   g_return_val_if_fail (gst_uri_protocol_is_valid (protocol), NULL);
447   g_return_val_if_fail (location != NULL, NULL);
448
449   escaped = escape_string (location);
450   retval = g_strdup_printf ("%s://%s", protocol, escaped);
451   g_free (escaped);
452
453   return retval;
454 }
455
456 typedef struct
457 {
458   GstURIType type;
459   gchar *protocol;
460 }
461 SearchEntry;
462
463 static gboolean
464 search_by_entry (GstPluginFeature * feature, gpointer search_entry)
465 {
466   gchar **protocols;
467   GstElementFactory *factory;
468   SearchEntry *entry = (SearchEntry *) search_entry;
469
470   if (!GST_IS_ELEMENT_FACTORY (feature))
471     return FALSE;
472   factory = GST_ELEMENT_FACTORY (feature);
473
474   if (gst_element_factory_get_uri_type (factory) != entry->type)
475     return FALSE;
476
477   protocols = gst_element_factory_get_uri_protocols (factory);
478   /* must be set when uri type is valid */
479   g_assert (protocols);
480   while (*protocols != NULL) {
481     if (strcmp (*protocols, entry->protocol) == 0)
482       return TRUE;
483     protocols++;
484   }
485   return FALSE;
486 }
487
488 static gint
489 sort_by_rank (gconstpointer a, gconstpointer b)
490 {
491   GstPluginFeature *first = GST_PLUGIN_FEATURE (a);
492   GstPluginFeature *second = GST_PLUGIN_FEATURE (b);
493
494   return gst_plugin_feature_get_rank (second) -
495       gst_plugin_feature_get_rank (first);
496 }
497
498 /**
499  * gst_element_make_from_uri:
500  * @type: Wether to create a source or a sink
501  * @uri: URI to create an element for
502  * @elementname: Name of created element, can be NULL.
503  *
504  * Creates an element for handling the given URI.
505  *
506  * Returns: a new element or NULL if none could be created
507  */
508 GstElement *
509 gst_element_make_from_uri (const GstURIType type, const gchar * uri,
510     const gchar * elementname)
511 {
512   GList *possibilities, *walk;
513   SearchEntry entry;
514   GstElement *ret = NULL;
515
516   g_return_val_if_fail (GST_URI_TYPE_IS_VALID (type), NULL);
517   g_return_val_if_fail (gst_uri_is_valid (uri), NULL);
518
519   entry.type = type;
520   entry.protocol = gst_uri_get_protocol (uri);
521   possibilities = gst_registry_feature_filter (gst_registry_get_default (),
522       search_by_entry, FALSE, &entry);
523   g_free (entry.protocol);
524
525   if (!possibilities) {
526     GST_DEBUG ("No %s for URI '%s'", type == GST_URI_SINK ? "sink" : "source",
527         uri);
528     return NULL;
529   }
530
531   possibilities = g_list_sort (possibilities, sort_by_rank);
532   walk = possibilities;
533   while (walk) {
534     if ((ret = gst_element_factory_create (GST_ELEMENT_FACTORY (walk->data),
535                 elementname)) != NULL) {
536       GstURIHandler *handler = GST_URI_HANDLER (ret);
537
538       if (gst_uri_handler_set_uri (handler, uri))
539         break;
540       gst_object_unref (ret);
541       ret = NULL;
542     }
543     walk = walk->next;
544   }
545   g_list_free (possibilities);
546
547   GST_LOG_OBJECT (ret, "created %s for URL '%s'",
548       type == GST_URI_SINK ? "sink" : "source", uri);
549   return ret;
550 }
551
552 /**
553  * gst_uri_handler_get_uri_type:
554  * @handler: A #GstURIHandler.
555  *
556  * Gets the type of the given URI handler
557  *
558  * Returns: the #GstURIType of the URI handler.
559  * Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly.
560  */
561 guint
562 gst_uri_handler_get_uri_type (GstURIHandler * handler)
563 {
564   GstURIHandlerInterface *iface;
565   guint ret;
566
567   g_return_val_if_fail (GST_IS_URI_HANDLER (handler), GST_URI_UNKNOWN);
568
569   iface = GST_URI_HANDLER_GET_INTERFACE (handler);
570   g_return_val_if_fail (iface != NULL, GST_URI_UNKNOWN);
571   g_return_val_if_fail (iface->get_type != NULL, GST_URI_UNKNOWN);
572   ret = iface->get_type ();
573   g_return_val_if_fail (GST_URI_TYPE_IS_VALID (ret), GST_URI_UNKNOWN);
574
575   return ret;
576 }
577
578 /**
579  * gst_uri_handler_get_protocols:
580  * @handler: A #GstURIHandler.
581  *
582  * Gets the list of protocols supported by @handler. This list may not be
583  * modified.
584  *
585  * Returns: the supported protocols.
586  * Returns NULL if the @handler isn't implemented properly, or the @handler
587  * doesn't support any protocols.
588  */
589 gchar **
590 gst_uri_handler_get_protocols (GstURIHandler * handler)
591 {
592   GstURIHandlerInterface *iface;
593   gchar **ret;
594
595   g_return_val_if_fail (GST_IS_URI_HANDLER (handler), NULL);
596
597   iface = GST_URI_HANDLER_GET_INTERFACE (handler);
598   g_return_val_if_fail (iface != NULL, NULL);
599   g_return_val_if_fail (iface->get_protocols != NULL, NULL);
600   ret = iface->get_protocols ();
601   g_return_val_if_fail (ret != NULL, NULL);
602
603   return ret;
604 }
605
606 /**
607  * gst_uri_handler_get_uri:
608  * @handler: A #GstURIHandler
609  *
610  * Gets the currently handled URI.
611  *
612  * Returns: the URI currently handler by the @handler.
613  * Returns NULL if there are no URI currently handled.
614  */
615 G_CONST_RETURN gchar *
616 gst_uri_handler_get_uri (GstURIHandler * handler)
617 {
618   GstURIHandlerInterface *iface;
619   const gchar *ret;
620
621   g_return_val_if_fail (GST_IS_URI_HANDLER (handler), NULL);
622
623   iface = GST_URI_HANDLER_GET_INTERFACE (handler);
624   g_return_val_if_fail (iface != NULL, NULL);
625   g_return_val_if_fail (iface->get_uri != NULL, NULL);
626   ret = iface->get_uri (handler);
627   if (ret != NULL)
628     g_return_val_if_fail (gst_uri_is_valid (ret), NULL);
629
630   return ret;
631 }
632
633 /**
634  * gst_uri_handler_set_uri:
635  * @handler: A #GstURIHandler
636  * @uri: URI to set
637  *
638  * Tries to set the URI of the given handler.
639  *
640  * Returns: TRUE if the URI was set successfully, else FALSE.
641  */
642 gboolean
643 gst_uri_handler_set_uri (GstURIHandler * handler, const gchar * uri)
644 {
645   GstURIHandlerInterface *iface;
646
647   g_return_val_if_fail (GST_IS_URI_HANDLER (handler), FALSE);
648   g_return_val_if_fail (gst_uri_is_valid (uri), FALSE);
649
650   iface = GST_URI_HANDLER_GET_INTERFACE (handler);
651   g_return_val_if_fail (iface != NULL, FALSE);
652   g_return_val_if_fail (iface->set_uri != NULL, FALSE);
653   return iface->set_uri (handler, uri);
654 }
655
656 /**
657  * gst_uri_handler_new_uri:
658  * @handler: A #GstURIHandler
659  * @uri: new URI or NULL if it was unset
660  *
661  * Emits the new-uri signal for a given handler, when that handler has a new URI.
662  * This function should only be called by URI handlers themselves.
663  */
664 void
665 gst_uri_handler_new_uri (GstURIHandler * handler, const gchar * uri)
666 {
667   g_return_if_fail (GST_IS_URI_HANDLER (handler));
668
669   g_signal_emit_by_name (handler, "new-uri", uri);
670 }