]> git.mxchange.org Git - friendica.git/blob - src/Model/Profile.php
Use getByNickname as suggested in code review.
[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\Session;
33 use Friendica\Core\System;
34 use Friendica\Database\DBA;
35 use Friendica\DI;
36 use Friendica\Protocol\Activity;
37 use Friendica\Protocol\Diaspora;
38 use Friendica\Util\DateTimeFormat;
39 use Friendica\Util\Network;
40 use Friendica\Util\Proxy as ProxyUtils;
41 use Friendica\Util\Strings;
42
43 class Profile
44 {
45         /**
46          * Returns default profile for a given user id
47          *
48          * @param integer User ID
49          *
50          * @return array Profile data
51          * @throws \Exception
52          */
53         public static function getByUID($uid)
54         {
55                 return DBA::selectFirst('profile', [], ['uid' => $uid]);
56         }
57
58         /**
59          * Returns default profile for a given user ID and ID
60          *
61          * @param int $uid The contact ID
62          * @param int $id The contact owner ID
63          * @param array $fields The selected fields
64          *
65          * @return array Profile data for the ID
66          * @throws \Exception
67          */
68         public static function getById(int $uid, int $id, array $fields = [])
69         {
70                 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
71         }
72
73         /**
74          * Returns profile data for the contact owner
75          *
76          * @param int $uid The User ID
77          * @param array $fields The fields to retrieve
78          *
79          * @return array Array of profile data
80          * @throws \Exception
81          */
82         public static function getListByUser(int $uid, array $fields = [])
83         {
84                 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
85         }
86
87         /**
88          * Returns a formatted location string from the given profile array
89          *
90          * @param array $profile Profile array (Generated from the "profile" table)
91          *
92          * @return string Location string
93          */
94         public static function formatLocation(array $profile)
95         {
96                 $location = '';
97
98                 if (!empty($profile['locality'])) {
99                         $location .= $profile['locality'];
100                 }
101
102                 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
103                         if ($location) {
104                                 $location .= ', ';
105                         }
106
107                         $location .= $profile['region'];
108                 }
109
110                 if (!empty($profile['country-name'])) {
111                         if ($location) {
112                                 $location .= ', ';
113                         }
114
115                         $location .= $profile['country-name'];
116                 }
117
118                 return $location;
119         }
120
121         /**
122          * Loads a profile into the page sidebar.
123          *
124          * The function requires a writeable copy of the main App structure, and the nickname
125          * of a registered local account.
126          *
127          * If the viewer is an authenticated remote viewer, the profile displayed is the
128          * one that has been configured for his/her viewing in the Contact manager.
129          * Passing a non-zero profile ID can also allow a preview of a selected profile
130          * by the owner.
131          *
132          * Profile information is placed in the App structure for later retrieval.
133          * Honours the owner's chosen theme for display.
134          *
135          * @attention Should only be run in the _init() functions of a module. That ensures that
136          *      the theme is chosen before the _init() function of a theme is run, which will usually
137          *      load a lot of theme-specific content
138          *
139          * @param App     $a
140          * @param string  $nickname     string
141          * @param array   $profiledata  array
142          * @param boolean $show_connect Show connect link
143          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
144          * @throws \ImagickException
145          */
146         public static function load(App $a, $nickname, array $profiledata = [], $show_connect = true)
147         {
148                 $user = User::getByNickname($nickname);
149
150                 if (!DBA::isResult($user) && empty($profiledata)) {
151                         Logger::log('profile error: ' . DI::args()->getQueryString(), Logger::DEBUG);
152                         return;
153                 }
154
155                 if (count($profiledata) > 0) {
156                         // Ensure to have a "nickname" field
157                         if (empty($profiledata['nickname']) && !empty($profiledata['nick'])) {
158                                 $profiledata['nickname'] = $profiledata['nick'];
159                         }
160
161                         // Add profile data to sidebar
162                         DI::page()['aside'] .= self::sidebar($a, $profiledata, true, $show_connect);
163
164                         if (!DBA::isResult($user)) {
165                                 return;
166                         }
167                 }
168
169                 if (empty($user['uid'])) {
170                         $profile = [];
171                 } else {
172                         $profile = array_merge(
173                                 $user,
174                                 Profile::getByUID($user['uid']),
175                                 Contact::getById(Contact::getIdForURL(Strings::normaliseLink(DI::baseurl() . '/profile/' . $nickname), local_user()))
176                         );
177                         $profile['cid'] = $profile['id'];
178                 }
179
180                 if (empty($profile) && empty($profiledata)) {
181                         Logger::log('profile error: ' . DI::args()->getQueryString(), Logger::DEBUG);
182                         return;
183                 }
184
185                 if (empty($profile)) {
186                         $profile = ['uid' => 0, 'name' => $nickname];
187                 }
188
189                 $a->profile = $profile;
190                 $a->profile_uid = $profile['uid'];
191
192                 $a->profile['mobile-theme'] = DI::pConfig()->get($a->profile['uid'], 'system', 'mobile_theme');
193                 $a->profile['network'] = Protocol::DFRN;
194
195                 DI::page()['title'] = $a->profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
196
197                 if (!$profiledata && !DI::pConfig()->get(local_user(), 'system', 'always_my_theme')) {
198                         $a->setCurrentTheme($a->profile['theme']);
199                         $a->setCurrentMobileTheme($a->profile['mobile-theme']);
200                 }
201
202                 /*
203                 * load/reload current theme info
204                 */
205
206                 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
207
208                 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
209                 if (file_exists($theme_info_file)) {
210                         require_once $theme_info_file;
211                 }
212
213                 $block = ((DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) ? true : false);
214
215                 /**
216                  * @todo
217                  * By now, the contact block isn't shown, when a different profile is given
218                  * But: When this profile was on the same server, then we could display the contacts
219                  */
220                 if (!$profiledata) {
221                         DI::page()['aside'] .= self::sidebar($a, $a->profile, $block, $show_connect);
222                 }
223
224                 return;
225         }
226
227         /**
228          * Get all profile data of a local user
229          *
230          * If the viewer is an authenticated remote viewer, the profile displayed is the
231          * one that has been configured for his/her viewing in the Contact manager.
232          * Passing a non-zero profile ID can also allow a preview of a selected profile
233          * by the owner
234          *
235          * Includes all available profile data
236          *
237          * @param string $nickname   nick
238          * @param int    $uid        uid
239          * @param int    $profile_id ID of the profile
240          * @return array
241          * @throws \Exception
242          */
243         public static function getByNickname($nickname, $uid = 0)
244         {
245                 $profile = DBA::selectFirst('owner-view', [], ['nickname' => $nickname, 'uid' => $uid]);
246                 return $profile;
247         }
248
249         /**
250          * Formats a profile for display in the sidebar.
251          *
252          * It is very difficult to templatise the HTML completely
253          * because of all the conditional logic.
254          *
255          * @param array   $profile
256          * @param int     $block
257          * @param boolean $show_connect Show connect link
258          *
259          * @return string HTML sidebar module
260          *
261          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
262          * @throws \ImagickException
263          * @note  Returns empty string if passed $profile is wrong type or not populated
264          *
265          * @hooks 'profile_sidebar_enter'
266          *      array $profile - profile data
267          * @hooks 'profile_sidebar'
268          *      array $arr
269          */
270         private static function sidebar(App $a, array $profile, $block = 0, $show_connect = true)
271         {
272                 $o = '';
273                 $location = false;
274
275                 // This function can also use contact information in $profile
276                 $is_contact = !empty($profile['cid']);
277
278                 if (empty($profile['nickname'])) {
279                         Logger::warning('Received profile with no nickname', ['profile' => $profile, 'callstack' => System::callstack(10)]);
280                         return $o;
281                 }
282
283                 $profile['picdate'] = urlencode($profile['picdate'] ?? '');
284
285                 if (($profile['network'] != '') && ($profile['network'] != Protocol::DFRN)) {
286                         $profile['network_link'] = Strings::formatNetworkName($profile['network'], $profile['url']);
287                 } else {
288                         $profile['network_link'] = '';
289                 }
290
291                 Hook::callAll('profile_sidebar_enter', $profile);
292
293                 if (isset($profile['url'])) {
294                         $profile_url = $profile['url'];
295                 } else {
296                         $profile_url = DI::baseUrl()->get() . '/profile/' . $profile['nickname'];
297                 }
298
299                 $follow_link = null;
300                 $unfollow_link = null;
301                 $subscribe_feed_link = null;
302                 $wallmessage_link = null;
303
304                 $visitor_contact = [];
305                 if (!empty($profile['uid']) && self::getMyURL()) {
306                         $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
307                 }
308
309                 $profile_contact = [];
310                 if (!empty($profile['cid']) && self::getMyURL()) {
311                         $profile_contact = Contact::selectFirst(['rel'], ['id' => $profile['cid']]);
312                 }
313
314                 $profile_is_dfrn = $profile['network'] == Protocol::DFRN;
315                 $profile_is_native = in_array($profile['network'], Protocol::NATIVE_SUPPORT);
316                 $local_user_is_self = self::getMyURL() && ($profile['url'] == self::getMyURL());
317                 $visitor_is_authenticated = (bool)self::getMyURL();
318                 $visitor_is_following =
319                         in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
320                         || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
321                 $visitor_is_followed =
322                         in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
323                         || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
324                 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
325
326                 if (!$local_user_is_self && $show_connect) {
327                         if (!$visitor_is_authenticated) {
328                                 // Remote follow is only available for local profiles
329                                 if (!empty($profile['nickname']) && strpos($profile_url, DI::baseUrl()->get()) === 0) {
330                                         $follow_link = 'remote_follow/' . $profile['nickname'];
331                                 }
332                         } elseif ($profile_is_native) {
333                                 if ($visitor_is_following) {
334                                         $unfollow_link = $visitor_base_path . '/unfollow?url=' . urlencode($profile_url) . '&auto=1';
335                                 } else {
336                                         $follow_link =  $visitor_base_path .'/follow?url=' . urlencode($profile_url) . '&auto=1';
337                                 }
338                         }
339
340                         if ($profile_is_dfrn) {
341                                 $subscribe_feed_link = 'dfrn_poll/' . $profile['nickname'];
342                         }
343
344                         if (Contact::canReceivePrivateMessages($profile)) {
345                                 if ($visitor_is_followed || $visitor_is_following) {
346                                         $wallmessage_link = $visitor_base_path . '/message/new/' . $profile['cid'];
347                                 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
348                                         $wallmessage_link = 'wallmessage/' . $profile['nickname'];
349                                 }
350                         }
351                 }
352
353                 // show edit profile to yourself
354                 if (!$is_contact && $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
374                 if ((!empty($profile['hidewall']) || $block) && !Session::isAuthenticated()) {
375                         $location = $homepage = $about = false;
376                 }
377
378                 $split_name = Diaspora::splitName($profile['name']);
379                 $firstname = $split_name['first'];
380                 $lastname = $split_name['last'];
381
382                 if (!empty($profile['guid'])) {
383                         $diaspora = [
384                                 'guid' => $profile['guid'],
385                                 'podloc' => DI::baseUrl(),
386                                 'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
387                                 'nickname' => $profile['nickname'],
388                                 'fullname' => $profile['name'],
389                                 'firstname' => $firstname,
390                                 'lastname' => $lastname,
391                                 'photo300' => $profile['photo'] ?? '',
392                                 'photo100' => $profile['thumb'] ?? '',
393                                 'photo50' => $profile['micro'] ?? '',
394                         ];
395                 } else {
396                         $diaspora = false;
397                 }
398
399                 $contact_block = '';
400                 $updated = '';
401                 $contact_count = 0;
402
403                 if (!empty($profile['last-item'])) {
404                         $updated = date('c', strtotime($profile['last-item']));
405                 }
406
407                 if (!$block) {
408                         $contact_block = ContactBlock::getHTML($a->profile);
409
410                         if (is_array($a->profile) && !$a->profile['hide-friends']) {
411                                 $contact_count = DBA::count('contact', [
412                                         'uid' => $profile['uid'],
413                                         'self' => false,
414                                         'blocked' => false,
415                                         'pending' => false,
416                                         'hidden' => false,
417                                         'archive' => false,
418                                         'failed' => false,
419                                         'network' => Protocol::FEDERATED,
420                                 ]);
421                         }
422                 }
423
424                 // Expected profile/vcard.tpl profile.* template variables
425                 $p = [
426                         'address' => null,
427                         'edit' => null,
428                         'upubkey' => null,
429                 ];
430                 foreach ($profile as $k => $v) {
431                         $k = str_replace('-', '_', $k);
432                         $p[$k] = $v;
433                 }
434
435                 if (isset($p['about'])) {
436                         $p['about'] = BBCode::convert($p['about']);
437                 }
438
439                 if (isset($p['address'])) {
440                         $p['address'] = BBCode::convert($p['address']);
441                 }
442
443                 if (isset($p['photo'])) {
444                         $p['photo'] = ProxyUtils::proxifyUrl($p['photo'], false, ProxyUtils::SIZE_SMALL);
445                 }
446
447                 $p['url'] = Contact::magicLink(($p['url'] ?? '') ?: $profile_url);
448
449                 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
450                 $o .= Renderer::replaceMacros($tpl, [
451                         '$profile' => $p,
452                         '$xmpp' => $xmpp,
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' => $subscribe_feed_link,
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::convert($rr['start'], $a->timezone, 'UTC', $rr['adjust'] ? $bd_format : $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::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', 'Y-m-d');
618                                 if ($strt === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
619                                         $istoday = true;
620                                 }
621
622                                 $title = strip_tags(html_entity_decode(BBCode::convert($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::convert($rr['desc'])), 0, 32) . '... ';
629                                 if (!$description) {
630                                         $description = DI::l10n()->t('[No description]');
631                                 }
632
633                                 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC');
634
635                                 if (substr($strt, 0, 10) < DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
636                                         continue;
637                                 }
638
639                                 $today = ((substr($strt, 0, 10) === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) ? true : false);
640
641                                 $rr['title'] = $title;
642                                 $rr['description'] = $description;
643                                 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', $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::httpRequest()->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::log('unable to finger ' . $handle, Logger::DEBUG);
767                         return [];
768                 }
769
770                 $visitor = DBA::selectFirst('contact', [], ['id' => $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->contact = $visitor;
783
784                 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
785
786                 return $visitor;
787         }
788
789         /**
790          * OpenWebAuth authentication.
791          *
792          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
793          *
794          * @param string $token
795          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
796          * @throws \ImagickException
797          */
798         public static function openWebAuthInit($token)
799         {
800                 $a = DI::app();
801
802                 // Clean old OpenWebAuthToken entries.
803                 OpenWebAuthToken::purge('owt', '3 MINUTE');
804
805                 // Check if the token we got is the same one
806                 // we have stored in the database.
807                 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
808
809                 if ($visitor_handle === false) {
810                         return;
811                 }
812
813                 $visitor = self::addVisitorCookieForHandle($visitor_handle);
814                 if (empty($visitor)) {
815                         return;
816                 }
817
818                 $arr = [
819                         'visitor' => $visitor,
820                         'url' => DI::args()->getQueryString()
821                 ];
822                 /**
823                  * @hooks magic_auth_success
824                  *   Called when a magic-auth was successful.
825                  *   * \e array \b visitor
826                  *   * \e string \b url
827                  */
828                 Hook::callAll('magic_auth_success', $arr);
829
830                 $a->contact = $arr['visitor'];
831
832                 info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
833
834                 Logger::log('OpenWebAuth: auth success from ' . $visitor['addr'], Logger::DEBUG);
835         }
836
837         public static function zrl($s, $force = false)
838         {
839                 if (!strlen($s)) {
840                         return $s;
841                 }
842                 if (!strpos($s, '/profile/') && !$force) {
843                         return $s;
844                 }
845                 if ($force && substr($s, -1, 1) !== '/') {
846                         $s = $s . '/';
847                 }
848                 $achar = strpos($s, '?') ? '&' : '?';
849                 $mine = self::getMyURL();
850                 if ($mine && !Strings::compareLink($mine, $s)) {
851                         return $s . $achar . 'zrl=' . urlencode($mine);
852                 }
853                 return $s;
854         }
855
856         /**
857          * Get the user ID of the page owner.
858          *
859          * Used from within PCSS themes to set theme parameters. If there's a
860          * profile_uid variable set in App, that is the "page owner" and normally their theme
861          * settings take precedence; unless a local user sets the "always_my_theme"
862          * system pconfig, which means they don't want to see anybody else's theme
863          * settings except their own while on this site.
864          *
865          * @return int user ID
866          *
867          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
868          * @note Returns local_user instead of user ID if "always_my_theme" is set to true
869          */
870         public static function getThemeUid(App $a)
871         {
872                 $uid = !empty($a->profile_uid) ? intval($a->profile_uid) : 0;
873                 if (local_user() && (DI::pConfig()->get(local_user(), 'system', 'always_my_theme') || !$uid)) {
874                         return local_user();
875                 }
876
877                 return $uid;
878         }
879
880         /**
881          * search for Profiles
882          *
883          * @param int  $start
884          * @param int  $count
885          * @param null $search
886          *
887          * @return array [ 'total' => 123, 'entries' => [...] ];
888          *
889          * @throws \Exception
890          */
891         public static function searchProfiles($start = 0, $count = 100, $search = null)
892         {
893                 if (!empty($search)) {
894                         $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
895                         $searchTerm = '%' . $search . '%';
896                         $condition = ["NOT `blocked` AND NOT `account_removed`
897                                 $publish
898                                 AND ((`name` LIKE ?) OR
899                                 (`nickname` LIKE ?) OR
900                                 (`about` LIKE ?) OR
901                                 (`locality` LIKE ?) OR
902                                 (`region` LIKE ?) OR
903                                 (`country-name` LIKE ?) OR
904                                 (`pub_keywords` LIKE ?) OR
905                                 (`prv_keywords` LIKE ?))",
906                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
907                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
908                 } else {
909                         $condition = ['blocked' => false, 'account_removed' => false];
910                         if (!DI::config()->get('system', 'publish_all')) {
911                                 $condition['publish'] = true;
912                         }
913                 }
914
915                 $total = DBA::count('owner-view', $condition);
916
917                 // If nothing found, don't try to select details
918                 if ($total > 0) {
919                         $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
920                 } else {
921                         $profiles = [];
922                 }
923
924                 return ['total' => $total, 'entries' => $profiles];
925         }
926 }