]> git.mxchange.org Git - friendica.git/blob - src/BaseModule.php
Fix field name
[friendica.git] / src / BaseModule.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2021, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
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.
11  *
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.
16  *
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/>.
19  *
20  */
21
22 namespace Friendica;
23
24 use Friendica\Core\Logger;
25
26 /**
27  * All modules in Friendica should extend BaseModule, although not all modules
28  * need to extend all the methods described here
29  *
30  * The filename of the module in src/Module needs to match the class name
31  * exactly to make the module available.
32  *
33  * @author Hypolite Petovan <hypolite@mrpetovan.com>
34  */
35 abstract class BaseModule
36 {
37         /**
38          * Initialization method common to both content() and post()
39          *
40          * Extend this method if you need to do any shared processing before both
41          * content() or post()
42          */
43         public static function init(array $parameters = [])
44         {
45         }
46
47         /**
48          * Module GET method to display raw content from technical endpoints
49          *
50          * Extend this method if the module is supposed to return communication data,
51          * e.g. from protocol implementations.
52          */
53         public static function rawContent(array $parameters = [])
54         {
55                 // echo '';
56                 // exit;
57         }
58
59         /**
60          * Module GET method to display any content
61          *
62          * Extend this method if the module is supposed to return any display
63          * through a GET request. It can be an HTML page through templating or a
64          * XML feed or a JSON output.
65          *
66          * @return string
67          */
68         public static function content(array $parameters = [])
69         {
70                 $o = '';
71
72                 return $o;
73         }
74
75         /**
76          * Module DELETE method to process submitted data
77          *
78          * Extend this method if the module is supposed to process DELETE requests.
79          * Doesn't display any content
80          */
81         public static function delete(array $parameters = [])
82         {
83         }
84
85         /**
86          * Module PATCH method to process submitted data
87          *
88          * Extend this method if the module is supposed to process PATCH requests.
89          * Doesn't display any content
90          */
91         public static function patch(array $parameters = [])
92         {
93         }
94
95         /**
96          * Module POST method to process submitted data
97          *
98          * Extend this method if the module is supposed to process POST requests.
99          * Doesn't display any content
100          */
101         public static function post(array $parameters = [])
102         {
103                 // DI::baseurl()->redirect('module');
104         }
105
106         /**
107          * Called after post()
108          *
109          * Unknown purpose
110          */
111         public static function afterpost(array $parameters = [])
112         {
113         }
114
115         /**
116          * Module PUT method to process submitted data
117          *
118          * Extend this method if the module is supposed to process PUT requests.
119          * Doesn't display any content
120          */
121         public static function put(array $parameters = [])
122         {
123         }
124
125         /*
126          * Functions used to protect against Cross-Site Request Forgery
127          * 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.
128          * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
129          * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amount of time (3hours).
130          * The "typename" separates the security tokens of different types of forms. This could be relevant in the following case:
131          *    A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link).
132          *    If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
133          *    Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are,
134          *    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).
135          */
136         public static function getFormSecurityToken($typename = '')
137         {
138                 $a = DI::app();
139
140                 $timestamp = time();
141                 $sec_hash = hash('whirlpool', ($a->user['guid'] ?? '') . ($a->user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
142
143                 return $timestamp . '.' . $sec_hash;
144         }
145
146         public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token')
147         {
148                 $hash = null;
149
150                 if (!empty($_REQUEST[$formname])) {
151                         /// @TODO Careful, not secured!
152                         $hash = $_REQUEST[$formname];
153                 }
154
155                 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
156                         /// @TODO Careful, not secured!
157                         $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
158                 }
159
160                 if (empty($hash)) {
161                         return false;
162                 }
163
164                 $max_livetime = 10800; // 3 hours
165
166                 $a = DI::app();
167
168                 $x = explode('.', $hash);
169                 if (time() > (intval($x[0]) + $max_livetime)) {
170                         return false;
171                 }
172
173                 $sec_hash = hash('whirlpool', ($a->user['guid'] ?? '') . ($a->user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
174
175                 return ($sec_hash == $x[1]);
176         }
177
178         public static function getFormSecurityStandardErrorMessage()
179         {
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;
181         }
182
183         public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
184         {
185                 if (!self::checkFormSecurityToken($typename, $formname)) {
186                         $a = DI::app();
187                         Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
188                         Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
189                         notice(self::getFormSecurityStandardErrorMessage());
190                         DI::baseUrl()->redirect($err_redirect);
191                 }
192         }
193
194         public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
195         {
196                 if (!self::checkFormSecurityToken($typename, $formname)) {
197                         $a = DI::app();
198                         Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
199                         Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
200
201                         throw new \Friendica\Network\HTTPException\ForbiddenException();
202                 }
203         }
204
205         protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab)
206         {
207                 $tabs = [
208                         [
209                                 'label' => DI::l10n()->t('All contacts'),
210                                 'url'   => $baseUrl . '/contacts',
211                                 'sel'   => !$current || $current == 'all' ? 'active' : '',
212                         ],
213                         [
214                                 'label' => DI::l10n()->t('Followers'),
215                                 'url'   => $baseUrl . '/contacts/followers',
216                                 'sel'   => $current == 'followers' ? 'active' : '',
217                         ],
218                         [
219                                 'label' => DI::l10n()->t('Following'),
220                                 'url'   => $baseUrl . '/contacts/following',
221                                 'sel'   => $current == 'following' ? 'active' : '',
222                         ],
223                         [
224                                 'label' => DI::l10n()->t('Mutual friends'),
225                                 'url'   => $baseUrl . '/contacts/mutuals',
226                                 'sel'   => $current == 'mutuals' ? 'active' : '',
227                         ],
228                 ];
229
230                 if ($displayCommonTab) {
231                         $tabs[] = [
232                                 'label' => DI::l10n()->t('Common'),
233                                 'url'   => $baseUrl . '/contacts/common',
234                                 'sel'   => $current == 'common' ? 'active' : '',
235                         ];
236                 }
237
238                 return $tabs;
239         }
240 }