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