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