inc/classes/main/request/console/class_ConsoleRequest.php

   1 <?php
   2 /**
   3  * A concrete request class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class ConsoleRequest extends BaseRequest implements Requestable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class and prepares it a little
  37          *
  38          * @return      $httpInstance   An instance of this class
  39          */
  40         public static final function createConsoleRequest () {
  41                 // Create an instance
  42                 $httpInstance = new ConsoleRequest();
  43
  44                 // Prepare the console request data for usage
  45                 $httpInstance->prepareRequestData();
  46
  47                 // Return the prepared instance
  48                 return $httpInstance;
  49         }
  50
  51         /**
  52          * Prepares the request data for usage
  53          *
  54          * @return      void
  55          */
  56         public function prepareRequestData () {
  57                 // Get the "request data" from the command-line argument list
  58                 $args = $_SERVER['argv'];
  59
  60                 // Are there less than two parameters?
  61                 if ($_SERVER['argc'] < 2) {
  62                         // Skip this
  63                         return;
  64                 } // END - if
  65
  66                 // Is the first element "index.php" ?
  67                 if ($args[0] == 'index.php') {
  68                         // Then remove it
  69                         array_shift($args);
  70                 } // END - if
  71
  72                 // Try to determine next parameters
  73                 foreach ($args as $arg) {
  74                         // Seperate arguemnt name from value
  75                         $argArray = explode('=', $arg);
  76
  77                         // Is the second one set?
  78                         if (!isset($argArray[1])) {
  79                                 // Add it likewise, but empty value
  80                                 $this->setRequestElement($argArray[0], '');
  81                         } else {
  82                                 // Set a name=value pair escaped and secured
  83                                 $this->setRequestElement($argArray[0], escapeshellcmd($argArray[1]));
  84                         }
  85                 } // END - foreach
  86         }
  87
  88         /**
  89          * Getter for a header element or 'null' if header was not found
  90          *
  91          * @param       $headerName             Name of the header
  92          * @return      $headerValue    Value of the header or 'null' if not found
  93          * @throws      UnsupportedOperationException   This method should never be called
  94          */
  95         public function getHeader ($headerName) {
  96                 // Console doesn't have any headers
  97                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
  98         }
  99
 100         /**
 101          * Getter for request method. This getter might be useful for security filters
 102          *
 103          * @return      $requestMethod  Used request method
 104          */
 105         public final function getRequestMethod () {
 106                 // @TODO Can't this be 'CONSOLE' ?
 107                 return 'LOCAL';
 108         }
 109
 110         /**
 111          * Reads a cookie and returns it's value or null if not found
 112          *
 113          * @param       $cookieName             Name of cookie we shall read
 114          * @return      $cookieValue    Value of cookie or null if not found
 115          * @throws      UnsupportedOperationException   This method should never be called
 116          */
 117         public final function readCookie ($cookieName) {
 118                 // There are no cookies on console
 119                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
 120         }
 121 }
 122
 123 // [EOF]
 124 ?>