git.roojs.org Git - pear/blob - HTML/FlexyFramework/Cli.php

   1 <?php
   2
   3 /**
   4  *
   5  * handles the cli features of Flexy Framework.
   6  *
   7  *
   8  * usage :
   9  *
  10  *   $x = new HTML_FlexyFramework_Cli($ff);
  11  *   $x->cliHelp(); // summary of all classes which can be run with cli.
  12  *             (contain static $cli_desc)
  13  *   $x->cliParse($classname);
  14  *
  15  *
  16  */
  17 class HTML_FlexyFramework_Cli
  18 {
  19
  20     /**
  21      * Default options that allow modification of the framewoek behaviour
  22      *
  23      *
  24      */
  25
  26
  27     static $cli_opts = array(
  28
  29         // this is a flag argument
  30         'pman-nodatabase' => array(
  31             'desc' => 'Turn off database',
  32             'max' => 0,
  33         )
  34
  35     );
  36
  37
  38
  39
  40
  41
  42
  43     var $ff; // the Framework instance.
  44
  45
  46     function __construct($ff)
  47     {
  48         $this->ff = $ff;
  49     }
  50     /**
  51       * looks for Cli.php files and runs available() on them
  52      * this should return a list of classes that can be used.
  53      * - we should the load each one, and find the summary..
  54      *
  55      *
  56      */
  57     function cliHelp()
  58     {
  59
  60         $fn = basename($_SERVER["SCRIPT_FILENAME"]);
  61
  62         echo "\n-------------------------------------------------
  63 FlexyFramework Cli Application Usage:
  64
  65 #php -d include_path=.:/var/www/pear $fn [COMMAND] --help
  66 or
  67 #php  $fn [COMMAND] --help
  68
  69 -------------------------------------------------
  70 Available commands:
  71
  72 ";
  73         // add cli files..
  74         //$this->cliShortHelp('Database');
  75
  76
  77         $p = dirname(realpath($_SERVER["SCRIPT_FILENAME"]));
  78         $pr = $this->ff->project;
  79
  80         $this->cliHelpSearch($p,$pr);
  81         if (!empty($this->ff->projectExtends)) {
  82             foreach($this->ff->projectExtends as $pr) {
  83                 $this->cliHelpSearch($p,$pr);
  84             }
  85         }
  86
  87         echo "\n\n";
  88         exit;
  89     }
  90
  91
  92     function cliHelpSearch($p,$pr, $path=false) {
  93
  94
  95
  96         $full_path = array($p,$pr);
  97         $class_path = array();
  98         if ($path !== false)  {
  99             $full_path= array_merge($full_path, $path);
 100             $class_path = array_merge($class_path, $path);
 101         }
 102         //print_r("CHKDIR:    ". implode('/', $full_path)."\n");
 103
 104         foreach(scandir(implode('/', $full_path)) as $d) {
 105
 106             if (!strlen($d) || $d[0] == '.') {
 107                 continue;
 108             }
 109             $chk = $full_path;
 110             $chk[] = $d;
 111
 112             $clp = $class_path;
 113
 114
 115
 116             //print_r("CHK:          " . implode('/', $chk)."\n");
 117             // is it a file.. and .PHP...
 118             if (!is_dir(implode('/', $chk))) {
 119                 if (!preg_match('/\.php$/',$d)) {
 120                     continue;
 121                 }
 122                 $clp[] = preg_replace('/\.php$/','', $d);
 123
 124                 //print_r("CLP:          " . implode('/', $clp)."\n");
 125                 $this->cliShortHelp(implode('/', $clp ));
 126                 continue;
 127             }
 128             // skip special directories..
 129             if ($d == 'templates') {
 130                 continue;
 131             }
 132             if ($d == 'DataObjects') {
 133                 continue;
 134             }
 135
 136
 137             $clp[] = $d;
 138             // otherwise recurse...
 139             //print_r("RECURSE:        " . implode('/', $clp)."\n");
 140
 141             $this->cliHelpSearch($p,$pr, $clp);
 142
 143
 144         }
 145
 146         //print_r("COMPLETE:    ". implode('/', $full_path)."\n");
 147
 148
 149
 150
 151     }
 152
 153
 154
 155
 156     /**
 157      * creates an instance of all the CLI classes and prints out class + title..
 158      *
 159      */
 160     function cliShortHelp($p) {
 161         ////print_r("CHKFILE:         $p\n ");
 162         list($classname,$subRequest) = $this->ff->requestToClassName($p,FALSE);
 163         //var_dump($classname);
 164         // does it have a description.
 165         try {
 166             $cls = new ReflectionClass($classname);
 167             $val = $cls->getStaticPropertyValue('cli_desc');
 168         } catch (Exception $e) {
 169             return;
 170         }
 171         if (empty($val)) {
 172             return;
 173         }
 174         echo str_pad($p,40," ") . $val ."\n";
 175
 176
 177
 178     }
 179
 180     /**
 181     * cliParse - parse command line arguments, and return the values.
 182     *  Will die with help message if --help or error is found..
 183     *
 184     * @param {String} $classname name of class - should be loaded..
 185     * @return {Array|false} array of key=>value arguments.. or false if not parsed
 186     *
 187     */
 188     function cliParse($classname)
 189     {
 190
 191     // cli static $classname::$cli_opts
 192
 193         try {
 194             // look up the parent tree for core opts.
 195             $cls = new ReflectionClass($classname);
 196             if (method_exists($classname, 'cli_opts')) {
 197                 $val = $classname::cli_opts();
 198             } else {
 199                 if ($cls->getStaticProperties());
 200                 $val = $cls->getStaticPropertyValue('cli_opts');
 201             }
 202
 203             $val = is_array($val) ? $val : array();
 204             while ($cls = $cls->getParentClass()) {
 205                 //var_dump($cls);
 206
 207                 try {
 208
 209                     if (method_exists($cls->name, 'cli_opts')) {
 210                         $cn = $cls->name;
 211                         $vadd = $cn::cli_opts();
 212                     } else {
 213                         $vadd = $cls->getStaticPropertyValue('cli_opts') ;
 214
 215                     }
 216                     $val = array_merge($val, is_array($vadd) ? $vadd : array()  );
 217                 } catch (ReflectionException $e) {
 218                     continue;
 219                 }
 220             }
 221
 222
 223
 224         } catch (ReflectionException $e) {
 225             print_r($e);
 226             echo "cliParse:Warning:  {$e->getMessage()}\n";
 227         }
 228         if (empty($val)) {
 229             return false;
 230         }
 231
 232         $val = array_merge(self::$cli_opts, $val);
 233
 234
 235         require_once 'Console/Getargs.php';
 236         $ar = $_SERVER['argv'];
 237         $call = array(array_shift($ar)); // remove index.php
 238         $call[] = array_shift($ar); // remove our class...
 239         //var_dump($ar);
 240
 241         $newargs = Console_Getargs::factory($val, $ar);
 242
 243         if (!is_a($newargs, 'PEAR_Error')) {
 244             return $newargs->getValues();
 245         }
 246
 247         list($optional, $required, $params) = Console_Getargs::getOptionalRequired($val);
 248
 249         $helpHeader = 'Usage: php ' . implode (' ', $call) . ' '.
 250               $optional . ' ' . $required . ' ' . $params . "\n\n";
 251
 252
 253         if ($newargs->getCode() === CONSOLE_GETARGS_ERROR_USER) {
 254             // User put illegal values on the command line.
 255             echo Console_Getargs::getHelp($val,
 256                     $helpHeader, "\n\n".$newargs->getMessage(), 78, 4)."\n\n";
 257             exit;
 258         }
 259         if ($newargs->getCode() === CONSOLE_GETARGS_HELP) {
 260             // User needs help.
 261             echo Console_Getargs::getHelp($val,
 262                     $helpHeader, NULL, 78, 4)."\n\n";
 263             exit;
 264         }
 265
 266         die($newargs->getMessage());
 267
 268
 269     }
 270
 271
 272
 273     /**
 274      * the framework can be run without a database even if it's configured.
 275      * to support this, we need to handle things like
 276      *  --pman-nodatabase=1 on the command line.
 277      *
 278      *
 279      * @returns   array() - args, false - nothing matched / invalid, true = help!
 280      *
 281      */
 282
 283     function parseDefaultOpts()
 284     {
 285         require_once 'Console/Getargs.php';
 286         $ar = $_SERVER['argv'];
 287         $call = array(array_shift($ar)); // remove index.php
 288         $call[] = array_shift($ar);
 289         //var_dump($ar);
 290         $val = self::$cli_opts;
 291
 292         $newargs = Console_Getargs::factory($val, $ar);
 293
 294         if (is_a($newargs, 'PEAR_Error')) {
 295
 296
 297
 298             if ($newargs->getCode() === CONSOLE_GETARGS_ERROR_USER) {
 299                 // since we do not handle all the arguemnts here...
 300                 // skip errors if we find unknown arguments.
 301                 if (preg_match('/^Unknown argument/', $newargs->getMessage())) {
 302                     return false;
 303                 }
 304
 305                 // User put illegal values on the command line.
 306                 echo Console_Getargs::getHelp($val,
 307                         $helpHeader, "\n\n".$newargs->getMessage(), 78, 4)."\n\n";
 308                 exit;
 309             }
 310             if ($newargs->getCode() === CONSOLE_GETARGS_HELP) {
 311
 312                 return true;// hel
 313             }
 314
 315             return false;
 316         }
 317
 318
 319         // now handle real arguments..
 320
 321
 322         $ret =  $newargs->getValues();
 323         foreach($ret as $k=>$v) {
 324             switch($k) {
 325                 case 'pman-nodatabase':
 326                     //echo "Turning off database";
 327                     $this->ff->nodatabase= true;
 328
 329                     break;
 330
 331                 default:
 332                     die("need to fix option $k");
 333             }
 334
 335         }
 336         return false;
 337
 338     }
 339
 340
 341
 342 }