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