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