git.sesse.net Git - vlc/blob - src/extras/libc.c

   1 /*****************************************************************************
   2  * libc.c: Extra libc function for some systems.
   3  *****************************************************************************
   4  * Copyright (C) 2002-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          Gildas Bazin <gbazin@videolan.org>
  10  *          Derk-Jan Hartman <hartman at videolan dot org>
  11  *          Christophe Massiot <massiot@via.ecp.fr>
  12  *          Rémi Denis-Courmont <rem à videolan.org>
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  27  *****************************************************************************/
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33
  34 #include <ctype.h>
  35
  36
  37 #undef iconv_t
  38 #undef iconv_open
  39 #undef iconv
  40 #undef iconv_close
  41
  42 #if defined(HAVE_ICONV)
  43 #   include <iconv.h>
  44 #endif
  45
  46 #ifdef HAVE_DIRENT_H
  47 #   include <dirent.h>
  48 #endif
  49
  50 #include <signal.h>
  51
  52 #ifdef HAVE_FORK
  53 #   include <sys/time.h>
  54 #   include <unistd.h>
  55 #   include <errno.h>
  56 #   include <sys/wait.h>
  57 #   include <fcntl.h>
  58 #   include <sys/socket.h>
  59 #   include <sys/poll.h>
  60 #endif
  61
  62 #if defined(WIN32) || defined(UNDER_CE)
  63 #   undef _wopendir
  64 #   undef _wreaddir
  65 #   undef _wclosedir
  66 #   undef rewinddir
  67 #   define WIN32_LEAN_AND_MEAN
  68 #   include <windows.h>
  69 #endif
  70
  71 /*****************************************************************************
  72  * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
  73  * when called with an empty argument or just '\'
  74  *****************************************************************************/
  75 #if defined(WIN32)
  76 #   include <assert.h>
  77
  78 typedef struct vlc_DIR
  79 {
  80     _WDIR *p_real_dir;
  81     int i_drives;
  82     struct _wdirent dd_dir;
  83     bool b_insert_back;
  84 } vlc_DIR;
  85
  86 void *vlc_wopendir( const wchar_t *wpath )
  87 {
  88     vlc_DIR *p_dir = NULL;
  89     _WDIR *p_real_dir = NULL;
  90
  91     if ( wpath == NULL || wpath[0] == '\0'
  92           || (wcscmp (wpath, L"\\") == 0) )
  93     {
  94         /* Special mode to list drive letters */
  95         p_dir = malloc( sizeof(vlc_DIR) );
  96         if( !p_dir )
  97             return NULL;
  98         p_dir->p_real_dir = NULL;
  99 #if defined(UNDER_CE)
 100         p_dir->i_drives = NULL;
 101 #else
 102         p_dir->i_drives = GetLogicalDrives();
 103 #endif
 104         return (void *)p_dir;
 105     }
 106
 107     p_real_dir = _wopendir( wpath );
 108     if ( p_real_dir == NULL )
 109         return NULL;
 110
 111     p_dir = malloc( sizeof(vlc_DIR) );
 112     if( !p_dir )
 113     {
 114         _wclosedir( p_real_dir );
 115         return NULL;
 116     }
 117     p_dir->p_real_dir = p_real_dir;
 118
 119     assert (wpath[0]); // wpath[1] is defined
 120     p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
 121     return (void *)p_dir;
 122 }
 123
 124 struct _wdirent *vlc_wreaddir( void *_p_dir )
 125 {
 126     vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
 127     DWORD i_drives;
 128
 129     if ( p_dir->p_real_dir != NULL )
 130     {
 131         if ( p_dir->b_insert_back )
 132         {
 133             /* Adds "..", gruik! */
 134             p_dir->dd_dir.d_ino = 0;
 135             p_dir->dd_dir.d_reclen = 0;
 136             p_dir->dd_dir.d_namlen = 2;
 137             wcscpy( p_dir->dd_dir.d_name, L".." );
 138             p_dir->b_insert_back = false;
 139             return &p_dir->dd_dir;
 140         }
 141
 142         return _wreaddir( p_dir->p_real_dir );
 143     }
 144
 145     /* Drive letters mode */
 146     i_drives = p_dir->i_drives;
 147 #ifdef UNDER_CE
 148     swprintf( p_dir->dd_dir.d_name, L"\\");
 149     p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
 150 #else
 151     unsigned int i;
 152     if ( !i_drives )
 153         return NULL; /* end */
 154
 155     for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
 156         if ( i_drives & 1 ) break;
 157
 158     if ( i >= 26 )
 159         return NULL; /* this should not happen */
 160
 161     swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
 162     p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
 163     p_dir->i_drives &= ~(1UL << i);
 164 #endif
 165     return &p_dir->dd_dir;
 166 }
 167
 168 void vlc_rewinddir( void *_p_dir )
 169 {
 170     vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
 171
 172     if ( p_dir->p_real_dir != NULL )
 173         _wrewinddir( p_dir->p_real_dir );
 174 }
 175 #endif
 176
 177 /* This one is in the libvlccore exported symbol list */
 178 int vlc_wclosedir( void *_p_dir )
 179 {
 180 #if defined(WIN32)
 181     vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
 182     int i_ret = 0;
 183
 184     if ( p_dir->p_real_dir != NULL )
 185         i_ret = _wclosedir( p_dir->p_real_dir );
 186
 187     free( p_dir );
 188     return i_ret;
 189 #else
 190     return closedir( _p_dir );
 191 #endif
 192 }
 193
 194 #ifdef ENABLE_NLS
 195 # include <libintl.h>
 196 #endif
 197
 198 /**
 199  * In-tree plugins share their gettext domain with LibVLC.
 200  */
 201 char *vlc_gettext( const char *msgid )
 202 {
 203 #ifdef ENABLE_NLS
 204     return dgettext( PACKAGE_NAME, msgid );
 205 #else
 206     return (char *)msgid;
 207 #endif
 208 }
 209
 210 /*****************************************************************************
 211  * iconv wrapper
 212  *****************************************************************************/
 213 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
 214 {
 215 #if defined(HAVE_ICONV)
 216     return iconv_open( tocode, fromcode );
 217 #else
 218     return (vlc_iconv_t)(-1);
 219 #endif
 220 }
 221
 222 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
 223                   char **outbuf, size_t *outbytesleft )
 224 {
 225 #if defined(HAVE_ICONV)
 226     return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
 227                   outbuf, outbytesleft );
 228 #else
 229     abort ();
 230 #endif
 231 }
 232
 233 int vlc_iconv_close( vlc_iconv_t cd )
 234 {
 235 #if defined(HAVE_ICONV)
 236     return iconv_close( cd );
 237 #else
 238     abort ();
 239 #endif
 240 }
 241
 242 /*****************************************************************************
 243  * reduce a fraction
 244  *   (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
 245  *****************************************************************************/
 246 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
 247                         uint64_t i_nom, uint64_t i_den, uint64_t i_max )
 248 {
 249     bool b_exact = 1;
 250     uint64_t i_gcd;
 251
 252     if( i_den == 0 )
 253     {
 254         *pi_dst_nom = 0;
 255         *pi_dst_den = 1;
 256         return 1;
 257     }
 258
 259     i_gcd = GCD( i_nom, i_den );
 260     i_nom /= i_gcd;
 261     i_den /= i_gcd;
 262
 263     if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
 264
 265     if( i_nom > i_max || i_den > i_max )
 266     {
 267         uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
 268         b_exact = 0;
 269
 270         for( ; ; )
 271         {
 272             uint64_t i_x = i_nom / i_den;
 273             uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
 274             uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
 275
 276             if( i_a2n > i_max || i_a2d > i_max ) break;
 277
 278             i_nom %= i_den;
 279
 280             i_a0_num = i_a1_num; i_a0_den = i_a1_den;
 281             i_a1_num = i_a2n; i_a1_den = i_a2d;
 282             if( i_nom == 0 ) break;
 283             i_x = i_nom; i_nom = i_den; i_den = i_x;
 284         }
 285         i_nom = i_a1_num;
 286         i_den = i_a1_den;
 287     }
 288
 289     *pi_dst_nom = i_nom;
 290     *pi_dst_den = i_den;
 291
 292     return b_exact;
 293 }
 294
 295 /*************************************************************************
 296  * vlc_execve: Execute an external program with a given environment,
 297  * wait until it finishes and return its standard output
 298  *************************************************************************/
 299 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
 300                   char *const *ppsz_env, const char *psz_cwd,
 301                   const char *p_in, size_t i_in,
 302                   char **pp_data, size_t *pi_data )
 303 {
 304     (void)i_argc; // <-- hmph
 305 #ifdef HAVE_FORK
 306 # define BUFSIZE 1024
 307     int fds[2], i_status;
 308
 309     if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
 310         return -1;
 311
 312     pid_t pid = -1;
 313     if ((fds[0] > 2) && (fds[1] > 2))
 314         pid = fork ();
 315
 316     switch (pid)
 317     {
 318         case -1:
 319             msg_Err (p_object, "unable to fork (%m)");
 320             close (fds[0]);
 321             close (fds[1]);
 322             return -1;
 323
 324         case 0:
 325         {
 326             sigset_t set;
 327             sigemptyset (&set);
 328             pthread_sigmask (SIG_SETMASK, &set, NULL);
 329
 330             /* NOTE:
 331              * Like it or not, close can fail (and not only with EBADF)
 332              */
 333             if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
 334              && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
 335              && (open ("/dev/null", O_RDONLY) == 2)
 336              && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
 337                 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
 338
 339             exit (EXIT_FAILURE);
 340         }
 341     }
 342
 343     close (fds[1]);
 344
 345     *pi_data = 0;
 346     if (*pp_data)
 347         free (*pp_data);
 348     *pp_data = NULL;
 349
 350     if (i_in == 0)
 351         shutdown (fds[0], SHUT_WR);
 352
 353     while (!p_object->b_die)
 354     {
 355         struct pollfd ufd[1];
 356         memset (ufd, 0, sizeof (ufd));
 357         ufd[0].fd = fds[0];
 358         ufd[0].events = POLLIN;
 359
 360         if (i_in > 0)
 361             ufd[0].events |= POLLOUT;
 362
 363         if (poll (ufd, 1, 10) <= 0)
 364             continue;
 365
 366         if (ufd[0].revents & ~POLLOUT)
 367         {
 368             char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
 369             if (ptr == NULL)
 370                 break; /* safely abort */
 371
 372             *pp_data = ptr;
 373
 374             ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
 375             switch (val)
 376             {
 377                 case -1:
 378                 case 0:
 379                     shutdown (fds[0], SHUT_RD);
 380                     break;
 381
 382                 default:
 383                     *pi_data += val;
 384             }
 385         }
 386
 387         if (ufd[0].revents & POLLOUT)
 388         {
 389             ssize_t val = write (fds[0], p_in, i_in);
 390             switch (val)
 391             {
 392                 case -1:
 393                 case 0:
 394                     i_in = 0;
 395                     shutdown (fds[0], SHUT_WR);
 396                     break;
 397
 398                 default:
 399                     i_in -= val;
 400                     p_in += val;
 401             }
 402         }
 403     }
 404
 405     close (fds[0]);
 406
 407     while (waitpid (pid, &i_status, 0) == -1);
 408
 409     if (WIFEXITED (i_status))
 410     {
 411         i_status = WEXITSTATUS (i_status);
 412         if (i_status)
 413             msg_Warn (p_object,  "child %s (PID %d) exited with error code %d",
 414                       ppsz_argv[0], (int)pid, i_status);
 415     }
 416     else
 417     if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
 418     {
 419         i_status = WTERMSIG (i_status);
 420         msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
 421                   ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
 422     }
 423
 424 #elif defined( WIN32 ) && !defined( UNDER_CE )
 425     SECURITY_ATTRIBUTES saAttr;
 426     PROCESS_INFORMATION piProcInfo;
 427     STARTUPINFO siStartInfo;
 428     BOOL bFuncRetn = FALSE;
 429     HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
 430     DWORD i_status;
 431     char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
 432     char **ppsz_parser;
 433     int i_size;
 434
 435     /* Set the bInheritHandle flag so pipe handles are inherited. */
 436     saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
 437     saAttr.bInheritHandle = TRUE;
 438     saAttr.lpSecurityDescriptor = NULL;
 439
 440     /* Create a pipe for the child process's STDOUT. */
 441     if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
 442     {
 443         msg_Err( p_object, "stdout pipe creation failed" );
 444         return -1;
 445     }
 446
 447     /* Ensure the read handle to the pipe for STDOUT is not inherited. */
 448     SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
 449
 450     /* Create a pipe for the child process's STDIN. */
 451     if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
 452     {
 453         msg_Err( p_object, "stdin pipe creation failed" );
 454         return -1;
 455     }
 456
 457     /* Ensure the write handle to the pipe for STDIN is not inherited. */
 458     SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
 459
 460     /* Set up members of the PROCESS_INFORMATION structure. */
 461     ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
 462
 463     /* Set up members of the STARTUPINFO structure. */
 464     ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
 465     siStartInfo.cb = sizeof(STARTUPINFO);
 466     siStartInfo.hStdError = hChildStdoutWr;
 467     siStartInfo.hStdOutput = hChildStdoutWr;
 468     siStartInfo.hStdInput = hChildStdinRd;
 469     siStartInfo.wShowWindow = SW_HIDE;
 470     siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
 471
 472     /* Set up the command line. */
 473     psz_cmd = malloc(32768);
 474     if( !psz_cmd )
 475         return -1;
 476     psz_cmd[0] = '\0';
 477     i_size = 32768;
 478     ppsz_parser = &ppsz_argv[0];
 479     while ( ppsz_parser[0] != NULL && i_size > 0 )
 480     {
 481         /* Protect the last argument with quotes ; the other arguments
 482          * are supposed to be already protected because they have been
 483          * passed as a command-line option. */
 484         if ( ppsz_parser[1] == NULL )
 485         {
 486             strncat( psz_cmd, "\"", i_size );
 487             i_size--;
 488         }
 489         strncat( psz_cmd, *ppsz_parser, i_size );
 490         i_size -= strlen( *ppsz_parser );
 491         if ( ppsz_parser[1] == NULL )
 492         {
 493             strncat( psz_cmd, "\"", i_size );
 494             i_size--;
 495         }
 496         strncat( psz_cmd, " ", i_size );
 497         i_size--;
 498         ppsz_parser++;
 499     }
 500
 501     /* Set up the environment. */
 502     p = p_env = malloc(32768);
 503     if( !p )
 504     {
 505         free( psz_cmd );
 506         return -1;
 507     }
 508
 509     i_size = 32768;
 510     ppsz_parser = &ppsz_env[0];
 511     while ( *ppsz_parser != NULL && i_size > 0 )
 512     {
 513         memcpy( p, *ppsz_parser,
 514                 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
 515         p += strlen(*ppsz_parser) + 1;
 516         i_size -= strlen(*ppsz_parser) + 1;
 517         ppsz_parser++;
 518     }
 519     *p = '\0';
 520
 521     /* Create the child process. */
 522     bFuncRetn = CreateProcess( NULL,
 523           psz_cmd,       // command line
 524           NULL,          // process security attributes
 525           NULL,          // primary thread security attributes
 526           TRUE,          // handles are inherited
 527           0,             // creation flags
 528           p_env,
 529           psz_cwd,
 530           &siStartInfo,  // STARTUPINFO pointer
 531           &piProcInfo ); // receives PROCESS_INFORMATION
 532
 533     free( psz_cmd );
 534     free( p_env );
 535
 536     if ( bFuncRetn == 0 )
 537     {
 538         msg_Err( p_object, "child creation failed" );
 539         return -1;
 540     }
 541
 542     /* Read from a file and write its contents to a pipe. */
 543     while ( i_in > 0 && !p_object->b_die )
 544     {
 545         DWORD i_written;
 546         if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
 547             break;
 548         i_in -= i_written;
 549         p_in += i_written;
 550     }
 551
 552     /* Close the pipe handle so the child process stops reading. */
 553     CloseHandle(hChildStdinWr);
 554
 555     /* Close the write end of the pipe before reading from the
 556      * read end of the pipe. */
 557     CloseHandle(hChildStdoutWr);
 558
 559     /* Read output from the child process. */
 560     *pi_data = 0;
 561     if( *pp_data )
 562         free( pp_data );
 563     *pp_data = NULL;
 564     *pp_data = malloc( 1025 );  /* +1 for \0 */
 565
 566     while ( !p_object->b_die )
 567     {
 568         DWORD i_read;
 569         if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
 570                         NULL )
 571               || i_read == 0 )
 572             break;
 573         *pi_data += i_read;
 574         *pp_data = realloc( *pp_data, *pi_data + 1025 );
 575     }
 576
 577     while ( !p_object->b_die
 578              && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
 579              && i_status != STILL_ACTIVE )
 580         msleep( 10000 );
 581
 582     CloseHandle(piProcInfo.hProcess);
 583     CloseHandle(piProcInfo.hThread);
 584
 585     if ( i_status )
 586         msg_Warn( p_object,
 587                   "child %s returned with error code %ld",
 588                   ppsz_argv[0], i_status );
 589
 590 #else
 591     msg_Err( p_object, "vlc_execve called but no implementation is available" );
 592     return -1;
 593
 594 #endif
 595
 596     if (*pp_data == NULL)
 597         return -1;
 598
 599     (*pp_data)[*pi_data] = '\0';
 600     return 0;
 601 }