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