src/Object/Post.php

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