3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\App;
25 * Determine all arguments of the current call, including
26 * - The whole querystring (except the pagename/q parameter)
28 * - The arguments (C-Style based)
29 * - The count of arguments
33 const DEFAULT_MODULE = 'home';
36 * @var string The complete query string
40 * @var string The current Friendica command
44 * @var string The name of the current module
48 * @var array The arguments of the current execution
52 * @var int The count of arguments
56 * @var string The used HTTP method
60 public function __construct(string $queryString = '', string $command = '', string $moduleName = '', array $argv = [], int $argc = 0, string $method = Router::GET)
62 $this->queryString = $queryString;
63 $this->command = $command;
64 $this->moduleName = $moduleName;
67 $this->method = $method;
71 * @return string The whole query string of this call with url-encoded query parameters
73 public function getQueryString()
75 return $this->queryString;
79 * @return string The whole command of this call
81 public function getCommand(): string
83 return $this->command;
87 * @return string The module name based on the arguments
89 public function getModuleName(): string
91 return $this->moduleName;
95 * @return array All arguments of this call
97 public function getArgv(): array
103 * @return string The used HTTP method
105 public function getMethod(): string
107 return $this->method;
111 * @return int The count of arguments of this call
113 public function getArgc(): int
118 public function setArgv(array $argv)
121 $this->argc = count($argv);
124 public function setArgc(int $argc)
130 * Returns the value of a argv key
131 * @todo there are a lot of $a->argv usages in combination with ?? which can be replaced with this method
133 * @param int $position the position of the argument
134 * @param mixed $default the default value if not found
136 * @return mixed returns the value of the argument
138 public function get(int $position, $default = '')
140 return $this->has($position) ? $this->argv[$position] : $default;
144 * @param int $position
146 * @return bool if the argument position exists
148 public function has(int $position): bool
150 return array_key_exists($position, $this->argv);
154 * Determine the arguments of the current call
156 * @param array $server The $_SERVER variable
157 * @param array $get The $_GET variable
159 * @return Arguments The determined arguments
161 public function determine(array $server, array $get): Arguments
163 // removing leading / - maybe a nginx problem
164 $server['QUERY_STRING'] = ltrim($server['QUERY_STRING'] ?? '', '/');
166 $queryParameters = [];
167 parse_str($server['QUERY_STRING'], $queryParameters);
169 if (!empty($get['pagename'])) {
170 $command = trim($get['pagename'], '/\\');
171 } elseif (!empty($queryParameters['pagename'])) {
172 $command = trim($queryParameters['pagename'], '/\\');
173 } elseif (!empty($get['q'])) {
174 // Legacy page name parameter, now conflicts with the search query parameter
175 $command = trim($get['q'], '/\\');
180 // Remove generated and one-time use parameters
181 unset($queryParameters['pagename']);
182 unset($queryParameters['zrl']);
183 unset($queryParameters['owt']);
186 * Break the URL path into C style argc/argv style arguments for our
187 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
188 * will be 3 (integer) and $this->argv will contain:
194 $argv = explode('/', $command);
199 $argc = count($argv);
201 $queryString = $command . ($queryParameters ? '?' . http_build_query($queryParameters) : '');
204 $module = str_replace('.', '_', $argv[0]);
205 $module = str_replace('-', '_', $module);
207 $module = self::DEFAULT_MODULE;
210 // Compatibility with the Firefox App
211 if (($module == "users") && ($command == "users/sign_in")) {
215 $httpMethod = in_array($server['REQUEST_METHOD'] ?? '', Router::ALLOWED_METHODS) ? $server['REQUEST_METHOD'] : Router::GET;
217 return new Arguments($queryString, $command, $module, $argv, $argc, $httpMethod);