src/App/Arguments.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\App;
  23
  24 /**
  25  * Determine all arguments of the current call, including
  26  * - The whole querystring (except the pagename/q parameter)
  27  * - The command
  28  * - The arguments (C-Style based)
  29  * - The count of arguments
  30  */
  31 class Arguments
  32 {
  33         const DEFAULT_MODULE = 'home';
  34
  35         /**
  36          * @var string The complete query string
  37          */
  38         private $queryString;
  39         /**
  40          * @var string The current Friendica command
  41          */
  42         private $command;
  43         /**
  44          * @var string The name of the current module
  45          */
  46         private $moduleName;
  47         /**
  48          * @var array The arguments of the current execution
  49          */
  50         private $argv;
  51         /**
  52          * @var int The count of arguments
  53          */
  54         private $argc;
  55         /**
  56          * @var string The used HTTP method
  57          */
  58         private $method;
  59
  60         public function __construct(string $queryString = '', string $command = '', string $moduleName = '', array $argv = [], int $argc = 0, string $method = Router::GET)
  61         {
  62                 $this->queryString = $queryString;
  63                 $this->command     = $command;
  64                 $this->moduleName  = $moduleName;
  65                 $this->argv        = $argv;
  66                 $this->argc        = $argc;
  67                 $this->method      = $method;
  68         }
  69
  70         /**
  71          * @return string The whole query string of this call with url-encoded query parameters
  72          */
  73         public function getQueryString()
  74         {
  75                 return $this->queryString;
  76         }
  77
  78         /**
  79          * @return string The whole command of this call
  80          */
  81         public function getCommand()
  82         {
  83                 return $this->command;
  84         }
  85
  86         /**
  87          * @return string The module name based on the arguments
  88          */
  89         public function getModuleName(): string
  90         {
  91                 return $this->moduleName;
  92         }
  93
  94         /**
  95          * @return array All arguments of this call
  96          */
  97         public function getArgv()
  98         {
  99                 return $this->argv;
 100         }
 101
 102         public function getMethod()
 103         {
 104                 return $this->method;
 105         }
 106
 107         /**
 108          * @return int The count of arguments of this call
 109          */
 110         public function getArgc()
 111         {
 112                 return $this->argc;
 113         }
 114
 115         public function setArgv(array $argv)
 116         {
 117                 $this->argv = $argv;
 118                 $this->argc = count($argv);
 119         }
 120
 121         public function setArgc(int $argc)
 122         {
 123                 $this->argc = $argc;
 124         }
 125
 126         /**
 127          * Returns the value of a argv key
 128          * @todo there are a lot of $a->argv usages in combination with ?? which can be replaced with this method
 129          *
 130          * @param int   $position the position of the argument
 131          * @param mixed $default  the default value if not found
 132          *
 133          * @return mixed returns the value of the argument
 134          */
 135         public function get(int $position, $default = '')
 136         {
 137                 return $this->has($position) ? $this->argv[$position] : $default;
 138         }
 139
 140         /**
 141          * @param int $position
 142          *
 143          * @return bool if the argument position exists
 144          */
 145         public function has(int $position)
 146         {
 147                 return array_key_exists($position, $this->argv);
 148         }
 149
 150         /**
 151          * Determine the arguments of the current call
 152          *
 153          * @param array $server The $_SERVER variable
 154          * @param array $get    The $_GET variable
 155          *
 156          * @return Arguments The determined arguments
 157          */
 158         public function determine(array $server, array $get)
 159         {
 160                 // removing leading / - maybe a nginx problem
 161                 $server['QUERY_STRING'] = ltrim($server['QUERY_STRING'] ?? '', '/');
 162
 163                 $queryParameters = [];
 164                 parse_str($server['QUERY_STRING'], $queryParameters);
 165
 166                 if (!empty($get['pagename'])) {
 167                         $command = trim($get['pagename'], '/\\');
 168                 } elseif (!empty($queryParameters['pagename'])) {
 169                         $command = trim($queryParameters['pagename'], '/\\');
 170                 } elseif (!empty($get['q'])) {
 171                         // Legacy page name parameter, now conflicts with the search query parameter
 172                         $command = trim($get['q'], '/\\');
 173                 } else {
 174                         $command = '';
 175                 }
 176
 177                 // Remove generated and one-time use parameters
 178                 unset($queryParameters['pagename']);
 179                 unset($queryParameters['zrl']);
 180                 unset($queryParameters['owt']);
 181
 182                 /*
 183                  * Break the URL path into C style argc/argv style arguments for our
 184                  * modules. Given "http://example.com/module/arg1/arg2", $this->argc
 185                  * will be 3 (integer) and $this->argv will contain:
 186                  *   [0] => 'module'
 187                  *   [1] => 'arg1'
 188                  *   [2] => 'arg2'
 189                  */
 190                 if ($command) {
 191                         $argv = explode('/', $command);
 192                 } else {
 193                         $argv = [];
 194                 }
 195
 196                 $argc = count($argv);
 197
 198                 $queryString = $command . ($queryParameters ? '?' . http_build_query($queryParameters) : '');
 199
 200                 if ($argc > 0) {
 201                         $module = str_replace('.', '_', $argv[0]);
 202                         $module = str_replace('-', '_', $module);
 203                 } else {
 204                         $module = self::DEFAULT_MODULE;
 205                 }
 206
 207                 // Compatibility with the Firefox App
 208                 if (($module == "users") && ($command == "users/sign_in")) {
 209                         $module = "login";
 210                 }
 211
 212                 $httpMethod = in_array($server['REQUEST_METHOD'] ?? '', Router::ALLOWED_METHODS) ? $server['REQUEST_METHOD'] : Router::GET;
 213
 214                 return new Arguments($queryString, $command, $module, $argv, $argc, $httpMethod);
 215         }
 216 }