src/Model/Profile.php

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