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