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