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\Strings;
  43 use Friendica\Util\Temporal;
  44
  45 /**
  46  * An item
  47  */
  48 class Post
  49 {
  50         private $data = [];
  51         private $template = null;
  52         private $available_templates = [
  53                 'wall' => 'wall_thread.tpl',
  54                 'wall2wall' => 'wallwall_thread.tpl'
  55         ];
  56         private $comment_box_template = 'comment_item.tpl';
  57         private $toplevel = false;
  58         private $writable = false;
  59         /**
  60          * @var Post[]
  61          */
  62         private $children = [];
  63         private $parent = null;
  64
  65         /**
  66          * @var Thread
  67          */
  68         private $thread = null;
  69         private $redirect_url = null;
  70         private $owner_url = '';
  71         private $owner_photo = '';
  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($a->contact['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 (($item['network'] != Protocol::DIASPORA) && empty($comment) && !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                 } else {
 408                         $remote_comment = '';
 409                 }
 410
 411                 $direction = [];
 412                 if (!empty($item['direction'])) {
 413                         $direction = $item['direction'];
 414                 } elseif (DI::config()->get('debug', 'show_direction')) {
 415                         $conversation = DBA::selectFirst('conversation', ['direction'], ['item-uri' => $item['uri']]);
 416                         if (!empty($conversation['direction']) && in_array($conversation['direction'], [1, 2])) {
 417                                 $direction_title = [1 => DI::l10n()->t('Pushed'), 2 => DI::l10n()->t('Pulled')];
 418                                 $direction = ['direction' => $conversation['direction'], 'title' => $direction_title[$conversation['direction']]];
 419                         }
 420                 }
 421
 422                 $languages = [];
 423                 if (!empty($item['language'])) {
 424                         $languages = [DI::l10n()->t('Languages'), Item::getLanguageMessage($item)];
 425                 }
 426
 427                 $tmp_item = [
 428                         'template'        => $this->getTemplate(),
 429                         'type'            => implode("", array_slice(explode("/", $item['verb']), -1)),
 430                         'comment_firstcollapsed' => false,
 431                         'comment_lastcollapsed' => false,
 432                         'suppress_tags'   => DI::config()->get('system', 'suppress_tags'),
 433                         'tags'            => $tags['tags'],
 434                         'hashtags'        => $tags['hashtags'],
 435                         'mentions'        => $tags['mentions'],
 436                         'implicit_mentions' => $tags['implicit_mentions'],
 437                         'txt_cats'        => DI::l10n()->t('Categories:'),
 438                         'txt_folders'     => DI::l10n()->t('Filed under:'),
 439                         'has_cats'        => ((count($categories)) ? 'true' : ''),
 440                         'has_folders'     => ((count($folders)) ? 'true' : ''),
 441                         'categories'      => $categories,
 442                         'folders'         => $folders,
 443                         'body_html'       => $body_html,
 444                         'text'            => strip_tags($body_html),
 445                         'id'              => $this->getId(),
 446                         'guid'            => urlencode($item['guid']),
 447                         'isevent'         => $isevent,
 448                         'attend'          => $attend,
 449                         'linktitle'       => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
 450                         'olinktitle'      => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
 451                         'to'              => DI::l10n()->t('to'),
 452                         'via'             => DI::l10n()->t('via'),
 453                         'wall'            => DI::l10n()->t('Wall-to-Wall'),
 454                         'vwall'           => DI::l10n()->t('via Wall-To-Wall:'),
 455                         'profile_url'     => $profile_link,
 456                         'name'            => $profile_name,
 457                         'item_photo_menu_html' => item_photo_menu($item),
 458                         'thumb'           => DI::baseUrl()->remove($item['author-avatar']),
 459                         'osparkle'        => $osparkle,
 460                         'sparkle'         => $sparkle,
 461                         'title'           => $title,
 462                         'localtime'       => DateTimeFormat::local($item['created'], 'r'),
 463                         'ago'             => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
 464                         'app'             => $item['app'],
 465                         'created'         => $ago,
 466                         'lock'            => $lock,
 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($item['owner-avatar']),
 473                         'owner_name'      => $this->getOwnerName(),
 474                         'plink'           => Item::getPlink($item),
 475                         'edpost'          => $edpost,
 476                         'ispinned'        => $ispinned,
 477                         'pin'             => $pin,
 478                         'pinned'          => $pinned,
 479                         'isstarred'       => $isstarred,
 480                         'star'            => $star,
 481                         'ignore'          => $ignore,
 482                         'tagger'          => $tagger,
 483                         'filer'           => $filer,
 484                         'language'        => $languages,
 485                         'drop'            => $drop,
 486                         'block'           => $block,
 487                         'vote'            => $buttons,
 488                         'like_html'       => $responses['like']['output'],
 489                         'dislike_html'    => $responses['dislike']['output'],
 490                         'responses'       => $responses,
 491                         'switchcomment'   => DI::l10n()->t('Comment'),
 492                         'reply_label'     => DI::l10n()->t('Reply to %s', $profile_name),
 493                         'comment_html'    => $comment_html,
 494                         'remote_comment'  => $remote_comment,
 495                         'menu'            => DI::l10n()->t('More'),
 496                         'previewing'      => $conv->isPreview() ? ' preview ' : '',
 497                         'wait'            => DI::l10n()->t('Please wait'),
 498                         'thread_level'    => $thread_level,
 499                         'edited'          => $edited,
 500                         'network'         => $item["network"],
 501                         'network_name'    => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network']),
 502                         'network_icon'    => ContactSelector::networkToIcon($item['network'], $item['author-link']),
 503                         'received'        => $item['received'],
 504                         'commented'       => $item['commented'],
 505                         'created_date'    => $item['created'],
 506                         'uriid'           => $item['uri-id'],
 507                         'return'          => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
 508                         'direction'       => $direction,
 509                         'reshared'        => $item['reshared'] ?? '',
 510                         'delivery'        => [
 511                                 'queue_count'       => $item['delivery_queue_count'],
 512                                 'queue_done'        => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
 513                                 'notifier_pending'  => DI::l10n()->t('Notifier task is pending'),
 514                                 'delivery_pending'  => DI::l10n()->t('Delivery to remote servers is pending'),
 515                                 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
 516                                 'delivery_almost'   => DI::l10n()->t('Delivery to remote servers is mostly done'),
 517                                 'delivery_done'     => DI::l10n()->t('Delivery to remote servers is done'),
 518                         ],
 519                 ];
 520
 521                 $arr = ['item' => $item, 'output' => $tmp_item];
 522                 Hook::callAll('display_item', $arr);
 523
 524                 $result = $arr['output'];
 525
 526                 $result['children'] = [];
 527                 $children = $this->getChildren();
 528                 $nb_children = count($children);
 529                 if ($nb_children > 0) {
 530                         foreach ($children as $child) {
 531                                 $result['children'][] = $child->getTemplateData($conv_responses, $thread_level + 1);
 532                         }
 533
 534                         // Collapse
 535                         if (($nb_children > 2) || ($thread_level > 1)) {
 536                                 $result['children'][0]['comment_firstcollapsed'] = true;
 537                                 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
 538                                 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
 539                                 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
 540                                 if ($thread_level > 1) {
 541                                         $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
 542                                 } else {
 543                                         $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
 544                                 }
 545                         }
 546                 }
 547
 548                 $result['total_comments_num'] = $this->isToplevel() ? $total_children : 0;
 549
 550                 $result['private'] = $item['private'];
 551                 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
 552
 553                 if ($this->isThreaded()) {
 554                         $result['flatten'] = false;
 555                         $result['threaded'] = true;
 556                 } else {
 557                         $result['flatten'] = true;
 558                         $result['threaded'] = false;
 559                 }
 560
 561                 return $result;
 562         }
 563
 564         /**
 565          * @return integer
 566          */
 567         public function getId()
 568         {
 569                 return $this->getDataValue('id');
 570         }
 571
 572         /**
 573          * @return boolean
 574          */
 575         public function isThreaded()
 576         {
 577                 return $this->threaded;
 578         }
 579
 580         /**
 581          * Add a child item
 582          *
 583          * @param Post $item The child item to add
 584          *
 585          * @return mixed
 586          * @throws \Exception
 587          */
 588         public function addChild(Post $item)
 589         {
 590                 $item_id = $item->getId();
 591                 if (!$item_id) {
 592                         Logger::log('[ERROR] Post::addChild : Item has no ID!!', Logger::DEBUG);
 593                         return false;
 594                 } elseif ($this->getChild($item->getId())) {
 595                         Logger::log('[WARN] Post::addChild : Item already exists (' . $item->getId() . ').', Logger::DEBUG);
 596                         return false;
 597                 }
 598
 599                 $activity = DI::activity();
 600
 601                 /*
 602                  * Only add what will be displayed
 603                  */
 604                 if ($item->getDataValue('network') === Protocol::MAIL && local_user() != $item->getDataValue('uid')) {
 605                         return false;
 606                 } elseif ($activity->match($item->getDataValue('verb'), Activity::LIKE) ||
 607                           $activity->match($item->getDataValue('verb'), Activity::DISLIKE)) {
 608                         return false;
 609                 }
 610
 611                 $item->setParent($this);
 612                 $this->children[] = $item;
 613
 614                 return end($this->children);
 615         }
 616
 617         /**
 618          * Get a child by its ID
 619          *
 620          * @param integer $id The child id
 621          *
 622          * @return mixed
 623          */
 624         public function getChild($id)
 625         {
 626                 foreach ($this->getChildren() as $child) {
 627                         if ($child->getId() == $id) {
 628                                 return $child;
 629                         }
 630                 }
 631
 632                 return null;
 633         }
 634
 635         /**
 636          * Get all our children
 637          *
 638          * @return Post[]
 639          */
 640         public function getChildren()
 641         {
 642                 return $this->children;
 643         }
 644
 645         /**
 646          * Set our parent
 647          *
 648          * @param Post $item The item to set as parent
 649          *
 650          * @return void
 651          */
 652         protected function setParent(Post $item)
 653         {
 654                 $parent = $this->getParent();
 655                 if ($parent) {
 656                         $parent->removeChild($this);
 657                 }
 658
 659                 $this->parent = $item;
 660                 $this->setThread($item->getThread());
 661         }
 662
 663         /**
 664          * Remove our parent
 665          *
 666          * @return void
 667          */
 668         protected function removeParent()
 669         {
 670                 $this->parent = null;
 671                 $this->thread = null;
 672         }
 673
 674         /**
 675          * Remove a child
 676          *
 677          * @param Post $item The child to be removed
 678          *
 679          * @return boolean Success or failure
 680          * @throws \Exception
 681          */
 682         public function removeChild(Post $item)
 683         {
 684                 $id = $item->getId();
 685                 foreach ($this->getChildren() as $key => $child) {
 686                         if ($child->getId() == $id) {
 687                                 $child->removeParent();
 688                                 unset($this->children[$key]);
 689                                 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
 690                                 $this->children = array_values($this->children);
 691                                 return true;
 692                         }
 693                 }
 694                 Logger::log('[WARN] Item::removeChild : Item is not a child (' . $id . ').', Logger::DEBUG);
 695                 return false;
 696         }
 697
 698         /**
 699          * Get parent item
 700          *
 701          * @return object
 702          */
 703         protected function getParent()
 704         {
 705                 return $this->parent;
 706         }
 707
 708         /**
 709          * Set conversation thread
 710          *
 711          * @param Thread $thread
 712          *
 713          * @return void
 714          */
 715         public function setThread(Thread $thread = null)
 716         {
 717                 $this->thread = $thread;
 718
 719                 // Set it on our children too
 720                 foreach ($this->getChildren() as $child) {
 721                         $child->setThread($thread);
 722                 }
 723         }
 724
 725         /**
 726          * Get conversation
 727          *
 728          * @return Thread
 729          */
 730         public function getThread()
 731         {
 732                 return $this->thread;
 733         }
 734
 735         /**
 736          * Get raw data
 737          *
 738          * We shouldn't need this
 739          *
 740          * @return array
 741          */
 742         public function getData()
 743         {
 744                 return $this->data;
 745         }
 746
 747         /**
 748          * Get a data value
 749          *
 750          * @param string $name key
 751          *
 752          * @return mixed value on success
 753          *               false on failure
 754          */
 755         public function getDataValue($name)
 756         {
 757                 if (!isset($this->data[$name])) {
 758                         // Logger::log('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".', Logger::DEBUG);
 759                         return false;
 760                 }
 761
 762                 return $this->data[$name];
 763         }
 764
 765         /**
 766          * Set template
 767          *
 768          * @param string $name template name
 769          * @return bool
 770          * @throws \Exception
 771          */
 772         private function setTemplate($name)
 773         {
 774                 if (empty($this->available_templates[$name])) {
 775                         Logger::log('[ERROR] Item::setTemplate : Template not available ("' . $name . '").', Logger::DEBUG);
 776                         return false;
 777                 }
 778
 779                 $this->template = $this->available_templates[$name];
 780
 781                 return true;
 782         }
 783
 784         /**
 785          * Get template
 786          *
 787          * @return object
 788          */
 789         private function getTemplate()
 790         {
 791                 return $this->template;
 792         }
 793
 794         /**
 795          * Check if this is a toplevel post
 796          *
 797          * @return boolean
 798          */
 799         private function isToplevel()
 800         {
 801                 return $this->toplevel;
 802         }
 803
 804         /**
 805          * Check if this is writable
 806          *
 807          * @return boolean
 808          */
 809         private function isWritable()
 810         {
 811                 $conv = $this->getThread();
 812
 813                 if ($conv) {
 814                         // This will allow us to comment on wall-to-wall items owned by our friends
 815                         // and community forums even if somebody else wrote the post.
 816                         // bug #517 - this fixes for conversation owner
 817                         if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == local_user()) {
 818                                 return true;
 819                         }
 820
 821                         // this fixes for visitors
 822                         return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
 823                 }
 824                 return $this->writable;
 825         }
 826
 827         /**
 828          * Count the total of our descendants
 829          *
 830          * @return integer
 831          */
 832         private function countDescendants()
 833         {
 834                 $children = $this->getChildren();
 835                 $total = count($children);
 836                 if ($total > 0) {
 837                         foreach ($children as $child) {
 838                                 $total += $child->countDescendants();
 839                         }
 840                 }
 841
 842                 return $total;
 843         }
 844
 845         /**
 846          * Get the template for the comment box
 847          *
 848          * @return string
 849          */
 850         private function getCommentBoxTemplate()
 851         {
 852                 return $this->comment_box_template;
 853         }
 854
 855         /**
 856          * Get default text for the comment box
 857          *
 858          * @return string
 859          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 860          */
 861         private function getDefaultText()
 862         {
 863                 $a = DI::app();
 864
 865                 if (!local_user()) {
 866                         return '';
 867                 }
 868
 869                 $owner = User::getOwnerDataById($a->user['uid']);
 870
 871                 if (!Feature::isEnabled(local_user(), 'explicit_mentions')) {
 872                         return '';
 873                 }
 874
 875                 $item = PostModel::selectFirst(['author-addr', 'uri-id', 'network', 'gravity'], ['id' => $this->getId()]);
 876                 if (!DBA::isResult($item) || empty($item['author-addr'])) {
 877                         // Should not happen
 878                         return '';
 879                 }
 880
 881                 if (($item['author-addr'] != $owner['addr']) && (($item['gravity'] != GRAVITY_PARENT) || !in_array($item['network'], [Protocol::DIASPORA]))) {
 882                         $text = '@' . $item['author-addr'] . ' ';
 883                 } else {
 884                         $text = '';
 885                 }
 886
 887                 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
 888                 foreach ($terms as $term) {
 889                         if (!$term['url']) {
 890                                 DI::logger()->warning('Mention term with no URL', ['term' => $term]);
 891                                 continue;
 892                         }
 893
 894                         $profile = Contact::getByURL($term['url'], false, ['addr', 'contact-type']);
 895                         if (!empty($profile['addr']) && (($profile['contact-type'] ?? Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
 896                                 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])) {
 897                                 $text .= '@' . $profile['addr'] . ' ';
 898                         }
 899                 }
 900
 901                 return $text;
 902         }
 903
 904         /**
 905          * Get the comment box
 906          *
 907          * @param string $indent Indent value
 908          *
 909          * @return mixed The comment box string (empty if no comment box)
 910          *               false on failure
 911          * @throws \Exception
 912          */
 913         private function getCommentBox($indent)
 914         {
 915                 $a = DI::app();
 916
 917                 $comment_box = '';
 918                 $conv = $this->getThread();
 919
 920                 if ($conv->isWritable() && $this->isWritable()) {
 921                         /*
 922                          * Hmmm, code depending on the presence of a particular addon?
 923                          * This should be better if done by a hook
 924                          */
 925                         $qcomment = null;
 926                         if (Addon::isEnabled('qcomment')) {
 927                                 $words = DI::pConfig()->get(local_user(), 'qcomment', 'words');
 928                                 $qcomment = $words ? explode("\n", $words) : [];
 929                         }
 930
 931                         // Fetch the user id from the parent when the owner user is empty
 932                         $uid = $conv->getProfileOwner();
 933                         $parent_uid = $this->getDataValue('uid');
 934
 935                         $default_text = $this->getDefaultText();
 936
 937                         if (!is_null($parent_uid) && ($uid != $parent_uid)) {
 938                                 $uid = $parent_uid;
 939                         }
 940
 941                         $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
 942                         $comment_box = Renderer::replaceMacros($template, [
 943                                 '$return_path' => DI::args()->getQueryString(),
 944                                 '$threaded'    => $this->isThreaded(),
 945                                 '$jsreload'    => '',
 946                                 '$wall'        => ($conv->getMode() === 'profile'),
 947                                 '$id'          => $this->getId(),
 948                                 '$parent'      => $this->getId(),
 949                                 '$qcomment'    => $qcomment,
 950                                 '$default'     => $default_text,
 951                                 '$profile_uid' => $uid,
 952                                 '$mylink'      => DI::baseUrl()->remove($a->contact['url'] ?? ''),
 953                                 '$mytitle'     => DI::l10n()->t('This is you'),
 954                                 '$myphoto'     => DI::baseUrl()->remove($a->contact['thumb'] ?? ''),
 955                                 '$comment'     => DI::l10n()->t('Comment'),
 956                                 '$submit'      => DI::l10n()->t('Submit'),
 957                                 '$loading'     => DI::l10n()->t('Loading...'),
 958                                 '$edbold'      => DI::l10n()->t('Bold'),
 959                                 '$editalic'    => DI::l10n()->t('Italic'),
 960                                 '$eduline'     => DI::l10n()->t('Underline'),
 961                                 '$edquote'     => DI::l10n()->t('Quote'),
 962                                 '$edcode'      => DI::l10n()->t('Code'),
 963                                 '$edimg'       => DI::l10n()->t('Image'),
 964                                 '$edurl'       => DI::l10n()->t('Link'),
 965                                 '$edattach'    => DI::l10n()->t('Link or Media'),
 966                                 '$prompttext'  => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
 967                                 '$preview'     => DI::l10n()->t('Preview'),
 968                                 '$indent'      => $indent,
 969                                 '$sourceapp'   => DI::l10n()->t($a->sourcename),
 970                                 '$rand_num'    => Crypto::randomDigits(12)
 971                         ]);
 972                 }
 973
 974                 return $comment_box;
 975         }
 976
 977         /**
 978          * @return string
 979          */
 980         private function getRedirectUrl()
 981         {
 982                 return $this->redirect_url;
 983         }
 984
 985         /**
 986          * Check if we are a wall to wall item and set the relevant properties
 987          *
 988          * @return void
 989          * @throws \Exception
 990          */
 991         protected function checkWallToWall()
 992         {
 993                 $a = DI::app();
 994                 $conv = $this->getThread();
 995                 $this->wall_to_wall = false;
 996
 997                 if ($this->isToplevel()) {
 998                         if ($conv->getMode() !== 'profile') {
 999                                 if ($this->getDataValue('wall') && !$this->getDataValue('self') && !empty($a->page_contact)) {
1000                                         // On the network page, I am the owner. On the display page it will be the profile owner.
1001                                         // This will have been stored in $a->page_contact by our calling page.
1002                                         // Put this person as the wall owner of the wall-to-wall notice.
1003
1004                                         $this->owner_url = Contact::magicLinkByContact($a->page_contact);
1005                                         $this->owner_photo = $a->page_contact['thumb'];
1006                                         $this->owner_name = $a->page_contact['name'];
1007                                         $this->wall_to_wall = true;
1008                                 } elseif ($this->getDataValue('owner-link')) {
1009                                         $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
1010                                         $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
1011                                         $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
1012
1013                                         if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
1014                                                 // The author url doesn't match the owner (typically the contact)
1015                                                 // and also doesn't match the contact alias.
1016                                                 // The name match is a hack to catch several weird cases where URLs are
1017                                                 // all over the park. It can be tricked, but this prevents you from
1018                                                 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
1019                                                 // well that it's the same Bob Smith.
1020                                                 // But it could be somebody else with the same name. It just isn't highly likely.
1021
1022
1023                                                 $this->owner_photo = $this->getDataValue('owner-avatar');
1024                                                 $this->owner_name = $this->getDataValue('owner-name');
1025                                                 $this->wall_to_wall = true;
1026
1027                                                 $owner = ['uid' => 0, 'id' => $this->getDataValue('owner-id'),
1028                                                         'network' => $this->getDataValue('owner-network'),
1029                                                         'url' => $this->getDataValue('owner-link')];
1030                                                 $this->owner_url = Contact::magicLinkByContact($owner);
1031                                         }
1032                                 }
1033                         }
1034                 }
1035
1036                 if (!$this->wall_to_wall) {
1037                         $this->setTemplate('wall');
1038                         $this->owner_url = '';
1039                         $this->owner_photo = '';
1040                         $this->owner_name = '';
1041                 }
1042         }
1043
1044         /**
1045          * @return boolean
1046          */
1047         private function isWallToWall()
1048         {
1049                 return $this->wall_to_wall;
1050         }
1051
1052         /**
1053          * @return string
1054          */
1055         private function getOwnerUrl()
1056         {
1057                 return $this->owner_url;
1058         }
1059
1060         /**
1061          * @return string
1062          */
1063         private function getOwnerName()
1064         {
1065                 return $this->owner_name;
1066         }
1067
1068         /**
1069          * @return boolean
1070          */
1071         private function isVisiting()
1072         {
1073                 return $this->visiting;
1074         }
1075 }