/*****************************************************************************
* strings.c: String related functions
*****************************************************************************
- * Copyright (C) 2006 the VideoLAN team
+ * Copyright (C) 2006 VLC authors and VideoLAN
+ * Copyright (C) 2008-2009 Rémi Denis-Courmont
* $Id$
*
* Authors: Antoine Cellerier <dionoea at videolan dot org>
* Daniel Stranger <vlc at schmaller dot de>
* Rémi Denis-Courmont <rem # videolan org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
/* Needed by str_format_time */
#include <time.h>
+#include <limits.h>
+#include <math.h>
/* Needed by str_format_meta */
#include <vlc_input.h>
#include <vlc_meta.h>
-#include <vlc_playlist.h>
#include <vlc_aout.h>
#include <vlc_strings.h>
-#include <vlc_url.h>
#include <vlc_charset.h>
-
-/**
- * Unescape URI encoded string
- * \return decoded duplicated string
- */
-char *unescape_URI_duplicate( const char *psz )
-{
- char *psz_dup = strdup( psz );
- unescape_URI( psz_dup );
- return psz_dup;
-}
-
-/**
- * Unescape URI encoded string in place
- * \return nothing
- */
-void unescape_URI( char *psz )
-{
- unsigned char *in = (unsigned char *)psz, *out = in, c;
- if( psz == NULL )
- return;
-
- while( ( c = *in++ ) != '\0' )
- {
- switch( c )
- {
- case '%':
- {
- char val[5], *pval = val;
- unsigned long cp;
-
- switch( c = *in++ )
- {
- case '\0':
- return;
-
- case 'u':
- case 'U':
- if( ( *pval++ = *in++ ) == '\0' )
- return;
- if( ( *pval++ = *in++ ) == '\0' )
- return;
- c = *in++;
-
- default:
- *pval++ = c;
- if( ( *pval++ = *in++ ) == '\0' )
- return;
- *pval = '\0';
- }
-
- cp = strtoul( val, NULL, 0x10 );
- if( cp < 0x80 )
- *out++ = cp;
- else
- if( cp < 0x800 )
- {
- *out++ = (( cp >> 6) | 0xc0);
- *out++ = (( cp & 0x3f) | 0x80);
- }
- else
- {
- assert( cp < 0x10000 );
- *out++ = (( cp >> 12) | 0xe0);
- *out++ = (((cp >> 6) & 0x3f) | 0x80);
- *out++ = (( cp & 0x3f) | 0x80);
- }
- break;
- }
-
- /* + is not a special case - it means plus, not space. */
-
- default:
- /* Inserting non-ASCII or non-printable characters is unsafe,
- * and no sane browser will send these unencoded */
- if( ( c < 32 ) || ( c > 127 ) )
- *out++ = '?';
- else
- *out++ = c;
- }
- }
- *out = '\0';
-}
-
-/**
- * Decode encoded URI string
- * \return decoded duplicated string
- */
-char *decode_URI_duplicate( const char *psz )
-{
- char *psz_dup = strdup( psz );
- decode_URI( psz_dup );
- return psz_dup;
-}
-
-/**
- * Decode encoded URI string in place
- * \return nothing
- */
-void decode_URI( char *psz )
-{
- unsigned char *in = (unsigned char *)psz, *out = in, c;
- if( psz == NULL )
- return;
-
- while( ( c = *in++ ) != '\0' )
- {
- switch( c )
- {
- case '%':
- {
- char hex[3];
-
- if( ( ( hex[0] = *in++ ) == 0 )
- || ( ( hex[1] = *in++ ) == 0 ) )
- return;
-
- hex[2] = '\0';
- *out++ = (unsigned char)strtoul( hex, NULL, 0x10 );
- break;
- }
-
- case '+':
- *out++ = ' ';
- break;
-
- default:
- /* Inserting non-ASCII or non-printable characters is unsafe,
- * and no sane browser will send these unencoded */
- if( ( c < 32 ) || ( c > 127 ) )
- *out++ = '?';
- else
- *out++ = c;
- }
- }
- *out = '\0';
- EnsureUTF8( psz );
-}
-
-static inline bool isurisafe( int c )
-{
- /* These are the _unreserved_ URI characters (RFC3986 §2.3) */
- return ( (unsigned char)( c - 'a' ) < 26 )
- || ( (unsigned char)( c - 'A' ) < 26 )
- || ( (unsigned char)( c - '0' ) < 10 )
- || ( strchr( "-._~", c ) != NULL );
-}
-
-/**
- * Encodes an URI component (RFC3986 §2).
- *
- * @param psz_uri nul-terminated UTF-8 representation of the component.
- * Obviously, you can't pass an URI containing a nul character, but you don't
- * want to do that, do you?
- *
- * @return encoded string (must be free()'d), or NULL for ENOMEM.
- */
-char *encode_URI_component( const char *psz_uri )
-{
- char *psz_enc = malloc ((3 * strlen (psz_uri)) + 1), *out = psz_enc;
-
- if (psz_enc == NULL)
- return NULL;
-
- while (*psz_uri)
- {
- static const char hex[16] = "0123456789ABCDEF";
- uint8_t c = *psz_uri;
-
- if( isurisafe( c ) )
- *out++ = c;
- /* This is URI encoding, not HTTP forms:
- * Space is encoded as '%20', not '+'. */
- else
- {
- *out++ = '%';
- *out++ = hex[c >> 4];
- *out++ = hex[c & 0xf];
- }
- psz_uri++;
- }
- *out++ = '\0';
-
- out = realloc (psz_enc, out - psz_enc);
- return out ? out : psz_enc; /* realloc() can fail (safe) */
-}
+#include <libvlc.h>
+#include <errno.h>
static const struct xml_entity_s
{
char psz_entity[8];
- uint8_t i_length;
char psz_char[4];
-} p_xml_entities[] = {
+} xml_entities[] = {
/* Important: this list has to be in alphabetical order (psz_entity-wise) */
- { "AElig;", 6, "Æ" },
- { "Aacute;", 7, "Á" },
- { "Acirc;", 6, "Â" },
- { "Agrave;", 7, "À" },
- { "Aring;", 6, "Å" },
- { "Atilde;", 7, "Ã" },
- { "Auml;", 5, "Ä" },
- { "Ccedil;", 7, "Ç" },
- { "Dagger;", 7, "‡" },
- { "ETH;", 4, "Ð" },
- { "Eacute;", 7, "É" },
- { "Ecirc;", 6, "Ê" },
- { "Egrave;", 7, "È" },
- { "Euml;", 5, "Ë" },
- { "Iacute;", 7, "Í" },
- { "Icirc;", 6, "Î" },
- { "Igrave;", 7, "Ì" },
- { "Iuml;", 5, "Ï" },
- { "Ntilde;", 7, "Ñ" },
- { "OElig;", 6, "Œ" },
- { "Oacute;", 7, "Ó" },
- { "Ocirc;", 6, "Ô" },
- { "Ograve;", 7, "Ò" },
- { "Oslash;", 7, "Ø" },
- { "Otilde;", 7, "Õ" },
- { "Ouml;", 5, "Ö" },
- { "Scaron;", 7, "Š" },
- { "THORN;", 6, "Þ" },
- { "Uacute;", 7, "Ú" },
- { "Ucirc;", 6, "Û" },
- { "Ugrave;", 7, "Ù" },
- { "Uuml;", 5, "Ü" },
- { "Yacute;", 7, "Ý" },
- { "Yuml;", 5, "Ÿ" },
- { "aacute;", 7, "á" },
- { "acirc;", 6, "â" },
- { "acute;", 6, "´" },
- { "aelig;", 6, "æ" },
- { "agrave;", 7, "à" },
- { "aring;", 6, "å" },
- { "atilde;", 7, "ã" },
- { "auml;", 5, "ä" },
- { "bdquo;", 6, "„" },
- { "brvbar;", 7, "¦" },
- { "ccedil;", 7, "ç" },
- { "cedil;", 6, "¸" },
- { "cent;", 5, "¢" },
- { "circ;", 5, "ˆ" },
- { "copy;", 5, "©" },
- { "curren;", 7, "¤" },
- { "dagger;", 7, "†" },
- { "deg;", 4, "°" },
- { "divide;", 7, "÷" },
- { "eacute;", 7, "é" },
- { "ecirc;", 6, "ê" },
- { "egrave;", 7, "è" },
- { "eth;", 4, "ð" },
- { "euml;", 5, "ë" },
- { "euro;", 5, "€" },
- { "frac12;", 7, "½" },
- { "frac14;", 7, "¼" },
- { "frac34;", 7, "¾" },
- { "hellip;", 7, "…" },
- { "iacute;", 7, "í" },
- { "icirc;", 6, "î" },
- { "iexcl;", 6, "¡" },
- { "igrave;", 7, "ì" },
- { "iquest;", 7, "¿" },
- { "iuml;", 5, "ï" },
- { "laquo;", 6, "«" },
- { "ldquo;", 6, "“" },
- { "lsaquo;", 7, "‹" },
- { "lsquo;", 6, "‘" },
- { "macr;", 5, "¯" },
- { "mdash;", 6, "—" },
- { "micro;", 6, "µ" },
- { "middot;", 7, "·" },
- { "ndash;", 6, "–" },
- { "not;", 4, "¬" },
- { "ntilde;", 7, "ñ" },
- { "oacute;", 7, "ó" },
- { "ocirc;", 6, "ô" },
- { "oelig;", 6, "œ" },
- { "ograve;", 7, "ò" },
- { "ordf;", 5, "ª" },
- { "ordm;", 5, "º" },
- { "oslash;", 7, "ø" },
- { "otilde;", 7, "õ" },
- { "ouml;", 5, "ö" },
- { "para;", 5, "¶" },
- { "permil;", 7, "‰" },
- { "plusmn;", 7, "±" },
- { "pound;", 6, "£" },
- { "raquo;", 6, "»" },
- { "rdquo;", 6, "”" },
- { "reg;", 4, "®" },
- { "rsaquo;", 7, "›" },
- { "rsquo;", 6, "’" },
- { "sbquo;", 6, "‚" },
- { "scaron;", 7, "š" },
- { "sect;", 5, "§" },
- { "shy;", 4, "" },
- { "sup1;", 5, "¹" },
- { "sup2;", 5, "²" },
- { "sup3;", 5, "³" },
- { "szlig;", 6, "ß" },
- { "thorn;", 6, "þ" },
- { "tilde;", 6, "˜" },
- { "times;", 6, "×" },
- { "trade;", 6, "™" },
- { "uacute;", 7, "ú" },
- { "ucirc;", 6, "û" },
- { "ugrave;", 7, "ù" },
- { "uml;", 4, "¨" },
- { "uuml;", 5, "ü" },
- { "yacute;", 7, "ý" },
- { "yen;", 4, "¥" },
- { "yuml;", 5, "ÿ" },
+ { "AElig;", "Æ" },
+ { "Aacute;", "Á" },
+ { "Acirc;", "Â" },
+ { "Agrave;", "À" },
+ { "Aring;", "Å" },
+ { "Atilde;", "Ã" },
+ { "Auml;", "Ä" },
+ { "Ccedil;", "Ç" },
+ { "Dagger;", "‡" },
+ { "ETH;", "Ð" },
+ { "Eacute;", "É" },
+ { "Ecirc;", "Ê" },
+ { "Egrave;", "È" },
+ { "Euml;", "Ë" },
+ { "Iacute;", "Í" },
+ { "Icirc;", "Î" },
+ { "Igrave;", "Ì" },
+ { "Iuml;", "Ï" },
+ { "Ntilde;", "Ñ" },
+ { "OElig;", "Œ" },
+ { "Oacute;", "Ó" },
+ { "Ocirc;", "Ô" },
+ { "Ograve;", "Ò" },
+ { "Oslash;", "Ø" },
+ { "Otilde;", "Õ" },
+ { "Ouml;", "Ö" },
+ { "Scaron;", "Š" },
+ { "THORN;", "Þ" },
+ { "Uacute;", "Ú" },
+ { "Ucirc;", "Û" },
+ { "Ugrave;", "Ù" },
+ { "Uuml;", "Ü" },
+ { "Yacute;", "Ý" },
+ { "Yuml;", "Ÿ" },
+ { "aacute;", "á" },
+ { "acirc;", "â" },
+ { "acute;", "´" },
+ { "aelig;", "æ" },
+ { "agrave;", "à" },
+ { "amp;", "&" },
+ { "apos;", "'" },
+ { "aring;", "å" },
+ { "atilde;", "ã" },
+ { "auml;", "ä" },
+ { "bdquo;", "„" },
+ { "brvbar;", "¦" },
+ { "ccedil;", "ç" },
+ { "cedil;", "¸" },
+ { "cent;", "¢" },
+ { "circ;", "ˆ" },
+ { "copy;", "©" },
+ { "curren;", "¤" },
+ { "dagger;", "†" },
+ { "deg;", "°" },
+ { "divide;", "÷" },
+ { "eacute;", "é" },
+ { "ecirc;", "ê" },
+ { "egrave;", "è" },
+ { "eth;", "ð" },
+ { "euml;", "ë" },
+ { "euro;", "€" },
+ { "frac12;", "½" },
+ { "frac14;", "¼" },
+ { "frac34;", "¾" },
+ { "gt;", ">" },
+ { "hellip;", "…" },
+ { "iacute;", "í" },
+ { "icirc;", "î" },
+ { "iexcl;", "¡" },
+ { "igrave;", "ì" },
+ { "iquest;", "¿" },
+ { "iuml;", "ï" },
+ { "laquo;", "«" },
+ { "ldquo;", "“" },
+ { "lsaquo;", "‹" },
+ { "lsquo;", "‘" },
+ { "lt;", "<" },
+ { "macr;", "¯" },
+ { "mdash;", "—" },
+ { "micro;", "µ" },
+ { "middot;", "·" },
+ { "nbsp;", "\xc2\xa0" },
+ { "ndash;", "–" },
+ { "not;", "¬" },
+ { "ntilde;", "ñ" },
+ { "oacute;", "ó" },
+ { "ocirc;", "ô" },
+ { "oelig;", "œ" },
+ { "ograve;", "ò" },
+ { "ordf;", "ª" },
+ { "ordm;", "º" },
+ { "oslash;", "ø" },
+ { "otilde;", "õ" },
+ { "ouml;", "ö" },
+ { "para;", "¶" },
+ { "permil;", "‰" },
+ { "plusmn;", "±" },
+ { "pound;", "£" },
+ { "quot;", "\"" },
+ { "raquo;", "»" },
+ { "rdquo;", "”" },
+ { "reg;", "®" },
+ { "rsaquo;", "›" },
+ { "rsquo;", "’" },
+ { "sbquo;", "‚" },
+ { "scaron;", "š" },
+ { "sect;", "§" },
+ { "shy;", "" },
+ { "sup1;", "¹" },
+ { "sup2;", "²" },
+ { "sup3;", "³" },
+ { "szlig;", "ß" },
+ { "thorn;", "þ" },
+ { "tilde;", "˜" },
+ { "times;", "×" },
+ { "trade;", "™" },
+ { "uacute;", "ú" },
+ { "ucirc;", "û" },
+ { "ugrave;", "ù" },
+ { "uml;", "¨" },
+ { "uuml;", "ü" },
+ { "yacute;", "ý" },
+ { "yen;", "¥" },
+ { "yuml;", "ÿ" },
};
+static int cmp_entity (const void *key, const void *elem)
+{
+ const struct xml_entity_s *ent = elem;
+ const char *name = key;
+
+ return strncmp (name, ent->psz_entity, strlen (ent->psz_entity));
+}
+
/**
* Converts "<", ">" and "&" to "<", ">" and "&"
* \param string to convert
{
if( *psz_value == '&' )
{
- char *psz_value1 = psz_value + 1;
-#define TRY_CHAR( src, len, dst ) \
- if( !strncmp( psz_value1, src, len ) ) \
- { \
- *p_pos = dst; \
- psz_value += len + 1; \
- }
- TRY_CHAR( "lt;", 3, '<' )
- else TRY_CHAR( "amp;", 4, '&' )
- else TRY_CHAR( "apos;", 5, '\'' )
- else TRY_CHAR( "gt;", 3, '>' )
- else TRY_CHAR( "quot;", 5, '"' )
-#undef TRY_CHAR
- else if( *psz_value1 == '#' )
- {
+ if( psz_value[1] == '#' )
+ { /* &#DDD; or &#xHHHH; Unicode code point */
char *psz_end;
- int i = strtol( psz_value+2, &psz_end, 10 );
+ unsigned long cp;
+
+ if( psz_value[2] == 'x' ) /* The x must be lower-case. */
+ cp = strtoul( psz_value + 3, &psz_end, 16 );
+ else
+ cp = strtoul( psz_value + 2, &psz_end, 10 );
+
if( *psz_end == ';' )
{
- if( i >= 32 && i <= 126 )
+ psz_value = psz_end + 1;
+ if( cp == 0 )
+ (void)0; /* skip nuls */
+ else
+ if( cp <= 0x7F )
+ {
+ *p_pos = cp;
+ }
+ else
+ /* Unicode code point outside ASCII.
+ * &#xxx; representation is longer than UTF-8 :) */
+ if( cp <= 0x7FF )
{
- *p_pos = (char)i;
- psz_value = psz_end+1;
+ *p_pos++ = 0xC0 | (cp >> 6);
+ *p_pos = 0x80 | (cp & 0x3F);
}
else
+ if( cp <= 0xFFFF )
{
- /* Unhandled code, FIXME */
- *p_pos = *psz_value;
- psz_value++;
+ *p_pos++ = 0xE0 | (cp >> 12);
+ *p_pos++ = 0x80 | ((cp >> 6) & 0x3F);
+ *p_pos = 0x80 | (cp & 0x3F);
+ }
+ else
+ if( cp <= 0x1FFFFF ) /* Outside the BMP */
+ { /* Unicode stops at 10FFFF, but who cares? */
+ *p_pos++ = 0xF0 | (cp >> 18);
+ *p_pos++ = 0x80 | ((cp >> 12) & 0x3F);
+ *p_pos++ = 0x80 | ((cp >> 6) & 0x3F);
+ *p_pos = 0x80 | (cp & 0x3F);
}
}
else
}
}
else
- {
- const size_t i_entities = sizeof( p_xml_entities ) /
- sizeof( p_xml_entities[0] );
- assert( i_entities < 128 );
- size_t step = 128>>1;
- size_t i = step-1;
- int cmp = -1;
- while( step )
+ { /* Well-known XML entity */
+ const struct xml_entity_s *ent;
+
+ ent = bsearch (psz_value + 1, xml_entities,
+ sizeof (xml_entities) / sizeof (*ent),
+ sizeof (*ent), cmp_entity);
+ if (ent != NULL)
{
- step >>= 1;
- if( i >= i_entities )
- cmp = -1;
- else
- cmp = strncmp( psz_value1, /* Skip the & */
- p_xml_entities[i].psz_entity,
- p_xml_entities[i].i_length );
- if( cmp == 0 )
- {
- size_t i_len = strlen( p_xml_entities[i].psz_char );
- strncpy( p_pos, p_xml_entities[i].psz_char, i_len );
- p_pos += i_len - 1;
- psz_value += p_xml_entities[i].i_length+1;
- break;
- }
- else if( cmp < 0 )
- i -= step;
- else
- i += step;
+ size_t olen = strlen (ent->psz_char);
+ memcpy (p_pos, ent->psz_char, olen);
+ p_pos += olen - 1;
+ psz_value += strlen (ent->psz_entity) + 1;
}
- if( cmp != 0 )
- {
+ else
+ { /* No match */
*p_pos = *psz_value;
psz_value++;
}
}
/**
- * Converts '<', '>', '\"', '\'' and '&' to their html entities
- * \param psz_content simple element content that is to be converted
+ * XML-encode an UTF-8 string
+ * \param str nul-terminated UTF-8 byte sequence to XML-encode
+ * \return XML encoded string or NULL on error
+ * (errno is set to ENOMEM or EILSEQ as appropriate)
*/
-char *convert_xml_special_chars( const char *psz_content )
+char *convert_xml_special_chars (const char *str)
{
- char *psz_temp = malloc( 6 * strlen( psz_content ) + 1 );
- const char *p_from = psz_content;
- char *p_to = psz_temp;
+ assert (str != NULL);
+
+ const size_t len = strlen (str);
+ char *const buf = malloc (6 * len + 1), *ptr = buf;
+ if (unlikely(buf == NULL))
+ return NULL;
+
+ size_t n;
+ uint32_t cp;
- while ( *p_from )
+ while ((n = vlc_towc (str, &cp)) != 0)
{
- if ( *p_from == '<' )
- {
- strcpy( p_to, "<" );
- p_to += 4;
- }
- else if ( *p_from == '>' )
- {
- strcpy( p_to, ">" );
- p_to += 4;
- }
- else if ( *p_from == '&' )
+ if (unlikely(n == (size_t)-1))
{
- strcpy( p_to, "&" );
- p_to += 5;
- }
- else if( *p_from == '\"' )
- {
- strcpy( p_to, """ );
- p_to += 6;
- }
- else if( *p_from == '\'' )
- {
- strcpy( p_to, "'" );
- p_to += 6;
+ free (buf);
+ errno = EILSEQ;
+ return NULL;
}
+
+ if ((cp & ~0x0080) < 32 /* C0/C1 control codes */
+ && memchr ("\x09\x0A\x0D\x85", cp, 4) == NULL)
+ ptr += sprintf (ptr, "&#%"PRIu32";", cp);
else
+ switch (cp)
{
- *p_to = *p_from;
- p_to++;
+ case '\"': strcpy (ptr, """); ptr += 6; break;
+ case '&': strcpy (ptr, "&"); ptr += 5; break;
+ case '\'': strcpy (ptr, "'"); ptr += 5; break;
+ case '<': strcpy (ptr, "<"); ptr += 4; break;
+ case '>': strcpy (ptr, ">"); ptr += 4; break;
+ default: memcpy (ptr, str, n); ptr += n; break;
}
- p_from++;
+ str += n;
}
- *p_to = '\0';
+ *(ptr++) = '\0';
- return psz_temp;
+ ptr = realloc (buf, ptr - buf);
+ return likely(ptr != NULL) ? ptr : buf; /* cannot fail */
}
/* Base64 encoding */
{
const int c = b64[(unsigned int)*p];
if( c == -1 )
- continue;
+ break;
switch( i_level )
{
return p_dst;
}
-/****************************************************************************
- * String formating functions
- ****************************************************************************/
+/**
+ * Formats current time into a heap-allocated string.
+ * @param tformat time format (as with C strftime())
+ * @return an allocated string (must be free()'d), or NULL on memory error.
+ */
char *str_format_time( const char *tformat )
{
- char buffer[255];
time_t curtime;
struct tm loctime;
+ if (strcmp (tformat, "") == 0)
+ return strdup (""); /* corner case w.r.t. strftime() return value */
+
/* Get the current time. */
- curtime = time( NULL );
+ time( &curtime );
/* Convert it to local time representation. */
localtime_r( &curtime, &loctime );
- strftime( buffer, 255, tformat, &loctime );
- return strdup( buffer );
+ for (size_t buflen = strlen (tformat) + 32;; buflen += 32)
+ {
+ char *str = malloc (buflen);
+ if (str == NULL)
+ return NULL;
+
+ size_t len = strftime (str, buflen, tformat, &loctime);
+ if (len > 0)
+ {
+ char *ret = realloc (str, len + 1);
+ return ret ? ret : str; /* <- this cannot fail */
+ }
+ free (str);
+ }
+ vlc_assert_unreachable ();
}
-#define INSERT_STRING( string ) \
- if( string != NULL ) \
- { \
- int len = strlen( string ); \
- dst = realloc( dst, i_size = i_size + len );\
- memcpy( (dst+d), string, len ); \
- d += len; \
- free( string ); \
- } \
- else if( !b_empty_if_na ) \
- { \
- *(dst+d) = '-'; \
- d++; \
- } \
-
-/* same than INSERT_STRING, except that string won't be freed */
-#define INSERT_STRING_NO_FREE( string ) \
- { \
- int len = strlen( string ); \
- dst = realloc( dst, i_size = i_size + len );\
- memcpy( dst+d, string, len ); \
- d += len; \
- }
-char *__str_format_meta( vlc_object_t *p_object, const char *string )
+static void write_duration(FILE *stream, int64_t duration)
{
- const char *s = string;
+ lldiv_t d;
+ long long sec;
+
+ duration /= CLOCK_FREQ;
+ d = lldiv(duration, 60);
+ sec = d.rem;
+ d = lldiv(d.quot, 60);
+ fprintf(stream, "%02lld:%02lld:%02lld", d.quot, d.rem, sec);
+}
+
+static int write_meta(FILE *stream, input_item_t *item, vlc_meta_type_t type)
+{
+ if (item == NULL)
+ return EOF;
+
+ char *value = input_item_GetMeta(item, type);
+ if (value == NULL)
+ return EOF;
+
+ int ret = fputs(value, stream);
+ free(value);
+ return ret;
+}
+
+char *str_format_meta(input_thread_t *input, const char *s)
+{
+ char *str;
+ size_t len;
+#ifdef HAVE_OPEN_MEMSTREAM
+ FILE *stream = open_memstream(&str, &len);
+#elif defined( _WIN32 )
+ FILE *stream = vlc_win32_tmpfile();
+#else
+ FILE *stream = tmpfile();
+#endif
+ if (stream == NULL)
+ return NULL;
+
+ input_item_t *item = (input != NULL) ? input_GetItem(input) : NULL;
+
+ char c;
bool b_is_format = false;
bool b_empty_if_na = false;
- char buf[10];
- int i_size = strlen( string ) + 1; /* +1 to store '\0' */
- char *dst = strdup( string );
- if( !dst ) return NULL;
- int d = 0;
-
- playlist_t *p_playlist = pl_Hold( p_object );
- input_thread_t *p_input = playlist_CurrentInput( p_playlist );
- input_item_t *p_item = NULL;
- pl_Release( p_object );
- if( p_input )
- {
- p_item = input_GetItem(p_input);
- }
- while( *s )
+ while ((c = *s) != '\0')
{
- if( b_is_format )
+ s++;
+
+ if (!b_is_format)
{
- switch( *s )
+ if (c == '$')
{
- case 'a':
- if( p_item )
- {
- INSERT_STRING( input_item_GetArtist( p_item ) );
- }
- break;
- case 'b':
- if( p_item )
- {
- INSERT_STRING( input_item_GetAlbum( p_item ) );
- }
- break;
- case 'c':
- if( p_item )
- {
- INSERT_STRING( input_item_GetCopyright( p_item ) );
- }
- break;
- case 'd':
- if( p_item )
- {
- INSERT_STRING( input_item_GetDescription( p_item ) );
- }
- break;
- case 'e':
- if( p_item )
- {
- INSERT_STRING( input_item_GetEncodedBy( p_item ) );
- }
- break;
- case 'f':
- if( p_item && p_item->p_stats )
- {
- snprintf( buf, 10, "%d",
- p_item->p_stats->i_displayed_pictures );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "-" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'g':
- if( p_item )
- {
- INSERT_STRING( input_item_GetGenre( p_item ) );
- }
- break;
- case 'l':
- if( p_item )
- {
- INSERT_STRING( input_item_GetLanguage( p_item ) );
- }
- break;
- case 'n':
- if( p_item )
- {
- INSERT_STRING( input_item_GetTrackNum( p_item ) );
- }
- break;
- case 'p':
- if( p_item )
- {
- INSERT_STRING( input_item_GetNowPlaying( p_item ) );
- }
- break;
- case 'r':
- if( p_item )
- {
- INSERT_STRING( input_item_GetRating( p_item ) );
- }
- break;
- case 's':
+ b_is_format = true;
+ b_empty_if_na = false;
+ continue;
+ }
+
+ fputc(c, stream);
+ continue;
+ }
+
+ b_is_format = false;
+
+ switch (c)
+ {
+ case 'a':
+ write_meta(stream, item, vlc_meta_Artist);
+ break;
+ case 'b':
+ write_meta(stream, item, vlc_meta_Album);
+ break;
+ case 'c':
+ write_meta(stream, item, vlc_meta_Copyright);
+ break;
+ case 'd':
+ write_meta(stream, item, vlc_meta_Description);
+ break;
+ case 'e':
+ write_meta(stream, item, vlc_meta_EncodedBy);
+ break;
+ case 'f':
+ if (item != NULL && item->p_stats != NULL)
{
- char *lang = NULL;
- if( p_input )
- lang = var_GetNonEmptyString( p_input, "sub-language" );
- if( lang == NULL )
- lang = strdup( b_empty_if_na ? "" : "-" );
- INSERT_STRING( lang );
- break;
+ vlc_mutex_lock(&item->p_stats->lock);
+ fprintf(stream, "%"PRIi64,
+ item->p_stats->i_displayed_pictures);
+ vlc_mutex_unlock(&item->p_stats->lock);
}
- case 't':
- if( p_item )
- {
- INSERT_STRING( input_item_GetTitle( p_item ) );
- }
- break;
- case 'u':
- if( p_item )
- {
- INSERT_STRING( input_item_GetURL( p_item ) );
- }
- break;
- case 'A':
- if( p_item )
- {
- INSERT_STRING( input_item_GetDate( p_item ) );
- }
- break;
- case 'B':
- if( p_input )
- {
- snprintf( buf, 10, "%d",
- var_GetInteger( p_input, "bit-rate" )/1000 );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "-" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'C':
- if( p_input )
- {
- snprintf( buf, 10, "%d",
- var_GetInteger( p_input, "chapter" ) );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "-" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'D':
- if( p_item )
- {
- mtime_t i_duration = input_item_GetDuration( p_item );
- sprintf( buf, "%02d:%02d:%02d",
- (int)(i_duration/(3600000000)),
- (int)((i_duration/(60000000))%60),
- (int)((i_duration/1000000)%60) );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "--:--:--" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'F':
- if( p_item )
- {
- INSERT_STRING( input_item_GetURI( p_item ) );
- }
- break;
- case 'I':
- if( p_input )
- {
- snprintf( buf, 10, "%d",
- var_GetInteger( p_input, "title" ) );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "-" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'L':
- if( p_item && p_input )
- {
- mtime_t i_duration = input_item_GetDuration( p_item );
- int64_t i_time = p_input->i_time;
- sprintf( buf, "%02d:%02d:%02d",
- (int)( ( i_duration - i_time ) / 3600000000 ),
- (int)( ( ( i_duration - i_time ) / 60000000 ) % 60 ),
- (int)( ( ( i_duration - i_time ) / 1000000 ) % 60 ) );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "--:--:--" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'N':
- if( p_item )
- {
- INSERT_STRING( input_item_GetName( p_item ) );
- }
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ case 'g':
+ write_meta(stream, item, vlc_meta_Genre);
+ break;
+ case 'l':
+ write_meta(stream, item, vlc_meta_Language);
+ break;
+ case 'n':
+ write_meta(stream, item, vlc_meta_TrackNumber);
+ break;
+ case 'p':
+ if (item == NULL)
break;
- case 'O':
{
- char *lang = NULL;
- if( p_input )
- lang = var_GetNonEmptyString( p_input,
- "audio-language" );
- if( lang == NULL )
- lang = strdup( b_empty_if_na ? "" : "-" );
- INSERT_STRING( lang );
- break;
+ char *value = input_item_GetNowPlayingFb(item);
+ if (value == NULL)
+ break;
+
+ fputs(value, stream);
+ free(value);
}
- case 'P':
- if( p_input )
- {
- snprintf( buf, 10, "%2.1lf",
- var_GetFloat( p_input, "position" ) * 100. );
- }
- else
- {
- sprintf( buf, b_empty_if_na ? "" : "--.-%%" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'R':
- if( p_input )
- {
- int r = var_GetInteger( p_input, "rate" );
- snprintf( buf, 10, "%d.%d", r/1000, r%1000 );
- }
- else
+ break;
+ case 'r':
+ write_meta(stream, item, vlc_meta_Rating);
+ break;
+ case 's':
+ {
+ char *lang = NULL;
+
+ if (input != NULL)
+ lang = var_GetNonEmptyString(input, "sub-language");
+ if (lang != NULL)
+ {
+ fputs(lang, stream);
+ free(lang);
+ }
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ }
+ case 't':
+ write_meta(stream, item, vlc_meta_Title);
+ break;
+ case 'u':
+ write_meta(stream, item, vlc_meta_URL);
+ break;
+ case 'A':
+ write_meta(stream, item, vlc_meta_Date);
+ break;
+ case 'B':
+ if (input != NULL)
+ fprintf(stream, "%"PRId64,
+ var_GetInteger(input, "bit-rate") / 1000);
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ case 'C':
+ if (input != NULL)
+ fprintf(stream, "%"PRId64,
+ var_GetInteger(input, "chapter"));
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ case 'D':
+ if (item != NULL)
+ write_duration(stream, input_item_GetDuration(item));
+ else if (!b_empty_if_na)
+ fputs("--:--:--", stream);
+ break;
+ case 'F':
+ if (item != NULL)
+ {
+ char *uri = input_item_GetURI(item);
+ if (uri != NULL)
{
- sprintf( buf, b_empty_if_na ? "" : "-" );
+ fputs(uri, stream);
+ free(uri);
}
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'S':
- if( p_input )
+ }
+ break;
+ case 'I':
+ if (input != NULL)
+ fprintf(stream, "%"PRId64, var_GetInteger(input, "title"));
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ case 'L':
+ if (item != NULL)
+ {
+ assert(input != NULL);
+ write_duration(stream, input_item_GetDuration(item)
+ - var_GetTime(input, "time"));
+ }
+ else if (!b_empty_if_na)
+ fputs("--:--:--", stream);
+ break;
+ case 'N':
+ if (item != NULL)
+ {
+ char *name = input_item_GetName(item);
+ if (name != NULL)
{
- int r = var_GetInteger( p_input, "sample-rate" );
- snprintf( buf, 10, "%d.%d", r/1000, (r/100)%10 );
+ fputs(name, stream);
+ free(name);
}
- else
+ }
+ break;
+ case 'O':
+ {
+ char *lang = NULL;
+
+ if (input != NULL)
+ lang = var_GetNonEmptyString(input, "audio-language");
+ if (lang != NULL)
+ {
+ fputs(lang, stream);
+ free(lang);
+ }
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ }
+ case 'P':
+ if (input != NULL)
+ fprintf(stream, "%2.1f",
+ var_GetFloat(input, "position") * 100.f);
+ else if (!b_empty_if_na)
+ fputs("--.-%", stream);
+ break;
+ case 'R':
+ if (input != NULL)
+ fprintf(stream, "%.3f", var_GetFloat(input, "rate"));
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ case 'S':
+ if (input != NULL)
+ {
+ int rate = var_GetInteger(input, "sample-rate");
+ div_t dr = div((rate + 50) / 100, 10);
+
+ fprintf(stream, "%d.%01d", dr.quot, dr.rem);
+ }
+ else if (!b_empty_if_na)
+ fputc('-', stream);
+ break;
+ case 'T':
+ if (input != NULL)
+ write_duration(stream, var_GetTime(input, "time"));
+ else if (!b_empty_if_na)
+ fputs("--:--:--", stream);
+ break;
+ case 'U':
+ write_meta(stream, item, vlc_meta_Publisher);
+ break;
+ case 'V':
+ {
+ float vol = 0.f;
+
+ if (input != NULL)
+ {
+ audio_output_t *aout = input_GetAout(input);
+ if (aout != NULL)
{
- sprintf( buf, b_empty_if_na ? "" : "-" );
+ vol = aout_VolumeGet(aout);
+ vlc_object_release(aout);
}
- INSERT_STRING_NO_FREE( buf );
+ }
+ if (vol >= 0.f)
+ fprintf(stream, "%ld", lroundf(vol * 256.f));
+ else if (!b_empty_if_na)
+ fputs("---", stream);
+ break;
+ }
+ case '_':
+ fputc('\n', stream);
+ break;
+ case 'Z':
+ if (item == NULL)
break;
- case 'T':
- if( p_input )
+ {
+ char *value = input_item_GetNowPlayingFb(item);
+ if (value != NULL)
{
- sprintf( buf, "%02d:%02d:%02d",
- (int)( p_input->i_time / ( 3600000000 ) ),
- (int)( ( p_input->i_time / ( 60000000 ) ) % 60 ),
- (int)( ( p_input->i_time / 1000000 ) % 60 ) );
+ fputs(value, stream);
+ free(value);
}
else
{
- sprintf( buf, b_empty_if_na ? "" : "--:--:--" );
- }
- INSERT_STRING_NO_FREE( buf );
- break;
- case 'U':
- if( p_item )
- {
- INSERT_STRING( input_item_GetPublisher( p_item ) );
- }
- break;
- case 'V':
- {
- audio_volume_t volume;
- aout_VolumeGet( p_object, &volume );
- snprintf( buf, 10, "%d", volume );
- INSERT_STRING_NO_FREE( buf );
- break;
- }
- case '_':
- *(dst+d) = '\n';
- d++;
- break;
+ char *title = input_item_GetTitleFbName(item);
- case ' ':
- b_empty_if_na = true;
- break;
+ if (write_meta(stream, item, vlc_meta_Artist) >= 0
+ && title != NULL)
+ fputs(" - ", stream);
- default:
- *(dst+d) = *s;
- d++;
- break;
- }
- if( *s != ' ' )
- b_is_format = false;
- }
- else if( *s == '$' )
- {
- b_is_format = true;
- b_empty_if_na = false;
- }
- else
- {
- *(dst+d) = *s;
- d++;
+ if (title != NULL)
+ {
+ fputs(title, stream);
+ free(title);
+ }
+ }
+ }
+ break;
+ case ' ':
+ b_empty_if_na = true;
+ b_is_format = true;
+ break;
+ default:
+ fputc(c, stream);
+ break;
}
- s++;
}
- *(dst+d) = '\0';
-
- if( p_input )
- vlc_object_release( p_input );
-
- return dst;
-}
-#undef INSERT_STRING
-#undef INSERT_STRING_NO_FREE
-/**
- * Apply str format time and str format meta
- */
-char *__str_format( vlc_object_t *p_this, const char *psz_src )
-{
- char *psz_buf1, *psz_buf2;
- psz_buf1 = str_format_time( psz_src );
- psz_buf2 = str_format_meta( p_this, psz_buf1 );
- free( psz_buf1 );
- return psz_buf2;
+#ifdef HAVE_OPEN_MEMSTREAM
+ return (fclose(stream) == 0) ? str : NULL;
+#else
+ len = ftell(stream);
+ if (len != (size_t)-1)
+ {
+ rewind(stream);
+ str = xmalloc(len + 1);
+ fread(str, len, 1, stream);
+ str[len] = '\0';
+ }
+ fclose(stream);
+ return str;
+#endif
}
/**
- * Remove forbidden characters from filenames (including slashes)
+ * Remove forbidden, potentially forbidden and otherwise evil characters from
+ * filenames. This includes slashes, and popular characters like colon
+ * (on Unix anyway), so this should only be used for automatically generated
+ * filenames.
+ * \warning Do not use this on full paths,
+ * only single file names without any directory separator!
*/
void filename_sanitize( char *str )
{
- if( *str == '.' && (str[1] == '\0' || (str[1] == '.' && str[2] == '\0' ) ) )
+ unsigned char c;
+
+ /* Special file names, not allowed */
+ if( !strcmp( str, "." ) || !strcmp( str, ".." ) )
{
while( *str )
- {
- *str = '_';
- str++;
- }
+ *(str++) = '_';
return;
}
- while( *str )
+ /* On platforms not using UTF-7, VLC cannot access non-Unicode paths.
+ * Also, some file systems require Unicode file names.
+ * NOTE: This may inserts '?' thus is done replacing '?' with '_'. */
+ EnsureUTF8( str );
+
+ /* Avoid leading spaces to please Windows. */
+ while( (c = *str) != '\0' )
{
- switch( *str )
- {
- case '/':
-#if defined( __APPLE__ )
- case ':':
-#elif defined( WIN32 )
- case '\\':
- case '*':
- case '"':
- case '?':
- case ':':
- case '|':
- case '<':
- case '>':
-#endif
- *str = '_';
- }
+ if( c != ' ' )
+ break;
+ *(str++) = '_';
+ }
+
+ char *start = str;
+
+ while( (c = *str) != '\0' )
+ {
+ /* Non-printable characters are not a good idea */
+ if( c < 32 )
+ *str = '_';
+ /* This is the list of characters not allowed by Microsoft.
+ * We also black-list them on Unix as they may be confusing, and are
+ * not supported by some file system types (notably CIFS). */
+ else if( strchr( "/:\\*\"?|<>", c ) != NULL )
+ *str = '_';
str++;
}
+
+ /* Avoid trailing spaces also to please Windows. */
+ while( str > start )
+ {
+ if( *(--str) != ' ' )
+ break;
+ *str = '_';
+ }
}
/**
*/
void path_sanitize( char *str )
{
-#if 0
- /*
- * Uncomment the two blocks to prevent /../ or /./, i'm not sure that we
- * want to.
- */
- char *prev = str - 1;
-#endif
-#ifdef WIN32
+#if defined( _WIN32 ) || defined( __OS2__ )
/* check drive prefix if path is absolute */
- if( isalpha(*str) && (':' == *(str+1)) )
+ if( (((unsigned char)(str[0] - 'A') < 26)
+ || ((unsigned char)(str[0] - 'a') < 26)) && (':' == str[1]) )
str += 2;
#endif
while( *str )
#if defined( __APPLE__ )
if( *str == ':' )
*str = '_';
-#elif defined( WIN32 )
- switch( *str )
- {
- case '*':
- case '"':
- case '?':
- case ':':
- case '|':
- case '<':
- case '>':
- *str = '_';
- }
-#endif
-#if 0
- if( *str == '/'
-#ifdef WIN32
- || *str == '\\'
+#elif defined( _WIN32 ) || defined( __OS2__ )
+ if( strchr( "*\"?:|<>", *str ) )
+ *str = '_';
+ if( *str == '/' )
+ *str = DIR_SEP_CHAR;
#endif
- )
+ str++;
+ }
+}
+
+/*
+ Decodes a duration as defined by ISO 8601
+ http://en.wikipedia.org/wiki/ISO_8601#Durations
+ @param str A null-terminated string to convert
+ @return: The duration in seconds. -1 if an error occurred.
+
+ Exemple input string: "PT0H9M56.46S"
+ */
+time_t str_duration( const char *psz_duration )
+{
+ bool timeDesignatorReached = false;
+ time_t res = 0;
+ char* end_ptr;
+
+ if ( psz_duration == NULL )
+ return -1;
+ if ( ( *(psz_duration++) ) != 'P' )
+ return -1;
+ do
+ {
+ double number = us_strtod( psz_duration, &end_ptr );
+ double mul = 0;
+ if ( psz_duration != end_ptr )
+ psz_duration = end_ptr;
+ switch( *psz_duration )
{
- if( str - prev == 2 && prev[1] == '.' )
+ case 'M':
{
- prev[1] = '.';
+ //M can mean month or minutes, if the 'T' flag has been reached.
+ //We don't handle months though.
+ if ( timeDesignatorReached == true )
+ mul = 60.0;
+ break ;
}
- else if( str - prev == 3 && prev[1] == '.' && prev[2] == '.' )
- {
- prev[1] = '_';
- prev[2] = '_';
- }
- prev = str;
+ case 'Y':
+ case 'W':
+ break ; //Don't handle this duration.
+ case 'D':
+ mul = 86400.0;
+ break ;
+ case 'T':
+ timeDesignatorReached = true;
+ break ;
+ case 'H':
+ mul = 3600.0;
+ break ;
+ case 'S':
+ mul = 1.0;
+ break ;
+ default:
+ break ;
}
-#endif
- str++;
- }
+ res += (time_t)(mul * number);
+ if ( *psz_duration )
+ psz_duration++;
+ } while ( *psz_duration );
+ return res;
}