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