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
34 * @var string The complete query string
38 * @var string The current Friendica command
42 * @var array The arguments of the current execution
46 * @var int The count of arguments
50 public function __construct(string $queryString = '', string $command = '', array $argv = [], int $argc = 0)
52 $this->queryString = $queryString;
53 $this->command = $command;
59 * @return string The whole query string of this call with url-encoded query parameters
61 public function getQueryString()
63 return $this->queryString;
67 * @return string The whole command of this call
69 public function getCommand()
71 return $this->command;
75 * @return array All arguments of this call
77 public function getArgv()
83 * @return int The count of arguments of this call
85 public function getArgc()
91 * Returns the value of a argv key
92 * @todo there are a lot of $a->argv usages in combination with ?? which can be replaced with this method
94 * @param int $position the position of the argument
95 * @param mixed $default the default value if not found
97 * @return mixed returns the value of the argument
99 public function get(int $position, $default = '')
101 return $this->has($position) ? $this->argv[$position] : $default;
105 * @param int $position
107 * @return bool if the argument position exists
109 public function has(int $position)
111 return array_key_exists($position, $this->argv);
115 * Determine the arguments of the current call
117 * @param array $server The $_SERVER variable
118 * @param array $get The $_GET variable
120 * @return Arguments The determined arguments
122 public function determine(array $server, array $get)
124 // removing leading / - maybe a nginx problem
125 $server['QUERY_STRING'] = ltrim($server['QUERY_STRING'] ?? '', '/');
127 $queryParameters = [];
128 parse_str($server['QUERY_STRING'], $queryParameters);
130 if (!empty($get['pagename'])) {
131 $command = trim($get['pagename'], '/\\');
132 } elseif (!empty($queryParameters['pagename'])) {
133 $command = trim($queryParameters['pagename'], '/\\');
134 } elseif (!empty($get['q'])) {
135 // Legacy page name parameter, now conflicts with the search query parameter
136 $command = trim($get['q'], '/\\');
141 // Remove generated and one-time use parameters
142 unset($queryParameters['pagename']);
143 unset($queryParameters['zrl']);
144 unset($queryParameters['owt']);
147 * Break the URL path into C style argc/argv style arguments for our
148 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
149 * will be 3 (integer) and $this->argv will contain:
155 $argv = explode('/', $command);
160 $argc = count($argv);
162 $queryString = $command . ($queryParameters ? '?' . http_build_query($queryParameters) : '');
164 return new Arguments($queryString, $command, $argv, $argc);