src/Model/Profile.php

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