1 /*****************************************************************************
2 * strings.c: String related functions
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
5 * Copyright (C) 2008-2009 Rémi Denis-Courmont
8 * Authors: Antoine Cellerier <dionoea at videolan dot org>
9 * Daniel Stranger <vlc at schmaller dot de>
10 * Rémi Denis-Courmont <rem # videolan org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
34 #include <vlc_common.h>
37 /* Needed by str_format_time */
41 /* Needed by str_format_meta */
42 #include <vlc_input.h>
44 #include <vlc_playlist.h>
47 #include <vlc_strings.h>
49 #include <vlc_charset.h>
52 * Decode encoded URI component. See also decode_URI().
53 * \return decoded duplicated string
55 char *decode_URI_duplicate( const char *psz )
57 char *psz_dup = strdup( psz );
58 decode_URI( psz_dup );
63 * Decode an encoded URI component in place.
64 * <b>This function does NOT decode entire URIs.</b>
65 * It decodes components (e.g. host name, directory, file name).
66 * Decoded URIs do not exist in the real world (see RFC3986 §2.4).
67 * Complete URIs are always "encoded" (or they are syntaxically invalid).
69 * Note that URI encoding is different from Javascript escaping. Especially,
70 * white spaces and Unicode non-ASCII code points are encoded differently.
72 * \return psz on success, NULL if it was not properly encoded
74 char *decode_URI( char *psz )
76 unsigned char *in = (unsigned char *)psz, *out = in, c;
81 while( ( c = *in++ ) != '\0' )
89 if( ( ( hex[0] = *in++ ) == 0 )
90 || ( ( hex[1] = *in++ ) == 0 ) )
94 *out++ = (unsigned char)strtoul( hex, NULL, 0x10 );
98 case '+': /* This is HTTP forms, not URI decoding... */
103 /* Inserting non-ASCII or non-printable characters is unsafe,
104 * and no sane browser will send these unencoded */
105 if( ( c < 32 ) || ( c > 127 ) )
116 static inline bool isurisafe( int c )
118 /* These are the _unreserved_ URI characters (RFC3986 §2.3) */
119 return ( (unsigned char)( c - 'a' ) < 26 )
120 || ( (unsigned char)( c - 'A' ) < 26 )
121 || ( (unsigned char)( c - '0' ) < 10 )
122 || ( strchr( "-._~", c ) != NULL );
125 static char *encode_URI_bytes (const char *psz_uri, size_t len)
127 char *psz_enc = malloc (3 * len + 1), *out = psz_enc;
131 for (size_t i = 0; i < len; i++)
133 static const char hex[16] = "0123456789ABCDEF";
134 uint8_t c = *psz_uri;
138 /* This is URI encoding, not HTTP forms:
139 * Space is encoded as '%20', not '+'. */
143 *out++ = hex[c >> 4];
144 *out++ = hex[c & 0xf];
150 out = realloc (psz_enc, out - psz_enc);
151 return out ? out : psz_enc; /* realloc() can fail (safe) */
155 * Encodes an URI component (RFC3986 §2).
157 * @param psz_uri nul-terminated UTF-8 representation of the component.
158 * Obviously, you can't pass an URI containing a nul character, but you don't
159 * want to do that, do you?
161 * @return encoded string (must be free()'d), or NULL for ENOMEM.
163 char *encode_URI_component( const char *psz_uri )
165 return encode_URI_bytes (psz_uri, strlen (psz_uri));
169 static const struct xml_entity_s
174 /* Important: this list has to be in alphabetical order (psz_entity-wise) */
256 { "nbsp;", "\xc2\xa0" },
301 static int cmp_entity (const void *key, const void *elem)
303 const struct xml_entity_s *ent = elem;
304 const char *name = key;
306 return strncmp (name, ent->psz_entity, strlen (ent->psz_entity));
310 * Converts "<", ">" and "&" to "<", ">" and "&"
311 * \param string to convert
313 void resolve_xml_special_chars( char *psz_value )
315 char *p_pos = psz_value;
319 if( *psz_value == '&' )
321 if( psz_value[1] == '#' )
322 { /* &#xxx; Unicode code point */
324 unsigned long cp = strtoul( psz_value+2, &psz_end, 10 );
325 if( *psz_end == ';' )
327 psz_value = psz_end + 1;
329 (void)0; /* skip nuls */
336 /* Unicode code point outside ASCII.
337 * &#xxx; representation is longer than UTF-8 :) */
340 *p_pos++ = 0xC0 | (cp >> 6);
341 *p_pos = 0x80 | (cp & 0x3F);
346 *p_pos++ = 0xE0 | (cp >> 12);
347 *p_pos++ = 0x80 | ((cp >> 6) & 0x3F);
348 *p_pos = 0x80 | (cp & 0x3F);
351 if( cp <= 0x1FFFFF ) /* Outside the BMP */
352 { /* Unicode stops at 10FFFF, but who cares? */
353 *p_pos++ = 0xF0 | (cp >> 18);
354 *p_pos++ = 0x80 | ((cp >> 12) & 0x3F);
355 *p_pos++ = 0x80 | ((cp >> 6) & 0x3F);
356 *p_pos = 0x80 | (cp & 0x3F);
361 /* Invalid entity number */
367 { /* Well-known XML entity */
368 const struct xml_entity_s *ent;
370 ent = bsearch (psz_value + 1, xml_entities,
371 sizeof (xml_entities) / sizeof (*ent),
372 sizeof (*ent), cmp_entity);
375 size_t olen = strlen (ent->psz_char);
376 memcpy (p_pos, ent->psz_char, olen);
378 psz_value += strlen (ent->psz_entity) + 1;
400 * Converts '<', '>', '\"', '\'' and '&' to their html entities
401 * \param psz_content simple element content that is to be converted
403 char *convert_xml_special_chars( const char *psz_content )
405 char *psz_temp = malloc( 6 * strlen( psz_content ) + 1 );
406 const char *p_from = psz_content;
407 char *p_to = psz_temp;
411 if ( *p_from == '<' )
413 strcpy( p_to, "<" );
416 else if ( *p_from == '>' )
418 strcpy( p_to, ">" );
421 else if ( *p_from == '&' )
423 strcpy( p_to, "&" );
426 else if( *p_from == '\"' )
428 strcpy( p_to, """ );
431 else if( *p_from == '\'' )
433 strcpy( p_to, "'" );
448 /* Base64 encoding */
449 char *vlc_b64_encode_binary( const uint8_t *src, size_t i_src )
451 static const char b64[] =
452 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
454 char *ret = malloc( ( i_src + 4 ) * 4 / 3 );
462 /* pops (up to) 3 bytes of input, push 4 bytes */
467 *dst++ = b64[v >> 26];
473 *dst++ = b64[v >> 26];
478 v |= *src++ << 20; // 3/3
479 *dst++ = ( i_src >= 2 ) ? b64[v >> 26] : '='; // 3/4
483 *dst++ = ( i_src >= 3 ) ? b64[v >> 26] : '='; // 4/4
495 char *vlc_b64_encode( const char *src )
498 return vlc_b64_encode_binary( (const uint8_t*)src, strlen(src) );
500 return vlc_b64_encode_binary( (const uint8_t*)"", 0 );
503 /* Base64 decoding */
504 size_t vlc_b64_decode_binary_to_buffer( uint8_t *p_dst, size_t i_dst, const char *p_src )
506 static const int b64[256] = {
507 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* 00-0F */
508 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* 10-1F */
509 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,62,-1,-1,-1,63, /* 20-2F */
510 52,53,54,55,56,57,58,59,60,61,-1,-1,-1,-1,-1,-1, /* 30-3F */
511 -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12,13,14, /* 40-4F */
512 15,16,17,18,19,20,21,22,23,24,25,-1,-1,-1,-1,-1, /* 50-5F */
513 -1,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40, /* 60-6F */
514 41,42,43,44,45,46,47,48,49,50,51,-1,-1,-1,-1,-1, /* 70-7F */
515 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* 80-8F */
516 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* 90-9F */
517 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* A0-AF */
518 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* B0-BF */
519 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* C0-CF */
520 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* D0-DF */
521 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, /* E0-EF */
522 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1 /* F0-FF */
524 uint8_t *p_start = p_dst;
525 uint8_t *p = (uint8_t *)p_src;
530 for( i_level = 0, i_last = 0; (size_t)( p_dst - p_start ) < i_dst && *p != '\0'; p++ )
532 const int c = b64[(unsigned int)*p];
542 *p_dst++ = ( i_last << 2 ) | ( ( c >> 4)&0x03 );
546 *p_dst++ = ( ( i_last << 4 )&0xf0 ) | ( ( c >> 2 )&0x0f );
550 *p_dst++ = ( ( i_last &0x03 ) << 6 ) | c;
556 return p_dst - p_start;
558 size_t vlc_b64_decode_binary( uint8_t **pp_dst, const char *psz_src )
560 const int i_src = strlen( psz_src );
563 *pp_dst = p_dst = malloc( i_src );
566 return vlc_b64_decode_binary_to_buffer( p_dst, i_src, psz_src );
568 char *vlc_b64_decode( const char *psz_src )
570 const int i_src = strlen( psz_src );
571 char *p_dst = malloc( i_src + 1 );
576 i_dst = vlc_b64_decode_binary_to_buffer( (uint8_t*)p_dst, i_src, psz_src );
583 * Formats current time into a heap-allocated string.
584 * @param tformat time format (as with C strftime())
585 * @return an allocated string (must be free()'d), or NULL on memory error.
587 char *str_format_time( const char *tformat )
592 if (strcmp (tformat, "") == 0)
593 return strdup (""); /* corner case w.r.t. strftime() return value */
595 /* Get the current time. */
598 /* Convert it to local time representation. */
599 localtime_r( &curtime, &loctime );
600 for (size_t buflen = strlen (tformat) + 32;; buflen += 32)
602 char *str = malloc (buflen);
606 size_t len = strftime (str, buflen, tformat, &loctime);
609 char *ret = realloc (str, len + 1);
610 return ret ? ret : str; /* <- this cannot fail */
616 #define INSERT_STRING( string ) \
617 if( string != NULL ) \
619 int len = strlen( string ); \
620 dst = realloc( dst, i_size = i_size + len );\
621 memcpy( (dst+d), string, len ); \
625 else if( !b_empty_if_na ) \
631 /* same than INSERT_STRING, except that string won't be freed */
632 #define INSERT_STRING_NO_FREE( string ) \
634 int len = strlen( string ); \
635 dst = realloc( dst, i_size = i_size + len );\
636 memcpy( dst+d, string, len ); \
639 char *__str_format_meta( vlc_object_t *p_object, const char *string )
641 const char *s = string;
642 bool b_is_format = false;
643 bool b_empty_if_na = false;
645 int i_size = strlen( string ) + 1; /* +1 to store '\0' */
646 char *dst = strdup( string );
647 if( !dst ) return NULL;
650 playlist_t *p_playlist = pl_Hold( p_object );
651 input_thread_t *p_input = playlist_CurrentInput( p_playlist );
652 input_item_t *p_item = NULL;
653 pl_Release( p_object );
656 p_item = input_GetItem(p_input);
668 INSERT_STRING( input_item_GetArtist( p_item ) );
674 INSERT_STRING( input_item_GetAlbum( p_item ) );
680 INSERT_STRING( input_item_GetCopyright( p_item ) );
686 INSERT_STRING( input_item_GetDescription( p_item ) );
692 INSERT_STRING( input_item_GetEncodedBy( p_item ) );
696 if( p_item && p_item->p_stats )
698 vlc_mutex_lock( &p_item->p_stats->lock );
699 snprintf( buf, 10, "%d",
700 p_item->p_stats->i_displayed_pictures );
701 vlc_mutex_unlock( &p_item->p_stats->lock );
705 sprintf( buf, b_empty_if_na ? "" : "-" );
707 INSERT_STRING_NO_FREE( buf );
712 INSERT_STRING( input_item_GetGenre( p_item ) );
718 INSERT_STRING( input_item_GetLanguage( p_item ) );
724 INSERT_STRING( input_item_GetTrackNum( p_item ) );
730 INSERT_STRING( input_item_GetNowPlaying( p_item ) );
736 INSERT_STRING( input_item_GetRating( p_item ) );
743 lang = var_GetNonEmptyString( p_input, "sub-language" );
745 lang = strdup( b_empty_if_na ? "" : "-" );
746 INSERT_STRING( lang );
752 INSERT_STRING( input_item_GetTitle( p_item ) );
758 INSERT_STRING( input_item_GetURL( p_item ) );
764 INSERT_STRING( input_item_GetDate( p_item ) );
770 snprintf( buf, 10, "%d",
771 var_GetInteger( p_input, "bit-rate" )/1000 );
775 sprintf( buf, b_empty_if_na ? "" : "-" );
777 INSERT_STRING_NO_FREE( buf );
782 snprintf( buf, 10, "%d",
783 var_GetInteger( p_input, "chapter" ) );
787 sprintf( buf, b_empty_if_na ? "" : "-" );
789 INSERT_STRING_NO_FREE( buf );
794 mtime_t i_duration = input_item_GetDuration( p_item );
795 snprintf( buf, 10, "%02d:%02d:%02d",
796 (int)(i_duration/(3600000000)),
797 (int)((i_duration/(60000000))%60),
798 (int)((i_duration/1000000)%60) );
802 snprintf( buf, 10, b_empty_if_na ? "" : "--:--:--" );
804 INSERT_STRING_NO_FREE( buf );
809 INSERT_STRING( input_item_GetURI( p_item ) );
815 snprintf( buf, 10, "%d",
816 var_GetInteger( p_input, "title" ) );
820 sprintf( buf, b_empty_if_na ? "" : "-" );
822 INSERT_STRING_NO_FREE( buf );
825 if( p_item && p_input )
827 mtime_t i_duration = input_item_GetDuration( p_item );
828 int64_t i_time = var_GetTime( p_input, "time" );
829 snprintf( buf, 10, "%02d:%02d:%02d",
830 (int)( ( i_duration - i_time ) / 3600000000 ),
831 (int)( ( ( i_duration - i_time ) / 60000000 ) % 60 ),
832 (int)( ( ( i_duration - i_time ) / 1000000 ) % 60 ) );
836 snprintf( buf, 10, b_empty_if_na ? "" : "--:--:--" );
838 INSERT_STRING_NO_FREE( buf );
843 INSERT_STRING( input_item_GetName( p_item ) );
850 lang = var_GetNonEmptyString( p_input,
853 lang = strdup( b_empty_if_na ? "" : "-" );
854 INSERT_STRING( lang );
860 snprintf( buf, 10, "%2.1lf",
861 var_GetFloat( p_input, "position" ) * 100. );
865 snprintf( buf, 10, b_empty_if_na ? "" : "--.-%%" );
867 INSERT_STRING_NO_FREE( buf );
872 int r = var_GetInteger( p_input, "rate" );
873 snprintf( buf, 10, "%d.%d", r/1000, r%1000 );
877 sprintf( buf, b_empty_if_na ? "" : "-" );
879 INSERT_STRING_NO_FREE( buf );
884 int r = var_GetInteger( p_input, "sample-rate" );
885 snprintf( buf, 10, "%d.%d", r/1000, (r/100)%10 );
889 sprintf( buf, b_empty_if_na ? "" : "-" );
891 INSERT_STRING_NO_FREE( buf );
896 int64_t i_time = var_GetTime( p_input, "time" );
897 snprintf( buf, 10, "%02d:%02d:%02d",
898 (int)( i_time / ( 3600000000 ) ),
899 (int)( ( i_time / ( 60000000 ) ) % 60 ),
900 (int)( ( i_time / 1000000 ) % 60 ) );
904 snprintf( buf, 10, b_empty_if_na ? "" : "--:--:--" );
906 INSERT_STRING_NO_FREE( buf );
911 INSERT_STRING( input_item_GetPublisher( p_item ) );
916 audio_volume_t volume;
917 aout_VolumeGet( p_object, &volume );
918 snprintf( buf, 10, "%d", volume );
919 INSERT_STRING_NO_FREE( buf );
928 b_empty_if_na = true;
942 b_empty_if_na = false;
954 vlc_object_release( p_input );
959 #undef INSERT_STRING_NO_FREE
962 * Apply str format time and str format meta
964 char *__str_format( vlc_object_t *p_this, const char *psz_src )
966 char *psz_buf1, *psz_buf2;
967 psz_buf1 = str_format_time( psz_src );
968 psz_buf2 = str_format_meta( p_this, psz_buf1 );
974 * Remove forbidden characters from filenames (including slashes)
976 char* filename_sanitize( const char *str_origin )
978 char *str = strdup( str_origin );
979 char *str_base = str;
980 if( *str == '.' && (str[1] == '\0' || (str[1] == '.' && str[2] == '\0' ) ) )
991 // Change leading spaces into underscores
992 while( *str && *str == ' ' )
1001 #if defined( __APPLE__ )
1003 #elif defined( WIN32 )
1018 #if defined( WIN32 )
1019 // Change trailing spaces into underscores
1021 while( str != str_base )
1033 * Remove forbidden characters from full paths (leaves slashes)
1035 void path_sanitize( char *str )
1038 /* check drive prefix if path is absolute */
1039 if( (((unsigned char)(str[0] - 'A') < 26)
1040 || ((unsigned char)(str[0] - 'a') < 26)) && (':' == str[1]) )
1045 #if defined( __APPLE__ )
1048 #elif defined( WIN32 )
1049 if( strchr( "*\"?:|<>", *str ) )
1052 *str = DIR_SEP_CHAR;
1058 #include <vlc_url.h>
1061 * Convert a file path to an URI. If already an URI, do nothing.
1063 char *make_URI (const char *path)
1067 if (strstr (path, "://") != NULL)
1068 return strdup (path); /* Already an URI */
1069 /* Note: VLC cannot handle URI schemes without double slash after the
1070 * scheme name (such as mailto: or news:). */
1074 if (isalpha (path[0]) && (path[1] == ':'))
1076 if (asprintf (&buf, "file:///%c:", path[0]) == -1)
1083 /* Windows UNC paths (file://host/share/path instead of file:///path) */
1084 if (!strncmp (path, "\\\\", 2))
1087 buf = strdup ("file://");
1091 if (path[0] != DIR_SEP_CHAR)
1092 { /* Relative path: prepend the current working directory */
1095 if (getcwd (cwd, sizeof (cwd)) == NULL) /* FIXME: UTF8? */
1097 if (asprintf (&buf, "%s/%s", cwd, path) == -1)
1099 char *ret = make_URI (buf);
1104 buf = strdup ("file://");
1108 assert (path[0] == DIR_SEP_CHAR);
1110 /* Absolute file path */
1111 for (const char *ptr = path + 1;; ptr++)
1113 size_t len = strcspn (ptr, DIR_SEP);
1114 char *component = encode_URI_bytes (ptr, len);
1115 if (component == NULL)
1121 int val = asprintf (&uri, "%s/%s", buf, component);