]> git.mxchange.org Git - friendica.git/blob - src/Model/Profile.php
Add explicit parameter to IHandleUserSession->setvisitorContacts
[friendica.git] / src / Model / 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\Model;
23
24 use Friendica\App;
25 use Friendica\Content\Text\BBCode;
26 use Friendica\Content\Widget\ContactBlock;
27 use Friendica\Core\Cache\Enum\Duration;
28 use Friendica\Core\Hook;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\Renderer;
32 use Friendica\Core\Search;
33 use Friendica\Core\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\DBA;
36 use Friendica\DI;
37 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
38 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
39 use Friendica\Network\HTTPException;
40 use Friendica\Protocol\Activity;
41 use Friendica\Protocol\Diaspora;
42 use Friendica\Security\PermissionSet\Entity\PermissionSet;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\HTTPSignature;
45 use Friendica\Util\Network;
46 use Friendica\Util\Proxy;
47 use Friendica\Util\Strings;
48
49 class Profile
50 {
51         /**
52          * Returns default profile for a given user id
53          *
54          * @param integer User ID
55          *
56          * @return array|bool Profile data or false on error
57          * @throws \Exception
58          */
59         public static function getByUID(int $uid)
60         {
61                 return DBA::selectFirst('profile', [], ['uid' => $uid]);
62         }
63
64         /**
65          * Returns default profile for a given user ID and ID
66          *
67          * @param int $uid The contact ID
68          * @param int $id The contact owner ID
69          * @param array $fields The selected fields
70          *
71          * @return array|bool Profile data for the ID or false on error
72          * @throws \Exception
73          */
74         public static function getById(int $uid, int $id, array $fields = [])
75         {
76                 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
77         }
78
79         /**
80          * Returns profile data for the contact owner
81          *
82          * @param int $uid The User ID
83          * @param array|bool $fields The fields to retrieve or false on error
84          *
85          * @return array Array of profile data
86          * @throws \Exception
87          */
88         public static function getListByUser(int $uid, array $fields = [])
89         {
90                 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
91         }
92
93         /**
94          * Update a profile entry and distribute the changes if needed
95          *
96          * @param array $fields Profile fields to update
97          * @param integer $uid User id
98          *
99          * @return boolean Whether update was successful
100          */
101         public static function update(array $fields, int $uid): bool
102         {
103                 $old_owner = User::getOwnerDataById($uid);
104                 if (empty($old_owner)) {
105                         return false;
106                 }
107
108                 if (!DBA::update('profile', $fields, ['uid' => $uid])) {
109                         return false;
110                 }
111
112                 $update = Contact::updateSelfFromUserID($uid);
113
114                 $owner = User::getOwnerDataById($uid);
115                 if (empty($owner)) {
116                         return false;
117                 }
118
119                 if ($old_owner['name'] != $owner['name']) {
120                         User::update(['username' => $owner['name']], $uid);
121                 }
122
123                 $profile_fields = ['postal-code', 'dob', 'prv_keywords', 'homepage'];
124                 foreach ($profile_fields as $field) {
125                         if ($old_owner[$field] != $owner[$field]) {
126                                 $update = true;
127                         }
128                 }
129
130                 if ($update) {
131                         self::publishUpdate($uid, ($old_owner['net-publish'] != $owner['net-publish']));
132                 }
133
134                 return true;
135         }
136
137         /**
138          * Publish a changed profile
139          *
140          * @param int  $uid User id
141          * @param bool $force Force publishing to the directory
142          *
143          * @return void
144          */
145         public static function publishUpdate(int $uid, bool $force = false)
146         {
147                 $owner = User::getOwnerDataById($uid);
148                 if (empty($owner)) {
149                         return;
150                 }
151
152                 if ($owner['net-publish'] || $force) {
153                         // Update global directory in background
154                         if (Search::getGlobalDirectory()) {
155                                 Worker::add(Worker::PRIORITY_LOW, 'Directory', $owner['url']);
156                         }
157                 }
158
159                 Worker::add(Worker::PRIORITY_LOW, 'ProfileUpdate', $uid);
160         }
161
162         /**
163          * Returns a formatted location string from the given profile array
164          *
165          * @param array $profile Profile array (Generated from the "profile" table)
166          *
167          * @return string Location string
168          */
169         public static function formatLocation(array $profile): string
170         {
171                 $location = '';
172
173                 if (!empty($profile['locality'])) {
174                         $location .= $profile['locality'];
175                 }
176
177                 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
178                         if ($location) {
179                                 $location .= ', ';
180                         }
181
182                         $location .= $profile['region'];
183                 }
184
185                 if (!empty($profile['country-name'])) {
186                         if ($location) {
187                                 $location .= ', ';
188                         }
189
190                         $location .= $profile['country-name'];
191                 }
192
193                 return $location;
194         }
195
196         /**
197          * Loads a profile into the page sidebar.
198          *
199          * The function requires a writeable copy of the main App structure, and the nickname
200          * of a registered local account.
201          *
202          * If the viewer is an authenticated remote viewer, the profile displayed is the
203          * one that has been configured for his/her viewing in the Contact manager.
204          * Passing a non-zero profile ID can also allow a preview of a selected profile
205          * by the owner.
206          *
207          * Profile information is placed in the App structure for later retrieval.
208          * Honours the owner's chosen theme for display.
209          *
210          * @attention Should only be run in the _init() functions of a module. That ensures that
211          *      the theme is chosen before the _init() function of a theme is run, which will usually
212          *      load a lot of theme-specific content
213          *
214          * @param App    $a
215          * @param string $nickname string
216          * @param bool   $show_contacts
217          *
218          * @return array Profile
219          * @throws HTTPException\NotFoundException
220          * @throws HTTPException\InternalServerErrorException
221          * @throws \ImagickException
222          */
223         public static function load(App $a, string $nickname, bool $show_contacts = true): array
224         {
225                 $profile = User::getOwnerDataByNick($nickname);
226                 if (!isset($profile['account_removed']) || $profile['account_removed']) {
227                         Logger::info('profile error: ' . DI::args()->getQueryString());
228                         return [];
229                 }
230
231                 // System user, aborting
232                 if ($profile['uid'] === 0) {
233                         DI::logger()->warning('System user found in Profile::load', ['nickname' => $nickname, 'callstack' => System::callstack(20)]);
234                         throw new HTTPException\NotFoundException(DI::l10n()->t('User not found.'));
235                 }
236
237                 $a->setProfileOwner($profile['uid']);
238
239                 DI::page()['title'] = $profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
240
241                 if (!DI::userSession()->getLocalUserId()) {
242                         $a->setCurrentTheme($profile['theme']);
243                         $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme') ?? '');
244                 }
245
246                 /*
247                 * load/reload current theme info
248                 */
249
250                 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
251
252                 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
253                 if (file_exists($theme_info_file)) {
254                         require_once $theme_info_file;
255                 }
256
257                 $block = (DI::config()->get('system', 'block_public') && !DI::userSession()->isAuthenticated());
258
259                 /**
260                  * @todo
261                  * By now, the contact block isn't shown, when a different profile is given
262                  * But: When this profile was on the same server, then we could display the contacts
263                  */
264                 DI::page()['aside'] .= self::getVCardHtml($profile, $block, $show_contacts);
265
266                 return $profile;
267         }
268
269         /**
270          * Formats a profile for display in the sidebar.
271          *
272          * It is very difficult to templatise the HTML completely
273          * because of all the conditional logic.
274          *
275          * @param array $profile       Profile array
276          * @param bool  $block         Block personal details
277          * @param bool  $show_contacts Show contact block
278          *
279          * @return string HTML sidebar module
280          *
281          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
282          * @throws \ImagickException
283          * @note  Returns empty string if passed $profile is wrong type or not populated
284          *
285          * @hooks 'profile_sidebar_enter'
286          *      array $profile - profile data
287          * @hooks 'profile_sidebar'
288          *      array $arr
289          */
290         public static function getVCardHtml(array $profile, bool $block, bool $show_contacts): string
291         {
292                 $o = '';
293                 $location = false;
294
295                 $profile_contact = [];
296
297                 if (DI::userSession()->getLocalUserId() && ($profile['uid'] ?? 0) != DI::userSession()->getLocalUserId()) {
298                         $profile_contact = Contact::getByURL($profile['nurl'], null, [], DI::userSession()->getLocalUserId());
299                 }
300                 if (!empty($profile['cid']) && self::getMyURL()) {
301                         $profile_contact = Contact::selectFirst([], ['id' => $profile['cid']]);
302                 }
303
304                 $profile['picdate'] = urlencode($profile['picdate']);
305
306                 $profile['network_link'] = '';
307
308                 Hook::callAll('profile_sidebar_enter', $profile);
309
310                 $profile_url = $profile['url'];
311
312                 $cid = $profile['id'];
313
314                 $follow_link = null;
315                 $unfollow_link = null;
316                 $wallmessage_link = null;
317
318                 // Who is the logged-in user to this profile?
319                 $visitor_contact = [];
320                 if (!empty($profile['uid']) && self::getMyURL()) {
321                         $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
322                 }
323
324                 $local_user_is_self = self::getMyURL() && ($profile['url'] == self::getMyURL());
325                 $visitor_is_authenticated = (bool)self::getMyURL();
326                 $visitor_is_following =
327                         in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
328                         || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
329                 $visitor_is_followed =
330                         in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
331                         || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
332                 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
333
334                 if (!$local_user_is_self) {
335                         if (!$visitor_is_authenticated) {
336                                 // Remote follow is only available for local profiles
337                                 if (!empty($profile['nickname']) && strpos($profile_url, (string)DI::baseUrl()) === 0) {
338                                         $follow_link = 'profile/' . $profile['nickname'] . '/remote_follow';
339                                 }
340                         } else {
341                                 if ($visitor_is_following) {
342                                         $unfollow_link = $visitor_base_path . '/contact/unfollow?url=' . urlencode($profile_url) . '&auto=1';
343                                 } else {
344                                         $follow_link = $visitor_base_path . '/contact/follow?url=' . urlencode($profile_url) . '&auto=1';
345                                 }
346                         }
347
348                         if (Contact::canReceivePrivateMessages($profile_contact)) {
349                                 if ($visitor_is_followed || $visitor_is_following) {
350                                         $wallmessage_link = $visitor_base_path . '/message/new/' . $profile_contact['id'];
351                                 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
352                                         $wallmessage_link = 'profile/' . $profile['nickname'] . '/unkmail';
353                                 }
354                         }
355                 }
356
357                 // show edit profile to yourself, but only if this is not meant to be
358                 // rendered as a "contact". i.e., if 'self' (a "contact" table column) isn't
359                 // set in $profile.
360                 if (!isset($profile['self']) && $local_user_is_self) {
361                         $profile['edit'] = [DI::baseUrl() . '/settings/profile', DI::l10n()->t('Edit profile'), '', DI::l10n()->t('Edit profile')];
362                         $profile['menu'] = [
363                                 'chg_photo' => DI::l10n()->t('Change profile photo'),
364                                 'cr_new' => null,
365                                 'entries' => [],
366                         ];
367                 }
368
369                 // Fetch the account type
370                 $account_type = Contact::getAccountType($profile['account-type']);
371
372                 if (!empty($profile['address']) || !empty($profile['location'])) {
373                         $location = DI::l10n()->t('Location:');
374                 }
375
376                 $homepage = !empty($profile['homepage']) ? DI::l10n()->t('Homepage:') : false;
377                 $about    = !empty($profile['about'])    ? DI::l10n()->t('About:')    : false;
378                 $xmpp     = !empty($profile['xmpp'])     ? DI::l10n()->t('XMPP:')     : false;
379                 $matrix   = !empty($profile['matrix'])   ? DI::l10n()->t('Matrix:')   : false;
380
381                 if ((!empty($profile['hidewall']) || $block) && !DI::userSession()->isAuthenticated()) {
382                         $location = $homepage = $about = false;
383                 }
384
385                 $split_name = Diaspora::splitName($profile['name']);
386                 $firstname = $split_name['first'];
387                 $lastname = $split_name['last'];
388
389                 if (!empty($profile['guid'])) {
390                         $diaspora = [
391                                 'guid'       => $profile['guid'],
392                                 'podloc'     => DI::baseUrl(),
393                                 'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
394                                 'nickname'   => $profile['nickname'],
395                                 'fullname'   => $profile['name'],
396                                 'firstname'  => $firstname,
397                                 'lastname'   => $lastname,
398                                 'photo300'   => $profile['photo'] ?? '',
399                                 'photo100'   => $profile['thumb'] ?? '',
400                                 'photo50'    => $profile['micro'] ?? '',
401                         ];
402                 } else {
403                         $diaspora = false;
404                 }
405
406                 $contact_block = '';
407                 $updated = '';
408                 $contact_count = 0;
409
410                 if (!empty($profile['last-item'])) {
411                         $updated = date('c', strtotime($profile['last-item']));
412                 }
413
414                 if (!$block && $show_contacts) {
415                         $contact_block = ContactBlock::getHTML($profile, DI::userSession()->getLocalUserId());
416
417                         if (is_array($profile) && !$profile['hide-friends']) {
418                                 $contact_count = DBA::count('contact', [
419                                         'uid'     => $profile['uid'],
420                                         'self'    => false,
421                                         'blocked' => false,
422                                         'pending' => false,
423                                         'hidden'  => false,
424                                         'archive' => false,
425                                         'failed'  => false,
426                                         'network' => Protocol::FEDERATED,
427                                 ]);
428                         }
429                 }
430
431                 // Expected profile/vcard.tpl profile.* template variables
432                 $p = [
433                         'address' => null,
434                         'edit'    => null,
435                         'upubkey' => null,
436                 ];
437                 foreach ($profile as $k => $v) {
438                         $k = str_replace('-', '_', $k);
439                         $p[$k] = $v;
440                 }
441
442                 if (isset($p['about'])) {
443                         $p['about'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['about']);
444                 }
445
446                 if (isset($p['address'])) {
447                         $p['address'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['address']);
448                 }
449
450                 $p['photo'] = Contact::getAvatarUrlForId($cid, Proxy::SIZE_SMALL);
451
452                 $p['url'] = Contact::magicLinkById($cid, $profile['url']);
453
454                 if (!isset($profile['hidewall'])) {
455                         Logger::warning('Missing hidewall key in profile array', ['profile' => $profile, 'callstack' => System::callstack(10)]);
456                 }
457
458                 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
459                 $o .= Renderer::replaceMacros($tpl, [
460                         '$profile' => $p,
461                         '$xmpp' => $xmpp,
462                         '$matrix' => $matrix,
463                         '$follow' => DI::l10n()->t('Follow'),
464                         '$follow_link' => $follow_link,
465                         '$unfollow' => DI::l10n()->t('Unfollow'),
466                         '$unfollow_link' => $unfollow_link,
467                         '$subscribe_feed' => DI::l10n()->t('Atom feed'),
468                         '$subscribe_feed_link' => $profile['hidewall'] ?? 0 ? '' : $profile['poll'],
469                         '$wallmessage' => DI::l10n()->t('Message'),
470                         '$wallmessage_link' => $wallmessage_link,
471                         '$account_type' => $account_type,
472                         '$location' => $location,
473                         '$homepage' => $homepage,
474                         '$homepage_verified' => DI::l10n()->t('This website has been verified to belong to the same person.'),
475                         '$about' => $about,
476                         '$network' => DI::l10n()->t('Network:'),
477                         '$contacts' => $contact_count,
478                         '$updated' => $updated,
479                         '$diaspora' => $diaspora,
480                         '$contact_block' => $contact_block,
481                 ]);
482
483                 $arr = ['profile' => &$profile, 'entry' => &$o];
484
485                 Hook::callAll('profile_sidebar', $arr);
486
487                 return $o;
488         }
489
490         /**
491          * Returns the upcoming birthdays of contacts of the current user as HTML content
492          *
493          * @return string The upcoming birthdays (HTML)
494          * @throws HTTPException\InternalServerErrorException
495          * @throws HTTPException\ServiceUnavailableException
496          * @throws \ImagickException
497          */
498         public static function getBirthdays(): string
499         {
500                 if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
501                         return '';
502                 }
503
504                 /*
505                 * $mobile_detect = new Mobile_Detect();
506                 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
507                 *               if ($is_mobile)
508                 *                       return $o;
509                 */
510
511                 $bd_short = DI::l10n()->t('F d');
512
513                 $cacheKey = 'get_birthdays:' . DI::userSession()->getLocalUserId();
514                 $events   = DI::cache()->get($cacheKey);
515                 if (is_null($events)) {
516                         $result = DBA::p(
517                                 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
518                                 INNER JOIN `contact`
519                                         ON `contact`.`id` = `event`.`cid`
520                                         AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
521                                         AND NOT `contact`.`pending`
522                                         AND NOT `contact`.`hidden`
523                                         AND NOT `contact`.`blocked`
524                                         AND NOT `contact`.`archive`
525                                         AND NOT `contact`.`deleted`
526                                 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
527                                 ORDER BY `start`",
528                                 Contact::SHARING,
529                                 Contact::FRIEND,
530                                 DI::userSession()->getLocalUserId(),
531                                 DateTimeFormat::utc('now + 6 days'),
532                                 DateTimeFormat::utcNow()
533                         );
534                         if (DBA::isResult($result)) {
535                                 $events = DBA::toArray($result);
536                                 DI::cache()->set($cacheKey, $events, Duration::HOUR);
537                         }
538                 }
539
540                 $total      = 0;
541                 $classToday = '';
542                 $tpl_events = [];
543                 if (DBA::isResult($events)) {
544                         $now  = strtotime('now');
545                         $cids = [];
546
547                         $isToday = false;
548                         foreach ($events as $event) {
549                                 if (strlen($event['name'])) {
550                                         $total++;
551                                 }
552                                 if ((strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now)) {
553                                         $isToday = true;
554                                 }
555                         }
556                         $classToday = $isToday ? ' birthday-today ' : '';
557                         if ($total) {
558                                 foreach ($events as $event) {
559                                         if (!strlen($event['name'])) {
560                                                 continue;
561                                         }
562
563                                         // avoid duplicates
564                                         if (in_array($event['cid'], $cids)) {
565                                                 continue;
566                                         }
567                                         $cids[] = $event['cid'];
568
569                                         $today = (strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now);
570
571                                         $tpl_events[] = [
572                                                 'id'    => $event['id'],
573                                                 'link'  => Contact::magicLinkById($event['cid']),
574                                                 'title' => $event['name'],
575                                                 'date'  => DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '')
576                                         ];
577                                 }
578                         }
579                 }
580                 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
581                 return Renderer::replaceMacros($tpl, [
582                         '$classtoday'      => $classToday,
583                         '$count'           => $total,
584                         '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
585                         '$event_title'     => DI::l10n()->t('Birthdays this week:'),
586                         '$events'          => $tpl_events,
587                         '$lbr'             => '{', // raw brackets mess up if/endif macro processing
588                         '$rbr'             => '}'
589                 ]);
590         }
591
592         /**
593          * Renders HTML for event reminder (e.g. contact birthdays
594          *
595          * @return string Rendered HTML
596          */
597         public static function getEventsReminderHTML(): string
598         {
599                 $a = DI::app();
600                 $o = '';
601
602                 if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
603                         return $o;
604                 }
605
606                 /*
607                 *       $mobile_detect = new Mobile_Detect();
608                 *               $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
609                 *               if ($is_mobile)
610                 *                       return $o;
611                 */
612
613                 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
614                 $classtoday = '';
615
616                 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
617                         DI::userSession()->getLocalUserId(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
618                 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
619
620                 $r = [];
621
622                 if (DBA::isResult($s)) {
623                         $istoday = false;
624                         $total = 0;
625
626                         while ($rr = DBA::fetch($s)) {
627                                 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => DI::userSession()->getPublicContactId(),
628                                         'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
629                                         'visible' => true, 'deleted' => false];
630                                 if (!Post::exists($condition)) {
631                                         continue;
632                                 }
633
634                                 if (strlen($rr['summary'])) {
635                                         $total++;
636                                 }
637
638                                 $strt = DateTimeFormat::local($rr['start'], 'Y-m-d');
639                                 if ($strt === DateTimeFormat::localNow('Y-m-d')) {
640                                         $istoday = true;
641                                 }
642
643                                 $title = strip_tags(html_entity_decode(BBCode::convertForUriId($rr['uri-id'], $rr['summary']), ENT_QUOTES, 'UTF-8'));
644
645                                 if (strlen($title) > 35) {
646                                         $title = substr($title, 0, 32) . '... ';
647                                 }
648
649                                 $description = substr(strip_tags(BBCode::convertForUriId($rr['uri-id'], $rr['desc'])), 0, 32) . '... ';
650                                 if (!$description) {
651                                         $description = DI::l10n()->t('[No description]');
652                                 }
653
654                                 $strt = DateTimeFormat::local($rr['start']);
655
656                                 if (substr($strt, 0, 10) < DateTimeFormat::localNow('Y-m-d')) {
657                                         continue;
658                                 }
659
660                                 $today = substr($strt, 0, 10) === DateTimeFormat::localNow('Y-m-d');
661
662                                 $rr['title'] = $title;
663                                 $rr['description'] = $description;
664                                 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::local($rr['start'], $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
665                                 $rr['startime'] = $strt;
666                                 $rr['today'] = $today;
667
668                                 $r[] = $rr;
669                         }
670                         DBA::close($s);
671                         $classtoday = (($istoday) ? 'event-today' : '');
672                 }
673                 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
674                 return Renderer::replaceMacros($tpl, [
675                         '$classtoday' => $classtoday,
676                         '$count' => count($r),
677                         '$event_reminders' => DI::l10n()->t('Event Reminders'),
678                         '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
679                         '$events' => $r,
680                 ]);
681         }
682
683         /**
684          * Retrieves the my_url session variable
685          *
686          * @return string
687          * @deprecated since version 2022.12, please use UserSession->getMyUrl instead
688          */
689         public static function getMyURL(): string
690         {
691                 return DI::userSession()->getMyUrl();
692         }
693
694         /**
695          * Process the 'zrl' parameter and initiate the remote authentication.
696          *
697          * This method checks if the visitor has a public contact entry and
698          * redirects the visitor to his/her instance to start the magic auth (Authentication)
699          * process.
700          *
701          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
702          *
703          * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
704          * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
705          * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
706          *
707          * It would be favourable to harmonize the two implementations.
708          *
709          * @param App $a Application instance.
710          *
711          * @return void
712          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
713          * @throws \ImagickException
714          */
715         public static function zrlInit(App $a)
716         {
717                 $my_url = self::getMyURL();
718                 $my_url = Network::isUrlValid($my_url);
719
720                 if (empty($my_url) || DI::userSession()->getLocalUserId()) {
721                         return;
722                 }
723
724                 $addr = $_GET['addr'] ?? $my_url;
725
726                 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
727                 Hook::callAll('zrl_init', $arr);
728
729                 // Try to find the public contact entry of the visitor.
730                 $cid = Contact::getIdForURL($my_url);
731                 if (!$cid) {
732                         Logger::info('No contact record found for ' . $my_url);
733                         return;
734                 }
735
736                 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
737
738                 if (DBA::isResult($contact) && DI::userSession()->getRemoteUserId() && DI::userSession()->getRemoteUserId() == $contact['id']) {
739                         Logger::info('The visitor ' . $my_url . ' is already authenticated');
740                         return;
741                 }
742
743                 // Avoid endless loops
744                 $cachekey = 'zrlInit:' . $my_url;
745                 if (DI::cache()->get($cachekey)) {
746                         Logger::info('URL ' . $my_url . ' already tried to authenticate.');
747                         return;
748                 } else {
749                         DI::cache()->set($cachekey, true, Duration::MINUTE);
750                 }
751
752                 Logger::info('Not authenticated. Invoking reverse magic-auth for ' . $my_url);
753
754                 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
755                 $addr_request = 'addr=' . urlencode($addr);
756                 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
757
758                 // The other instance needs to know where to redirect.
759                 $dest = urlencode(DI::baseUrl() . '/' . $query);
760
761                 // We need to extract the basebath from the profile url
762                 // to redirect the visitors '/magic' module.
763                 $basepath = Contact::getBasepath($contact['url']);
764
765                 if ($basepath != DI::baseUrl() && !strstr($dest, '/magic')) {
766                         $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
767
768                         // We have to check if the remote server does understand /magic without invoking something
769                         $serverret = DI::httpClient()->head($basepath . '/magic', [HttpClientOptions::ACCEPT_CONTENT => HttpClientAccept::HTML]);
770                         if ($serverret->isSuccess()) {
771                                 Logger::info('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path);
772                                 System::externalRedirect($magic_path);
773                         }
774                 }
775         }
776
777         /**
778          * Set the visitor cookies (see remote_user()) for the given handle
779          *
780          * @param string $handle Visitor handle
781          *
782          * @return array Visitor contact array
783          */
784         public static function addVisitorCookieForHandle(string $handle): array
785         {
786                 $a = DI::app();
787
788                 // Try to find the public contact entry of the visitor.
789                 $cid = Contact::getIdForURL($handle);
790                 if (!$cid) {
791                         Logger::info('Handle not found', ['handle' => $handle]);
792                         return [];
793                 }
794
795                 $visitor = Contact::getById($cid);
796
797                 // Authenticate the visitor.
798                 DI::userSession()->setMultiple([
799                         'authenticated'  => 1,
800                         'visitor_id'     => $visitor['id'],
801                         'visitor_handle' => $visitor['addr'],
802                         'visitor_home'   => $visitor['url'],
803                         'my_url'         => $visitor['url'],
804                         'remote_comment' => $visitor['subscribe'],
805                 ]);
806
807                 DI::userSession()->setVisitorsContacts($visitor['url']);
808
809                 $a->setContactId($visitor['id']);
810
811                 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
812
813                 return $visitor;
814         }
815
816         /**
817          * Set the visitor cookies (see remote_user()) for signed HTTP requests
818          (
819          * @return array Visitor contact array
820          */
821         public static function addVisitorCookieForHTTPSigner(): array
822         {
823                 $requester = HTTPSignature::getSigner('', $_SERVER);
824                 if (empty($requester)) {
825                         return [];
826                 }
827                 return Profile::addVisitorCookieForHandle($requester);
828         }
829
830         /**
831          * OpenWebAuth authentication.
832          *
833          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
834          *
835          * @param string $token
836          *
837          * @return void
838          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
839          * @throws \ImagickException
840          */
841         public static function openWebAuthInit(string $token)
842         {
843                 $a = DI::app();
844
845                 // Clean old OpenWebAuthToken entries.
846                 OpenWebAuthToken::purge('owt', '3 MINUTE');
847
848                 // Check if the token we got is the same one
849                 // we have stored in the database.
850                 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
851
852                 if ($visitor_handle === false) {
853                         return;
854                 }
855
856                 $visitor = self::addVisitorCookieForHandle($visitor_handle);
857                 if (empty($visitor)) {
858                         return;
859                 }
860
861                 $arr = [
862                         'visitor' => $visitor,
863                         'url' => DI::args()->getQueryString()
864                 ];
865                 /**
866                  * @hooks magic_auth_success
867                  *   Called when a magic-auth was successful.
868                  *   * \e array \b visitor
869                  *   * \e string \b url
870                  */
871                 Hook::callAll('magic_auth_success', $arr);
872
873                 $a->setContactId($arr['visitor']['id']);
874
875                 DI::sysmsg()->addInfo(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHost(), $visitor['name']));
876
877                 Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
878         }
879
880         /**
881          * Returns URL with URL-encoded zrl parameter
882          *
883          * @param string $url   URL to enhance
884          * @param bool   $force Either to force adding zrl parameter
885          *
886          * @return string URL with 'zrl' parameter or original URL in case of no Friendica profile URL
887          */
888         public static function zrl(string $url, bool $force = false): string
889         {
890                 if (!strlen($url)) {
891                         return $url;
892                 }
893                 if (!strpos($url, '/profile/') && !$force) {
894                         return $url;
895                 }
896                 if ($force && substr($url, -1, 1) !== '/') {
897                         $url = $url . '/';
898                 }
899
900                 $achar = strpos($url, '?') ? '&' : '?';
901                 $mine = self::getMyURL();
902
903                 if ($mine && !Strings::compareLink($mine, $url)) {
904                         return $url . $achar . 'zrl=' . urlencode($mine);
905                 }
906
907                 return $url;
908         }
909
910         /**
911          * Get the user ID of the page owner.
912          *
913          * Used from within PCSS themes to set theme parameters. If there's a
914          * profile_uid variable set in App, that is the "page owner" and normally their theme
915          * settings take precedence; unless a local user is logged in which means they don't
916          * want to see anybody else's theme settings except their own while on this site.
917          *
918          * @param App $a
919          *
920          * @return int user ID
921          *
922          * @note Returns local_user instead of user ID if "always_my_theme" is set to true
923          */
924         public static function getThemeUid(App $a): int
925         {
926                 return DI::userSession()->getLocalUserId() ?: $a->getProfileOwner();
927         }
928
929         /**
930          * search for Profiles
931          *
932          * @param int  $start Starting record (see LIMIT start,count)
933          * @param int  $count Maximum records (see LIMIT start,count)
934          * @param string $search Optional search word (see LIKE %s?%s)
935          *
936          * @return array [ 'total' => 123, 'entries' => [...] ];
937          *
938          * @throws \Exception
939          */
940         public static function searchProfiles(int $start = 0, int $count = 100, string $search = null): array
941         {
942                 if (!empty($search)) {
943                         $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
944                         $searchTerm = '%' . $search . '%';
945                         $condition = ["NOT `blocked` AND NOT `account_removed`
946                                 $publish
947                                 AND ((`name` LIKE ?) OR
948                                 (`nickname` LIKE ?) OR
949                                 (`about` LIKE ?) OR
950                                 (`locality` LIKE ?) OR
951                                 (`region` LIKE ?) OR
952                                 (`country-name` LIKE ?) OR
953                                 (`pub_keywords` LIKE ?) OR
954                                 (`prv_keywords` LIKE ?))",
955                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
956                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
957                 } else {
958                         $condition = ['blocked' => false, 'account_removed' => false];
959                         if (!DI::config()->get('system', 'publish_all')) {
960                                 $condition['publish'] = true;
961                         }
962                 }
963
964                 $total = DBA::count('owner-view', $condition);
965
966                 // If nothing found, don't try to select details
967                 if ($total > 0) {
968                         $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
969                 } else {
970                         $profiles = [];
971                 }
972
973                 return ['total' => $total, 'entries' => $profiles];
974         }
975
976         /**
977          * Migrates a legacy profile to the new slimmer profile with extra custom fields.
978          * Multi profiles are converted to ACl-protected custom fields and deleted.
979          *
980          * @param array $profile One profile array
981          *
982          * @return void
983          * @throws \Exception
984          */
985         public static function migrate(array $profile)
986         {
987                 // Already processed, aborting
988                 if ($profile['is-default'] === null) {
989                         return;
990                 }
991
992                 $contacts = [];
993
994                 if (!$profile['is-default']) {
995                         $contacts = Contact::selectToArray(['id'], [
996                                 'uid'        => $profile['uid'],
997                                 'profile-id' => $profile['id']
998                         ]);
999                         if (!count($contacts)) {
1000                                 // No contact visibility selected defaults to user-only permission
1001                                 $contacts = Contact::selectToArray(['id'], ['uid' => $profile['uid'], 'self' => true]);
1002                         }
1003                 }
1004
1005                 $permissionSet = DI::permissionSet()->selectOrCreate(
1006                         new PermissionSet(
1007                                 $profile['uid'],
1008                                 array_column($contacts, 'id') ?? []
1009                         )
1010                 );
1011
1012                 $order = 1;
1013
1014                 $custom_fields = [
1015                         'hometown'  => DI::l10n()->t('Hometown:'),
1016                         'marital'   => DI::l10n()->t('Marital Status:'),
1017                         'with'      => DI::l10n()->t('With:'),
1018                         'howlong'   => DI::l10n()->t('Since:'),
1019                         'sexual'    => DI::l10n()->t('Sexual Preference:'),
1020                         'politic'   => DI::l10n()->t('Political Views:'),
1021                         'religion'  => DI::l10n()->t('Religious Views:'),
1022                         'likes'     => DI::l10n()->t('Likes:'),
1023                         'dislikes'  => DI::l10n()->t('Dislikes:'),
1024                         'pdesc'     => DI::l10n()->t('Title/Description:'),
1025                         'summary'   => DI::l10n()->t('Summary'),
1026                         'music'     => DI::l10n()->t('Musical interests'),
1027                         'book'      => DI::l10n()->t('Books, literature'),
1028                         'tv'        => DI::l10n()->t('Television'),
1029                         'film'      => DI::l10n()->t('Film/dance/culture/entertainment'),
1030                         'interest'  => DI::l10n()->t('Hobbies/Interests'),
1031                         'romance'   => DI::l10n()->t('Love/romance'),
1032                         'work'      => DI::l10n()->t('Work/employment'),
1033                         'education' => DI::l10n()->t('School/education'),
1034                         'contact'   => DI::l10n()->t('Contact information and Social Networks'),
1035                 ];
1036
1037                 foreach ($custom_fields as $field => $label) {
1038                         if (!empty($profile[$field]) && $profile[$field] > DBA::NULL_DATE && $profile[$field] > DBA::NULL_DATETIME) {
1039                                 DI::profileField()->save(DI::profileFieldFactory()->createFromValues(
1040                                         $profile['uid'],
1041                                         $order,
1042                                         trim($label, ':'),
1043                                         $profile[$field],
1044                                         $permissionSet
1045                                 ));
1046                         }
1047
1048                         $profile[$field] = null;
1049                 }
1050
1051                 if ($profile['is-default']) {
1052                         $profile['profile-name'] = null;
1053                         $profile['is-default']   = null;
1054                         DBA::update('profile', $profile, ['id' => $profile['id']]);
1055                 } else if (!empty($profile['id'])) {
1056                         DBA::delete('profile', ['id' => $profile['id']]);
1057                 }
1058         }
1059 }