3 * @copyright Copyright (C) 2010-2021, 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 public function __construct(string $queryString = '', string $command = '', string $moduleName = '', array $argv = [], int $argc = 0)
58 $this->queryString = $queryString;
59 $this->command = $command;
60 $this->moduleName = $moduleName;
66 * @return string The whole query string of this call with url-encoded query parameters
68 public function getQueryString()
70 return $this->queryString;
74 * @return string The whole command of this call
76 public function getCommand()
78 return $this->command;
82 * @return string The module name based on the arguments
84 public function getModuleName(): string
86 return $this->moduleName;
90 * @return array All arguments of this call
92 public function getArgv()
98 * @return int The count of arguments of this call
100 public function getArgc()
105 public function setArgv(array $argv)
108 $this->argc = count($argv);
111 public function setArgc(int $argc)
117 * Returns the value of a argv key
118 * @todo there are a lot of $a->argv usages in combination with ?? which can be replaced with this method
120 * @param int $position the position of the argument
121 * @param mixed $default the default value if not found
123 * @return mixed returns the value of the argument
125 public function get(int $position, $default = '')
127 return $this->has($position) ? $this->argv[$position] : $default;
131 * @param int $position
133 * @return bool if the argument position exists
135 public function has(int $position)
137 return array_key_exists($position, $this->argv);
141 * Determine the arguments of the current call
143 * @param array $server The $_SERVER variable
144 * @param array $get The $_GET variable
146 * @return Arguments The determined arguments
148 public function determine(array $server, array $get)
150 // removing leading / - maybe a nginx problem
151 $server['QUERY_STRING'] = ltrim($server['QUERY_STRING'] ?? '', '/');
153 $queryParameters = [];
154 parse_str($server['QUERY_STRING'], $queryParameters);
156 if (!empty($get['pagename'])) {
157 $command = trim($get['pagename'], '/\\');
158 } elseif (!empty($queryParameters['pagename'])) {
159 $command = trim($queryParameters['pagename'], '/\\');
160 } elseif (!empty($get['q'])) {
161 // Legacy page name parameter, now conflicts with the search query parameter
162 $command = trim($get['q'], '/\\');
167 // Remove generated and one-time use parameters
168 unset($queryParameters['pagename']);
169 unset($queryParameters['zrl']);
170 unset($queryParameters['owt']);
173 * Break the URL path into C style argc/argv style arguments for our
174 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
175 * will be 3 (integer) and $this->argv will contain:
181 $argv = explode('/', $command);
186 $argc = count($argv);
188 $queryString = $command . ($queryParameters ? '?' . http_build_query($queryParameters) : '');
191 $module = str_replace('.', '_', $argv[0]);
192 $module = str_replace('-', '_', $module);
194 $module = self::DEFAULT_MODULE;
197 // Compatibility with the Firefox App
198 if (($module == "users") && ($command == "users/sign_in")) {
202 return new Arguments($queryString, $command, $module, $argv, $argc);