]> git.mxchange.org Git - friendica.git/blob - src/Module/Profile/Profile.php
Apply suggestions from code review
[friendica.git] / src / Module / Profile / Profile.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2023, 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\Module\Profile;
23
24 use Friendica\App;
25 use Friendica\Content\Feature;
26 use Friendica\Content\ForumManager;
27 use Friendica\Content\Nav;
28 use Friendica\Content\Text\BBCode;
29 use Friendica\Core\Config\Capability\IManageConfigValues;
30 use Friendica\Core\Hook;
31 use Friendica\Core\L10n;
32 use Friendica\Core\Protocol;
33 use Friendica\Core\Renderer;
34 use Friendica\Core\Session\Capability\IHandleUserSessions;
35 use Friendica\Core\System;
36 use Friendica\Database\Database;
37 use Friendica\Database\DBA;
38 use Friendica\Model\Contact;
39 use Friendica\Model\Profile as ProfileModel;
40 use Friendica\Model\Tag;
41 use Friendica\Model\User;
42 use Friendica\Module\BaseProfile;
43 use Friendica\Module\Response;
44 use Friendica\Module\Security\Login;
45 use Friendica\Network\HTTPException;
46 use Friendica\Profile\ProfileField\Repository\ProfileField;
47 use Friendica\Protocol\ActivityPub;
48 use Friendica\Util\DateTimeFormat;
49 use Friendica\Util\Profiler;
50 use Friendica\Util\Strings;
51 use Friendica\Util\Temporal;
52 use Psr\Log\LoggerInterface;
53
54 class Profile extends BaseProfile
55 {
56         /** @var Database */
57         private $database;
58         /** @var App */
59         private $app;
60         /** @var IHandleUserSessions */
61         private $session;
62         /** @var IManageConfigValues */
63         private $config;
64         /** @var App\Page */
65         private $page;
66         /** @var ProfileField */
67         private $profileField;
68
69         public function __construct(ProfileField $profileField, App\Page $page, IManageConfigValues $config, IHandleUserSessions $session, App $app, Database $database, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
70         {
71                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
72
73                 $this->database     = $database;
74                 $this->app          = $app;
75                 $this->session      = $session;
76                 $this->config       = $config;
77                 $this->page         = $page;
78                 $this->profileField = $profileField;
79         }
80
81         protected function rawContent(array $request = [])
82         {
83                 if (ActivityPub::isRequest()) {
84                         $user = $this->database->selectFirst('user', ['uid'], ['nickname' => $this->parameters['nickname'] ?? '', 'account_removed' => false]);
85                         if ($user) {
86                                 try {
87                                         $data = ActivityPub\Transmitter::getProfile($user['uid']);
88                                         header('Access-Control-Allow-Origin: *');
89                                         header('Cache-Control: max-age=23200, stale-while-revalidate=23200');
90                                         System::jsonExit($data, 'application/activity+json');
91                                 } catch (HTTPException\NotFoundException $e) {
92                                         System::jsonError(404, ['error' => 'Record not found']);
93                                 }
94                         }
95
96                         if ($this->database->exists('userd', ['username' => $this->parameters['nickname']])) {
97                                 // Known deleted user
98                                 $data = ActivityPub\Transmitter::getDeletedUser($this->parameters['nickname']);
99
100                                 System::jsonError(410, $data);
101                         } else {
102                                 // Any other case (unknown, blocked, nverified, expired, no profile, no self contact)
103                                 System::jsonError(404, []);
104                         }
105                 }
106         }
107
108         protected function content(array $request = []): string
109         {
110                 $profile = ProfileModel::load($this->app, $this->parameters['nickname'] ?? '');
111                 if (!$profile) {
112                         throw new HTTPException\NotFoundException($this->t('Profile not found.'));
113                 }
114
115                 $remote_contact_id = $this->session->getRemoteContactID($profile['uid']);
116
117                 if ($this->config->get('system', 'block_public') && !$this->session->isAuthenticated()) {
118                         return Login::form();
119                 }
120
121                 if (!empty($profile['hidewall']) && !$this->session->isAuthenticated()) {
122                         $this->baseUrl->redirect('profile/' . $profile['nickname'] . '/restricted');
123                 }
124
125                 if (!empty($profile['page-flags']) && $profile['page-flags'] == User::PAGE_FLAGS_COMMUNITY) {
126                         $this->page['htmlhead'] .= '<meta name="friendica.community" content="true" />' . "\n";
127                 }
128
129                 $this->page['htmlhead'] .= $this->buildHtmlHead($profile, $this->parameters['nickname']);
130
131                 Nav::setSelected('home');
132
133                 $is_owner = $this->session->getLocalUserId() == $profile['uid'];
134                 $o        = self::getTabsHTML('profile', $is_owner, $profile['nickname'], $profile['hide-friends']);
135
136                 $view_as_contacts      = [];
137                 $view_as_contact_id    = 0;
138                 $view_as_contact_alert = '';
139                 if ($is_owner) {
140                         $view_as_contact_id = intval($request['viewas'] ?? 0);
141
142                         $view_as_contacts = Contact::selectToArray(['id', 'name'], [
143                                 'uid'     => $this->session->getLocalUserId(),
144                                 'rel'     => [Contact::FOLLOWER, Contact::SHARING, Contact::FRIEND],
145                                 'network' => Protocol::DFRN,
146                                 'blocked' => false,
147                         ]);
148
149                         $view_as_contact_ids = array_column($view_as_contacts, 'id');
150
151                         // User manually provided a contact ID they aren't privy to, silently defaulting to their own view
152                         if (!in_array($view_as_contact_id, $view_as_contact_ids)) {
153                                 $view_as_contact_id = 0;
154                         }
155
156                         if (($key = array_search($view_as_contact_id, $view_as_contact_ids)) !== false) {
157                                 $view_as_contact_alert = $this->t(
158                                         'You\'re currently viewing your profile as <b>%s</b> <a href="%s" class="btn btn-sm pull-right">Cancel</a>',
159                                         htmlentities($view_as_contacts[$key]['name'], ENT_COMPAT, 'UTF-8'),
160                                         'profile/' . $this->parameters['nickname'] . '/profile'
161                                 );
162                         }
163                 }
164
165                 $basic_fields = [];
166
167                 $basic_fields += self::buildField('fullname', $this->t('Full Name:'), $profile['name']);
168
169                 if (Feature::isEnabled($profile['uid'], 'profile_membersince')) {
170                         $basic_fields += self::buildField(
171                                 'membersince',
172                                 $this->t('Member since:'),
173                                 DateTimeFormat::local($profile['register_date'])
174                         );
175                 }
176
177                 if (!empty($profile['dob']) && $profile['dob'] > DBA::NULL_DATE) {
178                         $year_bd_format  = $this->t('j F, Y');
179                         $short_bd_format = $this->t('j F');
180
181                         $dob = $this->l10n->getDay(
182                                 intval($profile['dob']) ?
183                                         DateTimeFormat::utc($profile['dob'] . ' 00:00 +00:00', $year_bd_format)
184                                         : DateTimeFormat::utc('2001-' . substr($profile['dob'], 5) . ' 00:00 +00:00', $short_bd_format)
185                         );
186
187                         $basic_fields += self::buildField('dob', $this->t('Birthday:'), $dob);
188
189                         if ($age = Temporal::getAgeByTimezone($profile['dob'], $profile['timezone'])) {
190                                 $basic_fields += self::buildField('age', $this->t('Age: '), $this->tt('%d year old', '%d years old', $age));
191                         }
192                 }
193
194                 if ($profile['about']) {
195                         $basic_fields += self::buildField('about', $this->t('Description:'), BBCode::convertForUriId($profile['uri-id'], $profile['about']));
196                 }
197
198                 if ($profile['xmpp']) {
199                         $basic_fields += self::buildField('xmpp', $this->t('XMPP:'), $profile['xmpp']);
200                 }
201
202                 if ($profile['matrix']) {
203                         $basic_fields += self::buildField('matrix', $this->t('Matrix:'), $profile['matrix']);
204                 }
205
206                 if ($profile['homepage']) {
207                         $basic_fields += self::buildField(
208                                 'homepage',
209                                 $this->t('Homepage:'),
210                                 $this->tryRelMe($profile['homepage']) ?: $profile['homepage']
211                         );
212                 }
213
214                 if (
215                         $profile['address']
216                         || $profile['locality']
217                         || $profile['postal-code']
218                         || $profile['region']
219                         || $profile['country-name']
220                 ) {
221                         $basic_fields += self::buildField('location', $this->t('Location:'), ProfileModel::formatLocation($profile));
222                 }
223
224                 if ($profile['pub_keywords']) {
225                         $tags = [];
226                         // Separator is defined in Module\Settings\Profile\Index::cleanKeywords
227                         foreach (explode(', ', $profile['pub_keywords']) as $tag_label) {
228                                 $tags[] = [
229                                         'url'   => '/search?tag=' . $tag_label,
230                                         'label' => Tag::TAG_CHARACTER[Tag::HASHTAG] . $tag_label,
231                                 ];
232                         }
233
234                         $basic_fields += self::buildField('pub_keywords', $this->t('Tags:'), $tags);
235                 }
236
237                 $custom_fields = [];
238
239                 // Defaults to the current logged in user self contact id to show self-only fields
240                 $contact_id = $view_as_contact_id ?: $remote_contact_id ?: 0;
241
242                 if ($is_owner && $contact_id === 0) {
243                         $profile_fields = $this->profileField->selectByUserId($profile['uid']);
244                 } else {
245                         $profile_fields = $this->profileField->selectByContactId($contact_id, $profile['uid']);
246                 }
247
248                 foreach ($profile_fields as $profile_field) {
249                         $custom_fields += self::buildField(
250                                 'custom_' . $profile_field->order,
251                                 $profile_field->label,
252                                 $this->tryRelMe($profile_field->value) ?: BBCode::convertForUriId($profile['uri-id'], $profile_field->value),
253                                 'aprofile custom'
254                         );
255                 }
256
257                 //show subscribed forum if it is enabled in the usersettings
258                 if (Feature::isEnabled($profile['uid'], 'forumlist_profile')) {
259                         $custom_fields += self::buildField(
260                                 'forumlist',
261                                 $this->t('Forums:'),
262                                 ForumManager::profileAdvanced($profile['uid'])
263                         );
264                 }
265
266                 $tpl = Renderer::getMarkupTemplate('profile/profile.tpl');
267                 $o   .= Renderer::replaceMacros($tpl, [
268                         '$title'                 => $this->t('Profile'),
269                         '$yourself'              => $this->t('Yourself'),
270                         '$view_as_contacts'      => $view_as_contacts,
271                         '$view_as_contact_id'    => $view_as_contact_id,
272                         '$view_as_contact_alert' => $view_as_contact_alert,
273                         '$view_as'               => $this->t('View profile as:'),
274                         '$submit'                => $this->t('Submit'),
275                         '$basic'                 => $this->t('Basic'),
276                         '$advanced'              => $this->t('Advanced'),
277                         '$is_owner'              => $profile['uid'] == $this->session->getLocalUserId(),
278                         '$query_string'          => $this->args->getQueryString(),
279                         '$basic_fields'          => $basic_fields,
280                         '$custom_fields'         => $custom_fields,
281                         '$profile'               => $profile,
282                         '$edit_link'             => [
283                                 'url'   => 'settings/profile', $this->t('Edit profile'),
284                                 'title' => '',
285                                 'label' => $this->t('Edit profile')
286                         ],
287                         '$viewas_link'           => [
288                                 'url'   => $this->args->getQueryString() . '#viewas',
289                                 'title' => '',
290                                 'label' => $this->t('View as')
291                         ],
292                 ]);
293
294                 Hook::callAll('profile_advanced', $o);
295
296                 return $o;
297         }
298
299         /**
300          * Creates a profile field structure to be used in the profile template
301          *
302          * @param string $name  Arbitrary name of the field
303          * @param string $label Display label of the field
304          * @param mixed  $value Display value of the field
305          * @param string $class Optional CSS class to apply to the field
306          * @return array
307          */
308         private static function buildField(string $name, string $label, $value, string $class = 'aprofile'): array
309         {
310                 return [$name => [
311                         'id'    => 'aprofile-' . $name,
312                         'class' => $class,
313                         'label' => $label,
314                         'value' => $value,
315                 ]];
316         }
317
318         private function buildHtmlHead(array $profile, string $nickname): string
319         {
320                 $htmlhead = "\n";
321
322                 if (!empty($profile['page-flags']) && $profile['page-flags'] == User::PAGE_FLAGS_COMMUNITY) {
323                         $htmlhead .= '<meta name="friendica.community" content="true" />' . "\n";
324                 }
325
326                 if (!empty($profile['openidserver'])) {
327                         $htmlhead .= '<link rel="openid.server" href="' . $profile['openidserver'] . '" />' . "\n";
328                 }
329
330                 if (!empty($profile['openid'])) {
331                         $delegate = strstr($profile['openid'], '://') ? $profile['openid'] : 'https://' . $profile['openid'];
332                         $htmlhead .= '<link rel="openid.delegate" href="' . $delegate . '" />' . "\n";
333                 }
334
335                 // site block
336                 $blocked   = !$this->session->isAuthenticated() && $this->config->get('system', 'block_public');
337                 $userblock = !$this->session->isAuthenticated() && $profile['hidewall'];
338                 if (!$blocked && !$userblock) {
339                         $keywords = str_replace(['#', ',', ' ', ',,'], ['', ' ', ',', ','], $profile['pub_keywords'] ?? '');
340                         if (strlen($keywords)) {
341                                 $htmlhead .= '<meta name="keywords" content="' . $keywords . '" />' . "\n";
342                         }
343                 }
344
345                 $htmlhead .= '<meta name="dfrn-global-visibility" content="' . ($profile['net-publish'] ? 'true' : 'false') . '" />' . "\n";
346
347                 if (!$profile['net-publish']) {
348                         $htmlhead .= '<meta content="noindex, noarchive" name="robots" />' . "\n";
349                 }
350
351                 $htmlhead .= '<link rel="alternate" type="application/atom+xml" href="' . $this->baseUrl . '/dfrn_poll/' . $nickname . '" title="DFRN: ' . $this->t('%s\'s timeline', $profile['name']) . '"/>' . "\n";
352                 $htmlhead .= '<link rel="alternate" type="application/atom+xml" href="' . $this->baseUrl . '/feed/' . $nickname . '/" title="' . $this->t('%s\'s posts', $profile['name']) . '"/>' . "\n";
353                 $htmlhead .= '<link rel="alternate" type="application/atom+xml" href="' . $this->baseUrl . '/feed/' . $nickname . '/comments" title="' . $this->t('%s\'s comments', $profile['name']) . '"/>' . "\n";
354                 $htmlhead .= '<link rel="alternate" type="application/atom+xml" href="' . $this->baseUrl . '/feed/' . $nickname . '/activity" title="' . $this->t('%s\'s timeline', $profile['name']) . '"/>' . "\n";
355                 $uri      = urlencode('acct:' . $profile['nickname'] . '@' . $this->baseUrl->getHost() . ($this->baseUrl->getPath() ? '/' . $this->baseUrl->getPath() : ''));
356                 $htmlhead .= '<link rel="lrdd" type="application/xrd+xml" href="' . $this->baseUrl . '/xrd/?uri=' . $uri . '" />' . "\n";
357                 header('Link: <' . $this->baseUrl . '/xrd/?uri=' . $uri . '>; rel="lrdd"; type="application/xrd+xml"', false);
358
359                 $dfrn_pages = ['request', 'confirm', 'notify', 'poll'];
360                 foreach ($dfrn_pages as $dfrn) {
361                         $htmlhead .= '<link rel="dfrn-' . $dfrn . '" href="' . $this->baseUrl . '/dfrn_' . $dfrn . '/' . $nickname . '" />' . "\n";
362                 }
363
364                 return $htmlhead;
365         }
366
367         /**
368          * Check if the input is an HTTP(S) link and returns a rel="me" link if yes, empty string if not
369          *
370          * @param string $input
371          * @return string
372          */
373         private function tryRelMe(string $input): string
374         {
375                 if (preg_match(Strings::onlyLinkRegEx(), trim($input))) {
376                         return '<a href="' . trim($input) . '" target="_blank" rel="noopener noreferrer me">' . trim($input) . '</a>';
377                 }
378
379                 return '';
380         }
381 }