scripts/commandline.inc

   1 <?php
   2 /*
   3  * StatusNet - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 // -*- mode: php -*-
  21
  22 # Abort if called from a web server
  23
  24 if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
  25     print "This script must be run from the command line\n";
  26     exit();
  27 }
  28
  29 define('STATUSNET', true);
  30
  31 // Set various flags so we don't time out on long-running processes
  32
  33 ini_set("max_execution_time", "0");
  34 ini_set("max_input_time", "0");
  35 set_time_limit(0);
  36 mb_internal_encoding('UTF-8');
  37
  38 // Add extlib to our path so we can get Console_Getopt
  39
  40 $_extra_path = array(INSTALLDIR.'/extlib/');
  41
  42 set_include_path(implode(PATH_SEPARATOR, $_extra_path) . PATH_SEPARATOR . get_include_path());
  43
  44 require_once 'Console/Getopt.php';
  45
  46 // Note: $shortoptions and $longoptions should be pre-defined!
  47
  48 $_default_shortoptions = 'qvhc:s:p:';
  49
  50 $_default_longoptions = array('quiet', 'verbose', 'help', 'conf=', 'server=', 'path=');
  51
  52 if (isset($shortoptions)) {
  53     $shortoptions .= $_default_shortoptions;
  54 } else {
  55     $shortoptions = $_default_shortoptions;
  56 }
  57
  58 if (isset($longoptions)) {
  59     $longoptions = array_merge($longoptions, $_default_longoptions);
  60 } else {
  61     $longoptions = $_default_longoptions;
  62 }
  63
  64 $parser = new Console_Getopt();
  65
  66 $result = $parser->getopt($argv, $shortoptions, $longoptions);
  67
  68 if (PEAR::isError($result)) {
  69     print $result->getMessage()."\n";
  70     exit(1);
  71 } else {
  72     list($options, $args) = $result;
  73 }
  74
  75 function show_help()
  76 {
  77     global $helptext;
  78
  79     $_default_help_text = <<<END_OF_DEFAULT
  80       General options:
  81
  82     -q --quiet           Quiet (little output)
  83     -v --verbose         Verbose (lots of output)
  84     -c --conf=<filename> Use <filename> as config file
  85     -s --server=<name>   Use <name> as server name
  86     -p --path=<path>     Use <path> as path name
  87     -h --help            Show this message and quit.
  88
  89 END_OF_DEFAULT;
  90     if (isset($helptext)) {
  91         print $helptext;
  92     }
  93     print $_default_help_text;
  94     exit(0);
  95 }
  96
  97 foreach ($options as $option) {
  98
  99     switch ($option[0]) {
 100      case '--server':
 101      case 's':
 102         $server = $option[1];
 103         break;
 104
 105      case '--path':
 106      case 'p':
 107         $path = $option[1];
 108         break;
 109
 110      case '--conf':
 111      case 'c':
 112         $conffile = $option[1];
 113         break;
 114
 115      case '--help':
 116      case 'h':
 117         show_help();
 118     }
 119 }
 120
 121 require_once INSTALLDIR . '/lib/common.php';
 122
 123 set_error_handler('common_error_handler');
 124
 125 function _make_matches($opt, $alt)
 126 {
 127     $matches = array();
 128
 129     if (strlen($opt) > 1 && 0 != strncmp($opt, '--', 2)) {
 130         $matches[] = '--'.$opt;
 131     } else {
 132         $matches[] = $opt;
 133     }
 134
 135     if (!empty($alt)) {
 136         if (strlen($alt) > 1 && 0 != strncmp($alt, '--', 2)) {
 137             $matches[] = '--'.$alt;
 138         } else {
 139             $matches[] = $alt;
 140         }
 141     }
 142
 143     return $matches;
 144 }
 145
 146 function have_option($opt, $alt=null)
 147 {
 148     global $options;
 149
 150     $matches = _make_matches($opt, $alt);
 151
 152     foreach ($options as $option) {
 153         if (in_array($option[0], $matches)) {
 154             return true;
 155         }
 156     }
 157
 158     return false;
 159 }
 160
 161 function get_option_value($opt, $alt=null)
 162 {
 163     global $options;
 164
 165     $matches = _make_matches($opt, $alt);
 166
 167     foreach ($options as $option) {
 168         if (in_array($option[0], $matches)) {
 169             return $option[1];
 170         }
 171     }
 172
 173     return null;
 174 }