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