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++)
211 /*****************************************************************************
212 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
213 * when called with an empty argument or just '\'
214 *****************************************************************************/
215 #if defined(WIN32) && !defined(UNDER_CE)
218 typedef struct vlc_DIR
222 struct _wdirent dd_dir;
226 void *vlc_wopendir( const wchar_t *wpath )
228 vlc_DIR *p_dir = NULL;
229 _WDIR *p_real_dir = NULL;
231 if ( wpath == NULL || wpath[0] == '\0'
232 || (wcscmp (wpath, L"\\") == 0) )
234 /* Special mode to list drive letters */
235 p_dir = malloc( sizeof(vlc_DIR) );
238 p_dir->p_real_dir = NULL;
239 p_dir->i_drives = GetLogicalDrives();
240 return (void *)p_dir;
243 p_real_dir = _wopendir( wpath );
244 if ( p_real_dir == NULL )
247 p_dir = malloc( sizeof(vlc_DIR) );
250 _wclosedir( p_real_dir );
253 p_dir->p_real_dir = p_real_dir;
255 assert (wpath[0]); // wpath[1] is defined
256 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
257 return (void *)p_dir;
260 struct _wdirent *vlc_wreaddir( void *_p_dir )
262 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
266 if ( p_dir->p_real_dir != NULL )
268 if ( p_dir->b_insert_back )
270 /* Adds "..", gruik! */
271 p_dir->dd_dir.d_ino = 0;
272 p_dir->dd_dir.d_reclen = 0;
273 p_dir->dd_dir.d_namlen = 2;
274 wcscpy( p_dir->dd_dir.d_name, L".." );
275 p_dir->b_insert_back = false;
276 return &p_dir->dd_dir;
279 return _wreaddir( p_dir->p_real_dir );
282 /* Drive letters mode */
283 i_drives = p_dir->i_drives;
285 return NULL; /* end */
287 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
288 if ( i_drives & 1 ) break;
291 return NULL; /* this should not happen */
293 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
294 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
295 p_dir->i_drives &= ~(1UL << i);
296 return &p_dir->dd_dir;
299 void vlc_rewinddir( void *_p_dir )
301 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
303 if ( p_dir->p_real_dir != NULL )
304 _wrewinddir( p_dir->p_real_dir );
308 /* This one is in the libvlccore exported symbol list */
309 int vlc_wclosedir( void *_p_dir )
311 #if defined(WIN32) && !defined(UNDER_CE)
312 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
315 if ( p_dir->p_real_dir != NULL )
316 i_ret = _wclosedir( p_dir->p_real_dir );
321 return closedir( _p_dir );
326 * In-tree plugins share their gettext domain with LibVLC.
328 char *vlc_gettext( const char *msgid )
331 return dgettext( PACKAGE_NAME, msgid );
333 return (char *)msgid;
337 /*****************************************************************************
338 * count_utf8_string: returns the number of characters in the string.
339 *****************************************************************************/
340 static int count_utf8_string( const char *psz_string )
342 int i = 0, i_count = 0;
343 while( psz_string[ i ] != 0 )
345 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
351 /*****************************************************************************
352 * wraptext: inserts \n at convenient places to wrap the text.
353 * Returns the modified string in a new buffer.
354 *****************************************************************************/
355 char *vlc_wraptext( const char *psz_text, int i_line )
358 char *psz_line, *psz_new_text;
360 psz_line = psz_new_text = strdup( psz_text );
362 i_len = count_utf8_string( psz_text );
364 while( i_len > i_line )
366 /* Look if there is a newline somewhere. */
367 char *psz_parser = psz_line;
369 while( i_count <= i_line && *psz_parser != '\n' )
371 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
375 if( *psz_parser == '\n' )
377 i_len -= (i_count + 1);
378 psz_line = psz_parser + 1;
382 /* Find the furthest space. */
383 while( psz_parser > psz_line && *psz_parser != ' ' )
385 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
389 if( *psz_parser == ' ' )
392 i_len -= (i_count + 1);
393 psz_line = psz_parser + 1;
397 /* Wrapping has failed. Find the first space or newline */
398 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
400 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
404 if( i_count < i_len ) *psz_parser = '\n';
405 i_len -= (i_count + 1);
406 psz_line = psz_parser + 1;
412 /*****************************************************************************
414 *****************************************************************************/
415 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
417 #if defined(HAVE_ICONV)
418 return iconv_open( tocode, fromcode );
420 return (vlc_iconv_t)(-1);
424 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
425 char **outbuf, size_t *outbytesleft )
427 #if defined(HAVE_ICONV)
428 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
429 outbuf, outbytesleft );
435 int vlc_iconv_close( vlc_iconv_t cd )
437 #if defined(HAVE_ICONV)
438 return iconv_close( cd );
444 /*****************************************************************************
446 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
447 *****************************************************************************/
448 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
449 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
461 i_gcd = GCD( i_nom, i_den );
465 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
467 if( i_nom > i_max || i_den > i_max )
469 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
474 uint64_t i_x = i_nom / i_den;
475 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
476 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
478 if( i_a2n > i_max || i_a2d > i_max ) break;
482 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
483 i_a1_num = i_a2n; i_a1_den = i_a2d;
484 if( i_nom == 0 ) break;
485 i_x = i_nom; i_nom = i_den; i_den = i_x;
497 /*************************************************************************
498 * vlc_execve: Execute an external program with a given environment,
499 * wait until it finishes and return its standard output
500 *************************************************************************/
501 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
502 char *const *ppsz_env, const char *psz_cwd,
503 const char *p_in, size_t i_in,
504 char **pp_data, size_t *pi_data )
506 (void)i_argc; // <-- hmph
508 # define BUFSIZE 1024
509 int fds[2], i_status;
511 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
515 if ((fds[0] > 2) && (fds[1] > 2))
521 msg_Err (p_object, "unable to fork (%m)");
530 pthread_sigmask (SIG_SETMASK, &set, NULL);
533 * Like it or not, close can fail (and not only with EBADF)
535 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
536 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
537 && (open ("/dev/null", O_RDONLY) == 2)
538 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
539 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
553 shutdown (fds[0], SHUT_WR);
555 while (!p_object->b_die)
557 struct pollfd ufd[1];
558 memset (ufd, 0, sizeof (ufd));
560 ufd[0].events = POLLIN;
563 ufd[0].events |= POLLOUT;
565 if (poll (ufd, 1, 10) <= 0)
568 if (ufd[0].revents & ~POLLOUT)
570 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
572 break; /* safely abort */
576 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
581 shutdown (fds[0], SHUT_RD);
589 if (ufd[0].revents & POLLOUT)
591 ssize_t val = write (fds[0], p_in, i_in);
597 shutdown (fds[0], SHUT_WR);
609 while (waitpid (pid, &i_status, 0) == -1);
611 if (WIFEXITED (i_status))
613 i_status = WEXITSTATUS (i_status);
615 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
616 ppsz_argv[0], (int)pid, i_status);
619 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
621 i_status = WTERMSIG (i_status);
622 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
623 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
626 #elif defined( WIN32 ) && !defined( UNDER_CE )
627 SECURITY_ATTRIBUTES saAttr;
628 PROCESS_INFORMATION piProcInfo;
629 STARTUPINFO siStartInfo;
630 BOOL bFuncRetn = FALSE;
631 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
633 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
637 /* Set the bInheritHandle flag so pipe handles are inherited. */
638 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
639 saAttr.bInheritHandle = TRUE;
640 saAttr.lpSecurityDescriptor = NULL;
642 /* Create a pipe for the child process's STDOUT. */
643 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
645 msg_Err( p_object, "stdout pipe creation failed" );
649 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
650 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
652 /* Create a pipe for the child process's STDIN. */
653 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
655 msg_Err( p_object, "stdin pipe creation failed" );
659 /* Ensure the write handle to the pipe for STDIN is not inherited. */
660 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
662 /* Set up members of the PROCESS_INFORMATION structure. */
663 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
665 /* Set up members of the STARTUPINFO structure. */
666 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
667 siStartInfo.cb = sizeof(STARTUPINFO);
668 siStartInfo.hStdError = hChildStdoutWr;
669 siStartInfo.hStdOutput = hChildStdoutWr;
670 siStartInfo.hStdInput = hChildStdinRd;
671 siStartInfo.wShowWindow = SW_HIDE;
672 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
674 /* Set up the command line. */
675 psz_cmd = malloc(32768);
680 ppsz_parser = &ppsz_argv[0];
681 while ( ppsz_parser[0] != NULL && i_size > 0 )
683 /* Protect the last argument with quotes ; the other arguments
684 * are supposed to be already protected because they have been
685 * passed as a command-line option. */
686 if ( ppsz_parser[1] == NULL )
688 strncat( psz_cmd, "\"", i_size );
691 strncat( psz_cmd, *ppsz_parser, i_size );
692 i_size -= strlen( *ppsz_parser );
693 if ( ppsz_parser[1] == NULL )
695 strncat( psz_cmd, "\"", i_size );
698 strncat( psz_cmd, " ", i_size );
703 /* Set up the environment. */
704 p = p_env = malloc(32768);
712 ppsz_parser = &ppsz_env[0];
713 while ( *ppsz_parser != NULL && i_size > 0 )
715 memcpy( p, *ppsz_parser,
716 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
717 p += strlen(*ppsz_parser) + 1;
718 i_size -= strlen(*ppsz_parser) + 1;
723 /* Create the child process. */
724 bFuncRetn = CreateProcess( NULL,
725 psz_cmd, // command line
726 NULL, // process security attributes
727 NULL, // primary thread security attributes
728 TRUE, // handles are inherited
732 &siStartInfo, // STARTUPINFO pointer
733 &piProcInfo ); // receives PROCESS_INFORMATION
738 if ( bFuncRetn == 0 )
740 msg_Err( p_object, "child creation failed" );
744 /* Read from a file and write its contents to a pipe. */
745 while ( i_in > 0 && !p_object->b_die )
748 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
754 /* Close the pipe handle so the child process stops reading. */
755 CloseHandle(hChildStdinWr);
757 /* Close the write end of the pipe before reading from the
758 * read end of the pipe. */
759 CloseHandle(hChildStdoutWr);
761 /* Read output from the child process. */
766 *pp_data = malloc( 1025 ); /* +1 for \0 */
768 while ( !p_object->b_die )
771 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
776 *pp_data = realloc( *pp_data, *pi_data + 1025 );
779 while ( !p_object->b_die
780 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
781 && i_status != STILL_ACTIVE )
784 CloseHandle(piProcInfo.hProcess);
785 CloseHandle(piProcInfo.hThread);
789 "child %s returned with error code %ld",
790 ppsz_argv[0], i_status );
793 msg_Err( p_object, "vlc_execve called but no implementation is available" );
798 if (*pp_data == NULL)
801 (*pp_data)[*pi_data] = '\0';