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