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