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