1 /*****************************************************************************
2 * libc.c: Extra libc function for some systems.
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
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>
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.
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.
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 *****************************************************************************/
32 #include <vlc_common.h>
42 #if defined(HAVE_ICONV)
53 # include <sys/time.h>
56 # include <sys/wait.h>
58 # include <sys/socket.h>
59 # include <sys/poll.h>
62 #if defined(WIN32) || defined(UNDER_CE)
67 # define WIN32_LEAN_AND_MEAN
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 *****************************************************************************/
78 typedef struct vlc_DIR
82 struct _wdirent dd_dir;
86 void *vlc_wopendir( const wchar_t *wpath )
88 vlc_DIR *p_dir = NULL;
89 _WDIR *p_real_dir = NULL;
91 if ( wpath == NULL || wpath[0] == '\0'
92 || (wcscmp (wpath, L"\\") == 0) )
94 /* Special mode to list drive letters */
95 p_dir = malloc( sizeof(vlc_DIR) );
98 p_dir->p_real_dir = NULL;
100 p_dir->i_drives = NULL;
102 p_dir->i_drives = GetLogicalDrives();
104 return (void *)p_dir;
107 p_real_dir = _wopendir( wpath );
108 if ( p_real_dir == NULL )
111 p_dir = malloc( sizeof(vlc_DIR) );
114 _wclosedir( p_real_dir );
117 p_dir->p_real_dir = p_real_dir;
119 assert (wpath[0]); // wpath[1] is defined
120 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
121 return (void *)p_dir;
124 struct _wdirent *vlc_wreaddir( void *_p_dir )
126 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
129 if ( p_dir->p_real_dir != NULL )
131 if ( p_dir->b_insert_back )
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;
142 return _wreaddir( p_dir->p_real_dir );
145 /* Drive letters mode */
146 i_drives = p_dir->i_drives;
148 swprintf( p_dir->dd_dir.d_name, L"\\");
149 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
153 return NULL; /* end */
155 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
156 if ( i_drives & 1 ) break;
159 return NULL; /* this should not happen */
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);
165 return &p_dir->dd_dir;
168 void vlc_rewinddir( void *_p_dir )
170 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
172 if ( p_dir->p_real_dir != NULL )
173 _wrewinddir( p_dir->p_real_dir );
177 /* This one is in the libvlccore exported symbol list */
178 int vlc_wclosedir( void *_p_dir )
181 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
184 if ( p_dir->p_real_dir != NULL )
185 i_ret = _wclosedir( p_dir->p_real_dir );
190 return closedir( _p_dir );
195 * In-tree plugins share their gettext domain with LibVLC.
197 char *vlc_gettext( const char *msgid )
200 return dgettext( PACKAGE_NAME, msgid );
202 return (char *)msgid;
206 /*****************************************************************************
207 * count_utf8_string: returns the number of characters in the string.
208 *****************************************************************************/
209 static int count_utf8_string( const char *psz_string )
211 int i = 0, i_count = 0;
212 while( psz_string[ i ] != 0 )
214 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
220 /*****************************************************************************
221 * wraptext: inserts \n at convenient places to wrap the text.
222 * Returns the modified string in a new buffer.
223 *****************************************************************************/
224 char *vlc_wraptext( const char *psz_text, int i_line )
227 char *psz_line, *psz_new_text;
229 psz_line = psz_new_text = strdup( psz_text );
231 i_len = count_utf8_string( psz_text );
233 while( i_len > i_line )
235 /* Look if there is a newline somewhere. */
236 char *psz_parser = psz_line;
238 while( i_count <= i_line && *psz_parser != '\n' )
240 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
244 if( *psz_parser == '\n' )
246 i_len -= (i_count + 1);
247 psz_line = psz_parser + 1;
251 /* Find the furthest space. */
252 while( psz_parser > psz_line && *psz_parser != ' ' )
254 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
258 if( *psz_parser == ' ' )
261 i_len -= (i_count + 1);
262 psz_line = psz_parser + 1;
266 /* Wrapping has failed. Find the first space or newline */
267 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
269 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
273 if( i_count < i_len ) *psz_parser = '\n';
274 i_len -= (i_count + 1);
275 psz_line = psz_parser + 1;
281 /*****************************************************************************
283 *****************************************************************************/
284 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
286 #if defined(HAVE_ICONV)
287 return iconv_open( tocode, fromcode );
289 return (vlc_iconv_t)(-1);
293 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
294 char **outbuf, size_t *outbytesleft )
296 #if defined(HAVE_ICONV)
297 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
298 outbuf, outbytesleft );
304 int vlc_iconv_close( vlc_iconv_t cd )
306 #if defined(HAVE_ICONV)
307 return iconv_close( cd );
313 /*****************************************************************************
315 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
316 *****************************************************************************/
317 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
318 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
330 i_gcd = GCD( i_nom, i_den );
334 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
336 if( i_nom > i_max || i_den > i_max )
338 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
343 uint64_t i_x = i_nom / i_den;
344 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
345 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
347 if( i_a2n > i_max || i_a2d > i_max ) break;
351 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
352 i_a1_num = i_a2n; i_a1_den = i_a2d;
353 if( i_nom == 0 ) break;
354 i_x = i_nom; i_nom = i_den; i_den = i_x;
366 /*************************************************************************
367 * vlc_execve: Execute an external program with a given environment,
368 * wait until it finishes and return its standard output
369 *************************************************************************/
370 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
371 char *const *ppsz_env, const char *psz_cwd,
372 const char *p_in, size_t i_in,
373 char **pp_data, size_t *pi_data )
375 (void)i_argc; // <-- hmph
377 # define BUFSIZE 1024
378 int fds[2], i_status;
380 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
384 if ((fds[0] > 2) && (fds[1] > 2))
390 msg_Err (p_object, "unable to fork (%m)");
399 pthread_sigmask (SIG_SETMASK, &set, NULL);
402 * Like it or not, close can fail (and not only with EBADF)
404 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
405 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
406 && (open ("/dev/null", O_RDONLY) == 2)
407 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
408 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
422 shutdown (fds[0], SHUT_WR);
424 while (!p_object->b_die)
426 struct pollfd ufd[1];
427 memset (ufd, 0, sizeof (ufd));
429 ufd[0].events = POLLIN;
432 ufd[0].events |= POLLOUT;
434 if (poll (ufd, 1, 10) <= 0)
437 if (ufd[0].revents & ~POLLOUT)
439 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
441 break; /* safely abort */
445 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
450 shutdown (fds[0], SHUT_RD);
458 if (ufd[0].revents & POLLOUT)
460 ssize_t val = write (fds[0], p_in, i_in);
466 shutdown (fds[0], SHUT_WR);
478 while (waitpid (pid, &i_status, 0) == -1);
480 if (WIFEXITED (i_status))
482 i_status = WEXITSTATUS (i_status);
484 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
485 ppsz_argv[0], (int)pid, i_status);
488 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
490 i_status = WTERMSIG (i_status);
491 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
492 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
495 #elif defined( WIN32 ) && !defined( UNDER_CE )
496 SECURITY_ATTRIBUTES saAttr;
497 PROCESS_INFORMATION piProcInfo;
498 STARTUPINFO siStartInfo;
499 BOOL bFuncRetn = FALSE;
500 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
502 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
506 /* Set the bInheritHandle flag so pipe handles are inherited. */
507 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
508 saAttr.bInheritHandle = TRUE;
509 saAttr.lpSecurityDescriptor = NULL;
511 /* Create a pipe for the child process's STDOUT. */
512 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
514 msg_Err( p_object, "stdout pipe creation failed" );
518 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
519 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
521 /* Create a pipe for the child process's STDIN. */
522 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
524 msg_Err( p_object, "stdin pipe creation failed" );
528 /* Ensure the write handle to the pipe for STDIN is not inherited. */
529 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
531 /* Set up members of the PROCESS_INFORMATION structure. */
532 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
534 /* Set up members of the STARTUPINFO structure. */
535 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
536 siStartInfo.cb = sizeof(STARTUPINFO);
537 siStartInfo.hStdError = hChildStdoutWr;
538 siStartInfo.hStdOutput = hChildStdoutWr;
539 siStartInfo.hStdInput = hChildStdinRd;
540 siStartInfo.wShowWindow = SW_HIDE;
541 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
543 /* Set up the command line. */
544 psz_cmd = malloc(32768);
549 ppsz_parser = &ppsz_argv[0];
550 while ( ppsz_parser[0] != NULL && i_size > 0 )
552 /* Protect the last argument with quotes ; the other arguments
553 * are supposed to be already protected because they have been
554 * passed as a command-line option. */
555 if ( ppsz_parser[1] == NULL )
557 strncat( psz_cmd, "\"", i_size );
560 strncat( psz_cmd, *ppsz_parser, i_size );
561 i_size -= strlen( *ppsz_parser );
562 if ( ppsz_parser[1] == NULL )
564 strncat( psz_cmd, "\"", i_size );
567 strncat( psz_cmd, " ", i_size );
572 /* Set up the environment. */
573 p = p_env = malloc(32768);
581 ppsz_parser = &ppsz_env[0];
582 while ( *ppsz_parser != NULL && i_size > 0 )
584 memcpy( p, *ppsz_parser,
585 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
586 p += strlen(*ppsz_parser) + 1;
587 i_size -= strlen(*ppsz_parser) + 1;
592 /* Create the child process. */
593 bFuncRetn = CreateProcess( NULL,
594 psz_cmd, // command line
595 NULL, // process security attributes
596 NULL, // primary thread security attributes
597 TRUE, // handles are inherited
601 &siStartInfo, // STARTUPINFO pointer
602 &piProcInfo ); // receives PROCESS_INFORMATION
607 if ( bFuncRetn == 0 )
609 msg_Err( p_object, "child creation failed" );
613 /* Read from a file and write its contents to a pipe. */
614 while ( i_in > 0 && !p_object->b_die )
617 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
623 /* Close the pipe handle so the child process stops reading. */
624 CloseHandle(hChildStdinWr);
626 /* Close the write end of the pipe before reading from the
627 * read end of the pipe. */
628 CloseHandle(hChildStdoutWr);
630 /* Read output from the child process. */
635 *pp_data = malloc( 1025 ); /* +1 for \0 */
637 while ( !p_object->b_die )
640 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
645 *pp_data = realloc( *pp_data, *pi_data + 1025 );
648 while ( !p_object->b_die
649 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
650 && i_status != STILL_ACTIVE )
653 CloseHandle(piProcInfo.hProcess);
654 CloseHandle(piProcInfo.hThread);
658 "child %s returned with error code %ld",
659 ppsz_argv[0], i_status );
662 msg_Err( p_object, "vlc_execve called but no implementation is available" );
667 if (*pp_data == NULL)
670 (*pp_data)[*pi_data] = '\0';