src/Object/Post.php

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