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