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/>.
24 use Friendica\Core\Logger;
25 use Friendica\Model\User;
28 * All modules in Friendica should extend BaseModule, although not all modules
29 * need to extend all the methods described here
31 * The filename of the module in src/Module needs to match the class name
32 * exactly to make the module available.
34 * @author Hypolite Petovan <hypolite@mrpetovan.com>
36 abstract class BaseModule
39 * Initialization method common to both content() and post()
41 * Extend this method if you need to do any shared processing before both
44 public static function init(array $parameters = [])
49 * Module GET method to display raw content from technical endpoints
51 * Extend this method if the module is supposed to return communication data,
52 * e.g. from protocol implementations.
54 public static function rawContent(array $parameters = [])
61 * Module GET method to display any content
63 * Extend this method if the module is supposed to return any display
64 * through a GET request. It can be an HTML page through templating or a
65 * XML feed or a JSON output.
69 public static function content(array $parameters = [])
77 * Module DELETE method to process submitted data
79 * Extend this method if the module is supposed to process DELETE requests.
80 * Doesn't display any content
82 public static function delete(array $parameters = [])
87 * Module PATCH method to process submitted data
89 * Extend this method if the module is supposed to process PATCH requests.
90 * Doesn't display any content
92 public static function patch(array $parameters = [])
97 * Module POST method to process submitted data
99 * Extend this method if the module is supposed to process POST requests.
100 * Doesn't display any content
102 public static function post(array $parameters = [])
104 // DI::baseurl()->redirect('module');
108 * Called after post()
112 public static function afterpost(array $parameters = [])
117 * Module PUT method to process submitted data
119 * Extend this method if the module is supposed to process PUT requests.
120 * Doesn't display any content
122 public static function put(array $parameters = [])
127 * Functions used to protect against Cross-Site Request Forgery
128 * The security token has to base on at least one value that an attacker can't know - here it's the session ID and the private key.
129 * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
130 * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amount of time (3hours).
131 * The "typename" separates the security tokens of different types of forms. This could be relevant in the following case:
132 * A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link).
133 * If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
134 * Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are,
135 * so this mechanism brings in some damage control (the attacker would be able to forge a request to a form of this type, but not to forms of other types).
137 public static function getFormSecurityToken($typename = '')
139 $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
141 $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
143 return $timestamp . '.' . $sec_hash;
146 public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token')
150 if (!empty($_REQUEST[$formname])) {
151 /// @TODO Careful, not secured!
152 $hash = $_REQUEST[$formname];
155 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
156 /// @TODO Careful, not secured!
157 $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
164 $max_livetime = 10800; // 3 hours
166 $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
168 $x = explode('.', $hash);
169 if (time() > (intval($x[0]) + $max_livetime)) {
173 $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
175 return ($sec_hash == $x[1]);
178 public static function getFormSecurityStandardErrorMessage()
180 return DI::l10n()->t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it.") . EOL;
183 public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
185 if (!self::checkFormSecurityToken($typename, $formname)) {
186 Logger::log('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
187 Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
188 notice(self::getFormSecurityStandardErrorMessage());
189 DI::baseUrl()->redirect($err_redirect);
193 public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
195 if (!self::checkFormSecurityToken($typename, $formname)) {
196 Logger::log('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
197 Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
199 throw new \Friendica\Network\HTTPException\ForbiddenException();
203 protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab)
207 'label' => DI::l10n()->t('All contacts'),
208 'url' => $baseUrl . '/contacts',
209 'sel' => !$current || $current == 'all' ? 'active' : '',
212 'label' => DI::l10n()->t('Followers'),
213 'url' => $baseUrl . '/contacts/followers',
214 'sel' => $current == 'followers' ? 'active' : '',
217 'label' => DI::l10n()->t('Following'),
218 'url' => $baseUrl . '/contacts/following',
219 'sel' => $current == 'following' ? 'active' : '',
222 'label' => DI::l10n()->t('Mutual friends'),
223 'url' => $baseUrl . '/contacts/mutuals',
224 'sel' => $current == 'mutuals' ? 'active' : '',
228 if ($displayCommonTab) {
230 'label' => DI::l10n()->t('Common'),
231 'url' => $baseUrl . '/contacts/common',
232 'sel' => $current == 'common' ? 'active' : '',