src/Object/Post.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\Object;
  23
  24 use Friendica\Content\ContactSelector;
  25 use Friendica\Content\Feature;
  26 use Friendica\Core\Addon;
  27 use Friendica\Core\Hook;
  28 use Friendica\Core\Logger;
  29 use Friendica\Core\Protocol;
  30 use Friendica\Core\Renderer;
  31 use Friendica\DI;
  32 use Friendica\Model\Contact;
  33 use Friendica\Model\Item;
  34 use Friendica\Model\Post as PostModel;
  35 use Friendica\Model\Tag;
  36 use Friendica\Model\User;
  37 use Friendica\Protocol\Activity;
  38 use Friendica\Util\Crypto;
  39 use Friendica\Util\DateTimeFormat;
  40 use Friendica\Util\Strings;
  41 use Friendica\Util\Temporal;
  42 use GuzzleHttp\Psr7\Uri;
  43 use InvalidArgumentException;
  44
  45 /**
  46  * An item
  47  */
  48 class Post
  49 {
  50         private $data = [];
  51         private $template = null;
  52         private $available_templates = [
  53                 'wall' => 'wall_thread.tpl',
  54                 'wall2wall' => 'wallwall_thread.tpl'
  55         ];
  56         private $comment_box_template = 'comment_item.tpl';
  57         private $toplevel = false;
  58         private $writable = false;
  59         /**
  60          * @var Post[]
  61          */
  62         private $children = [];
  63         private $parent = null;
  64
  65         /**
  66          * @var Thread
  67          */
  68         private $thread = null;
  69         private $redirect_url = null;
  70         private $owner_url = '';
  71         private $owner_name = '';
  72         private $wall_to_wall = false;
  73         private $threaded = false;
  74         private $visiting = false;
  75
  76         /**
  77          * Constructor
  78          *
  79          * @param array $data data array
  80          * @throws \Exception
  81          */
  82         public function __construct(array $data)
  83         {
  84                 $this->data = $data;
  85                 $this->setTemplate('wall');
  86                 $this->toplevel = $this->getId() == $this->getDataValue('parent');
  87
  88                 if (!empty(DI::userSession()->getUserIDForVisitorContactID($this->getDataValue('contact-id')))) {
  89                         $this->visiting = true;
  90                 }
  91
  92                 $this->writable = $this->getDataValue('writable') || $this->getDataValue('self');
  93                 $author = [
  94                         'uid'     => 0,
  95                         'id'      => $this->getDataValue('author-id'),
  96                         'network' => $this->getDataValue('author-network'),
  97                         'url'     => $this->getDataValue('author-link'),
  98                         'alias'   => $this->getDataValue('author-alias')
  99                 ];
 100                 $this->redirect_url = Contact::magicLinkByContact($author);
 101                 if (!$this->isToplevel()) {
 102                         $this->threaded = true;
 103                 }
 104
 105                 // Prepare the children
 106                 if (!empty($data['children'])) {
 107                         foreach ($data['children'] as $item) {
 108                                 // Only add will be displayed
 109                                 if ($item['network'] === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item['uid']) {
 110                                         continue;
 111                                 } elseif (!DI::contentItem()->isVisibleActivity($item)) {
 112                                         continue;
 113                                 }
 114
 115                                 // You can always comment on Diaspora and OStatus items
 116                                 if (in_array($item['network'], [Protocol::OSTATUS, Protocol::DIASPORA]) && (DI::userSession()->getLocalUserId() == $item['uid'])) {
 117                                         $item['writable'] = true;
 118                                 }
 119
 120                                 $item['pagedrop'] = $data['pagedrop'];
 121                                 $child = new Post($item);
 122                                 $this->addChild($child);
 123                         }
 124                 }
 125         }
 126
 127         /**
 128          * Fetch the privacy of the post
 129          *
 130          * @param array $item Item record
 131          * @return string Item privacy message
 132          * @throws InvalidArgumentException If $item['private'] is unknown
 133          */
 134         private function fetchPrivacy(array $item): string
 135         {
 136                 switch ($item['private']) {
 137                         case Item::PRIVATE:
 138                                 $output = DI::l10n()->t('Private Message');
 139                                 break;
 140
 141                         case Item::PUBLIC:
 142                                 $output = DI::l10n()->t('Public Message');
 143                                 break;
 144
 145                         case Item::UNLISTED:
 146                                 $output = DI::l10n()->t('Unlisted Message');
 147                                 break;
 148
 149                         default:
 150                                 throw new InvalidArgumentException('Item privacy ' . $item['privacy'] . ' is unsupported');
 151                 }
 152
 153                 return $output;
 154         }
 155
 156         /**
 157          * Get data in a form usable by a conversation template
 158          *
 159          * @param array   $conv_responses    conversation responses
 160          * @param string  $formSecurityToken A security Token to avoid CSF attacks
 161          * @param integer $thread_level      default = 1
 162          * @param array   $thread_parent     Array of parent guid and parent author names
 163          *
 164          * @return mixed The data requested on success, false on failure
 165          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 166          * @throws \ImagickException
 167          */
 168         public function getTemplateData(array $conv_responses, string $formSecurityToken, int $thread_level = 1, array $thread_parent = [])
 169         {
 170                 $item = $this->getData();
 171                 $edited = false;
 172
 173                 /*
 174                  * If the time between "created" and "edited" differs we add
 175                  * a notice that the post was edited.
 176                  * Note: In some networks reshared items seem to have (sometimes) a difference
 177                  * between creation time and edit time of a second. Thats why we add the notice
 178                  * only if the difference is more than 1 second.
 179                  */
 180                 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
 181                         $edited = [
 182                                 'label'    => DI::l10n()->t('This entry was edited'),
 183                                 'date'     => DateTimeFormat::local($item['edited'], 'r'),
 184                                 'relative' => Temporal::getRelativeDate($item['edited']),
 185                         ];
 186                 }
 187                 $sparkle = '';
 188                 $buttons = [
 189                         'like'     => null,
 190                         'dislike'  => null,
 191                         'share'    => null,
 192                         'announce' => null,
 193                 ];
 194                 $dropping = false;
 195                 $pinned = '';
 196                 $pin = false;
 197                 $star = false;
 198                 $ignore_thread = false;
 199                 $ispinned = 'unpinned';
 200                 $isstarred = 'unstarred';
 201                 $indent = '';
 202                 $shiny = '';
 203                 $osparkle = '';
 204                 $total_children = $this->countDescendants();
 205
 206                 $conv = $this->getThread();
 207
 208                 $privacy   = $this->fetchPrivacy($item);
 209                 $lock      = ($item['private'] == Item::PRIVATE) ? $privacy : false;
 210                 $connector = !in_array($item['network'], Protocol::NATIVE_SUPPORT) ? DI::l10n()->t('Connector Message') : false;
 211
 212                 $shareable    = in_array($conv->getProfileOwner(), [0, DI::userSession()->getLocalUserId()]) && $item['private'] != Item::PRIVATE;
 213                 $announceable = $shareable && in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::TWITTER, Protocol::TUMBLR, Protocol::BLUESKY]);
 214                 $commentable  = ($item['network'] != Protocol::TUMBLR);
 215
 216                 // On Diaspora only toplevel posts can be reshared
 217                 if ($announceable && ($item['network'] == Protocol::DIASPORA) && ($item['gravity'] != Item::GRAVITY_PARENT)) {
 218                         $announceable = false;
 219                 }
 220
 221                 $edpost = false;
 222
 223                 if (DI::userSession()->getLocalUserId()) {
 224                         if (Strings::compareLink(DI::session()->get('my_url'), $item['author-link'])) {
 225                                 if ($item['event-id'] != 0) {
 226                                         $edpost = ['calendar/event/edit/' . $item['event-id'], DI::l10n()->t('Edit')];
 227                                 } else {
 228                                         $edpost = [sprintf('post/%s/edit', $item['id']), DI::l10n()->t('Edit')];
 229                                 }
 230                         }
 231                         $dropping = in_array($item['uid'], [0, DI::userSession()->getLocalUserId()]);
 232                 }
 233
 234                 // Editing on items of not subscribed users isn't currently possible
 235                 // There are some issues on editing that prevent this.
 236                 // But also it is an issue of the supported protocols that doesn't allow editing at all.
 237                 if ($item['uid'] == 0) {
 238                         $edpost = false;
 239                 }
 240
 241                 if (($this->getDataValue('uid') == DI::userSession()->getLocalUserId()) || $this->isVisiting()) {
 242                         $dropping = true;
 243                 }
 244
 245                 $origin = $item['origin'] || $item['parent-origin'];
 246
 247                 if (!empty($item['featured'])) {
 248                         $pinned = DI::l10n()->t('Pinned item');
 249                 }
 250
 251                 $drop         = false;
 252                 $block        = false;
 253                 $ignore       = false;
 254                 $collapse     = false;
 255                 $report       = false;
 256                 $ignoreServer = false;
 257                 if (DI::userSession()->getLocalUserId()) {
 258                         $drop = [
 259                                 'dropping' => $dropping,
 260                                 'pagedrop' => $item['pagedrop'],
 261                                 'select' => DI::l10n()->t('Select'),
 262                                 'label' => $origin ? DI::l10n()->t('Delete globally') : DI::l10n()->t('Remove locally'),
 263                         ];
 264                 }
 265
 266                 if (!$item['self'] && DI::userSession()->getLocalUserId()) {
 267                         $block = [
 268                                 'blocking'  => true,
 269                                 'label'     => DI::l10n()->t('Block %s', $item['author-name']),
 270                                 'author_id' => $item['author-id'],
 271                         ];
 272                         $ignore = [
 273                                 'ignoring'  => true,
 274                                 'label'     => DI::l10n()->t('Ignore %s', $item['author-name']),
 275                                 'author_id' => $item['author-id'],
 276                         ];
 277                         $collapse = [
 278                                 'collapsing' => true,
 279                                 'label'      => DI::l10n()->t('Collapse %s', $item['author-name']),
 280                                 'author_id'  => $item['author-id'],
 281                         ];
 282                         $report = [
 283                                 'label' => DI::l10n()->t('Report post'),
 284                                 'href'  => 'moderation/report/create?' . http_build_query(['cid' => $item['author-id'], 'uri-ids' => [$item['uri-id']]]),
 285                         ];
 286                         $authorBaseUri = new Uri($item['author-baseurl'] ?? '');
 287                         if ($authorBaseUri->getHost() && !DI::baseUrl()->isLocalUrl($authorBaseUri)) {
 288                                 $ignoreServer = [
 289                                         'label' => DI::l10n()->t("Ignore %s server", $authorBaseUri->getHost()),
 290                                 ];
 291                         }
 292                 }
 293
 294                 $filer = DI::userSession()->getLocalUserId() ? DI::l10n()->t('Save to folder') : false;
 295
 296                 $profile_name = $item['author-name'];
 297                 if (!empty($item['author-link']) && empty($item['author-name'])) {
 298                         $profile_name = $item['author-link'];
 299                 }
 300
 301                 if (DI::userSession()->isAuthenticated()) {
 302                         $author = [
 303                                 'uid'     => 0,
 304                                 'id'      => $item['author-id'],
 305                                 'network' => $item['author-network'],
 306                                 'url'     => $item['author-link'],
 307                                 'alias'   => $item['author-alias'],
 308                         ];
 309                         $profile_link = Contact::magicLinkByContact($author);
 310                 } else {
 311                         $profile_link = $item['author-link'];
 312                 }
 313
 314                 if (strpos($profile_link, 'contact/redir/') === 0) {
 315                         $sparkle = ' sparkle';
 316                 }
 317
 318                 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
 319                 Hook::callAll('render_location', $locate);
 320                 $location_html = $locate['html'] ?: Strings::escapeHtml($locate['location'] ?: $locate['coord'] ?: '');
 321
 322                 // process action responses - e.g. like/dislike/attend/agree/whatever
 323                 $response_verbs = ['like', 'dislike', 'announce'];
 324
 325                 $isevent = false;
 326                 $attend = [];
 327                 if ($item['object-type'] === Activity\ObjectType::EVENT) {
 328                         $response_verbs[] = 'attendyes';
 329                         $response_verbs[] = 'attendno';
 330                         $response_verbs[] = 'attendmaybe';
 331
 332                         if ($conv->isWritable()) {
 333                                 $isevent = true;
 334                                 $attend = [DI::l10n()->t('I will attend'), DI::l10n()->t('I will not attend'), DI::l10n()->t('I might attend')];
 335                         }
 336                 }
 337
 338                 $responses = [];
 339                 foreach ($response_verbs as $value => $verb) {
 340                         $responses[$verb] = [
 341                                 'self'   => $conv_responses[$verb][$item['uri-id']]['self'] ?? 0,
 342                                 'output' => !empty($conv_responses[$verb][$item['uri-id']]) ? DI::conversation()->formatActivity($conv_responses[$verb][$item['uri-id']]['links'], $verb, $item['uri-id']) : '',
 343                         ];
 344                 }
 345
 346                 /*
 347                  * We should avoid doing this all the time, but it depends on the conversation mode
 348                  * And the conv mode may change when we change the conv, or it changes its mode
 349                  * Maybe we should establish a way to be notified about conversation changes
 350                  */
 351                 $this->checkWallToWall();
 352
 353                 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
 354                         $osparkle = ' sparkle';
 355                 }
 356
 357                 $tagger = '';
 358
 359                 if ($this->isToplevel()) {
 360                         if (DI::userSession()->getLocalUserId()) {
 361                                 $ignored_thread = PostModel\ThreadUser::getIgnored($item['uri-id'], DI::userSession()->getLocalUserId());
 362                                 if ($item['mention'] || $ignored_thread) {
 363                                         $ignore_thread = [
 364                                                 'do'        => DI::l10n()->t('Ignore thread'),
 365                                                 'undo'      => DI::l10n()->t('Unignore thread'),
 366                                                 'toggle'    => DI::l10n()->t('Toggle ignore status'),
 367                                                 'classdo'   => $ignored_thread ? 'hidden' : '',
 368                                                 'classundo' => $ignored_thread ? '' : 'hidden',
 369                                                 'ignored'   => DI::l10n()->t('Ignored'),
 370                                         ];
 371                                 }
 372
 373                                 $isstarred = (($item['starred']) ? 'starred' : 'unstarred');
 374
 375                                 $star = [
 376                                         'do'        => DI::l10n()->t('Add star'),
 377                                         'undo'      => DI::l10n()->t('Remove star'),
 378                                         'toggle'    => DI::l10n()->t('Toggle star status'),
 379                                         'classdo'   => $item['starred'] ? 'hidden' : '',
 380                                         'classundo' => $item['starred'] ? '' : 'hidden',
 381                                         'starred'   => DI::l10n()->t('Starred'),
 382                                 ];
 383
 384                                 if ($conv->getProfileOwner() == DI::userSession()->getLocalUserId() && ($item['uid'] != 0)) {
 385                                         if ($origin && in_array($item['private'], [Item::PUBLIC, Item::UNLISTED])) {
 386                                                 $ispinned = ($item['featured'] ? 'pinned' : 'unpinned');
 387
 388                                                 $pin = [
 389                                                         'do'        => DI::l10n()->t('Pin'),
 390                                                         'undo'      => DI::l10n()->t('Unpin'),
 391                                                         'toggle'    => DI::l10n()->t('Toggle pin status'),
 392                                                         'classdo'   => $item['featured'] ? 'hidden' : '',
 393                                                         'classundo' => $item['featured'] ? '' : 'hidden',
 394                                                         'pinned'   => DI::l10n()->t('Pinned'),
 395                                                 ];
 396                                         }
 397
 398                                         $tagger = [
 399                                                 'add'   => DI::l10n()->t('Add tag'),
 400                                                 'class' => '',
 401                                         ];
 402                                 }
 403                         }
 404                 } else {
 405                         $indent = 'comment';
 406                 }
 407
 408                 if ($conv->isWritable()) {
 409                         $buttons['like']    = [DI::l10n()->t("I like this \x28toggle\x29"), DI::l10n()->t('Like')];
 410                         $buttons['dislike'] = [DI::l10n()->t("I don't like this \x28toggle\x29"), DI::l10n()->t('Dislike')];
 411                         if ($shareable) {
 412                                 $buttons['share'] = [DI::l10n()->t('Quote share this'), DI::l10n()->t('Quote Share')];
 413                         }
 414                         if ($announceable) {
 415                                 $buttons['announce'] = [DI::l10n()->t('Reshare this'), DI::l10n()->t('Reshare')];
 416                                 $buttons['unannounce'] = [DI::l10n()->t('Cancel your Reshare'), DI::l10n()->t('Unshare')];
 417                         }
 418                 }
 419
 420                 if ($commentable) {
 421                         $comment_html = $this->getCommentBox($indent);
 422                 } else {
 423                         $comment_html = '';
 424                 }
 425
 426                 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
 427                         $shiny = 'shiny';
 428                 }
 429
 430                 DI::contentItem()->localize($item);
 431
 432                 $body_html = Item::prepareBody($item, true);
 433
 434                 list($categories, $folders) = DI::contentItem()->determineCategoriesTerms($item, DI::userSession()->getLocalUserId());
 435
 436                 if (!empty($item['title'])) {
 437                         $title = $item['title'];
 438                 } elseif (!empty($item['content-warning']) && DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'disable_cw', false)) {
 439                         $title = ucfirst($item['content-warning']);
 440                 } else {
 441                         $title = '';
 442                 }
 443
 444                 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'hide_dislike')) {
 445                         $buttons['dislike'] = false;
 446                 }
 447
 448                 // Disable features that aren't available in several networks
 449                 if (!in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
 450                         if ($buttons['dislike']) {
 451                                 $buttons['dislike'] = false;
 452                         }
 453
 454                         $isevent = false;
 455                         $tagger = '';
 456                 }
 457
 458                 if ($buttons['like'] && in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
 459                         $buttons['like'] = false;
 460                 }
 461
 462                 $tags = Tag::populateFromItem($item);
 463
 464                 $ago = Temporal::getRelativeDate($item['created']);
 465                 $ago_received = Temporal::getRelativeDate($item['received']);
 466                 if (DI::config()->get('system', 'show_received') && (abs(strtotime($item['created']) - strtotime($item['received'])) > DI::config()->get('system', 'show_received_seconds')) && ($ago != $ago_received)) {
 467                         $ago = DI::l10n()->t('%s (Received %s)', $ago, $ago_received);
 468                 }
 469
 470                 // Fetching of Diaspora posts doesn't always work. There are issues with reshares and possibly comments
 471                 if (!DI::userSession()->getLocalUserId() && ($item['network'] != Protocol::DIASPORA) && !empty(DI::session()->get('remote_comment'))) {
 472                         $remote_comment = [
 473                                 DI::l10n()->t('Comment this item on your system'), DI::l10n()->t('Remote comment'),
 474                                 str_replace('{uri}', urlencode($item['uri']), DI::session()->get('remote_comment'))
 475                         ];
 476
 477                         // Ensure to either display the remote comment or the local activities
 478                         $buttons = [];
 479                         $comment_html = '';
 480                 } else {
 481                         $remote_comment = '';
 482                 }
 483
 484                 $direction = [];
 485                 if (!empty($item['direction'])) {
 486                         $direction = $item['direction'];
 487                 }
 488
 489                 $languages = [];
 490                 if (!empty($item['language'])) {
 491                         $languages = [DI::l10n()->t('Languages'), Item::getLanguageMessage($item)];
 492                 }
 493
 494                 if (in_array($item['private'], [Item::PUBLIC, Item::UNLISTED]) && in_array($item['network'], Protocol::FEDERATED)) {
 495                         $browsershare = [DI::l10n()->t('Share via ...'), DI::l10n()->t('Share via external services')];
 496                 } else {
 497                         $browsershare = null;
 498                 }
 499
 500                 $parent_guid     = $thread_parent[$item['thr-parent-id']]['guid'] ?? '';
 501                 $parent_username = $thread_parent[$item['thr-parent-id']]['name'] ?? '';
 502
 503                 $tmp_item = [
 504                         'parentguid'      => $parent_guid,
 505                         'isreplyto'       => DI::l10n()->t('is reply to %s', $parent_username),
 506                         'template'        => $this->getTemplate(),
 507                         'type'            => implode('', array_slice(explode('/', $item['verb']), -1)),
 508                         'comment_firstcollapsed' => false,
 509                         'comment_lastcollapsed' => false,
 510                         'suppress_tags'   => DI::config()->get('system', 'suppress_tags'),
 511                         'tags'            => $tags['tags'],
 512                         'hashtags'        => $tags['hashtags'],
 513                         'mentions'        => $tags['mentions'],
 514                         'implicit_mentions' => $tags['implicit_mentions'],
 515                         'txt_cats'        => DI::l10n()->t('Categories:'),
 516                         'txt_folders'     => DI::l10n()->t('Filed under:'),
 517                         'has_cats'        => ((count($categories)) ? 'true' : ''),
 518                         'has_folders'     => ((count($folders)) ? 'true' : ''),
 519                         'categories'      => $categories,
 520                         'folders'         => $folders,
 521                         'body_html'       => $body_html,
 522                         'text'            => strip_tags($body_html),
 523                         'id'              => $this->getId(),
 524                         'guid'            => urlencode($item['guid']),
 525                         'isevent'         => $isevent,
 526                         'attend'          => $attend,
 527                         'linktitle'       => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
 528                         'olinktitle'      => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
 529                         'to'              => DI::l10n()->t('to'),
 530                         'via'             => DI::l10n()->t('via'),
 531                         'wall'            => DI::l10n()->t('Wall-to-Wall'),
 532                         'vwall'           => DI::l10n()->t('via Wall-To-Wall:'),
 533                         'profile_url'     => $profile_link,
 534                         'name'            => $profile_name,
 535                         'item_photo_menu_html' => DI::contentItem()->photoMenu($item, $formSecurityToken),
 536                         'thumb'           => DI::baseUrl()->remove(DI::contentItem()->getAuthorAvatar($item)),
 537                         'osparkle'        => $osparkle,
 538                         'sparkle'         => $sparkle,
 539                         'title'           => $title,
 540                         'localtime'       => DateTimeFormat::local($item['created'], 'r'),
 541                         'ago'             => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
 542                         'app'             => $item['app'],
 543                         'created'         => $ago,
 544                         'lock'            => $lock,
 545                         'private'         => $item['private'],
 546                         'privacy'         => $privacy,
 547                         'connector'       => $connector,
 548                         'location_html'   => $location_html,
 549                         'indent'          => $indent,
 550                         'shiny'           => $shiny,
 551                         'owner_self'      => $item['author-link'] == DI::session()->get('my_url'),
 552                         'owner_url'       => $this->getOwnerUrl(),
 553                         'owner_photo'     => DI::baseUrl()->remove(DI::contentItem()->getOwnerAvatar($item)),
 554                         'owner_name'      => $this->getOwnerName(),
 555                         'plink'           => Item::getPlink($item),
 556                         'browsershare'    => $browsershare,
 557                         'edpost'          => $edpost,
 558                         'ispinned'        => $ispinned,
 559                         'pin'             => $pin,
 560                         'pinned'          => $pinned,
 561                         'isstarred'       => $isstarred,
 562                         'star'            => $star,
 563                         'ignore'          => $ignore_thread,
 564                         'tagger'          => $tagger,
 565                         'filer'           => $filer,
 566                         'language'        => $languages,
 567                         'drop'            => $drop,
 568                         'block'           => $block,
 569                         'ignore_author'   => $ignore,
 570                         'collapse'        => $collapse,
 571                         'report'          => $report,
 572                         'ignore_server'     => $ignoreServer,
 573                         'vote'            => $buttons,
 574                         'like_html'       => $responses['like']['output'],
 575                         'dislike_html'    => $responses['dislike']['output'],
 576                         'emojis'          => $this->getEmojis($item),
 577                         'responses'       => $responses,
 578                         'switchcomment'   => DI::l10n()->t('Comment'),
 579                         'reply_label'     => DI::l10n()->t('Reply to %s', $profile_name),
 580                         'comment_html'    => $comment_html,
 581                         'remote_comment'  => $remote_comment,
 582                         'menu'            => DI::l10n()->t('More'),
 583                         'previewing'      => $conv->isPreview() ? ' preview ' : '',
 584                         'wait'            => DI::l10n()->t('Please wait'),
 585                         'thread_level'    => $thread_level,
 586                         'edited'          => $edited,
 587                         'author_gsid'     => $item['author-gsid'],
 588                         'network'         => $item['network'],
 589                         'network_name'    => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network'], $item['author-gsid']),
 590                         'network_icon'    => ContactSelector::networkToIcon($item['network'], $item['author-link'], $item['author-gsid']),
 591                         'received'        => $item['received'],
 592                         'commented'       => $item['commented'],
 593                         'created_date'    => $item['created'],
 594                         'uriid'           => $item['uri-id'],
 595                         'return'          => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
 596                         'direction'       => $direction,
 597                         'reshared'        => $item['reshared'] ?? '',
 598                         'delivery'        => [
 599                                 'queue_count'       => $item['delivery_queue_count'],
 600                                 'queue_done'        => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
 601                                 'notifier_pending'  => DI::l10n()->t('Notifier task is pending'),
 602                                 'delivery_pending'  => DI::l10n()->t('Delivery to remote servers is pending'),
 603                                 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
 604                                 'delivery_almost'   => DI::l10n()->t('Delivery to remote servers is mostly done'),
 605                                 'delivery_done'     => DI::l10n()->t('Delivery to remote servers is done'),
 606                         ],
 607                 ];
 608
 609                 $arr = ['item' => $item, 'output' => $tmp_item];
 610                 Hook::callAll('display_item', $arr);
 611
 612                 $result = $arr['output'];
 613
 614                 $result['children'] = [];
 615                 $children = $this->getChildren();
 616                 $nb_children = count($children);
 617                 if ($nb_children > 0) {
 618                         $thread_parent[$item['uri-id']] = ['guid' => $item['guid'], 'name' => $item['author-name']];
 619                         foreach ($children as $child) {
 620                                 $thread_parent[$child->getDataValue('uri-id')] = ['guid' => $child->getDataValue('guid'), 'name' => $child->getDataValue('author-name')];
 621                                 $result['children'][] = $child->getTemplateData($conv_responses, $formSecurityToken, $thread_level + 1, $thread_parent);
 622                         }
 623
 624                         // Collapse
 625                         if (($nb_children > 2) || ($thread_level > 1)) {
 626                                 $result['children'][0]['comment_firstcollapsed'] = true;
 627                                 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
 628                                 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
 629                                 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
 630                                 if ($thread_level > 1) {
 631                                         $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
 632                                 } else {
 633                                         $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
 634                                 }
 635                         }
 636                 }
 637
 638                 // Copy values/set defaults
 639                 $result['total_comments_num'] = $this->isToplevel() ? $total_children : 0;
 640                 $result['private']            = $item['private'];
 641                 $result['toplevel']           = ($this->isToplevel() ? 'toplevel_item' : '');
 642                 $result['flatten']            = !$this->isThreaded();
 643                 $result['threaded']           = $this->isThreaded();
 644
 645                 return $result;
 646         }
 647
 648         /**
 649          * Fetch emojis
 650          *
 651          * @param array $item
 652          * @return array
 653          */
 654         private function getEmojis(array $item): array
 655         {
 656                 if (empty($item['emojis'])) {
 657                         return [];
 658                 }
 659
 660                 $emojis = [];
 661                 foreach ($item['emojis'] as $index => $element) {
 662                         $actors = implode(', ', $element['title']);
 663                         switch ($element['verb']) {
 664                                 case Activity::ANNOUNCE:
 665                                         $title = DI::l10n()->t('Reshared by: %s', $actors);
 666                                         $icon  = ['fa' => 'fa-retweet', 'icon' => 'icon-retweet'];
 667                                         break;
 668
 669                                 case Activity::VIEW:
 670                                         $title = DI::l10n()->t('Viewed by: %s', $actors);
 671                                         $icon  = ['fa' => 'fa-eye', 'icon' => 'icon-eye-open'];
 672                                         break;
 673
 674                                 case Activity::LIKE:
 675                                         $title = DI::l10n()->t('Liked by: %s', $actors);
 676                                         $icon  = ['fa' => 'fa-thumbs-up', 'icon' => 'icon-thumbs-up'];
 677                                         break;
 678
 679                                 case Activity::DISLIKE:
 680                                         $title = DI::l10n()->t('Disliked by: %s', $actors);
 681                                         $icon  = ['fa' => 'fa-thumbs-down', 'icon' => 'icon-thumbs-down'];
 682                                         break;
 683
 684                                 case Activity::ATTEND:
 685                                         $title = DI::l10n()->t('Attended by: %s', $actors);
 686                                         $icon  = ['fa' => 'fa-check', 'icon' => 'icon-ok'];
 687                                         break;
 688
 689                                 case Activity::ATTENDMAYBE:
 690                                         $title = DI::l10n()->t('Maybe attended by: %s', $actors);
 691                                         $icon  = ['fa' => 'fa-question', 'icon' => 'icon-question'];
 692                                         break;
 693
 694                                 case Activity::ATTENDNO:
 695                                         $title = DI::l10n()->t('Not attended by: %s', $actors);
 696                                         $icon  = ['fa' => 'fa-times', 'icon' => 'icon-remove'];
 697                                         break;
 698
 699                                 default:
 700                                         $title = DI::l10n()->t('Reacted with %s by: %s', $element['emoji'], $actors);
 701                                         $icon  = [];
 702                                         break;
 703                         }
 704                         $emojis[$index] = ['emoji' => $element['emoji'], 'total' => $element['total'], 'title' => $title, 'icon' => $icon];
 705                 }
 706                 ksort($emojis);
 707
 708                 return $emojis;
 709         }
 710
 711         /**
 712          * @return integer
 713          */
 714         public function getId(): int
 715         {
 716                 return $this->getDataValue('id');
 717         }
 718
 719         /**
 720          * @return boolean
 721          */
 722         public function isThreaded(): bool
 723         {
 724                 return $this->threaded;
 725         }
 726
 727         /**
 728          * Add a child post
 729          *
 730          * @param Post $item The child post to add
 731          *
 732          * @return Post|bool Last Post object or bool on any error
 733          * @throws \Exception
 734          */
 735         public function addChild(Post $item)
 736         {
 737                 if (!$item->getId()) {
 738                         Logger::error('Post object has no id', ['post' => $item]);
 739                         return false;
 740                 } elseif ($this->getChild($item->getId())) {
 741                         Logger::warning('Post object already exists', ['post' => $item]);
 742                         return false;
 743                 }
 744
 745                 /*
 746                  * Only add what will be displayed
 747                  */
 748                 if ($item->getDataValue('network') === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item->getDataValue('uid')) {
 749                         Logger::warning('Post object does not belong to local user', ['post' => $item, 'local_user' => DI::userSession()->getLocalUserId()]);
 750                         return false;
 751                 } elseif (
 752                         DI::activity()->match($item->getDataValue('verb'), Activity::LIKE) ||
 753                         DI::activity()->match($item->getDataValue('verb'), Activity::DISLIKE)
 754                 ) {
 755                         Logger::warning('Post objects is a like/dislike', ['post' => $item]);
 756                         return false;
 757                 }
 758
 759                 $item->setParent($this);
 760                 $this->children[] = $item;
 761
 762                 return end($this->children);
 763         }
 764
 765         /**
 766          * Get a child by its ID
 767          *
 768          * @param integer $id The child id
 769          * @return Thread|null Thread or NULL if not found
 770          */
 771         public function getChild(int $id)
 772         {
 773                 foreach ($this->getChildren() as $child) {
 774                         if ($child->getId() == $id) {
 775                                 return $child;
 776                         }
 777                 }
 778
 779                 return null;
 780         }
 781
 782         /**
 783          * Get all our children
 784          *
 785          * @return Post[]
 786          */
 787         public function getChildren(): array
 788         {
 789                 return $this->children;
 790         }
 791
 792         /**
 793          * Set our parent
 794          *
 795          * @param Post $item The item to set as parent
 796          * @return void
 797          */
 798         protected function setParent(Post $item)
 799         {
 800                 $parent = $this->getParent();
 801                 if ($parent) {
 802                         $parent->removeChild($this);
 803                 }
 804
 805                 $this->parent = $item;
 806                 $this->setThread($item->getThread());
 807         }
 808
 809         /**
 810          * Remove our parent
 811          *
 812          * @return void
 813          */
 814         protected function removeParent()
 815         {
 816                 $this->parent = null;
 817                 $this->thread = null;
 818         }
 819
 820         /**
 821          * Remove a child
 822          *
 823          * @param Post $item The child to be removed
 824          * @return boolean Success or failure
 825          * @throws \Exception
 826          */
 827         public function removeChild(Post $item): bool
 828         {
 829                 $id = $item->getId();
 830                 foreach ($this->getChildren() as $key => $child) {
 831                         if ($child->getId() == $id) {
 832                                 $child->removeParent();
 833                                 unset($this->children[$key]);
 834                                 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
 835                                 $this->children = array_values($this->children);
 836                                 return true;
 837                         }
 838                 }
 839
 840                 Logger::info('[WARN] Item::removeChild : Item is not a child (' . $id . ').');
 841                 return false;
 842         }
 843
 844         /**
 845          * Get parent item
 846          *
 847          * @return object
 848          */
 849         protected function getParent()
 850         {
 851                 return $this->parent;
 852         }
 853
 854         /**
 855          * Set conversation thread
 856          *
 857          * @param Thread|null $thread
 858          *
 859          * @return void
 860          */
 861         public function setThread(Thread $thread = null)
 862         {
 863                 $this->thread = $thread;
 864
 865                 // Set it on our children too
 866                 foreach ($this->getChildren() as $child) {
 867                         $child->setThread($thread);
 868                 }
 869         }
 870
 871         /**
 872          * Get conversation
 873          *
 874          * @return Thread|null
 875          */
 876         public function getThread()
 877         {
 878                 return $this->thread;
 879         }
 880
 881         /**
 882          * Get raw data
 883          *
 884          * We shouldn't need this
 885          *
 886          * @return array
 887          */
 888         public function getData(): array
 889         {
 890                 return $this->data;
 891         }
 892
 893         /**
 894          * Get a data value
 895          *
 896          * @param string $name key
 897          *
 898          * @return mixed value on success, false on failure
 899          */
 900         public function getDataValue(string $name)
 901         {
 902                 if (!isset($this->data[$name])) {
 903                         // Logger::info('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".');
 904                         return false;
 905                 }
 906
 907                 return $this->data[$name];
 908         }
 909
 910         /**
 911          * Set template by name
 912          *
 913          * @param string $name Template name
 914          *
 915          * @return void
 916          * @throws InvalidArgumentException
 917          */
 918         private function setTemplate(string $name)
 919         {
 920                 if (empty($this->available_templates[$name])) {
 921                         // Throw exception
 922                         throw new InvalidArgumentException('[ERROR] Item::setTemplate : Template not available ("' . $name . '").');
 923                 }
 924
 925                 $this->template = $this->available_templates[$name];
 926         }
 927
 928         /**
 929          * Get template
 930          *
 931          * @return object
 932          */
 933         private function getTemplate()
 934         {
 935                 return $this->template;
 936         }
 937
 938         /**
 939          * Check if this is a toplevel post
 940          *
 941          * @return boolean
 942          */
 943         private function isToplevel(): bool
 944         {
 945                 return $this->toplevel;
 946         }
 947
 948         /**
 949          * Check if this is writable
 950          *
 951          * @return boolean
 952          */
 953         private function isWritable(): bool
 954         {
 955                 $conv = $this->getThread();
 956
 957                 if ($conv) {
 958                         // This will allow us to comment on wall-to-wall items owned by our friends
 959                         // and community groups even if somebody else wrote the post.
 960                         // bug #517 - this fixes for conversation owner
 961                         if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == DI::userSession()->getLocalUserId()) {
 962                                 return true;
 963                         }
 964
 965                         // this fixes for visitors
 966                         return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
 967                 }
 968                 return $this->writable;
 969         }
 970
 971         /**
 972          * Count the total of our descendants
 973          *
 974          * @return integer
 975          */
 976         private function countDescendants(): int
 977         {
 978                 $children = $this->getChildren();
 979                 $total = count($children);
 980                 if ($total > 0) {
 981                         foreach ($children as $child) {
 982                                 $total += $child->countDescendants();
 983                         }
 984                 }
 985
 986                 return $total;
 987         }
 988
 989         /**
 990          * Get the template for the comment box
 991          *
 992          * @return string
 993          */
 994         private function getCommentBoxTemplate(): string
 995         {
 996                 return $this->comment_box_template;
 997         }
 998
 999         /**
1000          * Get default text for the comment box
1001          *
1002          * @return string
1003          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1004          */
1005         private function getDefaultText(): string
1006         {
1007                 $a = DI::app();
1008
1009                 if (!DI::userSession()->getLocalUserId()) {
1010                         return '';
1011                 }
1012
1013                 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1014                 $item = $this->getData();
1015
1016                 if (!empty($item['content-warning']) && Feature::isEnabled(DI::userSession()->getLocalUserId(), 'add_abstract')) {
1017                         $text = '[abstract=' . Protocol::ACTIVITYPUB . ']' . $item['content-warning'] . "[/abstract]\n";
1018                 } else {
1019                         $text = '';
1020                 }
1021
1022                 if (!Feature::isEnabled(DI::userSession()->getLocalUserId(), 'explicit_mentions')) {
1023                         return $text;
1024                 }
1025
1026                 if (($item['author-addr'] != $owner['addr']) && (($item['gravity'] != Item::GRAVITY_PARENT) || !in_array($item['network'], [Protocol::DIASPORA]))) {
1027                         $text .= '@' . $item['author-addr'] . ' ';
1028                 }
1029
1030                 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1031                 foreach ($terms as $term) {
1032                         if (!$term['url']) {
1033                                 DI::logger()->warning('Mention term with no URL', ['term' => $term]);
1034                                 continue;
1035                         }
1036
1037                         $profile = Contact::getByURL($term['url'], false, ['addr', 'contact-type']);
1038                         if (
1039                                 !empty($profile['addr']) && (($profile['contact-type'] ?? Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
1040                                 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])
1041                         ) {
1042                                 $text .= '@' . $profile['addr'] . ' ';
1043                         }
1044                 }
1045
1046                 return $text;
1047         }
1048
1049         /**
1050          * Get the comment box
1051          *
1052          * @param string $indent Indent value
1053          *
1054          * @return mixed The comment box string (empty if no comment box), false on failure
1055          * @throws \Exception
1056          * @todo return false is nowhere in this method?
1057          */
1058         private function getCommentBox(string $indent)
1059         {
1060                 $a = DI::app();
1061
1062                 $comment_box = '';
1063                 $conv = $this->getThread();
1064
1065                 if ($conv->isWritable() && $this->isWritable()) {
1066                         /*
1067                          * Hmmm, code depending on the presence of a particular addon?
1068                          * This should be better if done by a hook
1069                          */
1070                         $qcomment = null;
1071                         if (Addon::isEnabled('qcomment')) {
1072                                 $words = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'qcomment', 'words');
1073                                 $qcomment = $words ? explode("\n", $words) : [];
1074                         }
1075
1076                         // Fetch the user id from the parent when the owner user is empty
1077                         $uid = $conv->getProfileOwner();
1078                         $parent_uid = $this->getDataValue('uid');
1079
1080                         $owner = User::getOwnerDataById($a->getLoggedInUserId());
1081
1082                         $default_text = $this->getDefaultText();
1083
1084                         if (!is_null($parent_uid) && ($uid != $parent_uid)) {
1085                                 $uid = $parent_uid;
1086                         }
1087
1088                         $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
1089                         $comment_box = Renderer::replaceMacros($template, [
1090                                 '$return_path' => DI::args()->getQueryString(),
1091                                 '$threaded'    => $this->isThreaded(),
1092                                 '$jsreload'    => '',
1093                                 '$wall'        => ($conv->getMode() === 'profile'),
1094                                 '$id'          => $this->getId(),
1095                                 '$parent'      => $this->getId(),
1096                                 '$qcomment'    => $qcomment,
1097                                 '$default'     => $default_text,
1098                                 '$profile_uid' => $uid,
1099                                 '$mylink'      => DI::baseUrl()->remove($owner['url'] ?? ''),
1100                                 '$mytitle'     => DI::l10n()->t('This is you'),
1101                                 '$myphoto'     => DI::baseUrl()->remove($owner['thumb'] ?? ''),
1102                                 '$comment'     => DI::l10n()->t('Comment'),
1103                                 '$submit'      => DI::l10n()->t('Submit'),
1104                                 '$loading'     => DI::l10n()->t('Loading...'),
1105                                 '$edbold'      => DI::l10n()->t('Bold'),
1106                                 '$editalic'    => DI::l10n()->t('Italic'),
1107                                 '$eduline'     => DI::l10n()->t('Underline'),
1108                                 '$contentwarn' => DI::l10n()->t('Content Warning'),
1109                                 '$edquote'     => DI::l10n()->t('Quote'),
1110                                 '$edemojis'    => DI::l10n()->t('Add emojis'),
1111                                 '$edcode'      => DI::l10n()->t('Code'),
1112                                 '$edimg'       => DI::l10n()->t('Image'),
1113                                 '$edurl'       => DI::l10n()->t('Link'),
1114                                 '$edattach'    => DI::l10n()->t('Link or Media'),
1115                                 '$prompttext'  => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
1116                                 '$preview'     => DI::l10n()->t('Preview'),
1117                                 '$indent'      => $indent,
1118                                 '$rand_num'    => Crypto::randomDigits(12)
1119                         ]);
1120                 }
1121
1122                 return $comment_box;
1123         }
1124
1125         /**
1126          * @return string
1127          */
1128         private function getRedirectUrl(): string
1129         {
1130                 return $this->redirect_url;
1131         }
1132
1133         /**
1134          * Check if we are a wall to wall item and set the relevant properties
1135          *
1136          * @return void
1137          * @throws \Exception
1138          */
1139         protected function checkWallToWall()
1140         {
1141                 $a = DI::app();
1142                 $conv = $this->getThread();
1143                 $this->wall_to_wall = false;
1144
1145                 if ($this->isToplevel()) {
1146                         if ($conv->getMode() !== 'profile') {
1147                                 if ($this->getDataValue('owner-link')) {
1148                                         $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
1149                                         $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
1150                                         $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
1151
1152                                         if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
1153                                                 /*
1154                                                  * The author url doesn't match the owner (typically the contact)
1155                                                  * and also doesn't match the contact alias.
1156                                                  * The name match is a hack to catch several weird cases where URLs are
1157                                                  * all over the park. It can be tricked, but this prevents you from
1158                                                  * seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
1159                                                  * well that it's the same Bob Smith.
1160                                                  * But it could be somebody else with the same name. It just isn't highly likely.
1161                                                  */
1162                                                 $this->owner_name = $this->getDataValue('owner-name');
1163                                                 $this->wall_to_wall = true;
1164
1165                                                 $owner = [
1166                                                         'uid'     => 0,
1167                                                         'id'      => $this->getDataValue('owner-id'),
1168                                                         'network' => $this->getDataValue('owner-network'),
1169                                                         'url'     => $this->getDataValue('owner-link'),
1170                                                         'alias'   => $this->getDataValue('owner-alias'),
1171                                                 ];
1172                                                 $this->owner_url = Contact::magicLinkByContact($owner);
1173                                         }
1174                                 }
1175                         }
1176                 }
1177
1178                 if (!$this->wall_to_wall) {
1179                         $this->setTemplate('wall');
1180                         $this->owner_url = '';
1181                         $this->owner_name = '';
1182                 }
1183         }
1184
1185         /**
1186          * @return boolean
1187          */
1188         private function isWallToWall(): bool
1189         {
1190                 return $this->wall_to_wall;
1191         }
1192
1193         /**
1194          * @return string
1195          */
1196         private function getOwnerUrl(): string
1197         {
1198                 return $this->owner_url;
1199         }
1200
1201         /**
1202          * @return string
1203          */
1204         private function getOwnerName(): string
1205         {
1206                 return $this->owner_name;
1207         }
1208
1209         /**
1210          * @return boolean
1211          */
1212         private function isVisiting(): bool
1213         {
1214                 return $this->visiting;
1215         }
1216 }