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 # undef gettext
 196 # include <libintl.h>
 197 #endif
 198
 199 /**
 200  * In-tree plugins share their gettext domain with LibVLC.
 201  */
 202 char *vlc_gettext( const char *msgid )
 203 {
 204 #ifdef ENABLE_NLS
 205     return dgettext( PACKAGE_NAME, msgid );
 206 #else
 207     return (char *)msgid;
 208 #endif
 209 }
 210
 211 /*****************************************************************************
 212  * iconv wrapper
 213  *****************************************************************************/
 214 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
 215 {
 216 #if defined(HAVE_ICONV)
 217     return iconv_open( tocode, fromcode );
 218 #else
 219     return (vlc_iconv_t)(-1);
 220 #endif
 221 }
 222
 223 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
 224                   char **outbuf, size_t *outbytesleft )
 225 {
 226 #if defined(HAVE_ICONV)
 227     return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
 228                   outbuf, outbytesleft );
 229 #else
 230     abort ();
 231 #endif
 232 }
 233
 234 int vlc_iconv_close( vlc_iconv_t cd )
 235 {
 236 #if defined(HAVE_ICONV)
 237     return iconv_close( cd );
 238 #else
 239     abort ();
 240 #endif
 241 }
 242
 243 /*****************************************************************************
 244  * reduce a fraction
 245  *   (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
 246  *****************************************************************************/
 247 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
 248                         uint64_t i_nom, uint64_t i_den, uint64_t i_max )
 249 {
 250     bool b_exact = 1;
 251     uint64_t i_gcd;
 252
 253     if( i_den == 0 )
 254     {
 255         *pi_dst_nom = 0;
 256         *pi_dst_den = 1;
 257         return 1;
 258     }
 259
 260     i_gcd = GCD( i_nom, i_den );
 261     i_nom /= i_gcd;
 262     i_den /= i_gcd;
 263
 264     if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
 265
 266     if( i_nom > i_max || i_den > i_max )
 267     {
 268         uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
 269         b_exact = 0;
 270
 271         for( ; ; )
 272         {
 273             uint64_t i_x = i_nom / i_den;
 274             uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
 275             uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
 276
 277             if( i_a2n > i_max || i_a2d > i_max ) break;
 278
 279             i_nom %= i_den;
 280
 281             i_a0_num = i_a1_num; i_a0_den = i_a1_den;
 282             i_a1_num = i_a2n; i_a1_den = i_a2d;
 283             if( i_nom == 0 ) break;
 284             i_x = i_nom; i_nom = i_den; i_den = i_x;
 285         }
 286         i_nom = i_a1_num;
 287         i_den = i_a1_den;
 288     }
 289
 290     *pi_dst_nom = i_nom;
 291     *pi_dst_den = i_den;
 292
 293     return b_exact;
 294 }
 295
 296 /*************************************************************************
 297  * vlc_execve: Execute an external program with a given environment,
 298  * wait until it finishes and return its standard output
 299  *************************************************************************/
 300 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
 301                   char *const *ppsz_env, const char *psz_cwd,
 302                   const char *p_in, size_t i_in,
 303                   char **pp_data, size_t *pi_data )
 304 {
 305     (void)i_argc; // <-- hmph
 306 #ifdef HAVE_FORK
 307 # define BUFSIZE 1024
 308     int fds[2], i_status;
 309
 310     if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
 311         return -1;
 312
 313     pid_t pid = -1;
 314     if ((fds[0] > 2) && (fds[1] > 2))
 315         pid = fork ();
 316
 317     switch (pid)
 318     {
 319         case -1:
 320             msg_Err (p_object, "unable to fork (%m)");
 321             close (fds[0]);
 322             close (fds[1]);
 323             return -1;
 324
 325         case 0:
 326         {
 327             sigset_t set;
 328             sigemptyset (&set);
 329             pthread_sigmask (SIG_SETMASK, &set, NULL);
 330
 331             /* NOTE:
 332              * Like it or not, close can fail (and not only with EBADF)
 333              */
 334             if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
 335              && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
 336              && (open ("/dev/null", O_RDONLY) == 2)
 337              && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
 338                 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
 339
 340             exit (EXIT_FAILURE);
 341         }
 342     }
 343
 344     close (fds[1]);
 345
 346     *pi_data = 0;
 347     if (*pp_data)
 348         free (*pp_data);
 349     *pp_data = NULL;
 350
 351     if (i_in == 0)
 352         shutdown (fds[0], SHUT_WR);
 353
 354     while (!p_object->b_die)
 355     {
 356         struct pollfd ufd[1];
 357         memset (ufd, 0, sizeof (ufd));
 358         ufd[0].fd = fds[0];
 359         ufd[0].events = POLLIN;
 360
 361         if (i_in > 0)
 362             ufd[0].events |= POLLOUT;
 363
 364         if (poll (ufd, 1, 10) <= 0)
 365             continue;
 366
 367         if (ufd[0].revents & ~POLLOUT)
 368         {
 369             char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
 370             if (ptr == NULL)
 371                 break; /* safely abort */
 372
 373             *pp_data = ptr;
 374
 375             ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
 376             switch (val)
 377             {
 378                 case -1:
 379                 case 0:
 380                     shutdown (fds[0], SHUT_RD);
 381                     break;
 382
 383                 default:
 384                     *pi_data += val;
 385             }
 386         }
 387
 388         if (ufd[0].revents & POLLOUT)
 389         {
 390             ssize_t val = write (fds[0], p_in, i_in);
 391             switch (val)
 392             {
 393                 case -1:
 394                 case 0:
 395                     i_in = 0;
 396                     shutdown (fds[0], SHUT_WR);
 397                     break;
 398
 399                 default:
 400                     i_in -= val;
 401                     p_in += val;
 402             }
 403         }
 404     }
 405
 406     close (fds[0]);
 407
 408     while (waitpid (pid, &i_status, 0) == -1);
 409
 410     if (WIFEXITED (i_status))
 411     {
 412         i_status = WEXITSTATUS (i_status);
 413         if (i_status)
 414             msg_Warn (p_object,  "child %s (PID %d) exited with error code %d",
 415                       ppsz_argv[0], (int)pid, i_status);
 416     }
 417     else
 418     if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
 419     {
 420         i_status = WTERMSIG (i_status);
 421         msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
 422                   ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
 423     }
 424
 425 #elif defined( WIN32 ) && !defined( UNDER_CE )
 426     SECURITY_ATTRIBUTES saAttr;
 427     PROCESS_INFORMATION piProcInfo;
 428     STARTUPINFO siStartInfo;
 429     BOOL bFuncRetn = FALSE;
 430     HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
 431     DWORD i_status;
 432     char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
 433     char **ppsz_parser;
 434     int i_size;
 435
 436     /* Set the bInheritHandle flag so pipe handles are inherited. */
 437     saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
 438     saAttr.bInheritHandle = TRUE;
 439     saAttr.lpSecurityDescriptor = NULL;
 440
 441     /* Create a pipe for the child process's STDOUT. */
 442     if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
 443     {
 444         msg_Err( p_object, "stdout pipe creation failed" );
 445         return -1;
 446     }
 447
 448     /* Ensure the read handle to the pipe for STDOUT is not inherited. */
 449     SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
 450
 451     /* Create a pipe for the child process's STDIN. */
 452     if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
 453     {
 454         msg_Err( p_object, "stdin pipe creation failed" );
 455         return -1;
 456     }
 457
 458     /* Ensure the write handle to the pipe for STDIN is not inherited. */
 459     SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
 460
 461     /* Set up members of the PROCESS_INFORMATION structure. */
 462     ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
 463
 464     /* Set up members of the STARTUPINFO structure. */
 465     ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
 466     siStartInfo.cb = sizeof(STARTUPINFO);
 467     siStartInfo.hStdError = hChildStdoutWr;
 468     siStartInfo.hStdOutput = hChildStdoutWr;
 469     siStartInfo.hStdInput = hChildStdinRd;
 470     siStartInfo.wShowWindow = SW_HIDE;
 471     siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
 472
 473     /* Set up the command line. */
 474     psz_cmd = malloc(32768);
 475     if( !psz_cmd )
 476         return -1;
 477     psz_cmd[0] = '\0';
 478     i_size = 32768;
 479     ppsz_parser = &ppsz_argv[0];
 480     while ( ppsz_parser[0] != NULL && i_size > 0 )
 481     {
 482         /* Protect the last argument with quotes ; the other arguments
 483          * are supposed to be already protected because they have been
 484          * passed as a command-line option. */
 485         if ( ppsz_parser[1] == NULL )
 486         {
 487             strncat( psz_cmd, "\"", i_size );
 488             i_size--;
 489         }
 490         strncat( psz_cmd, *ppsz_parser, i_size );
 491         i_size -= strlen( *ppsz_parser );
 492         if ( ppsz_parser[1] == NULL )
 493         {
 494             strncat( psz_cmd, "\"", i_size );
 495             i_size--;
 496         }
 497         strncat( psz_cmd, " ", i_size );
 498         i_size--;
 499         ppsz_parser++;
 500     }
 501
 502     /* Set up the environment. */
 503     p = p_env = malloc(32768);
 504     if( !p )
 505     {
 506         free( psz_cmd );
 507         return -1;
 508     }
 509
 510     i_size = 32768;
 511     ppsz_parser = &ppsz_env[0];
 512     while ( *ppsz_parser != NULL && i_size > 0 )
 513     {
 514         memcpy( p, *ppsz_parser,
 515                 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
 516         p += strlen(*ppsz_parser) + 1;
 517         i_size -= strlen(*ppsz_parser) + 1;
 518         ppsz_parser++;
 519     }
 520     *p = '\0';
 521
 522     /* Create the child process. */
 523     bFuncRetn = CreateProcess( NULL,
 524           psz_cmd,       // command line
 525           NULL,          // process security attributes
 526           NULL,          // primary thread security attributes
 527           TRUE,          // handles are inherited
 528           0,             // creation flags
 529           p_env,
 530           psz_cwd,
 531           &siStartInfo,  // STARTUPINFO pointer
 532           &piProcInfo ); // receives PROCESS_INFORMATION
 533
 534     free( psz_cmd );
 535     free( p_env );
 536
 537     if ( bFuncRetn == 0 )
 538     {
 539         msg_Err( p_object, "child creation failed" );
 540         return -1;
 541     }
 542
 543     /* Read from a file and write its contents to a pipe. */
 544     while ( i_in > 0 && !p_object->b_die )
 545     {
 546         DWORD i_written;
 547         if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
 548             break;
 549         i_in -= i_written;
 550         p_in += i_written;
 551     }
 552
 553     /* Close the pipe handle so the child process stops reading. */
 554     CloseHandle(hChildStdinWr);
 555
 556     /* Close the write end of the pipe before reading from the
 557      * read end of the pipe. */
 558     CloseHandle(hChildStdoutWr);
 559
 560     /* Read output from the child process. */
 561     *pi_data = 0;
 562     if( *pp_data )
 563         free( pp_data );
 564     *pp_data = NULL;
 565     *pp_data = malloc( 1025 );  /* +1 for \0 */
 566
 567     while ( !p_object->b_die )
 568     {
 569         DWORD i_read;
 570         if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
 571                         NULL )
 572               || i_read == 0 )
 573             break;
 574         *pi_data += i_read;
 575         *pp_data = realloc( *pp_data, *pi_data + 1025 );
 576     }
 577
 578     while ( !p_object->b_die
 579              && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
 580              && i_status != STILL_ACTIVE )
 581         msleep( 10000 );
 582
 583     CloseHandle(piProcInfo.hProcess);
 584     CloseHandle(piProcInfo.hThread);
 585
 586     if ( i_status )
 587         msg_Warn( p_object,
 588                   "child %s returned with error code %ld",
 589                   ppsz_argv[0], i_status );
 590
 591 #else
 592     msg_Err( p_object, "vlc_execve called but no implementation is available" );
 593     return -1;
 594
 595 #endif
 596
 597     if (*pp_data == NULL)
 598         return -1;
 599
 600     (*pp_data)[*pi_data] = '\0';
 601     return 0;
 602 }