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>
65 #include <vlc_network.h>
69 #if defined(WIN32) || defined(UNDER_CE)
74 # define WIN32_LEAN_AND_MEAN
78 /******************************************************************************
79 * strcasestr: find a substring (little) in another substring (big)
80 * Case sensitive. Return NULL if not found, return big if little == null
81 *****************************************************************************/
82 char * vlc_strcasestr( const char *psz_big, const char *psz_little )
84 #if defined (HAVE_STRCASESTR) || defined (HAVE_STRISTR)
85 return strcasestr (psz_big, psz_little);
87 char *p_pos = (char *)psz_big;
89 if( !psz_big || !psz_little || !*psz_little ) return p_pos;
93 if( toupper( *p_pos ) == toupper( *psz_little ) )
95 char * psz_cur1 = p_pos + 1;
96 char * psz_cur2 = (char *)psz_little + 1;
97 while( *psz_cur1 && *psz_cur2 &&
98 toupper( *psz_cur1 ) == toupper( *psz_cur2 ) )
103 if( !*psz_cur2 ) return p_pos;
111 /*****************************************************************************
112 * strtoll: convert a string to a 64 bits int.
113 *****************************************************************************/
114 long long vlc_strtoll( const char *nptr, char **endptr, int base )
116 #if defined( HAVE_STRTOLL )
117 return strtoll( nptr, endptr, base );
119 long long i_value = 0;
120 int sign = 1, newbase = base ? base : 10;
122 while( isspace(*nptr) ) nptr++;
130 /* Try to detect base */
143 if( base && newbase != base )
145 if( endptr ) *endptr = (char *)nptr;
152 while( *nptr >= '0' && *nptr <= '9' )
155 i_value += ( *nptr++ - '0' );
157 if( endptr ) *endptr = (char *)nptr;
161 while( (*nptr >= '0' && *nptr <= '9') ||
162 (*nptr >= 'a' && *nptr <= 'f') ||
163 (*nptr >= 'A' && *nptr <= 'F') )
166 if(*nptr >= '0' && *nptr <= '9') i_valc = *nptr - '0';
167 else if(*nptr >= 'a' && *nptr <= 'f') i_valc = *nptr - 'a' +10;
168 else if(*nptr >= 'A' && *nptr <= 'F') i_valc = *nptr - 'A' +10;
173 if( endptr ) *endptr = (char *)nptr;
177 i_value = strtol( nptr, endptr, newbase );
181 return i_value * sign;
186 * Copy a string to a sized buffer. The result is always nul-terminated
187 * (contrary to strncpy()).
189 * @param dest destination buffer
190 * @param src string to be copied
191 * @param len maximum number of characters to be copied plus one for the
194 * @return strlen(src)
196 extern size_t vlc_strlcpy (char *tgt, const char *src, size_t bufsize)
199 return strlcpy (tgt, src, bufsize);
203 for (length = 1; (length < bufsize) && *src; length++)
216 /*****************************************************************************
217 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
218 * when called with an empty argument or just '\'
219 *****************************************************************************/
220 #if defined(WIN32) && !defined(UNDER_CE)
223 typedef struct vlc_DIR
227 struct _wdirent dd_dir;
231 void *vlc_wopendir( const wchar_t *wpath )
233 vlc_DIR *p_dir = NULL;
234 _WDIR *p_real_dir = NULL;
236 if ( wpath == NULL || wpath[0] == '\0'
237 || (wcscmp (wpath, L"\\") == 0) )
239 /* Special mode to list drive letters */
240 p_dir = malloc( sizeof(vlc_DIR) );
243 p_dir->p_real_dir = NULL;
244 p_dir->i_drives = GetLogicalDrives();
245 return (void *)p_dir;
248 p_real_dir = _wopendir( wpath );
249 if ( p_real_dir == NULL )
252 p_dir = malloc( sizeof(vlc_DIR) );
255 _wclosedir( p_real_dir );
258 p_dir->p_real_dir = p_real_dir;
260 assert (wpath[0]); // wpath[1] is defined
261 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
262 return (void *)p_dir;
265 struct _wdirent *vlc_wreaddir( void *_p_dir )
267 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
271 if ( p_dir->p_real_dir != NULL )
273 if ( p_dir->b_insert_back )
275 /* Adds "..", gruik! */
276 p_dir->dd_dir.d_ino = 0;
277 p_dir->dd_dir.d_reclen = 0;
278 p_dir->dd_dir.d_namlen = 2;
279 wcscpy( p_dir->dd_dir.d_name, L".." );
280 p_dir->b_insert_back = false;
281 return &p_dir->dd_dir;
284 return _wreaddir( p_dir->p_real_dir );
287 /* Drive letters mode */
288 i_drives = p_dir->i_drives;
290 return NULL; /* end */
292 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
293 if ( i_drives & 1 ) break;
296 return NULL; /* this should not happen */
298 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
299 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
300 p_dir->i_drives &= ~(1UL << i);
301 return &p_dir->dd_dir;
304 void vlc_rewinddir( void *_p_dir )
306 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
308 if ( p_dir->p_real_dir != NULL )
309 _wrewinddir( p_dir->p_real_dir );
313 /* This one is in the libvlccore exported symbol list */
314 int vlc_wclosedir( void *_p_dir )
316 #if defined(WIN32) && !defined(UNDER_CE)
317 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
320 if ( p_dir->p_real_dir != NULL )
321 i_ret = _wclosedir( p_dir->p_real_dir );
326 return closedir( _p_dir );
331 * In-tree plugins share their gettext domain with LibVLC.
333 char *vlc_gettext( const char *msgid )
336 return dgettext( PACKAGE_NAME, msgid );
338 return (char *)msgid;
342 /*****************************************************************************
343 * count_utf8_string: returns the number of characters in the string.
344 *****************************************************************************/
345 static int count_utf8_string( const char *psz_string )
347 int i = 0, i_count = 0;
348 while( psz_string[ i ] != 0 )
350 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
356 /*****************************************************************************
357 * wraptext: inserts \n at convenient places to wrap the text.
358 * Returns the modified string in a new buffer.
359 *****************************************************************************/
360 char *vlc_wraptext( const char *psz_text, int i_line )
363 char *psz_line, *psz_new_text;
365 psz_line = psz_new_text = strdup( psz_text );
367 i_len = count_utf8_string( psz_text );
369 while( i_len > i_line )
371 /* Look if there is a newline somewhere. */
372 char *psz_parser = psz_line;
374 while( i_count <= i_line && *psz_parser != '\n' )
376 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
380 if( *psz_parser == '\n' )
382 i_len -= (i_count + 1);
383 psz_line = psz_parser + 1;
387 /* Find the furthest space. */
388 while( psz_parser > psz_line && *psz_parser != ' ' )
390 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
394 if( *psz_parser == ' ' )
397 i_len -= (i_count + 1);
398 psz_line = psz_parser + 1;
402 /* Wrapping has failed. Find the first space or newline */
403 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
405 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
409 if( i_count < i_len ) *psz_parser = '\n';
410 i_len -= (i_count + 1);
411 psz_line = psz_parser + 1;
417 /*****************************************************************************
419 *****************************************************************************/
420 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
422 #if defined(HAVE_ICONV)
423 return iconv_open( tocode, fromcode );
425 return (vlc_iconv_t)(-1);
429 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
430 char **outbuf, size_t *outbytesleft )
432 #if defined(HAVE_ICONV)
433 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
434 outbuf, outbytesleft );
440 int vlc_iconv_close( vlc_iconv_t cd )
442 #if defined(HAVE_ICONV)
443 return iconv_close( cd );
449 /*****************************************************************************
451 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
452 *****************************************************************************/
453 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
454 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
466 i_gcd = GCD( i_nom, i_den );
470 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
472 if( i_nom > i_max || i_den > i_max )
474 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
479 uint64_t i_x = i_nom / i_den;
480 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
481 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
483 if( i_a2n > i_max || i_a2d > i_max ) break;
487 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
488 i_a1_num = i_a2n; i_a1_den = i_a2d;
489 if( i_nom == 0 ) break;
490 i_x = i_nom; i_nom = i_den; i_den = i_x;
502 /*************************************************************************
503 * vlc_execve: Execute an external program with a given environment,
504 * wait until it finishes and return its standard output
505 *************************************************************************/
506 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
507 char *const *ppsz_env, const char *psz_cwd,
508 const char *p_in, size_t i_in,
509 char **pp_data, size_t *pi_data )
511 (void)i_argc; // <-- hmph
513 # define BUFSIZE 1024
514 int fds[2], i_status;
516 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
520 if ((fds[0] > 2) && (fds[1] > 2))
526 msg_Err (p_object, "unable to fork (%m)");
535 pthread_sigmask (SIG_SETMASK, &set, NULL);
538 * Like it or not, close can fail (and not only with EBADF)
540 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
541 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
542 && (open ("/dev/null", O_RDONLY) == 2)
543 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
544 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
558 shutdown (fds[0], SHUT_WR);
560 while (!p_object->b_die)
562 struct pollfd ufd[1];
563 memset (ufd, 0, sizeof (ufd));
565 ufd[0].events = POLLIN;
568 ufd[0].events |= POLLOUT;
570 if (poll (ufd, 1, 10) <= 0)
573 if (ufd[0].revents & ~POLLOUT)
575 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
577 break; /* safely abort */
581 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
586 shutdown (fds[0], SHUT_RD);
594 if (ufd[0].revents & POLLOUT)
596 ssize_t val = write (fds[0], p_in, i_in);
602 shutdown (fds[0], SHUT_WR);
614 while (waitpid (pid, &i_status, 0) == -1);
616 if (WIFEXITED (i_status))
618 i_status = WEXITSTATUS (i_status);
620 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
621 ppsz_argv[0], (int)pid, i_status);
624 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
626 i_status = WTERMSIG (i_status);
627 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
628 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
631 #elif defined( WIN32 ) && !defined( UNDER_CE )
632 SECURITY_ATTRIBUTES saAttr;
633 PROCESS_INFORMATION piProcInfo;
634 STARTUPINFO siStartInfo;
635 BOOL bFuncRetn = FALSE;
636 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
638 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
642 /* Set the bInheritHandle flag so pipe handles are inherited. */
643 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
644 saAttr.bInheritHandle = TRUE;
645 saAttr.lpSecurityDescriptor = NULL;
647 /* Create a pipe for the child process's STDOUT. */
648 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
650 msg_Err( p_object, "stdout pipe creation failed" );
654 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
655 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
657 /* Create a pipe for the child process's STDIN. */
658 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
660 msg_Err( p_object, "stdin pipe creation failed" );
664 /* Ensure the write handle to the pipe for STDIN is not inherited. */
665 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
667 /* Set up members of the PROCESS_INFORMATION structure. */
668 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
670 /* Set up members of the STARTUPINFO structure. */
671 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
672 siStartInfo.cb = sizeof(STARTUPINFO);
673 siStartInfo.hStdError = hChildStdoutWr;
674 siStartInfo.hStdOutput = hChildStdoutWr;
675 siStartInfo.hStdInput = hChildStdinRd;
676 siStartInfo.wShowWindow = SW_HIDE;
677 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
679 /* Set up the command line. */
680 psz_cmd = malloc(32768);
685 ppsz_parser = &ppsz_argv[0];
686 while ( ppsz_parser[0] != NULL && i_size > 0 )
688 /* Protect the last argument with quotes ; the other arguments
689 * are supposed to be already protected because they have been
690 * passed as a command-line option. */
691 if ( ppsz_parser[1] == NULL )
693 strncat( psz_cmd, "\"", i_size );
696 strncat( psz_cmd, *ppsz_parser, i_size );
697 i_size -= strlen( *ppsz_parser );
698 if ( ppsz_parser[1] == NULL )
700 strncat( psz_cmd, "\"", i_size );
703 strncat( psz_cmd, " ", i_size );
708 /* Set up the environment. */
709 p = p_env = malloc(32768);
717 ppsz_parser = &ppsz_env[0];
718 while ( *ppsz_parser != NULL && i_size > 0 )
720 memcpy( p, *ppsz_parser,
721 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
722 p += strlen(*ppsz_parser) + 1;
723 i_size -= strlen(*ppsz_parser) + 1;
728 /* Create the child process. */
729 bFuncRetn = CreateProcess( NULL,
730 psz_cmd, // command line
731 NULL, // process security attributes
732 NULL, // primary thread security attributes
733 TRUE, // handles are inherited
737 &siStartInfo, // STARTUPINFO pointer
738 &piProcInfo ); // receives PROCESS_INFORMATION
743 if ( bFuncRetn == 0 )
745 msg_Err( p_object, "child creation failed" );
749 /* Read from a file and write its contents to a pipe. */
750 while ( i_in > 0 && !p_object->b_die )
753 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
759 /* Close the pipe handle so the child process stops reading. */
760 CloseHandle(hChildStdinWr);
762 /* Close the write end of the pipe before reading from the
763 * read end of the pipe. */
764 CloseHandle(hChildStdoutWr);
766 /* Read output from the child process. */
771 *pp_data = malloc( 1025 ); /* +1 for \0 */
773 while ( !p_object->b_die )
776 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
781 *pp_data = realloc( *pp_data, *pi_data + 1025 );
784 while ( !p_object->b_die
785 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
786 && i_status != STILL_ACTIVE )
789 CloseHandle(piProcInfo.hProcess);
790 CloseHandle(piProcInfo.hThread);
794 "child %s returned with error code %ld",
795 ppsz_argv[0], i_status );
798 msg_Err( p_object, "vlc_execve called but no implementation is available" );
803 if (*pp_data == NULL)
806 (*pp_data)[*pi_data] = '\0';