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