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 * strcasestr: find a substring (little) in another substring (big)
73 * Case sensitive. Return NULL if not found, return big if little == null
74 *****************************************************************************/
75 char * vlc_strcasestr( const char *psz_big, const char *psz_little )
77 #if defined (HAVE_STRCASESTR) || defined (HAVE_STRISTR)
78 return strcasestr (psz_big, psz_little);
80 char *p_pos = (char *)psz_big;
82 if( !psz_big || !psz_little || !*psz_little ) return p_pos;
86 if( toupper( *p_pos ) == toupper( *psz_little ) )
88 char * psz_cur1 = p_pos + 1;
89 char * psz_cur2 = (char *)psz_little + 1;
90 while( *psz_cur1 && *psz_cur2 &&
91 toupper( *psz_cur1 ) == toupper( *psz_cur2 ) )
96 if( !*psz_cur2 ) return p_pos;
104 /*****************************************************************************
105 * strtoll: convert a string to a 64 bits int.
106 *****************************************************************************/
107 long long vlc_strtoll( const char *nptr, char **endptr, int base )
109 #if defined( HAVE_STRTOLL )
110 return strtoll( nptr, endptr, base );
112 long long i_value = 0;
113 int sign = 1, newbase = base ? base : 10;
115 while( isspace(*nptr) ) nptr++;
123 /* Try to detect base */
136 if( base && newbase != base )
138 if( endptr ) *endptr = (char *)nptr;
145 while( *nptr >= '0' && *nptr <= '9' )
148 i_value += ( *nptr++ - '0' );
150 if( endptr ) *endptr = (char *)nptr;
154 while( (*nptr >= '0' && *nptr <= '9') ||
155 (*nptr >= 'a' && *nptr <= 'f') ||
156 (*nptr >= 'A' && *nptr <= 'F') )
159 if(*nptr >= '0' && *nptr <= '9') i_valc = *nptr - '0';
160 else if(*nptr >= 'a' && *nptr <= 'f') i_valc = *nptr - 'a' +10;
161 else if(*nptr >= 'A' && *nptr <= 'F') i_valc = *nptr - 'A' +10;
166 if( endptr ) *endptr = (char *)nptr;
170 i_value = strtol( nptr, endptr, newbase );
174 return i_value * sign;
179 * Copy a string to a sized buffer. The result is always nul-terminated
180 * (contrary to strncpy()).
182 * @param dest destination buffer
183 * @param src string to be copied
184 * @param len maximum number of characters to be copied plus one for the
187 * @return strlen(src)
189 extern size_t vlc_strlcpy (char *tgt, const char *src, size_t bufsize)
192 return strlcpy (tgt, src, bufsize);
196 for (length = 1; (length < bufsize) && *src; length++)
209 /*****************************************************************************
210 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
211 * when called with an empty argument or just '\'
212 *****************************************************************************/
216 typedef struct vlc_DIR
220 struct _wdirent dd_dir;
224 void *vlc_wopendir( const wchar_t *wpath )
226 vlc_DIR *p_dir = NULL;
227 _WDIR *p_real_dir = NULL;
229 if ( wpath == NULL || wpath[0] == '\0'
230 || (wcscmp (wpath, L"\\") == 0) )
232 /* Special mode to list drive letters */
233 p_dir = malloc( sizeof(vlc_DIR) );
236 p_dir->p_real_dir = NULL;
237 #if defined(UNDER_CE)
238 p_dir->i_drives = NULL;
240 p_dir->i_drives = GetLogicalDrives();
242 return (void *)p_dir;
245 p_real_dir = _wopendir( wpath );
246 if ( p_real_dir == NULL )
249 p_dir = malloc( sizeof(vlc_DIR) );
252 _wclosedir( p_real_dir );
255 p_dir->p_real_dir = p_real_dir;
257 assert (wpath[0]); // wpath[1] is defined
258 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
259 return (void *)p_dir;
262 struct _wdirent *vlc_wreaddir( void *_p_dir )
264 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
267 if ( p_dir->p_real_dir != NULL )
269 if ( p_dir->b_insert_back )
271 /* Adds "..", gruik! */
272 p_dir->dd_dir.d_ino = 0;
273 p_dir->dd_dir.d_reclen = 0;
274 p_dir->dd_dir.d_namlen = 2;
275 wcscpy( p_dir->dd_dir.d_name, L".." );
276 p_dir->b_insert_back = false;
277 return &p_dir->dd_dir;
280 return _wreaddir( p_dir->p_real_dir );
283 /* Drive letters mode */
284 i_drives = p_dir->i_drives;
286 swprintf( p_dir->dd_dir.d_name, L"\\");
287 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
291 return NULL; /* end */
293 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
294 if ( i_drives & 1 ) break;
297 return NULL; /* this should not happen */
299 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
300 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
301 p_dir->i_drives &= ~(1UL << i);
303 return &p_dir->dd_dir;
306 void vlc_rewinddir( void *_p_dir )
308 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
310 if ( p_dir->p_real_dir != NULL )
311 _wrewinddir( p_dir->p_real_dir );
315 /* This one is in the libvlccore exported symbol list */
316 int vlc_wclosedir( void *_p_dir )
319 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
322 if ( p_dir->p_real_dir != NULL )
323 i_ret = _wclosedir( p_dir->p_real_dir );
328 return closedir( _p_dir );
333 * In-tree plugins share their gettext domain with LibVLC.
335 char *vlc_gettext( const char *msgid )
338 return dgettext( PACKAGE_NAME, msgid );
340 return (char *)msgid;
344 /*****************************************************************************
345 * count_utf8_string: returns the number of characters in the string.
346 *****************************************************************************/
347 static int count_utf8_string( const char *psz_string )
349 int i = 0, i_count = 0;
350 while( psz_string[ i ] != 0 )
352 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
358 /*****************************************************************************
359 * wraptext: inserts \n at convenient places to wrap the text.
360 * Returns the modified string in a new buffer.
361 *****************************************************************************/
362 char *vlc_wraptext( const char *psz_text, int i_line )
365 char *psz_line, *psz_new_text;
367 psz_line = psz_new_text = strdup( psz_text );
369 i_len = count_utf8_string( psz_text );
371 while( i_len > i_line )
373 /* Look if there is a newline somewhere. */
374 char *psz_parser = psz_line;
376 while( i_count <= i_line && *psz_parser != '\n' )
378 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
382 if( *psz_parser == '\n' )
384 i_len -= (i_count + 1);
385 psz_line = psz_parser + 1;
389 /* Find the furthest space. */
390 while( psz_parser > psz_line && *psz_parser != ' ' )
392 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
396 if( *psz_parser == ' ' )
399 i_len -= (i_count + 1);
400 psz_line = psz_parser + 1;
404 /* Wrapping has failed. Find the first space or newline */
405 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
407 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
411 if( i_count < i_len ) *psz_parser = '\n';
412 i_len -= (i_count + 1);
413 psz_line = psz_parser + 1;
419 /*****************************************************************************
421 *****************************************************************************/
422 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
424 #if defined(HAVE_ICONV)
425 return iconv_open( tocode, fromcode );
427 return (vlc_iconv_t)(-1);
431 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
432 char **outbuf, size_t *outbytesleft )
434 #if defined(HAVE_ICONV)
435 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
436 outbuf, outbytesleft );
442 int vlc_iconv_close( vlc_iconv_t cd )
444 #if defined(HAVE_ICONV)
445 return iconv_close( cd );
451 /*****************************************************************************
453 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
454 *****************************************************************************/
455 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
456 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
468 i_gcd = GCD( i_nom, i_den );
472 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
474 if( i_nom > i_max || i_den > i_max )
476 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
481 uint64_t i_x = i_nom / i_den;
482 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
483 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
485 if( i_a2n > i_max || i_a2d > i_max ) break;
489 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
490 i_a1_num = i_a2n; i_a1_den = i_a2d;
491 if( i_nom == 0 ) break;
492 i_x = i_nom; i_nom = i_den; i_den = i_x;
504 /*************************************************************************
505 * vlc_execve: Execute an external program with a given environment,
506 * wait until it finishes and return its standard output
507 *************************************************************************/
508 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
509 char *const *ppsz_env, const char *psz_cwd,
510 const char *p_in, size_t i_in,
511 char **pp_data, size_t *pi_data )
513 (void)i_argc; // <-- hmph
515 # define BUFSIZE 1024
516 int fds[2], i_status;
518 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
522 if ((fds[0] > 2) && (fds[1] > 2))
528 msg_Err (p_object, "unable to fork (%m)");
537 pthread_sigmask (SIG_SETMASK, &set, NULL);
540 * Like it or not, close can fail (and not only with EBADF)
542 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
543 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
544 && (open ("/dev/null", O_RDONLY) == 2)
545 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
546 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
560 shutdown (fds[0], SHUT_WR);
562 while (!p_object->b_die)
564 struct pollfd ufd[1];
565 memset (ufd, 0, sizeof (ufd));
567 ufd[0].events = POLLIN;
570 ufd[0].events |= POLLOUT;
572 if (poll (ufd, 1, 10) <= 0)
575 if (ufd[0].revents & ~POLLOUT)
577 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
579 break; /* safely abort */
583 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
588 shutdown (fds[0], SHUT_RD);
596 if (ufd[0].revents & POLLOUT)
598 ssize_t val = write (fds[0], p_in, i_in);
604 shutdown (fds[0], SHUT_WR);
616 while (waitpid (pid, &i_status, 0) == -1);
618 if (WIFEXITED (i_status))
620 i_status = WEXITSTATUS (i_status);
622 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
623 ppsz_argv[0], (int)pid, i_status);
626 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
628 i_status = WTERMSIG (i_status);
629 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
630 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
633 #elif defined( WIN32 ) && !defined( UNDER_CE )
634 SECURITY_ATTRIBUTES saAttr;
635 PROCESS_INFORMATION piProcInfo;
636 STARTUPINFO siStartInfo;
637 BOOL bFuncRetn = FALSE;
638 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
640 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
644 /* Set the bInheritHandle flag so pipe handles are inherited. */
645 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
646 saAttr.bInheritHandle = TRUE;
647 saAttr.lpSecurityDescriptor = NULL;
649 /* Create a pipe for the child process's STDOUT. */
650 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
652 msg_Err( p_object, "stdout pipe creation failed" );
656 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
657 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
659 /* Create a pipe for the child process's STDIN. */
660 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
662 msg_Err( p_object, "stdin pipe creation failed" );
666 /* Ensure the write handle to the pipe for STDIN is not inherited. */
667 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
669 /* Set up members of the PROCESS_INFORMATION structure. */
670 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
672 /* Set up members of the STARTUPINFO structure. */
673 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
674 siStartInfo.cb = sizeof(STARTUPINFO);
675 siStartInfo.hStdError = hChildStdoutWr;
676 siStartInfo.hStdOutput = hChildStdoutWr;
677 siStartInfo.hStdInput = hChildStdinRd;
678 siStartInfo.wShowWindow = SW_HIDE;
679 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
681 /* Set up the command line. */
682 psz_cmd = malloc(32768);
687 ppsz_parser = &ppsz_argv[0];
688 while ( ppsz_parser[0] != NULL && i_size > 0 )
690 /* Protect the last argument with quotes ; the other arguments
691 * are supposed to be already protected because they have been
692 * passed as a command-line option. */
693 if ( ppsz_parser[1] == NULL )
695 strncat( psz_cmd, "\"", i_size );
698 strncat( psz_cmd, *ppsz_parser, i_size );
699 i_size -= strlen( *ppsz_parser );
700 if ( ppsz_parser[1] == NULL )
702 strncat( psz_cmd, "\"", i_size );
705 strncat( psz_cmd, " ", i_size );
710 /* Set up the environment. */
711 p = p_env = malloc(32768);
719 ppsz_parser = &ppsz_env[0];
720 while ( *ppsz_parser != NULL && i_size > 0 )
722 memcpy( p, *ppsz_parser,
723 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
724 p += strlen(*ppsz_parser) + 1;
725 i_size -= strlen(*ppsz_parser) + 1;
730 /* Create the child process. */
731 bFuncRetn = CreateProcess( NULL,
732 psz_cmd, // command line
733 NULL, // process security attributes
734 NULL, // primary thread security attributes
735 TRUE, // handles are inherited
739 &siStartInfo, // STARTUPINFO pointer
740 &piProcInfo ); // receives PROCESS_INFORMATION
745 if ( bFuncRetn == 0 )
747 msg_Err( p_object, "child creation failed" );
751 /* Read from a file and write its contents to a pipe. */
752 while ( i_in > 0 && !p_object->b_die )
755 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
761 /* Close the pipe handle so the child process stops reading. */
762 CloseHandle(hChildStdinWr);
764 /* Close the write end of the pipe before reading from the
765 * read end of the pipe. */
766 CloseHandle(hChildStdoutWr);
768 /* Read output from the child process. */
773 *pp_data = malloc( 1025 ); /* +1 for \0 */
775 while ( !p_object->b_die )
778 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
783 *pp_data = realloc( *pp_data, *pi_data + 1025 );
786 while ( !p_object->b_die
787 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
788 && i_status != STILL_ACTIVE )
791 CloseHandle(piProcInfo.hProcess);
792 CloseHandle(piProcInfo.hThread);
796 "child %s returned with error code %ld",
797 ppsz_argv[0], i_status );
800 msg_Err( p_object, "vlc_execve called but no implementation is available" );
805 if (*pp_data == NULL)
808 (*pp_data)[*pi_data] = '\0';