src/Object/Post.php

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