]> git.mxchange.org Git - friendica.git/blob - src/Model/Profile.php
Merge branch 'develop' of https://github.com/friendica/friendica into develop
[friendica.git] / src / Model / Profile.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2021, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Model;
23
24 use Friendica\App;
25 use Friendica\Content\Text\BBCode;
26 use Friendica\Content\Widget\ContactBlock;
27 use Friendica\Core\Cache\Duration;
28 use Friendica\Core\Hook;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\Renderer;
32 use Friendica\Core\Session;
33 use Friendica\Core\System;
34 use Friendica\Database\DBA;
35 use Friendica\DI;
36 use Friendica\Protocol\Activity;
37 use Friendica\Protocol\Diaspora;
38 use Friendica\Util\DateTimeFormat;
39 use Friendica\Util\Network;
40 use Friendica\Util\Proxy as ProxyUtils;
41 use Friendica\Util\Strings;
42
43 class Profile
44 {
45         /**
46          * Returns default profile for a given user id
47          *
48          * @param integer User ID
49          *
50          * @return array Profile data
51          * @throws \Exception
52          */
53         public static function getByUID($uid)
54         {
55                 return DBA::selectFirst('profile', [], ['uid' => $uid]);
56         }
57
58         /**
59          * Returns default profile for a given user ID and ID
60          *
61          * @param int $uid The contact ID
62          * @param int $id The contact owner ID
63          * @param array $fields The selected fields
64          *
65          * @return array Profile data for the ID
66          * @throws \Exception
67          */
68         public static function getById(int $uid, int $id, array $fields = [])
69         {
70                 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
71         }
72
73         /**
74          * Returns profile data for the contact owner
75          *
76          * @param int $uid The User ID
77          * @param array $fields The fields to retrieve
78          *
79          * @return array Array of profile data
80          * @throws \Exception
81          */
82         public static function getListByUser(int $uid, array $fields = [])
83         {
84                 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
85         }
86
87         /**
88          * Returns a formatted location string from the given profile array
89          *
90          * @param array $profile Profile array (Generated from the "profile" table)
91          *
92          * @return string Location string
93          */
94         public static function formatLocation(array $profile)
95         {
96                 $location = '';
97
98                 if (!empty($profile['locality'])) {
99                         $location .= $profile['locality'];
100                 }
101
102                 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
103                         if ($location) {
104                                 $location .= ', ';
105                         }
106
107                         $location .= $profile['region'];
108                 }
109
110                 if (!empty($profile['country-name'])) {
111                         if ($location) {
112                                 $location .= ', ';
113                         }
114
115                         $location .= $profile['country-name'];
116                 }
117
118                 return $location;
119         }
120
121         /**
122          * Loads a profile into the page sidebar.
123          *
124          * The function requires a writeable copy of the main App structure, and the nickname
125          * of a registered local account.
126          *
127          * If the viewer is an authenticated remote viewer, the profile displayed is the
128          * one that has been configured for his/her viewing in the Contact manager.
129          * Passing a non-zero profile ID can also allow a preview of a selected profile
130          * by the owner.
131          *
132          * Profile information is placed in the App structure for later retrieval.
133          * Honours the owner's chosen theme for display.
134          *
135          * @attention Should only be run in the _init() functions of a module. That ensures that
136          *      the theme is chosen before the _init() function of a theme is run, which will usually
137          *      load a lot of theme-specific content
138          *
139          * @param App     $a
140          * @param string  $nickname     string
141          * @param array   $profiledata  array
142          * @param boolean $show_connect Show connect link
143          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
144          * @throws \ImagickException
145          */
146         public static function load(App $a, $nickname, array $profiledata = [], $show_connect = true)
147         {
148                 $user = 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 = !empty($user['uid']) ? 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 = self::getMyURL() && ($profile['url'] == self::getMyURL());
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) . '&auto=1';
326                                 } else {
327                                         $follow_link =  $visitor_base_path .'/follow?url=' . urlencode($profile_url) . '&auto=1';
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                                         'failed' => false,
410                                         'network' => Protocol::FEDERATED,
411                                 ]);
412                         }
413                 }
414
415                 $p = [];
416                 foreach ($profile as $k => $v) {
417                         $k = str_replace('-', '_', $k);
418                         $p[$k] = $v;
419                 }
420
421                 if (isset($p['about'])) {
422                         $p['about'] = BBCode::convert($p['about']);
423                 }
424
425                 if (isset($p['address'])) {
426                         $p['address'] = BBCode::convert($p['address']);
427                 }
428
429                 if (isset($p['photo'])) {
430                         $p['photo'] = ProxyUtils::proxifyUrl($p['photo'], false, ProxyUtils::SIZE_SMALL);
431                 }
432
433                 $p['url'] = Contact::magicLink(($p['url'] ?? '') ?: $profile_url);
434
435                 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
436                 $o .= Renderer::replaceMacros($tpl, [
437                         '$profile' => $p,
438                         '$xmpp' => $xmpp,
439                         '$follow' => DI::l10n()->t('Follow'),
440                         '$follow_link' => $follow_link,
441                         '$unfollow' => DI::l10n()->t('Unfollow'),
442                         '$unfollow_link' => $unfollow_link,
443                         '$subscribe_feed' => DI::l10n()->t('Atom feed'),
444                         '$subscribe_feed_link' => $subscribe_feed_link,
445                         '$wallmessage' => DI::l10n()->t('Message'),
446                         '$wallmessage_link' => $wallmessage_link,
447                         '$account_type' => $account_type,
448                         '$location' => $location,
449                         '$homepage' => $homepage,
450                         '$about' => $about,
451                         '$network' => DI::l10n()->t('Network:'),
452                         '$contacts' => $contact_count,
453                         '$updated' => $updated,
454                         '$diaspora' => $diaspora,
455                         '$contact_block' => $contact_block,
456                 ]);
457
458                 $arr = ['profile' => &$profile, 'entry' => &$o];
459
460                 Hook::callAll('profile_sidebar', $arr);
461
462                 return $o;
463         }
464
465         public static function getBirthdays()
466         {
467                 $a = DI::app();
468                 $o = '';
469
470                 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
471                         return $o;
472                 }
473
474                 /*
475                 * $mobile_detect = new Mobile_Detect();
476                 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
477                 *               if ($is_mobile)
478                 *                       return $o;
479                 */
480
481                 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
482                 $bd_short = DI::l10n()->t('F d');
483
484                 $cachekey = 'get_birthdays:' . local_user();
485                 $r = DI::cache()->get($cachekey);
486                 if (is_null($r)) {
487                         $s = DBA::p(
488                                 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
489                                 INNER JOIN `contact`
490                                         ON `contact`.`id` = `event`.`cid`
491                                         AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
492                                         AND NOT `contact`.`pending`
493                                         AND NOT `contact`.`hidden`
494                                         AND NOT `contact`.`blocked`
495                                         AND NOT `contact`.`archive`
496                                         AND NOT `contact`.`deleted`
497                                 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
498                                 ORDER BY `start` ASC ",
499                                 Contact::SHARING,
500                                 Contact::FRIEND,
501                                 local_user(),
502                                 DateTimeFormat::utc('now + 6 days'),
503                                 DateTimeFormat::utcNow()
504                         );
505                         if (DBA::isResult($s)) {
506                                 $r = DBA::toArray($s);
507                                 DI::cache()->set($cachekey, $r, Duration::HOUR);
508                         }
509                 }
510
511                 $total = 0;
512                 $classtoday = '';
513                 if (DBA::isResult($r)) {
514                         $now = strtotime('now');
515                         $cids = [];
516
517                         $istoday = false;
518                         foreach ($r as $rr) {
519                                 if (strlen($rr['name'])) {
520                                         $total ++;
521                                 }
522                                 if ((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) {
523                                         $istoday = true;
524                                 }
525                         }
526                         $classtoday = $istoday ? ' birthday-today ' : '';
527                         if ($total) {
528                                 foreach ($r as &$rr) {
529                                         if (!strlen($rr['name'])) {
530                                                 continue;
531                                         }
532
533                                         // avoid duplicates
534
535                                         if (in_array($rr['cid'], $cids)) {
536                                                 continue;
537                                         }
538                                         $cids[] = $rr['cid'];
539
540                                         $today = (((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) ? true : false);
541
542                                         $rr['link'] = Contact::magicLinkById($rr['cid']);
543                                         $rr['title'] = $rr['name'];
544                                         $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $a->timezone, 'UTC', $rr['adjust'] ? $bd_format : $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
545                                         $rr['startime'] = null;
546                                         $rr['today'] = $today;
547                                 }
548                         }
549                 }
550                 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
551                 return Renderer::replaceMacros($tpl, [
552                         '$classtoday' => $classtoday,
553                         '$count' => $total,
554                         '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
555                         '$event_title' => DI::l10n()->t('Birthdays this week:'),
556                         '$events' => $r,
557                         '$lbr' => '{', // raw brackets mess up if/endif macro processing
558                         '$rbr' => '}'
559                 ]);
560         }
561
562         public static function getEventsReminderHTML()
563         {
564                 $a = DI::app();
565                 $o = '';
566
567                 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
568                         return $o;
569                 }
570
571                 /*
572                 *       $mobile_detect = new Mobile_Detect();
573                 *               $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
574                 *               if ($is_mobile)
575                 *                       return $o;
576                 */
577
578                 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
579                 $classtoday = '';
580
581                 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
582                         local_user(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
583                 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
584
585                 $r = [];
586
587                 if (DBA::isResult($s)) {
588                         $istoday = false;
589                         $total = 0;
590
591                         while ($rr = DBA::fetch($s)) {
592                                 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => public_contact(),
593                                         'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
594                                         'visible' => true, 'deleted' => false];
595                                 if (!Post::exists($condition)) {
596                                         continue;
597                                 }
598
599                                 if (strlen($rr['summary'])) {
600                                         $total++;
601                                 }
602
603                                 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', 'Y-m-d');
604                                 if ($strt === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
605                                         $istoday = true;
606                                 }
607
608                                 $title = strip_tags(html_entity_decode(BBCode::convert($rr['summary']), ENT_QUOTES, 'UTF-8'));
609
610                                 if (strlen($title) > 35) {
611                                         $title = substr($title, 0, 32) . '... ';
612                                 }
613
614                                 $description = substr(strip_tags(BBCode::convert($rr['desc'])), 0, 32) . '... ';
615                                 if (!$description) {
616                                         $description = DI::l10n()->t('[No description]');
617                                 }
618
619                                 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC');
620
621                                 if (substr($strt, 0, 10) < DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
622                                         continue;
623                                 }
624
625                                 $today = ((substr($strt, 0, 10) === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) ? true : false);
626
627                                 $rr['title'] = $title;
628                                 $rr['description'] = $description;
629                                 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
630                                 $rr['startime'] = $strt;
631                                 $rr['today'] = $today;
632
633                                 $r[] = $rr;
634                         }
635                         DBA::close($s);
636                         $classtoday = (($istoday) ? 'event-today' : '');
637                 }
638                 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
639                 return Renderer::replaceMacros($tpl, [
640                         '$classtoday' => $classtoday,
641                         '$count' => count($r),
642                         '$event_reminders' => DI::l10n()->t('Event Reminders'),
643                         '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
644                         '$events' => $r,
645                 ]);
646         }
647
648         /**
649          * Retrieves the my_url session variable
650          *
651          * @return string
652          */
653         public static function getMyURL()
654         {
655                 return Session::get('my_url');
656         }
657
658         /**
659          * Process the 'zrl' parameter and initiate the remote authentication.
660          *
661          * This method checks if the visitor has a public contact entry and
662          * redirects the visitor to his/her instance to start the magic auth (Authentication)
663          * process.
664          *
665          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
666          *
667          * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
668          * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
669          * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
670          *
671          * It would be favourable to harmonize the two implementations.
672          *
673          * @param App $a Application instance.
674          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
675          * @throws \ImagickException
676          */
677         public static function zrlInit(App $a)
678         {
679                 $my_url = self::getMyURL();
680                 $my_url = Network::isUrlValid($my_url);
681
682                 if (empty($my_url) || local_user()) {
683                         return;
684                 }
685
686                 $addr = $_GET['addr'] ?? $my_url;
687
688                 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
689                 Hook::callAll('zrl_init', $arr);
690
691                 // Try to find the public contact entry of the visitor.
692                 $cid = Contact::getIdForURL($my_url);
693                 if (!$cid) {
694                         Logger::log('No contact record found for ' . $my_url, Logger::DEBUG);
695                         return;
696                 }
697
698                 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
699
700                 if (DBA::isResult($contact) && remote_user() && remote_user() == $contact['id']) {
701                         Logger::log('The visitor ' . $my_url . ' is already authenticated', Logger::DEBUG);
702                         return;
703                 }
704
705                 // Avoid endless loops
706                 $cachekey = 'zrlInit:' . $my_url;
707                 if (DI::cache()->get($cachekey)) {
708                         Logger::log('URL ' . $my_url . ' already tried to authenticate.', Logger::DEBUG);
709                         return;
710                 } else {
711                         DI::cache()->set($cachekey, true, Duration::MINUTE);
712                 }
713
714                 Logger::log('Not authenticated. Invoking reverse magic-auth for ' . $my_url, Logger::DEBUG);
715
716                 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
717                 $addr_request = 'addr=' . urlencode($addr);
718                 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
719
720                 // The other instance needs to know where to redirect.
721                 $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
722
723                 // We need to extract the basebath from the profile url
724                 // to redirect the visitors '/magic' module.
725                 $basepath = Contact::getBasepath($contact['url']);
726
727                 if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
728                         $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
729
730                         // We have to check if the remote server does understand /magic without invoking something
731                         $serverret = DI::httpRequest()->get($basepath . '/magic');
732                         if ($serverret->isSuccess()) {
733                                 Logger::log('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path, Logger::DEBUG);
734                                 System::externalRedirect($magic_path);
735                         }
736                 }
737         }
738
739         /**
740          * Set the visitor cookies (see remote_user()) for the given handle
741          *
742          * @param string $handle Visitor handle
743          * @return array Visitor contact array
744          */
745         public static function addVisitorCookieForHandle($handle)
746         {
747                 $a = DI::app();
748
749                 // Try to find the public contact entry of the visitor.
750                 $cid = Contact::getIdForURL($handle);
751                 if (!$cid) {
752                         Logger::log('unable to finger ' . $handle, Logger::DEBUG);
753                         return [];
754                 }
755
756                 $visitor = DBA::selectFirst('contact', [], ['id' => $cid]);
757
758                 // Authenticate the visitor.
759                 $_SESSION['authenticated'] = 1;
760                 $_SESSION['visitor_id'] = $visitor['id'];
761                 $_SESSION['visitor_handle'] = $visitor['addr'];
762                 $_SESSION['visitor_home'] = $visitor['url'];
763                 $_SESSION['my_url'] = $visitor['url'];
764                 $_SESSION['remote_comment'] = $visitor['subscribe'];
765
766                 Session::setVisitorsContacts();
767
768                 $a->contact = $visitor;
769
770                 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
771
772                 return $visitor;
773         }
774
775         /**
776          * OpenWebAuth authentication.
777          *
778          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
779          *
780          * @param string $token
781          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
782          * @throws \ImagickException
783          */
784         public static function openWebAuthInit($token)
785         {
786                 $a = DI::app();
787
788                 // Clean old OpenWebAuthToken entries.
789                 OpenWebAuthToken::purge('owt', '3 MINUTE');
790
791                 // Check if the token we got is the same one
792                 // we have stored in the database.
793                 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
794
795                 if ($visitor_handle === false) {
796                         return;
797                 }
798
799                 $visitor = self::addVisitorCookieForHandle($visitor_handle);
800                 if (empty($visitor)) {
801                         return;
802                 }
803
804                 $arr = [
805                         'visitor' => $visitor,
806                         'url' => DI::args()->getQueryString()
807                 ];
808                 /**
809                  * @hooks magic_auth_success
810                  *   Called when a magic-auth was successful.
811                  *   * \e array \b visitor
812                  *   * \e string \b url
813                  */
814                 Hook::callAll('magic_auth_success', $arr);
815
816                 $a->contact = $arr['visitor'];
817
818                 info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
819
820                 Logger::log('OpenWebAuth: auth success from ' . $visitor['addr'], Logger::DEBUG);
821         }
822
823         public static function zrl($s, $force = false)
824         {
825                 if (!strlen($s)) {
826                         return $s;
827                 }
828                 if (!strpos($s, '/profile/') && !$force) {
829                         return $s;
830                 }
831                 if ($force && substr($s, -1, 1) !== '/') {
832                         $s = $s . '/';
833                 }
834                 $achar = strpos($s, '?') ? '&' : '?';
835                 $mine = self::getMyURL();
836                 if ($mine && !Strings::compareLink($mine, $s)) {
837                         return $s . $achar . 'zrl=' . urlencode($mine);
838                 }
839                 return $s;
840         }
841
842         /**
843          * Get the user ID of the page owner.
844          *
845          * Used from within PCSS themes to set theme parameters. If there's a
846          * profile_uid variable set in App, that is the "page owner" and normally their theme
847          * settings take precedence; unless a local user sets the "always_my_theme"
848          * system pconfig, which means they don't want to see anybody else's theme
849          * settings except their own while on this site.
850          *
851          * @return int user ID
852          *
853          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
854          * @note Returns local_user instead of user ID if "always_my_theme" is set to true
855          */
856         public static function getThemeUid(App $a)
857         {
858                 $uid = !empty($a->profile_uid) ? intval($a->profile_uid) : 0;
859                 if (local_user() && (DI::pConfig()->get(local_user(), 'system', 'always_my_theme') || !$uid)) {
860                         return local_user();
861                 }
862
863                 return $uid;
864         }
865
866         /**
867          * search for Profiles
868          *
869          * @param int  $start
870          * @param int  $count
871          * @param null $search
872          *
873          * @return array [ 'total' => 123, 'entries' => [...] ];
874          *
875          * @throws \Exception
876          */
877         public static function searchProfiles($start = 0, $count = 100, $search = null)
878         {
879                 if (!empty($search)) {
880                         $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
881                         $searchTerm = '%' . $search . '%';
882                         $condition = ["NOT `blocked` AND NOT `account_removed`
883                                 $publish
884                                 AND ((`name` LIKE ?) OR
885                                 (`nickname` LIKE ?) OR
886                                 (`about` LIKE ?) OR
887                                 (`locality` LIKE ?) OR
888                                 (`region` LIKE ?) OR
889                                 (`country-name` LIKE ?) OR
890                                 (`pub_keywords` LIKE ?) OR
891                                 (`prv_keywords` LIKE ?))",
892                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
893                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
894                 } else {
895                         $condition = ['blocked' => false, 'account_removed' => false];
896                         if (!DI::config()->get('system', 'publish_all')) {
897                                 $condition['publish'] = true;
898                         }
899                 }
900
901                 $total = DBA::count('owner-view', $condition);
902
903                 // If nothing found, don't try to select details
904                 if ($total > 0) {
905                         $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
906                 } else {
907                         $profiles = [];
908                 }
909
910                 return ['total' => $total, 'entries' => $profiles];
911         }
912 }