GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

upgrade Console_GetOpt to 1.9.2

Browse Source
This commit is contained in:
Evan Prodromou 2011-03-26 14:22:24 -04:00
parent 5502e535de
commit d1d5d234f8
1 changed files with 145 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

214
extlib/Console/Getopt.php
View File

@ -1,32 +1,40 @@
<?php <?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */ /* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+ /**
// | PHP Version 5 | * PHP Version 5
// +----------------------------------------------------------------------+ *
// | Copyright (c) 1997-2004 The PHP Group | * Copyright (c) 1997-2004 The PHP Group
// +----------------------------------------------------------------------+ *
// | This source file is subject to version 3.0 of the PHP license, | * This source file is subject to version 3.0 of the PHP license,
// | that is bundled with this package in the file LICENSE, and is | * that is bundled with this package in the file LICENSE, and is
// | available through the world-wide-web at the following url: | * available through the world-wide-web at the following url:
// | http://www.php.net/license/3_0.txt. | * http://www.php.net/license/3_0.txt.
// | If you did not receive a copy of the PHP license and are unable to | * If you did not receive a copy of the PHP license and are unable to
// | obtain it through the world-wide-web, please send a note to | * obtain it through the world-wide-web, please send a note to
// | license@php.net so we can mail you a copy immediately. | * license@php.net so we can mail you a copy immediately.
// +----------------------------------------------------------------------+ *
// | Author: Andrei Zmievski <andrei@php.net> | * @category Console
// +----------------------------------------------------------------------+ * @package Console_Getopt
// * @author Andrei Zmievski <andrei@php.net>
// $Id: Getopt.php,v 1.4 2007/06/12 14:58:56 cellog Exp $ * @license http://www.php.net/license/3_0.txt PHP 3.0
* @version CVS: $Id: Getopt.php 306067 2010-12-08 00:13:31Z dufuz $
* @link http://pear.php.net/package/Console_Getopt
*/
require_once 'PEAR.php'; require_once 'PEAR.php';
/** /**
* Command-line options parsing class. * Command-line options parsing class.
* *
* @author Andrei Zmievski <andrei@php.net> * @category Console
* * @package Console_Getopt
* @author Andrei Zmievski <andrei@php.net>
* @license http://www.php.net/license/3_0.txt PHP 3.0
* @link http://pear.php.net/package/Console_Getopt
*/ */
class Console_Getopt { class Console_Getopt
{
/** /**
* Parses the command-line options. * Parses the command-line options.
* *
@ -53,45 +61,60 @@ class Console_Getopt {
* *
* Most of the semantics of this function are based on GNU getopt_long(). * Most of the semantics of this function are based on GNU getopt_long().
* *
* @param array $args an array of command-line arguments * @param array $args an array of command-line arguments
* @param string $short_options specifies the list of allowed short options * @param string $short_options specifies the list of allowed short options
* @param array $long_options specifies the list of allowed long options * @param array $long_options specifies the list of allowed long options
* @param boolean $skip_unknown suppresses Console_Getopt: unrecognized option
* *
* @return array two-element array containing the list of parsed options and * @return array two-element array containing the list of parsed options and
* the non-option arguments * the non-option arguments
*
* @access public * @access public
*
*/ */
function getopt2($args, $short_options, $long_options = null) function getopt2($args, $short_options, $long_options = null, $skip_unknown = false)
{ {
return Console_Getopt::doGetopt(2, $args, $short_options, $long_options); return Console_Getopt::doGetopt(2, $args, $short_options, $long_options, $skip_unknown);
} }
/** /**
* This function expects $args to start with the script name (POSIX-style). * This function expects $args to start with the script name (POSIX-style).
* Preserved for backwards compatibility. * Preserved for backwards compatibility.
*
* @param array $args an array of command-line arguments
* @param string $short_options specifies the list of allowed short options
* @param array $long_options specifies the list of allowed long options
*
* @see getopt2() * @see getopt2()
*/ * @return array two-element array containing the list of parsed options and
function getopt($args, $short_options, $long_options = null) * the non-option arguments
*/
function getopt($args, $short_options, $long_options = null, $skip_unknown = false)
{ {
return Console_Getopt::doGetopt(1, $args, $short_options, $long_options); return Console_Getopt::doGetopt(1, $args, $short_options, $long_options, $skip_unknown);
} }
/** /**
* The actual implementation of the argument parsing code. * The actual implementation of the argument parsing code.
*
* @param int $version Version to use
* @param array $args an array of command-line arguments
* @param string $short_options specifies the list of allowed short options
* @param array $long_options specifies the list of allowed long options
* @param boolean $skip_unknown suppresses Console_Getopt: unrecognized option
*
* @return array
*/ */
function doGetopt($version, $args, $short_options, $long_options = null) function doGetopt($version, $args, $short_options, $long_options = null, $skip_unknown = false)
{ {
// in case you pass directly readPHPArgv() as the first arg // in case you pass directly readPHPArgv() as the first arg
if (PEAR::isError($args)) { if (PEAR::isError($args)) {
return $args; return $args;
} }
if (empty($args)) { if (empty($args)) {
return array(array(), array()); return array(array(), array());
} }
$opts = array();
$non_opts = array(); $non_opts = $opts = array();
settype($args, 'array'); settype($args, 'array');
@ -111,7 +134,6 @@ class Console_Getopt {
reset($args); reset($args);
while (list($i, $arg) = each($args)) { while (list($i, $arg) = each($args)) {
/* The special element '--' means explicit end of /* The special element '--' means explicit end of
options. Treat the rest of the arguments as non-options options. Treat the rest of the arguments as non-options
and end the loop. */ and end the loop. */
@ -124,17 +146,27 @@ class Console_Getopt {
$non_opts = array_merge($non_opts, array_slice($args, $i)); $non_opts = array_merge($non_opts, array_slice($args, $i));
break; break;
} elseif (strlen($arg) > 1 && $arg{1} == '-') { } elseif (strlen($arg) > 1 && $arg{1} == '-') {
$error = Console_Getopt::_parseLongOption(substr($arg, 2), $long_options, $opts, $args); $error = Console_Getopt::_parseLongOption(substr($arg, 2),
if (PEAR::isError($error)) $long_options,
$opts,
$args,
$skip_unknown);
if (PEAR::isError($error)) {
return $error; return $error;
}
} elseif ($arg == '-') { } elseif ($arg == '-') {
// - is stdin // - is stdin
$non_opts = array_merge($non_opts, array_slice($args, $i)); $non_opts = array_merge($non_opts, array_slice($args, $i));
break; break;
} else { } else {
$error = Console_Getopt::_parseShortOption(substr($arg, 1), $short_options, $opts, $args); $error = Console_Getopt::_parseShortOption(substr($arg, 1),
if (PEAR::isError($error)) $short_options,
$opts,
$args,
$skip_unknown);
if (PEAR::isError($error)) {
return $error; return $error;
}
} }
} }
@ -142,19 +174,31 @@ class Console_Getopt {
} }
/** /**
* @access private * Parse short option
* *
* @param string $arg Argument
* @param string[] $short_options Available short options
* @param string[][] &$opts
* @param string[] &$args
* @param boolean $skip_unknown suppresses Console_Getopt: unrecognized option
*
* @access private
* @return void
*/ */
function _parseShortOption($arg, $short_options, &$opts, &$args) function _parseShortOption($arg, $short_options, &$opts, &$args, $skip_unknown)
{ {
for ($i = 0; $i < strlen($arg); $i++) { for ($i = 0; $i < strlen($arg); $i++) {
$opt = $arg{$i}; $opt = $arg{$i};
$opt_arg = null; $opt_arg = null;
/* Try to find the short option in the specifier string. */ /* Try to find the short option in the specifier string. */
if (($spec = strstr($short_options, $opt)) === false || $arg{$i} == ':') if (($spec = strstr($short_options, $opt)) === false || $arg{$i} == ':') {
{ if ($skip_unknown === true) {
return PEAR::raiseError("Console_Getopt: unrecognized option -- $opt"); break;
}
$msg = "Console_Getopt: unrecognized option -- $opt";
return PEAR::raiseError($msg);
} }
if (strlen($spec) > 1 && $spec{1} == ':') { if (strlen($spec) > 1 && $spec{1} == ':') {
@ -173,11 +217,14 @@ class Console_Getopt {
break; break;
} else if (list(, $opt_arg) = each($args)) { } else if (list(, $opt_arg) = each($args)) {
/* Else use the next argument. */; /* Else use the next argument. */;
if (Console_Getopt::_isShortOpt($opt_arg) || Console_Getopt::_isLongOpt($opt_arg)) { if (Console_Getopt::_isShortOpt($opt_arg)
return PEAR::raiseError("Console_Getopt: option requires an argument -- $opt"); || Console_Getopt::_isLongOpt($opt_arg)) {
$msg = "option requires an argument --$opt";
return PEAR::raiseError("Console_Getopt:" . $msg);
} }
} else { } else {
return PEAR::raiseError("Console_Getopt: option requires an argument -- $opt"); $msg = "option requires an argument --$opt";
return PEAR::raiseError("Console_Getopt:" . $msg);
} }
} }
} }
@ -187,36 +234,54 @@ class Console_Getopt {
} }
/** /**
* @access private * Checks if an argument is a short option
* *
* @param string $arg Argument to check
*
* @access private
* @return bool
*/ */
function _isShortOpt($arg) function _isShortOpt($arg)
{ {
return strlen($arg) == 2 && $arg[0] == '-' && preg_match('/[a-zA-Z]/', $arg[1]); return strlen($arg) == 2 && $arg[0] == '-'
&& preg_match('/[a-zA-Z]/', $arg[1]);
} }
/** /**
* @access private * Checks if an argument is a long option
* *
* @param string $arg Argument to check
*
* @access private
* @return bool
*/ */
function _isLongOpt($arg) function _isLongOpt($arg)
{ {
return strlen($arg) > 2 && $arg[0] == '-' && $arg[1] == '-' && return strlen($arg) > 2 && $arg[0] == '-' && $arg[1] == '-' &&
preg_match('/[a-zA-Z]+$/', substr($arg, 2)); preg_match('/[a-zA-Z]+$/', substr($arg, 2));
} }
/** /**
* @access private * Parse long option
* *
* @param string $arg Argument
* @param string[] $long_options Available long options
* @param string[][] &$opts
* @param string[] &$args
*
* @access private
* @return void|PEAR_Error
*/ */
function _parseLongOption($arg, $long_options, &$opts, &$args) function _parseLongOption($arg, $long_options, &$opts, &$args, $skip_unknown)
{ {
@list($opt, $opt_arg) = explode('=', $arg, 2); @list($opt, $opt_arg) = explode('=', $arg, 2);
$opt_len = strlen($opt); $opt_len = strlen($opt);
for ($i = 0; $i < count($long_options); $i++) { for ($i = 0; $i < count($long_options); $i++) {
$long_opt = $long_options[$i]; $long_opt = $long_options[$i];
$opt_start = substr($long_opt, 0, $opt_len); $opt_start = substr($long_opt, 0, $opt_len);
$long_opt_name = str_replace('=', '', $long_opt); $long_opt_name = str_replace('=', '', $long_opt);
/* Option doesn't match. Go on to the next one. */ /* Option doesn't match. Go on to the next one. */
@ -224,7 +289,7 @@ class Console_Getopt {
continue; continue;
} }
$opt_rest = substr($long_opt, $opt_len); $opt_rest = substr($long_opt, $opt_len);
/* Check that the options uniquely matches one of the allowed /* Check that the options uniquely matches one of the allowed
options. */ options. */
@ -233,12 +298,15 @@ class Console_Getopt {
} else { } else {
$next_option_rest = ''; $next_option_rest = '';
} }
if ($opt_rest != '' && $opt{0} != '=' && if ($opt_rest != '' && $opt{0} != '=' &&
$i + 1 < count($long_options) && $i + 1 < count($long_options) &&
$opt == substr($long_options[$i+1], 0, $opt_len) && $opt == substr($long_options[$i+1], 0, $opt_len) &&
$next_option_rest != '' && $next_option_rest != '' &&
$next_option_rest{0} != '=') { $next_option_rest{0} != '=') {
return PEAR::raiseError("Console_Getopt: option --$opt is ambiguous");
$msg = "Console_Getopt: option --$opt is ambiguous";
return PEAR::raiseError($msg);
} }
if (substr($long_opt, -1) == '=') { if (substr($long_opt, -1) == '=') {
@ -246,37 +314,47 @@ class Console_Getopt {
/* Long option requires an argument. /* Long option requires an argument.
Take the next argument if one wasn't specified. */; Take the next argument if one wasn't specified. */;
if (!strlen($opt_arg) && !(list(, $opt_arg) = each($args))) { if (!strlen($opt_arg) && !(list(, $opt_arg) = each($args))) {
return PEAR::raiseError("Console_Getopt: option --$opt requires an argument"); $msg = "Console_Getopt: option requires an argument --$opt";
return PEAR::raiseError($msg);
} }
if (Console_Getopt::_isShortOpt($opt_arg) || Console_Getopt::_isLongOpt($opt_arg)) {
return PEAR::raiseError("Console_Getopt: option requires an argument --$opt"); if (Console_Getopt::_isShortOpt($opt_arg)
|| Console_Getopt::_isLongOpt($opt_arg)) {
$msg = "Console_Getopt: option requires an argument --$opt";
return PEAR::raiseError($msg);
} }
} }
} else if ($opt_arg) { } else if ($opt_arg) {
return PEAR::raiseError("Console_Getopt: option --$opt doesn't allow an argument"); $msg = "Console_Getopt: option --$opt doesn't allow an argument";
return PEAR::raiseError($msg);
} }
$opts[] = array('--' . $opt, $opt_arg); $opts[] = array('--' . $opt, $opt_arg);
return; return;
} }
if ($skip_unknown === true) {
return;
}
return PEAR::raiseError("Console_Getopt: unrecognized option --$opt"); return PEAR::raiseError("Console_Getopt: unrecognized option --$opt");
} }
/** /**
* Safely read the $argv PHP array across different PHP configurations. * Safely read the $argv PHP array across different PHP configurations.
* Will take care on register_globals and register_argc_argv ini directives * Will take care on register_globals and register_argc_argv ini directives
* *
* @access public * @access public
* @return mixed the $argv PHP array or PEAR error if not registered * @return mixed the $argv PHP array or PEAR error if not registered
*/ */
function readPHPArgv() function readPHPArgv()
{ {
global $argv; global $argv;
if (!is_array($argv)) { if (!is_array($argv)) {
if (!@is_array($_SERVER['argv'])) { if (!@is_array($_SERVER['argv'])) {
if (!@is_array($GLOBALS['HTTP_SERVER_VARS']['argv'])) { if (!@is_array($GLOBALS['HTTP_SERVER_VARS']['argv'])) {
return PEAR::raiseError("Console_Getopt: Could not read cmd args (register_argc_argv=Off?)"); $msg = "Could not read cmd args (register_argc_argv=Off?)";
return PEAR::raiseError("Console_Getopt: " . $msg);
} }
return $GLOBALS['HTTP_SERVER_VARS']['argv']; return $GLOBALS['HTTP_SERVER_VARS']['argv'];
} }
@ -285,6 +363,4 @@ class Console_Getopt {
return $argv; return $argv;
} }
} }
?>