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
 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 && $show_contacts) {
 399                         $contact_block = ContactBlock::getHTML($profile);
 400
 401                         if (is_array($profile) && !$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                 // Expected profile/vcard.tpl profile.* template variables
 416                 $p = [
 417                         'address' => null,
 418                         'edit' => null,
 419                         'upubkey' => null,
 420                 ];
 421                 foreach ($profile as $k => $v) {
 422                         $k = str_replace('-', '_', $k);
 423                         $p[$k] = $v;
 424                 }
 425
 426                 if (isset($p['about'])) {
 427                         $p['about'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['about']);
 428                 }
 429
 430                 if (isset($p['address'])) {
 431                         $p['address'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['address']);
 432                 }
 433
 434                 $p['photo'] = Contact::getAvatarUrlForId($cid, ProxyUtils::SIZE_SMALL);
 435
 436                 $p['url'] = Contact::magicLinkById($cid, $profile['url']);
 437
 438                 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
 439                 $o .= Renderer::replaceMacros($tpl, [
 440                         '$profile' => $p,
 441                         '$xmpp' => $xmpp,
 442                         '$follow' => DI::l10n()->t('Follow'),
 443                         '$follow_link' => $follow_link,
 444                         '$unfollow' => DI::l10n()->t('Unfollow'),
 445                         '$unfollow_link' => $unfollow_link,
 446                         '$subscribe_feed' => DI::l10n()->t('Atom feed'),
 447                         '$subscribe_feed_link' => $profile['poll'],
 448                         '$wallmessage' => DI::l10n()->t('Message'),
 449                         '$wallmessage_link' => $wallmessage_link,
 450                         '$account_type' => $account_type,
 451                         '$location' => $location,
 452                         '$homepage' => $homepage,
 453                         '$about' => $about,
 454                         '$network' => DI::l10n()->t('Network:'),
 455                         '$contacts' => $contact_count,
 456                         '$updated' => $updated,
 457                         '$diaspora' => $diaspora,
 458                         '$contact_block' => $contact_block,
 459                 ]);
 460
 461                 $arr = ['profile' => &$profile, 'entry' => &$o];
 462
 463                 Hook::callAll('profile_sidebar', $arr);
 464
 465                 return $o;
 466         }
 467
 468         public static function getBirthdays()
 469         {
 470                 $a = DI::app();
 471                 $o = '';
 472
 473                 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
 474                         return $o;
 475                 }
 476
 477                 /*
 478                 * $mobile_detect = new Mobile_Detect();
 479                 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
 480                 *               if ($is_mobile)
 481                 *                       return $o;
 482                 */
 483
 484                 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
 485                 $bd_short = DI::l10n()->t('F d');
 486
 487                 $cachekey = 'get_birthdays:' . local_user();
 488                 $r = DI::cache()->get($cachekey);
 489                 if (is_null($r)) {
 490                         $s = DBA::p(
 491                                 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
 492                                 INNER JOIN `contact`
 493                                         ON `contact`.`id` = `event`.`cid`
 494                                         AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
 495                                         AND NOT `contact`.`pending`
 496                                         AND NOT `contact`.`hidden`
 497                                         AND NOT `contact`.`blocked`
 498                                         AND NOT `contact`.`archive`
 499                                         AND NOT `contact`.`deleted`
 500                                 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
 501                                 ORDER BY `start` ASC ",
 502                                 Contact::SHARING,
 503                                 Contact::FRIEND,
 504                                 local_user(),
 505                                 DateTimeFormat::utc('now + 6 days'),
 506                                 DateTimeFormat::utcNow()
 507                         );
 508                         if (DBA::isResult($s)) {
 509                                 $r = DBA::toArray($s);
 510                                 DI::cache()->set($cachekey, $r, Duration::HOUR);
 511                         }
 512                 }
 513
 514                 $total = 0;
 515                 $classtoday = '';
 516                 if (DBA::isResult($r)) {
 517                         $now = strtotime('now');
 518                         $cids = [];
 519
 520                         $istoday = false;
 521                         foreach ($r as $rr) {
 522                                 if (strlen($rr['name'])) {
 523                                         $total ++;
 524                                 }
 525                                 if ((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) {
 526                                         $istoday = true;
 527                                 }
 528                         }
 529                         $classtoday = $istoday ? ' birthday-today ' : '';
 530                         if ($total) {
 531                                 foreach ($r as &$rr) {
 532                                         if (!strlen($rr['name'])) {
 533                                                 continue;
 534                                         }
 535
 536                                         // avoid duplicates
 537
 538                                         if (in_array($rr['cid'], $cids)) {
 539                                                 continue;
 540                                         }
 541                                         $cids[] = $rr['cid'];
 542
 543                                         $today = (((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) ? true : false);
 544
 545                                         $rr['link'] = Contact::magicLinkById($rr['cid']);
 546                                         $rr['title'] = $rr['name'];
 547                                         $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $a->getTimeZone(), 'UTC', $rr['adjust'] ? $bd_format : $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
 548                                         $rr['startime'] = null;
 549                                         $rr['today'] = $today;
 550                                 }
 551                         }
 552                 }
 553                 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
 554                 return Renderer::replaceMacros($tpl, [
 555                         '$classtoday' => $classtoday,
 556                         '$count' => $total,
 557                         '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
 558                         '$event_title' => DI::l10n()->t('Birthdays this week:'),
 559                         '$events' => $r,
 560                         '$lbr' => '{', // raw brackets mess up if/endif macro processing
 561                         '$rbr' => '}'
 562                 ]);
 563         }
 564
 565         public static function getEventsReminderHTML()
 566         {
 567                 $a = DI::app();
 568                 $o = '';
 569
 570                 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
 571                         return $o;
 572                 }
 573
 574                 /*
 575                 *       $mobile_detect = new Mobile_Detect();
 576                 *               $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
 577                 *               if ($is_mobile)
 578                 *                       return $o;
 579                 */
 580
 581                 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
 582                 $classtoday = '';
 583
 584                 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
 585                         local_user(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
 586                 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
 587
 588                 $r = [];
 589
 590                 if (DBA::isResult($s)) {
 591                         $istoday = false;
 592                         $total = 0;
 593
 594                         while ($rr = DBA::fetch($s)) {
 595                                 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => public_contact(),
 596                                         'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
 597                                         'visible' => true, 'deleted' => false];
 598                                 if (!Post::exists($condition)) {
 599                                         continue;
 600                                 }
 601
 602                                 if (strlen($rr['summary'])) {
 603                                         $total++;
 604                                 }
 605
 606                                 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->getTimeZone() : 'UTC', 'UTC', 'Y-m-d');
 607                                 if ($strt === DateTimeFormat::timezoneNow($a->getTimeZone(), 'Y-m-d')) {
 608                                         $istoday = true;
 609                                 }
 610
 611                                 $title = strip_tags(html_entity_decode(BBCode::convertForUriId($rr['uri-id'], $rr['summary']), ENT_QUOTES, 'UTF-8'));
 612
 613                                 if (strlen($title) > 35) {
 614                                         $title = substr($title, 0, 32) . '... ';
 615                                 }
 616
 617                                 $description = substr(strip_tags(BBCode::convertForUriId($rr['uri-id'], $rr['desc'])), 0, 32) . '... ';
 618                                 if (!$description) {
 619                                         $description = DI::l10n()->t('[No description]');
 620                                 }
 621
 622                                 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->getTimeZone() : 'UTC');
 623
 624                                 if (substr($strt, 0, 10) < DateTimeFormat::timezoneNow($a->getTimeZone(), 'Y-m-d')) {
 625                                         continue;
 626                                 }
 627
 628                                 $today = ((substr($strt, 0, 10) === DateTimeFormat::timezoneNow($a->getTimeZone(), 'Y-m-d')) ? true : false);
 629
 630                                 $rr['title'] = $title;
 631                                 $rr['description'] = $description;
 632                                 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->getTimeZone() : 'UTC', 'UTC', $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
 633                                 $rr['startime'] = $strt;
 634                                 $rr['today'] = $today;
 635
 636                                 $r[] = $rr;
 637                         }
 638                         DBA::close($s);
 639                         $classtoday = (($istoday) ? 'event-today' : '');
 640                 }
 641                 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
 642                 return Renderer::replaceMacros($tpl, [
 643                         '$classtoday' => $classtoday,
 644                         '$count' => count($r),
 645                         '$event_reminders' => DI::l10n()->t('Event Reminders'),
 646                         '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
 647                         '$events' => $r,
 648                 ]);
 649         }
 650
 651         /**
 652          * Retrieves the my_url session variable
 653          *
 654          * @return string
 655          */
 656         public static function getMyURL()
 657         {
 658                 return Session::get('my_url');
 659         }
 660
 661         /**
 662          * Process the 'zrl' parameter and initiate the remote authentication.
 663          *
 664          * This method checks if the visitor has a public contact entry and
 665          * redirects the visitor to his/her instance to start the magic auth (Authentication)
 666          * process.
 667          *
 668          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
 669          *
 670          * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
 671          * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
 672          * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
 673          *
 674          * It would be favourable to harmonize the two implementations.
 675          *
 676          * @param App $a Application instance.
 677          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 678          * @throws \ImagickException
 679          */
 680         public static function zrlInit(App $a)
 681         {
 682                 $my_url = self::getMyURL();
 683                 $my_url = Network::isUrlValid($my_url);
 684
 685                 if (empty($my_url) || local_user()) {
 686                         return;
 687                 }
 688
 689                 $addr = $_GET['addr'] ?? $my_url;
 690
 691                 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
 692                 Hook::callAll('zrl_init', $arr);
 693
 694                 // Try to find the public contact entry of the visitor.
 695                 $cid = Contact::getIdForURL($my_url);
 696                 if (!$cid) {
 697                         Logger::log('No contact record found for ' . $my_url, Logger::DEBUG);
 698                         return;
 699                 }
 700
 701                 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
 702
 703                 if (DBA::isResult($contact) && remote_user() && remote_user() == $contact['id']) {
 704                         Logger::log('The visitor ' . $my_url . ' is already authenticated', Logger::DEBUG);
 705                         return;
 706                 }
 707
 708                 // Avoid endless loops
 709                 $cachekey = 'zrlInit:' . $my_url;
 710                 if (DI::cache()->get($cachekey)) {
 711                         Logger::log('URL ' . $my_url . ' already tried to authenticate.', Logger::DEBUG);
 712                         return;
 713                 } else {
 714                         DI::cache()->set($cachekey, true, Duration::MINUTE);
 715                 }
 716
 717                 Logger::log('Not authenticated. Invoking reverse magic-auth for ' . $my_url, Logger::DEBUG);
 718
 719                 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
 720                 $addr_request = 'addr=' . urlencode($addr);
 721                 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
 722
 723                 // The other instance needs to know where to redirect.
 724                 $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
 725
 726                 // We need to extract the basebath from the profile url
 727                 // to redirect the visitors '/magic' module.
 728                 $basepath = Contact::getBasepath($contact['url']);
 729
 730                 if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
 731                         $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
 732
 733                         // We have to check if the remote server does understand /magic without invoking something
 734                         $serverret = DI::httpRequest()->get($basepath . '/magic');
 735                         if ($serverret->isSuccess()) {
 736                                 Logger::log('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path, Logger::DEBUG);
 737                                 System::externalRedirect($magic_path);
 738                         }
 739                 }
 740         }
 741
 742         /**
 743          * Set the visitor cookies (see remote_user()) for the given handle
 744          *
 745          * @param string $handle Visitor handle
 746          * @return array Visitor contact array
 747          */
 748         public static function addVisitorCookieForHandle($handle)
 749         {
 750                 $a = DI::app();
 751
 752                 // Try to find the public contact entry of the visitor.
 753                 $cid = Contact::getIdForURL($handle);
 754                 if (!$cid) {
 755                         Logger::info('Handle not found', ['handle' => $handle]);
 756                         return [];
 757                 }
 758
 759                 $visitor = Contact::getById($cid);
 760
 761                 // Authenticate the visitor.
 762                 $_SESSION['authenticated'] = 1;
 763                 $_SESSION['visitor_id'] = $visitor['id'];
 764                 $_SESSION['visitor_handle'] = $visitor['addr'];
 765                 $_SESSION['visitor_home'] = $visitor['url'];
 766                 $_SESSION['my_url'] = $visitor['url'];
 767                 $_SESSION['remote_comment'] = $visitor['subscribe'];
 768
 769                 Session::setVisitorsContacts();
 770
 771                 $a->setContactId($visitor['id']);
 772
 773                 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
 774
 775                 return $visitor;
 776         }
 777
 778         /**
 779          * Set the visitor cookies (see remote_user()) for signed HTTP requests
 780          * @return array Visitor contact array
 781          */
 782         public static function addVisitorCookieForHTTPSigner()
 783         {
 784                 $requester = HTTPSignature::getSigner('', $_SERVER);
 785                 if (empty($requester)) {
 786                         return [];
 787                 }
 788                 return Profile::addVisitorCookieForHandle($requester);
 789         }
 790
 791         /**
 792          * OpenWebAuth authentication.
 793          *
 794          * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
 795          *
 796          * @param string $token
 797          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 798          * @throws \ImagickException
 799          */
 800         public static function openWebAuthInit($token)
 801         {
 802                 $a = DI::app();
 803
 804                 // Clean old OpenWebAuthToken entries.
 805                 OpenWebAuthToken::purge('owt', '3 MINUTE');
 806
 807                 // Check if the token we got is the same one
 808                 // we have stored in the database.
 809                 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
 810
 811                 if ($visitor_handle === false) {
 812                         return;
 813                 }
 814
 815                 $visitor = self::addVisitorCookieForHandle($visitor_handle);
 816                 if (empty($visitor)) {
 817                         return;
 818                 }
 819
 820                 $arr = [
 821                         'visitor' => $visitor,
 822                         'url' => DI::args()->getQueryString()
 823                 ];
 824                 /**
 825                  * @hooks magic_auth_success
 826                  *   Called when a magic-auth was successful.
 827                  *   * \e array \b visitor
 828                  *   * \e string \b url
 829                  */
 830                 Hook::callAll('magic_auth_success', $arr);
 831
 832                 $a->setContactId($arr['visitor']['id']);
 833
 834                 info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
 835
 836                 Logger::log('OpenWebAuth: auth success from ' . $visitor['addr'], Logger::DEBUG);
 837         }
 838
 839         public static function zrl($s, $force = false)
 840         {
 841                 if (!strlen($s)) {
 842                         return $s;
 843                 }
 844                 if (!strpos($s, '/profile/') && !$force) {
 845                         return $s;
 846                 }
 847                 if ($force && substr($s, -1, 1) !== '/') {
 848                         $s = $s . '/';
 849                 }
 850                 $achar = strpos($s, '?') ? '&' : '?';
 851                 $mine = self::getMyURL();
 852                 if ($mine && !Strings::compareLink($mine, $s)) {
 853                         return $s . $achar . 'zrl=' . urlencode($mine);
 854                 }
 855                 return $s;
 856         }
 857
 858         /**
 859          * Get the user ID of the page owner.
 860          *
 861          * Used from within PCSS themes to set theme parameters. If there's a
 862          * profile_uid variable set in App, that is the "page owner" and normally their theme
 863          * settings take precedence; unless a local user sets the "always_my_theme"
 864          * system pconfig, which means they don't want to see anybody else's theme
 865          * settings except their own while on this site.
 866          *
 867          * @return int user ID
 868          *
 869          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 870          * @note Returns local_user instead of user ID if "always_my_theme" is set to true
 871          */
 872         public static function getThemeUid(App $a)
 873         {
 874                 $uid = !empty($a->getProfileOwner()) ? intval($a->getProfileOwner()) : 0;
 875                 if (local_user() && (DI::pConfig()->get(local_user(), 'system', 'always_my_theme') || !$uid)) {
 876                         return local_user();
 877                 }
 878
 879                 return $uid;
 880         }
 881
 882         /**
 883          * search for Profiles
 884          *
 885          * @param int  $start
 886          * @param int  $count
 887          * @param null $search
 888          *
 889          * @return array [ 'total' => 123, 'entries' => [...] ];
 890          *
 891          * @throws \Exception
 892          */
 893         public static function searchProfiles($start = 0, $count = 100, $search = null)
 894         {
 895                 if (!empty($search)) {
 896                         $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
 897                         $searchTerm = '%' . $search . '%';
 898                         $condition = ["NOT `blocked` AND NOT `account_removed`
 899                                 $publish
 900                                 AND ((`name` LIKE ?) OR
 901                                 (`nickname` LIKE ?) OR
 902                                 (`about` LIKE ?) OR
 903                                 (`locality` LIKE ?) OR
 904                                 (`region` LIKE ?) OR
 905                                 (`country-name` LIKE ?) OR
 906                                 (`pub_keywords` LIKE ?) OR
 907                                 (`prv_keywords` LIKE ?))",
 908                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
 909                                 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
 910                 } else {
 911                         $condition = ['blocked' => false, 'account_removed' => false];
 912                         if (!DI::config()->get('system', 'publish_all')) {
 913                                 $condition['publish'] = true;
 914                         }
 915                 }
 916
 917                 $total = DBA::count('owner-view', $condition);
 918
 919                 // If nothing found, don't try to select details
 920                 if ($total > 0) {
 921                         $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
 922                 } else {
 923                         $profiles = [];
 924                 }
 925
 926                 return ['total' => $total, 'entries' => $profiles];
 927         }
 928 }