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