git.sesse.net Git - vlc/blob - src/text/unicode.c

   1 /*****************************************************************************
   2  * unicode.c: Unicode <-> locale functions
   3  *****************************************************************************
   4  * Copyright (C) 2005-2006 the VideoLAN team
   5  * Copyright © 2005-2006 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: 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 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <vlc/vlc.h>
  29 #include <vlc_charset.h>
  30 #include "libvlc.h" /* utf8_mkdir */
  31
  32 #include <assert.h>
  33
  34 #include <stdio.h>
  35 #include <stdarg.h>
  36 #include <stdlib.h>
  37 #include <errno.h>
  38 #include <sys/types.h>
  39 #ifdef HAVE_DIRENT_H
  40 #  include <dirent.h>
  41 #endif
  42 #ifdef UNDER_CE
  43 #  include <tchar.h>
  44 #endif
  45 #ifdef HAVE_SYS_STAT_H
  46 # include <sys/stat.h>
  47 #endif
  48 #ifdef HAVE_FCNTL_H
  49 # include <fcntl.h>
  50 #endif
  51 #ifdef WIN32
  52 # include <io.h>
  53 #else
  54 # include <unistd.h>
  55 #endif
  56
  57 #ifndef HAVE_LSTAT
  58 # define lstat( a, b ) stat(a, b)
  59 #endif
  60
  61 #ifdef __APPLE__
  62 /* Define this if the OS always use UTF-8 internally */
  63 # define ASSUME_UTF8 1
  64 #endif
  65
  66 #if defined (ASSUME_UTF8)
  67 /* Cool */
  68 #elif defined (WIN32) || defined (UNDER_CE)
  69 # define USE_MB2MB 1
  70 #elif defined (HAVE_ICONV)
  71 # define USE_ICONV 1
  72 #else
  73 # error No UTF8 charset conversion implemented on this platform!
  74 #endif
  75
  76 #if defined (USE_ICONV)
  77 static char charset[sizeof ("CSISO11SWEDISHFORNAMES//translit")] = "";
  78
  79 static void find_charset_once (void)
  80 {
  81     char *psz_charset;
  82     if (vlc_current_charset (&psz_charset)
  83      || (psz_charset == NULL)
  84      || ((size_t)snprintf (charset, sizeof (charset), "%s//translit",
  85                            psz_charset) >= sizeof (charset)))
  86         strcpy (charset, "UTF-8");
  87
  88     free (psz_charset);
  89 }
  90
  91 static int find_charset (void)
  92 {
  93     static pthread_once_t once = PTHREAD_ONCE_INIT;
  94     pthread_once (&once, find_charset_once);
  95     return !strcmp (charset, "UTF-8");
  96 }
  97 #endif
  98
  99
 100 static char *locale_fast (const char *string, vlc_bool_t from)
 101 {
 102 #if defined (USE_ICONV)
 103     if (find_charset ())
 104         return (char *)string;
 105
 106     vlc_iconv_t hd = vlc_iconv_open (from ? "UTF-8" : charset,
 107                                      from ? charset : "UTF-8");
 108     if (hd == (vlc_iconv_t)(-1))
 109         return strdup (string); /* Uho! */
 110
 111     const char *iptr = string;
 112     size_t inb = strlen (string);
 113     size_t outb = inb * 6 + 1;
 114     char output[outb], *optr = output;
 115
 116     if (string == NULL)
 117         return NULL;
 118
 119     while (vlc_iconv (hd, &iptr, &inb, &optr, &outb) == (size_t)(-1))
 120     {
 121         *optr++ = '?';
 122         outb--;
 123         iptr++;
 124         inb--;
 125         vlc_iconv (hd, NULL, NULL, NULL, NULL);
 126     }
 127     *optr = '\0';
 128     vlc_iconv_close (hd);
 129
 130     assert (inb == 0);
 131     assert (*iptr == '\0');
 132     assert (*optr == '\0');
 133     assert (strlen (output) == (size_t)(optr - output));
 134     return strdup (output);
 135 #elif defined (USE_MB2MB)
 136     char *out;
 137     int len;
 138
 139     if (string == NULL)
 140         return NULL;
 141
 142     len = 1 + MultiByteToWideChar (from ? CP_ACP : CP_UTF8,
 143                                    0, string, -1, NULL, 0);
 144     wchar_t wide[len];
 145
 146     MultiByteToWideChar (from ? CP_ACP : CP_UTF8, 0, string, -1, wide, len);
 147     len = 1 + WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1, NULL, 0, NULL, NULL);
 148     out = malloc (len);
 149     if (out == NULL)
 150         return NULL;
 151
 152     WideCharToMultiByte (from ? CP_UTF8 : CP_ACP, 0, wide, -1, out, len, NULL, NULL);
 153     return out;
 154 #else
 155     return (char *)string;
 156 #endif
 157 }
 158
 159
 160 static inline char *locale_dup (const char *string, vlc_bool_t from)
 161 {
 162 #if defined (USE_ICONV)
 163     if (find_charset ())
 164         return strdup (string);
 165     return locale_fast (string, from);
 166 #elif defined (USE_MB2MB)
 167     return locale_fast (string, from);
 168 #else
 169     return strdup (string);
 170 #endif
 171 }
 172
 173
 174 void LocaleFree (const char *str)
 175 {
 176 #if defined (USE_ICONV)
 177     if (!find_charset ())
 178         free ((char *)str);
 179 #elif defined (USE_MB2MB)
 180     free ((char *)str);
 181 #endif
 182 }
 183
 184
 185 /**
 186  * FromLocale: converts a locale string to UTF-8
 187  *
 188  * @param locale nul-terminated string to be converted
 189  *
 190  * @return a nul-terminated UTF-8 string, or NULL in case of error.
 191  * To avoid memory leak, you have to pass the result to LocaleFree()
 192  * when it is no longer needed.
 193  */
 194 char *FromLocale (const char *locale)
 195 {
 196     return locale_fast (locale, VLC_TRUE);
 197 }
 198
 199 char *FromLocaleDup (const char *locale)
 200 {
 201     return locale_dup (locale, VLC_TRUE);
 202 }
 203
 204
 205 /**
 206  * ToLocale: converts a UTF-8 string to local system encoding.
 207  *
 208  * @param utf8 nul-terminated string to be converted
 209  *
 210  * @return a nul-terminated string, or NULL in case of error.
 211  * To avoid memory leak, you have to pass the result to LocaleFree()
 212  * when it is no longer needed.
 213  */
 214 char *ToLocale (const char *utf8)
 215 {
 216     return locale_fast (utf8, VLC_FALSE);
 217 }
 218
 219
 220 static char *ToLocaleDup (const char *utf8)
 221 {
 222     return locale_dup (utf8, VLC_FALSE);
 223 }
 224
 225
 226 /**
 227  * utf8_open: open() wrapper for UTF-8 filenames
 228  */
 229 int utf8_open (const char *filename, int flags, mode_t mode)
 230 {
 231 #if defined (WIN32) || defined (UNDER_CE)
 232     if (GetVersion() < 0x80000000)
 233     {
 234         /* for Windows NT and above */
 235         wchar_t wpath[MAX_PATH + 1];
 236
 237         if (!MultiByteToWideChar (CP_UTF8, 0, filename, -1, wpath, MAX_PATH))
 238         {
 239             errno = ENOENT;
 240             return -1;
 241         }
 242         wpath[MAX_PATH] = L'\0';
 243
 244         /*
 245          * open() cannot open files with non-“ANSI” characters on Windows.
 246          * We use _wopen() instead. Same thing for mkdir() and stat().
 247          */
 248         return _wopen (wpath, flags, mode);
 249     }
 250 #endif
 251     const char *local_name = ToLocale (filename);
 252
 253     if (local_name == NULL)
 254     {
 255         errno = ENOENT;
 256         return -1;
 257     }
 258
 259     int fd = open (local_name, flags, mode);
 260     LocaleFree (local_name);
 261     return fd;
 262 }
 263
 264 /**
 265  * utf8_fopen: fopen() wrapper for UTF-8 filenames
 266  */
 267 FILE *utf8_fopen (const char *filename, const char *mode)
 268 {
 269     int rwflags = 0, oflags = 0;
 270     vlc_bool_t append = VLC_FALSE;
 271
 272     for (const char *ptr = mode; *ptr; ptr++)
 273     {
 274         switch (*ptr)
 275         {
 276             case 'r':
 277                 rwflags = O_RDONLY;
 278                 break;
 279
 280             case 'a':
 281                 rwflags = O_WRONLY;
 282                 oflags |= O_CREAT;
 283                 append = VLC_TRUE;
 284                 break;
 285
 286             case 'w':
 287                 rwflags = O_WRONLY;
 288                 oflags |= O_CREAT | O_TRUNC;
 289                 break;
 290
 291             case '+':
 292                 rwflags = O_RDWR;
 293                 break;
 294
 295 #ifdef O_TEXT
 296             case 't':
 297                 oflags |= O_TEXT;
 298                 break;
 299 #endif
 300         }
 301     }
 302
 303     int fd = utf8_open (filename, rwflags | oflags, 0666);
 304     if (fd == -1)
 305         return NULL;
 306
 307     if (append && (lseek (fd, 0, SEEK_END) == -1))
 308     {
 309         close (fd);
 310         return NULL;
 311     }
 312
 313     FILE *stream = fdopen (fd, mode);
 314     if (stream == NULL)
 315         close (fd);
 316
 317     return stream;
 318 }
 319
 320 /**
 321  * utf8_mkdir: Calls mkdir() after conversion of file name to OS locale
 322  *
 323  * @param dirname a UTF-8 string with the name of the directory that you
 324  *        want to create.
 325  * @return A 0 return value indicates success. A -1 return value indicates an
 326  *        error, and an error code is stored in errno
 327  */
 328 int utf8_mkdir( const char *dirname, mode_t mode )
 329 {
 330 #if defined (UNDER_CE) || defined (WIN32)
 331     wchar_t wname[MAX_PATH + 1];
 332     char mod[MAX_PATH + 1];
 333     int i;
 334
 335     /* Convert '/' into '\' */
 336     for( i = 0; *dirname; i++ )
 337     {
 338         if( i == MAX_PATH )
 339             return -1; /* overflow */
 340
 341         if( *dirname == '/' )
 342             mod[i] = '\\';
 343         else
 344             mod[i] = *dirname;
 345         dirname++;
 346
 347     }
 348     mod[i] = 0;
 349
 350     if( MultiByteToWideChar( CP_UTF8, 0, mod, -1, wname, MAX_PATH ) == 0 )
 351     {
 352         errno = ENOENT;
 353         return -1;
 354     }
 355     wname[MAX_PATH] = L'\0';
 356
 357     if( CreateDirectoryW( wname, NULL ) == 0 )
 358     {
 359         if( GetLastError( ) == ERROR_ALREADY_EXISTS )
 360             errno = EEXIST;
 361         else
 362             errno = ENOENT;
 363         return -1;
 364     }
 365     return 0;
 366 #else
 367     char *locname = ToLocale( dirname );
 368     int res;
 369
 370     if( locname == NULL )
 371     {
 372         errno = ENOENT;
 373         return -1;
 374     }
 375     res = mkdir( locname, mode );
 376
 377     LocaleFree( locname );
 378     return res;
 379 #endif
 380 }
 381
 382 /**
 383  * utf8_opendir: wrapper that converts dirname to the locale in use by the OS
 384  *
 385  * @param dirname UTF-8 representation of the directory name
 386  *
 387  * @return a pointer to the DIR struct. Release with closedir().
 388  */
 389 DIR *utf8_opendir( const char *dirname )
 390 {
 391 #ifdef WIN32
 392     wchar_t wname[MAX_PATH + 1];
 393
 394     if (MultiByteToWideChar (CP_UTF8, 0, dirname, -1, wname, MAX_PATH))
 395     {
 396         wname[MAX_PATH] = L'\0';
 397         return (DIR *)vlc_wopendir (wname);
 398     }
 399 #else
 400     const char *local_name = ToLocale( dirname );
 401
 402     if( local_name != NULL )
 403     {
 404         DIR *dir = opendir( local_name );
 405         LocaleFree( local_name );
 406         return dir;
 407     }
 408 #endif
 409
 410     errno = ENOENT;
 411     return NULL;
 412 }
 413
 414 /**
 415  * utf8_readdir: a readdir wrapper that returns the name of the next entry
 416  *     in the directory as a UTF-8 string.
 417  *
 418  * @param dir The directory that is being read
 419  *
 420  * @return a UTF-8 string of the directory entry. Use free() to free this memory.
 421  */
 422 char *utf8_readdir( DIR *dir )
 423 {
 424 #ifdef WIN32
 425     struct _wdirent *ent = vlc_wreaddir (dir);
 426     if (ent == NULL)
 427         return NULL;
 428
 429     return FromWide (ent->d_name);
 430 #else
 431     struct dirent *ent;
 432
 433     ent = readdir( (DIR *)dir );
 434     if( ent == NULL )
 435         return NULL;
 436
 437     return vlc_fix_readdir( ent->d_name );
 438 #endif
 439 }
 440
 441 static int dummy_select( const char *str )
 442 {
 443     (void)str;
 444     return 1;
 445 }
 446
 447 int utf8_loaddir( DIR *dir, char ***namelist,
 448                   int (*select)( const char * ),
 449                   int (*compar)( const char **, const char ** ) )
 450 {
 451     if( select == NULL )
 452         select = dummy_select;
 453
 454     if( dir == NULL )
 455         return -1;
 456     else
 457     {
 458         char **tab = NULL;
 459         char *entry;
 460         unsigned num = 0;
 461
 462         rewinddir( dir );
 463
 464         while( ( entry = utf8_readdir( dir ) ) != NULL )
 465         {
 466             char **newtab;
 467
 468             if( !select( entry ) )
 469             {
 470                 free( entry );
 471                 continue;
 472             }
 473
 474             newtab = realloc( tab, sizeof( char * ) * (num + 1) );
 475             if( newtab == NULL )
 476             {
 477                 free( entry );
 478                 goto error;
 479             }
 480             tab = newtab;
 481             tab[num++] = entry;
 482         }
 483
 484         if( compar != NULL )
 485             qsort( tab, num, sizeof( tab[0] ),
 486                    (int (*)( const void *, const void *))compar );
 487
 488         *namelist = tab;
 489         return num;
 490
 491     error:{
 492         unsigned i;
 493
 494         for( i = 0; i < num; i++ )
 495             free( tab[i] );
 496         if( tab != NULL )
 497             free( tab );
 498         }
 499     }
 500     return -1;
 501 }
 502
 503 int utf8_scandir( const char *dirname, char ***namelist,
 504                   int (*select)( const char * ),
 505                   int (*compar)( const char **, const char ** ) )
 506 {
 507     DIR *dir = utf8_opendir (dirname);
 508     int val = -1;
 509
 510     if (dir != NULL)
 511     {
 512         val = utf8_loaddir (dir, namelist, select, compar);
 513         closedir (dir);
 514     }
 515     return val;
 516 }
 517
 518 static int utf8_statEx( const char *filename, struct stat *buf,
 519                         vlc_bool_t deref )
 520 {
 521 #if defined (WIN32) || defined (UNDER_CE)
 522     /* retrieve Windows OS version */
 523     if( GetVersion() < 0x80000000 )
 524     {
 525         /* for Windows NT and above */
 526         wchar_t wpath[MAX_PATH + 1];
 527
 528         if( !MultiByteToWideChar( CP_UTF8, 0, filename, -1, wpath, MAX_PATH ) )
 529         {
 530             errno = ENOENT;
 531             return -1;
 532         }
 533         wpath[MAX_PATH] = L'\0';
 534
 535         return _wstati64( wpath, buf );
 536     }
 537 #endif
 538 #ifdef HAVE_SYS_STAT_H
 539     const char *local_name = ToLocale( filename );
 540
 541     if( local_name != NULL )
 542     {
 543         int res = deref ? stat( local_name, buf )
 544                        : lstat( local_name, buf );
 545         LocaleFree( local_name );
 546         return res;
 547     }
 548     errno = ENOENT;
 549 #endif
 550     return -1;
 551 }
 552
 553
 554 int utf8_stat( const char *filename, struct stat *buf)
 555 {
 556     return utf8_statEx( filename, buf, VLC_TRUE );
 557 }
 558
 559 int utf8_lstat( const char *filename, struct stat *buf)
 560 {
 561     return utf8_statEx( filename, buf, VLC_FALSE );
 562 }
 563
 564 /**
 565  * utf8_*printf: *printf with conversion from UTF-8 to local encoding
 566  */
 567 static int utf8_vasprintf( char **str, const char *fmt, va_list ap )
 568 {
 569     char *utf8;
 570     int res = vasprintf( &utf8, fmt, ap );
 571     if( res == -1 )
 572         return -1;
 573
 574     *str = ToLocaleDup( utf8 );
 575     free( utf8 );
 576     return res;
 577 }
 578
 579 int utf8_vfprintf( FILE *stream, const char *fmt, va_list ap )
 580 {
 581     char *str;
 582     int res = utf8_vasprintf( &str, fmt, ap );
 583     if( res == -1 )
 584         return -1;
 585
 586     fputs( str, stream );
 587     free( str );
 588     return res;
 589 }
 590
 591 int utf8_fprintf( FILE *stream, const char *fmt, ... )
 592 {
 593     va_list ap;
 594     int res;
 595
 596     va_start( ap, fmt );
 597     res = utf8_vfprintf( stream, fmt, ap );
 598     va_end( ap );
 599     return res;
 600 }
 601
 602
 603 static char *CheckUTF8( char *str, char rep )
 604 {
 605     uint8_t *ptr = (uint8_t *)str;
 606     assert (str != NULL);
 607
 608     for (;;)
 609     {
 610         uint8_t c = ptr[0];
 611         int charlen = -1;
 612
 613         if (c == '\0')
 614             break;
 615
 616         for (int i = 0; i < 7; i++)
 617             if ((c >> (7 - i)) == ((0xff >> (7 - i)) ^ 1))
 618             {
 619                 charlen = i;
 620                 break;
 621             }
 622
 623         switch (charlen)
 624         {
 625             case 0: // 7-bit ASCII character -> OK
 626                 ptr++;
 627                 continue;
 628
 629             case -1: // 1111111x -> error
 630             case 1: // continuation byte -> error
 631                 goto error;
 632         }
 633
 634         assert (charlen >= 2);
 635
 636         uint32_t cp = c & ~((0xff >> (7 - charlen)) << (7 - charlen));
 637         for (int i = 1; i < charlen; i++)
 638         {
 639             assert (cp < (1 << 26));
 640             c = ptr[i];
 641
 642             if ((c == '\0') // unexpected end of string
 643              || ((c >> 6) != 2)) // not a continuation byte
 644                 goto error;
 645
 646             cp = (cp << 6) | (ptr[i] & 0x3f);
 647         }
 648
 649         if (cp < 128) // overlong (special case for ASCII)
 650             goto error;
 651         if (cp < (1u << (5 * charlen - 3))) // overlong
 652             goto error;
 653
 654         ptr += charlen;
 655         continue;
 656
 657     error:
 658         if (rep == 0)
 659             return NULL;
 660         *ptr++ = rep;
 661         str = NULL;
 662     }
 663
 664     return str;
 665 }
 666
 667 /**
 668  * EnsureUTF8: replaces invalid/overlong UTF-8 sequences with question marks
 669  * Note that it is not possible to convert from Latin-1 to UTF-8 on the fly,
 670  * so we don't try that, even though it would be less disruptive.
 671  *
 672  * @return str if it was valid UTF-8, NULL if not.
 673  */
 674 char *EnsureUTF8( char *str )
 675 {
 676     return CheckUTF8( str, '?' );
 677 }
 678
 679
 680 /**
 681  * IsUTF8: checks whether a string is a valid UTF-8 byte sequence.
 682  *
 683  * @param str nul-terminated string to be checked
 684  *
 685  * @return str if it was valid UTF-8, NULL if not.
 686  */
 687 const char *IsUTF8( const char *str )
 688 {
 689     return CheckUTF8( (char *)str, 0 );
 690 }