PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Source for file pearcmd.php

Documentation is available at pearcmd.php

  1. <?php
  2. /**
  3.  * PEAR, the PHP Extension and Application Repository
  4.  *
  5.  * Command line interface
  6.  *
  7.  * PHP versions 4 and 5
  8.  *
  9.  * @category   pear
  10.  * @package    PEAR
  11.  * @author     Stig Bakken <ssb@php.net>
  12.  * @author     Tomas V.V.Cox <cox@idecnet.com>
  13.  * @copyright  1997-2009 The Authors
  14.  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
  15.  * @version    CVS: $Id: pearcmd.php 313023 2011-07-06 19:17:11Z dufuz $
  16.  * @link       http://pear.php.net/package/PEAR
  17.  */
  18.  
  19. if (!defined('PEAR_RUNTYPE')) {
  20.     // this is defined in peclcmd.php as 'pecl'
  21.     define('PEAR_RUNTYPE''pear');
  22. }
  23. define('PEAR_IGNORE_BACKTRACE'1);
  24. /**
  25.  * @nodep Gtk
  26.  */
  27. if ('@include_path@' != '@'.'include_path'.'@'{
  28.     ini_set('include_path''@include_path@');
  29.     $raw = false;
  30. else {
  31.     // this is a raw, uninstalled pear, either a cvs checkout, or php distro
  32.     $raw = true;
  33. }
  34. @ini_set('allow_url_fopen'true);
  35. if (!ini_get('safe_mode')) {
  36.     @set_time_limit(0);
  37. }
  38. @ini_set('track_errors'true);
  39. @ini_set('html_errors'false);
  40. @ini_set('magic_quotes_runtime'false);
  41. $_PEAR_PHPDIR '#$%^&*';
  42. set_error_handler('error_handler');
  43.  
  44. $pear_package_version "@pear_version@";
  45.  
  46. require_once 'PEAR.php';
  47. require_once 'PEAR/Frontend.php';
  48. require_once 'PEAR/Config.php';
  49. require_once 'PEAR/Command.php';
  50. require_once 'Console/Getopt.php';
  51.  
  52.  
  53. $all_commands PEAR_Command::getCommands();
  54.  
  55. // remove this next part when we stop supporting that crap-ass PHP 4.2
  56. if (!isset($_SERVER['argv']&& !isset($argv&& !isset($HTTP_SERVER_VARS['argv'])) {
  57.     echo 'ERROR: either use the CLI php executable, or set register_argc_argv=On in php.ini';
  58.     exit(1);
  59. }
  60.  
  61. $argv = Console_Getopt::readPHPArgv();
  62. // fix CGI sapi oddity - the -- in pear.bat/pear is not removed
  63. if (php_sapi_name(!= 'cli' && isset($argv[1]&& $argv[1== '--'{
  64.     unset($argv[1]);
  65.     $argv array_values($argv);
  66. }
  67. $progname PEAR_RUNTYPE;
  68. array_shift($argv);
  69. $options = Console_Getopt::getopt2($argv"c:C:d:D:Gh?sSqu:vV");
  70. if (PEAR::isError($options)) {
  71.     usage($options);
  72. }
  73.  
  74. $opts $options[0];
  75.  
  76. $fetype 'CLI';
  77. if ($progname == 'gpear' || $progname == 'pear-gtk'{
  78.     $fetype 'Gtk';
  79. else {
  80.     foreach ($opts as $opt{
  81.         if ($opt[0== 'G'{
  82.             $fetype 'Gtk';
  83.         }
  84.     }
  85. }
  86. //Check if Gtk and PHP >= 5.1.0
  87. if ($fetype == 'Gtk' && version_compare(phpversion()'5.1.0''>=')) {
  88.     $fetype 'Gtk2';
  89. }
  90.  
  91. $pear_user_config '';
  92. $pear_system_config '';
  93. $store_user_config = false;
  94. $store_system_config = false;
  95. $verbose = 1;
  96.  
  97. foreach ($opts as $opt{
  98.     switch ($opt[0]{
  99.         case 'c':
  100.             $pear_user_config $opt[1];
  101.             break;
  102.         case 'C':
  103.             $pear_system_config $opt[1];
  104.             break;
  105.     }
  106. }
  107.  
  108. $config &PEAR_Config::singleton($pear_user_config$pear_system_config);
  109.  
  110. if (PEAR::isError($config)) {
  111.     $_file '';
  112.     if ($pear_user_config !== false{
  113.        $_file .= $pear_user_config;
  114.     }
  115.     if ($pear_system_config !== false{
  116.        $_file .= '/' $pear_system_config;
  117.     }
  118.     if ($_file == '/'{
  119.         $_file 'The default config file';
  120.     }
  121.     $config->getMessage();
  122.     $ui->outputData("ERROR: $_file is not a valid config file or is corrupted.");
  123.     // We stop, we have no idea where we are :)
  124.     exit(1);
  125. }
  126.  
  127. // this is used in the error handler to retrieve a relative path
  128. $_PEAR_PHPDIR $config->get('php_dir');
  129. $ui->setConfig($config);
  130. PEAR::setErrorHandling(PEAR_ERROR_CALLBACKarray($ui"displayFatalError"));
  131. if (ini_get('safe_mode')) {
  132.     $ui->outputData('WARNING: running in safe mode requires that all files created ' .
  133.         'be the same uid as the current script.  PHP reports this script is uid: ' .
  134.         @getmyuid(', and current user is: ' @get_current_user());
  135. }
  136.  
  137. $verbose $config->get("verbose");
  138. $cmdopts = array();
  139.  
  140. if ($raw{
  141.     if (!$config->isDefinedLayer('user'&& !$config->isDefinedLayer('system')) {
  142.         $found = false;
  143.         foreach ($opts as $opt{
  144.             if ($opt[0== 'd' || $opt[0== 'D'{
  145.                 $found = true; // the user knows what they are doing, and are setting config values
  146.             }
  147.         }
  148.         if (!$found{
  149.             // no prior runs, try to install PEAR
  150.             if (strpos(dirname(__FILE__)'scripts')) {
  151.                 $packagexml dirname(dirname(__FILE__)) . DIRECTORY_SEPARATOR . 'package2.xml';
  152.                 $pearbase dirname(dirname(__FILE__));
  153.             else {
  154.                 $packagexml dirname(__FILE__. DIRECTORY_SEPARATOR . 'package2.xml';
  155.                 $pearbase dirname(__FILE__);
  156.             }
  157.             if (file_exists($packagexml)) {
  158.                 $options[1= array(
  159.                     'install',
  160.                     $packagexml
  161.                 );
  162.                 $config->set('php_dir'$pearbase . DIRECTORY_SEPARATOR . 'php');
  163.                 $config->set('data_dir'$pearbase . DIRECTORY_SEPARATOR . 'data');
  164.                 $config->set('doc_dir'$pearbase . DIRECTORY_SEPARATOR . 'docs');
  165.                 $config->set('test_dir'$pearbase . DIRECTORY_SEPARATOR . 'tests');
  166.                 $config->set('ext_dir'$pearbase . DIRECTORY_SEPARATOR . 'extensions');
  167.                 $config->set('bin_dir'$pearbase);
  168.                 $config->mergeConfigFile($pearbase 'pear.ini'false);
  169.                 $config->store();
  170.                 $config->set('auto_discover'1);
  171.             }
  172.         }
  173.     }
  174. }
  175. foreach ($opts as $opt{
  176.     $param !empty($opt[1]$opt[1: true;
  177.     switch ($opt[0]{
  178.         case 'd':
  179.             if ($param === true{
  180.                 die('Invalid usage of "-d" option, expected -d config_value=value, ' .
  181.                     'received "-d"' "\n");
  182.             }
  183.             $possible explode('='$param);
  184.             if (count($possible!= 2{
  185.                 die('Invalid usage of "-d" option, expected -d config_value=value, received "' .
  186.                     $param '"' "\n");
  187.             }
  188.             list($key$valueexplode('='$param);
  189.             $config->set($key$value'user');
  190.             break;
  191.         case 'D':
  192.             if ($param === true{
  193.                 die('Invalid usage of "-d" option, expected -d config_value=value, ' .
  194.                     'received "-d"' "\n");
  195.             }
  196.             $possible explode('='$param);
  197.             if (count($possible!= 2{
  198.                 die('Invalid usage of "-d" option, expected -d config_value=value, received "' .
  199.                     $param '"' "\n");
  200.             }
  201.             list($key$valueexplode('='$param);
  202.             $config->set($key$value'system');
  203.             break;
  204.         case 's':
  205.             $store_user_config = true;
  206.             break;
  207.         case 'S':
  208.             $store_system_config = true;
  209.             break;
  210.         case 'u':
  211.             $config->remove($param'user');
  212.             break;
  213.         case 'v':
  214.             $config->set('verbose'$config->get('verbose'+ 1);
  215.             break;
  216.         case 'q':
  217.             $config->set('verbose'$config->get('verbose'- 1);
  218.             break;
  219.         case 'V':
  220.             usage(null'version');
  221.         case 'c':
  222.         case 'C':
  223.             break;
  224.         default:
  225.             // all non pear params goes to the command
  226.             $cmdopts[$opt[0]] $param;
  227.             break;
  228.     }
  229. }
  230.  
  231. if ($store_system_config{
  232.     $config->store('system');
  233. }
  234.  
  235. if ($store_user_config{
  236.     $config->store('user');
  237. }
  238.  
  239. $command (isset($options[1][0])) $options[1][0: null;
  240. if (empty($command&& ($store_user_config || $store_system_config)) {
  241.     exit;
  242. }
  243.  
  244. if ($fetype == 'Gtk' || $fetype == 'Gtk2'{
  245.     if (!$config->validConfiguration()) {
  246.         PEAR::raiseError('CRITICAL ERROR: no existing valid configuration files found in files ' .
  247.             "'$pear_user_config' or '$pear_system_config', please copy an existing configuration" .
  248.             'file to one of these locations, or use the -c and -s options to create one');
  249.     }
  250.     Gtk::main();
  251. else do {
  252.     if ($command == 'help'{
  253.         usage(null@$options[1][1]);
  254.     }
  255.  
  256.     if (!$config->validConfiguration()) {
  257.         PEAR::raiseError('CRITICAL ERROR: no existing valid configuration files found in files ' .
  258.             "'$pear_user_config' or '$pear_system_config', please copy an existing configuration" .
  259.             'file to one of these locations, or use the -c and -s options to create one');
  260.     }
  261.  
  262.     $cmd PEAR_Command::factory($command$config);
  263.     if (PEAR::isError($cmd)) {
  264.         usage(null@$options[1][0]);
  265.     }
  266.  
  267.     $short_args $long_args = null;
  268.     PEAR_Command::getGetoptArgs($command$short_args$long_args);
  269.     array_shift($options[1]);
  270.     $tmp = Console_Getopt::getopt2($options[1]$short_args$long_args);
  271.  
  272.     if (PEAR::isError($tmp)) {
  273.         break;
  274.     }
  275.  
  276.     list($tmpopt$params$tmp;
  277.     $opts = array();
  278.     foreach ($tmpopt as $foo => $tmp2{
  279.         list($opt$value$tmp2;
  280.         if ($value === null{
  281.             $value = true; // options without args
  282.         }
  283.  
  284.         if (strlen($opt== 1{
  285.             $cmdoptions $cmd->getOptions($command);
  286.             foreach ($cmdoptions as $o => $d{
  287.                 if (isset($d['shortopt']&& $d['shortopt'== $opt{
  288.                     $opts[$o$value;
  289.                 }
  290.             }
  291.         else {
  292.             if (substr($opt02== '--'{
  293.                 $opts[substr($opt2)$value;
  294.             }
  295.         }
  296.     }
  297.  
  298.     $ok $cmd->run($command$opts$params);
  299.     if ($ok === false{
  300.         PEAR::raiseError("unknown command `$command'");
  301.     }
  302.  
  303.     if (PEAR::isError($ok)) {
  304.         PEAR::setErrorHandling(PEAR_ERROR_CALLBACKarray($ui"displayFatalError"));
  305.         PEAR::raiseError($ok);
  306.     }
  307. while (false);
  308.  
  309. // {{{ usage()
  310.  
  311. function usage($error = null$helpsubject = null)
  312. {
  313.     global $progname$all_commands;
  314.     $stdout fopen('php://stdout''w');
  315.     if (PEAR::isError($error)) {
  316.         fputs($stdout$error->getMessage("\n");
  317.     elseif ($error !== null{
  318.         fputs($stdout"$error\n");
  319.     }
  320.  
  321.     if ($helpsubject != null{
  322.         $put cmdHelp($helpsubject);
  323.     else {
  324.         $put "Commands:\n";
  325.         $maxlen max(array_map("strlen"$all_commands));
  326.         $formatstr = "%-{$maxlen}s  %s\n";
  327.         ksort($all_commands);
  328.         foreach ($all_commands as $cmd => $class{
  329.             $put .= sprintf($formatstr$cmdPEAR_Command::getDescription($cmd));
  330.         }
  331.         $put .=
  332.             "Usage: $progname [options] command [command-options] <parameters>\n".
  333.             "Type \"$progname help options\" to list all options.\n".
  334.             "Type \"$progname help shortcuts\" to list all command shortcuts.\n".
  335.             "Type \"$progname help <command>\" to get the help for the specified command.";
  336.     }
  337.     fputs($stdout"$put\n");
  338.     fclose($stdout);
  339.  
  340.     if ($error === null{
  341.         exit(0);
  342.     }
  343.     exit(1);
  344. }
  345.  
  346. function cmdHelp($command)
  347. {
  348.     global $progname$all_commands$config;
  349.     if ($command == "options"{
  350.         return
  351.         "Options:\n".
  352.         "     -v         increase verbosity level (default 1)\n".
  353.         "     -q         be quiet, decrease verbosity level\n".
  354.         "     -c file    find user configuration in `file'\n".
  355.         "     -C file    find system configuration in `file'\n".
  356.         "     -d foo=bar set user config variable `foo' to `bar'\n".
  357.         "     -D foo=bar set system config variable `foo' to `bar'\n".
  358.         "     -G         start in graphical (Gtk) mode\n".
  359.         "     -s         store user configuration\n".
  360.         "     -S         store system configuration\n".
  361.         "     -u foo     unset `foo' in the user configuration\n".
  362.         "     -h, -?     display help/usage (this message)\n".
  363.         "     -V         version information\n";
  364.     elseif ($command == "shortcuts"{
  365.         $sc PEAR_Command::getShortcuts();
  366.         $ret "Shortcuts:\n";
  367.         foreach ($sc as $s => $c{
  368.             $ret .= sprintf("     %-8s %s\n"$s$c);
  369.         }
  370.         return $ret;
  371.  
  372.     elseif ($command == "version"{
  373.         return "PEAR Version: ".$GLOBALS['pear_package_version'].
  374.                "\nPHP Version: ".phpversion().
  375.                "\nZend Engine Version: ".zend_version().
  376.                "\nRunning on: ".php_uname();
  377.  
  378.     elseif ($help PEAR_Command::getHelp($command)) {
  379.         if (is_string($help)) {
  380.             return "$progname $command [options] $help\n";
  381.         }
  382.  
  383.         if ($help[1=== null{
  384.             return "$progname $command $help[0]";
  385.         }
  386.  
  387.         return "$progname $command [options] $help[0]\n$help[1]";
  388.     }
  389.  
  390.     return "Command '$command' is not valid, try '$progname help'";
  391. }
  392.  
  393. // }}}
  394.  
  395. function error_handler($errno$errmsg$file$line$vars{
  396.     if ((defined('E_STRICT'&& $errno E_STRICT|| (defined('E_DEPRECATED'&&
  397.           $errno E_DEPRECATED|| !error_reporting()) {
  398.         if (defined('E_STRICT'&& $errno E_STRICT{
  399.             return// E_STRICT
  400.         }
  401.         if (defined('E_DEPRECATED'&& $errno E_DEPRECATED{
  402.             return// E_DEPRECATED
  403.         }
  404.         if ($GLOBALS['config']->get('verbose'< 4{
  405.             return false; // @silenced error, show all if debug is high enough
  406.         }
  407.     }
  408.     $errortype = array (
  409.         E_ERROR   =>  "Error",
  410.         E_WARNING   =>  "Warning",
  411.         E_PARSE   =>  "Parsing Error",
  412.         E_NOTICE   =>  "Notice",
  413.         E_CORE_ERROR  =>  "Core Error",
  414.         E_CORE_WARNING  =>  "Core Warning",
  415.         E_COMPILE_ERROR  =>  "Compile Error",
  416.         E_COMPILE_WARNING =>  "Compile Warning",
  417.         E_USER_ERROR =>  "User Error",
  418.         E_USER_WARNING =>  "User Warning",
  419.         E_USER_NOTICE =>  "User Notice"
  420.     );
  421.     $prefix $errortype[$errno];
  422.     global $_PEAR_PHPDIR;
  423.     if (stristr($file$_PEAR_PHPDIR)) {
  424.         $file substr($filestrlen($_PEAR_PHPDIR+ 1);
  425.     else {
  426.         $file basename($file);
  427.     }
  428.     print "\n$prefix$errmsg in $file on line $line\n";
  429.     return false;
  430. }
  431.  
  432.  
  433. /*
  434.  * Local variables:
  435.  * tab-width: 4
  436.  * c-basic-offset: 4
  437.  * indent-tabs-mode: nil
  438.  * mode: php
  439.  * End:
  440.  */
  441. // vim600:syn=php

Documentation generated on Wed, 06 Jul 2011 23:31:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.