src/Object/Post.php

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