3 * @copyright Copyright (C) 2020, Friendica
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 = [Module::DEFAULT], int $argc = 1)
52 $this->queryString = $queryString;
53 $this->command = $command;
59 * @return string The whole query string of this call
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)
126 if (!empty($server['QUERY_STRING']) && strpos($server['QUERY_STRING'], 'pagename=') === 0) {
127 $queryString = urldecode(substr($server['QUERY_STRING'], 9));
128 } elseif (!empty($server['QUERY_STRING']) && strpos($server['QUERY_STRING'], 'q=') === 0) {
129 $queryString = urldecode(substr($server['QUERY_STRING'], 2));
132 // eventually strip ZRL
133 $queryString = $this->stripZRLs($queryString);
135 // eventually strip OWT
136 $queryString = $this->stripQueryParam($queryString, 'owt');
138 // removing trailing / - maybe a nginx problem
139 $queryString = ltrim($queryString, '/');
141 if (!empty($get['pagename'])) {
142 $command = trim($get['pagename'], '/\\');
143 } elseif (!empty($get['q'])) {
144 $command = trim($get['q'], '/\\');
146 $command = Module::DEFAULT;
151 if (!empty($command)) {
152 $queryString = str_replace(
159 // unix style "homedir"
160 if (substr($command, 0, 1) === '~') {
161 $command = 'profile/' . substr($command, 1);
164 // Diaspora style profile url
165 if (substr($command, 0, 2) === 'u/') {
166 $command = 'profile/' . substr($command, 2);
170 * Break the URL path into C style argc/argv style arguments for our
171 * modules. Given "http://example.com/module/arg1/arg2", $this->argc
172 * will be 3 (integer) and $this->argv will contain:
178 * There will always be one argument. If provided a naked domain
179 * URL, $this->argv[0] is set to "home".
182 $argv = explode('/', $command);
183 $argc = count($argv);
186 return new Arguments($queryString, $command, $argv, $argc);
190 * Strip zrl parameter from a string.
192 * @param string $queryString The input string.
194 * @return string The zrl.
196 public function stripZRLs(string $queryString)
198 return preg_replace('/[?&]zrl=(.*?)(&|$)/ism', '$2', $queryString);
202 * Strip query parameter from a string.
204 * @param string $queryString The input string.
205 * @param string $param
207 * @return string The query parameter.
209 public function stripQueryParam(string $queryString, string $param)
211 return preg_replace('/[?&]' . $param . '=(.*?)(&|$)/ism', '$2', $queryString);