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)
55 # include <sys/time.h>
58 # include <sys/wait.h>
60 # include <sys/socket.h>
61 # include <sys/poll.h>
64 #if defined(WIN32) || defined(UNDER_CE)
69 # define WIN32_LEAN_AND_MEAN
73 /******************************************************************************
74 * strcasestr: find a substring (little) in another substring (big)
75 * Case sensitive. Return NULL if not found, return big if little == null
76 *****************************************************************************/
77 char * vlc_strcasestr( const char *psz_big, const char *psz_little )
79 #if defined (HAVE_STRCASESTR) || defined (HAVE_STRISTR)
80 return strcasestr (psz_big, psz_little);
82 char *p_pos = (char *)psz_big;
84 if( !psz_big || !psz_little || !*psz_little ) return p_pos;
88 if( toupper( *p_pos ) == toupper( *psz_little ) )
90 char * psz_cur1 = p_pos + 1;
91 char * psz_cur2 = (char *)psz_little + 1;
92 while( *psz_cur1 && *psz_cur2 &&
93 toupper( *psz_cur1 ) == toupper( *psz_cur2 ) )
98 if( !*psz_cur2 ) return p_pos;
106 /*****************************************************************************
107 * strtoll: convert a string to a 64 bits int.
108 *****************************************************************************/
109 long long vlc_strtoll( const char *nptr, char **endptr, int base )
111 #if defined( HAVE_STRTOLL )
112 return strtoll( nptr, endptr, base );
114 long long i_value = 0;
115 int sign = 1, newbase = base ? base : 10;
117 while( isspace(*nptr) ) nptr++;
125 /* Try to detect base */
138 if( base && newbase != base )
140 if( endptr ) *endptr = (char *)nptr;
147 while( *nptr >= '0' && *nptr <= '9' )
150 i_value += ( *nptr++ - '0' );
152 if( endptr ) *endptr = (char *)nptr;
156 while( (*nptr >= '0' && *nptr <= '9') ||
157 (*nptr >= 'a' && *nptr <= 'f') ||
158 (*nptr >= 'A' && *nptr <= 'F') )
161 if(*nptr >= '0' && *nptr <= '9') i_valc = *nptr - '0';
162 else if(*nptr >= 'a' && *nptr <= 'f') i_valc = *nptr - 'a' +10;
163 else if(*nptr >= 'A' && *nptr <= 'F') i_valc = *nptr - 'A' +10;
168 if( endptr ) *endptr = (char *)nptr;
172 i_value = strtol( nptr, endptr, newbase );
176 return i_value * sign;
181 * Copy a string to a sized buffer. The result is always nul-terminated
182 * (contrary to strncpy()).
184 * @param dest destination buffer
185 * @param src string to be copied
186 * @param len maximum number of characters to be copied plus one for the
189 * @return strlen(src)
191 extern size_t vlc_strlcpy (char *tgt, const char *src, size_t bufsize)
194 return strlcpy (tgt, src, bufsize);
198 for (length = 1; (length < bufsize) && *src; length++)
212 * Extract a token from string.
213 * It is a replacement for strsep if not present.
215 char *vlc_strsep( char **ppsz_string, const char *psz_delimiters )
217 char *psz_string = *ppsz_string;
221 char *p = strpbrk( psz_string, psz_delimiters );
233 /*****************************************************************************
234 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
235 * when called with an empty argument or just '\'
236 *****************************************************************************/
240 typedef struct vlc_DIR
244 struct _wdirent dd_dir;
248 void *vlc_wopendir( const wchar_t *wpath )
250 vlc_DIR *p_dir = NULL;
251 _WDIR *p_real_dir = NULL;
253 if ( wpath == NULL || wpath[0] == '\0'
254 || (wcscmp (wpath, L"\\") == 0) )
256 /* Special mode to list drive letters */
257 p_dir = malloc( sizeof(vlc_DIR) );
260 p_dir->p_real_dir = NULL;
261 #if defined(UNDER_CE)
262 p_dir->i_drives = NULL;
264 p_dir->i_drives = GetLogicalDrives();
266 return (void *)p_dir;
269 p_real_dir = _wopendir( wpath );
270 if ( p_real_dir == NULL )
273 p_dir = malloc( sizeof(vlc_DIR) );
276 _wclosedir( p_real_dir );
279 p_dir->p_real_dir = p_real_dir;
281 assert (wpath[0]); // wpath[1] is defined
282 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
283 return (void *)p_dir;
286 struct _wdirent *vlc_wreaddir( void *_p_dir )
288 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
292 if ( p_dir->p_real_dir != NULL )
294 if ( p_dir->b_insert_back )
296 /* Adds "..", gruik! */
297 p_dir->dd_dir.d_ino = 0;
298 p_dir->dd_dir.d_reclen = 0;
299 p_dir->dd_dir.d_namlen = 2;
300 wcscpy( p_dir->dd_dir.d_name, L".." );
301 p_dir->b_insert_back = false;
302 return &p_dir->dd_dir;
305 return _wreaddir( p_dir->p_real_dir );
308 /* Drive letters mode */
309 i_drives = p_dir->i_drives;
311 swprintf( p_dir->dd_dir.d_name, L"\\");
312 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
315 return NULL; /* end */
317 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
318 if ( i_drives & 1 ) break;
321 return NULL; /* this should not happen */
323 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
324 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
325 p_dir->i_drives &= ~(1UL << i);
327 return &p_dir->dd_dir;
330 void vlc_rewinddir( void *_p_dir )
332 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
334 if ( p_dir->p_real_dir != NULL )
335 _wrewinddir( p_dir->p_real_dir );
339 /* This one is in the libvlccore exported symbol list */
340 int vlc_wclosedir( void *_p_dir )
343 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
346 if ( p_dir->p_real_dir != NULL )
347 i_ret = _wclosedir( p_dir->p_real_dir );
352 return closedir( _p_dir );
357 * In-tree plugins share their gettext domain with LibVLC.
359 char *vlc_gettext( const char *msgid )
362 return dgettext( PACKAGE_NAME, msgid );
364 return (char *)msgid;
368 /*****************************************************************************
369 * count_utf8_string: returns the number of characters in the string.
370 *****************************************************************************/
371 static int count_utf8_string( const char *psz_string )
373 int i = 0, i_count = 0;
374 while( psz_string[ i ] != 0 )
376 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
382 /*****************************************************************************
383 * wraptext: inserts \n at convenient places to wrap the text.
384 * Returns the modified string in a new buffer.
385 *****************************************************************************/
386 char *vlc_wraptext( const char *psz_text, int i_line )
389 char *psz_line, *psz_new_text;
391 psz_line = psz_new_text = strdup( psz_text );
393 i_len = count_utf8_string( psz_text );
395 while( i_len > i_line )
397 /* Look if there is a newline somewhere. */
398 char *psz_parser = psz_line;
400 while( i_count <= i_line && *psz_parser != '\n' )
402 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
406 if( *psz_parser == '\n' )
408 i_len -= (i_count + 1);
409 psz_line = psz_parser + 1;
413 /* Find the furthest space. */
414 while( psz_parser > psz_line && *psz_parser != ' ' )
416 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
420 if( *psz_parser == ' ' )
423 i_len -= (i_count + 1);
424 psz_line = psz_parser + 1;
428 /* Wrapping has failed. Find the first space or newline */
429 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
431 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
435 if( i_count < i_len ) *psz_parser = '\n';
436 i_len -= (i_count + 1);
437 psz_line = psz_parser + 1;
443 /*****************************************************************************
445 *****************************************************************************/
446 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
448 #if defined(HAVE_ICONV)
449 return iconv_open( tocode, fromcode );
451 return (vlc_iconv_t)(-1);
455 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
456 char **outbuf, size_t *outbytesleft )
458 #if defined(HAVE_ICONV)
459 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
460 outbuf, outbytesleft );
466 int vlc_iconv_close( vlc_iconv_t cd )
468 #if defined(HAVE_ICONV)
469 return iconv_close( cd );
475 /*****************************************************************************
477 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
478 *****************************************************************************/
479 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
480 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
492 i_gcd = GCD( i_nom, i_den );
496 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
498 if( i_nom > i_max || i_den > i_max )
500 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
505 uint64_t i_x = i_nom / i_den;
506 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
507 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
509 if( i_a2n > i_max || i_a2d > i_max ) break;
513 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
514 i_a1_num = i_a2n; i_a1_den = i_a2d;
515 if( i_nom == 0 ) break;
516 i_x = i_nom; i_nom = i_den; i_den = i_x;
528 /*************************************************************************
529 * vlc_execve: Execute an external program with a given environment,
530 * wait until it finishes and return its standard output
531 *************************************************************************/
532 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
533 char *const *ppsz_env, const char *psz_cwd,
534 const char *p_in, size_t i_in,
535 char **pp_data, size_t *pi_data )
537 (void)i_argc; // <-- hmph
539 # define BUFSIZE 1024
540 int fds[2], i_status;
542 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
546 if ((fds[0] > 2) && (fds[1] > 2))
552 msg_Err (p_object, "unable to fork (%m)");
561 pthread_sigmask (SIG_SETMASK, &set, NULL);
564 * Like it or not, close can fail (and not only with EBADF)
566 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
567 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
568 && (open ("/dev/null", O_RDONLY) == 2)
569 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
570 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
584 shutdown (fds[0], SHUT_WR);
586 while (!p_object->b_die)
588 struct pollfd ufd[1];
589 memset (ufd, 0, sizeof (ufd));
591 ufd[0].events = POLLIN;
594 ufd[0].events |= POLLOUT;
596 if (poll (ufd, 1, 10) <= 0)
599 if (ufd[0].revents & ~POLLOUT)
601 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
603 break; /* safely abort */
607 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
612 shutdown (fds[0], SHUT_RD);
620 if (ufd[0].revents & POLLOUT)
622 ssize_t val = write (fds[0], p_in, i_in);
628 shutdown (fds[0], SHUT_WR);
640 while (waitpid (pid, &i_status, 0) == -1);
642 if (WIFEXITED (i_status))
644 i_status = WEXITSTATUS (i_status);
646 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
647 ppsz_argv[0], (int)pid, i_status);
650 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
652 i_status = WTERMSIG (i_status);
653 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
654 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
657 #elif defined( WIN32 ) && !defined( UNDER_CE )
658 SECURITY_ATTRIBUTES saAttr;
659 PROCESS_INFORMATION piProcInfo;
660 STARTUPINFO siStartInfo;
661 BOOL bFuncRetn = FALSE;
662 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
664 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
668 /* Set the bInheritHandle flag so pipe handles are inherited. */
669 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
670 saAttr.bInheritHandle = TRUE;
671 saAttr.lpSecurityDescriptor = NULL;
673 /* Create a pipe for the child process's STDOUT. */
674 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
676 msg_Err( p_object, "stdout pipe creation failed" );
680 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
681 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
683 /* Create a pipe for the child process's STDIN. */
684 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
686 msg_Err( p_object, "stdin pipe creation failed" );
690 /* Ensure the write handle to the pipe for STDIN is not inherited. */
691 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
693 /* Set up members of the PROCESS_INFORMATION structure. */
694 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
696 /* Set up members of the STARTUPINFO structure. */
697 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
698 siStartInfo.cb = sizeof(STARTUPINFO);
699 siStartInfo.hStdError = hChildStdoutWr;
700 siStartInfo.hStdOutput = hChildStdoutWr;
701 siStartInfo.hStdInput = hChildStdinRd;
702 siStartInfo.wShowWindow = SW_HIDE;
703 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
705 /* Set up the command line. */
706 psz_cmd = malloc(32768);
711 ppsz_parser = &ppsz_argv[0];
712 while ( ppsz_parser[0] != NULL && i_size > 0 )
714 /* Protect the last argument with quotes ; the other arguments
715 * are supposed to be already protected because they have been
716 * passed as a command-line option. */
717 if ( ppsz_parser[1] == NULL )
719 strncat( psz_cmd, "\"", i_size );
722 strncat( psz_cmd, *ppsz_parser, i_size );
723 i_size -= strlen( *ppsz_parser );
724 if ( ppsz_parser[1] == NULL )
726 strncat( psz_cmd, "\"", i_size );
729 strncat( psz_cmd, " ", i_size );
734 /* Set up the environment. */
735 p = p_env = malloc(32768);
743 ppsz_parser = &ppsz_env[0];
744 while ( *ppsz_parser != NULL && i_size > 0 )
746 memcpy( p, *ppsz_parser,
747 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
748 p += strlen(*ppsz_parser) + 1;
749 i_size -= strlen(*ppsz_parser) + 1;
754 /* Create the child process. */
755 bFuncRetn = CreateProcess( NULL,
756 psz_cmd, // command line
757 NULL, // process security attributes
758 NULL, // primary thread security attributes
759 TRUE, // handles are inherited
763 &siStartInfo, // STARTUPINFO pointer
764 &piProcInfo ); // receives PROCESS_INFORMATION
769 if ( bFuncRetn == 0 )
771 msg_Err( p_object, "child creation failed" );
775 /* Read from a file and write its contents to a pipe. */
776 while ( i_in > 0 && !p_object->b_die )
779 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
785 /* Close the pipe handle so the child process stops reading. */
786 CloseHandle(hChildStdinWr);
788 /* Close the write end of the pipe before reading from the
789 * read end of the pipe. */
790 CloseHandle(hChildStdoutWr);
792 /* Read output from the child process. */
797 *pp_data = malloc( 1025 ); /* +1 for \0 */
799 while ( !p_object->b_die )
802 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
807 *pp_data = realloc( *pp_data, *pi_data + 1025 );
810 while ( !p_object->b_die
811 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
812 && i_status != STILL_ACTIVE )
815 CloseHandle(piProcInfo.hProcess);
816 CloseHandle(piProcInfo.hThread);
820 "child %s returned with error code %ld",
821 ppsz_argv[0], i_status );
824 msg_Err( p_object, "vlc_execve called but no implementation is available" );
829 if (*pp_data == NULL)
832 (*pp_data)[*pi_data] = '\0';