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