3 * @file src/Object/Post.php
5 namespace Friendica\Object;
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\PConfig;
14 use Friendica\Database\DBM;
15 use Friendica\Model\Contact;
16 use Friendica\Util\DateTimeFormat;
17 use Friendica\Util\Temporal;
20 require_once 'include/dba.php';
21 require_once 'include/text.php';
22 require_once 'boot.php';
23 require_once 'include/conversation.php';
28 class Post extends BaseObject
31 private $template = null;
32 private $available_templates = [
33 'wall' => 'wall_thread.tpl',
34 'wall2wall' => 'wallwall_thread.tpl'
36 private $comment_box_template = 'comment_item.tpl';
37 private $toplevel = false;
38 private $writable = false;
39 private $children = [];
40 private $parent = null;
41 private $thread = null;
42 private $redirect_url = null;
43 private $owner_url = '';
44 private $owner_photo = '';
45 private $owner_name = '';
46 private $wall_to_wall = false;
47 private $threaded = false;
48 private $visiting = false;
53 * @param array $data data array
55 public function __construct(array $data)
60 $this->setTemplate('wall');
61 $this->toplevel = $this->getId() == $this->getDataValue('parent');
63 if (x($_SESSION, 'remote') && is_array($_SESSION['remote'])) {
64 foreach ($_SESSION['remote'] as $visitor) {
65 if ($visitor['cid'] == $this->getDataValue('contact-id')) {
66 $this->visiting = true;
72 $this->writable = $this->getDataValue('writable') || $this->getDataValue('self');
73 $this->redirect_url = Contact::magicLinkById($this->getDataValue('cid'));
75 if (!$this->isToplevel()) {
76 $this->threaded = true;
79 // Prepare the children
80 if (!empty($data['children'])) {
81 foreach ($data['children'] as $item) {
82 // Only add will be displayed
83 if ($item['network'] === NETWORK_MAIL && local_user() != $item['uid']) {
85 } elseif (!visible_activity($item)) {
89 // You can always comment on Diaspora and OStatus items
90 if (in_array($item['network'], [NETWORK_OSTATUS, NETWORK_DIASPORA]) && (local_user() == $item['uid'])) {
91 $item['writable'] = true;
94 $item['pagedrop'] = $data['pagedrop'];
95 $child = new Post($item);
96 $this->addChild($child);
102 * Get data in a form usable by a conversation template
104 * @param object $conv_responses conversation responses
105 * @param integer $thread_level default = 1
107 * @return mixed The data requested on success
110 public function getTemplateData($conv_responses, $thread_level = 1)
112 require_once "mod/proxy.php";
118 $item = $this->getData();
120 // If the time between "created" and "edited" differs we add
121 // a notice that the post was edited.
122 // Note: In some networks reshared items seem to have (sometimes) a difference
123 // between creation time and edit time of a second. Thats why we add the notice
124 // only if the difference is more than 1 second.
125 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
127 'label' => L10n::t('This entry was edited'),
128 'date' => DateTimeFormat::local($item['edited'], 'r'),
129 'relative' => Temporal::getRelativeDate($item['edited'])
138 $isstarred = "unstarred";
142 $total_children = $this->countDescendants();
144 $conv = $this->getThread();
146 $lock = ((($item['private'] == 1) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid'])
147 || strlen($item['deny_cid']) || strlen($item['deny_gid']))))
148 ? L10n::t('Private Message')
150 $shareable = in_array($conv->getProfileOwner(), [0, local_user()]) && $item['private'] != 1;
152 if (local_user() && link_compare($a->contact['url'], $item['author-link'])) {
153 if ($item["event-id"] != 0) {
154 $edpost = ["events/event/" . $item['event-id'], L10n::t("Edit")];
156 $edpost = ["editpost/" . $item['id'], L10n::t("Edit")];
158 $dropping = in_array($item['uid'], [0, local_user()]);
163 // Editing on items of not subscribed users isn't currently possible
164 // There are some issues on editing that prevent this.
165 // But also it is an issue of the supported protocols that doesn't allow editing at all.
166 if ($item['uid'] == 0) {
170 if (($this->getDataValue('uid') == local_user()) || $this->isVisiting()) {
174 $origin = $item['origin'];
177 /// @todo This shouldn't be done as query here, but better during the data creation.
178 // it is now done here, since during the RC phase we shouldn't make to intense changes.
179 $parent = dba::selectFirst('item', ['origin'], ['id' => $item['parent']]);
180 if (DBM::is_result($parent)) {
181 $origin = $parent['origin'];
185 // Showing the one or the other text, depending upon if we can only hide it or really delete it.
186 $delete = $origin ? L10n::t('Delete globally') : L10n::t('Remove locally');
189 'dropping' => $dropping,
190 'pagedrop' => ((Feature::isEnabled($conv->getProfileOwner(), 'multi_delete')) ? $item['pagedrop'] : ''),
191 'select' => L10n::t('Select'),
195 if (!local_user() || ($item['uid'] == 0)) {
199 $filer = (($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) ? L10n::t("save to folder") : false);
201 $profile_name = htmlentities($item['author-name']);
202 if (!empty($item['author-link']) && empty($item['author-name'])) {
203 $profile_name = $item['author-link'];
206 $profile_link = Contact::magicLinkById($item['author-id']);
207 if (strpos($profile_link, 'redir/') === 0) {
208 $sparkle = ' sparkle';
211 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
212 Addon::callHooks('render_location', $locate);
213 $location = ((strlen($locate['html'])) ? $locate['html'] : render_location_dummy($locate));
215 // process action responses - e.g. like/dislike/attend/agree/whatever
216 $response_verbs = ['like', 'dislike'];
220 if ($item['object-type'] === ACTIVITY_OBJ_EVENT) {
221 $response_verbs[] = 'attendyes';
222 $response_verbs[] = 'attendno';
223 $response_verbs[] = 'attendmaybe';
224 if ($conv->isWritable()) {
226 $attend = [L10n::t('I will attend'), L10n::t('I will not attend'), L10n::t('I might attend')];
230 $responses = get_responses($conv_responses, $response_verbs, $this, $item);
232 foreach ($response_verbs as $value => $verbs) {
233 $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']) : '';
237 * We should avoid doing this all the time, but it depends on the conversation mode
238 * And the conv mode may change when we change the conv, or it changes its mode
239 * Maybe we should establish a way to be notified about conversation changes
241 $this->checkWallToWall();
243 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
244 $osparkle = ' sparkle';
249 if ($this->isToplevel()) {
250 if ($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) {
251 $isstarred = (($item['starred']) ? "starred" : "unstarred");
254 'do' => L10n::t("add star"),
255 'undo' => L10n::t("remove star"),
256 'toggle' => L10n::t("toggle star status"),
257 'classdo' => $item['starred'] ? "hidden" : "",
258 'classundo' => $item['starred'] ? "" : "hidden",
259 'starred' => L10n::t('starred'),
262 $thread = dba::selectFirst('thread', ['ignored'], ['uid' => $item['uid'], 'iid' => $item['id']]);
263 if (DBM::is_result($thread)) {
265 'do' => L10n::t("ignore thread"),
266 'undo' => L10n::t("unignore thread"),
267 'toggle' => L10n::t("toggle ignore status"),
268 'classdo' => $thread['ignored'] ? "hidden" : "",
269 'classundo' => $thread['ignored'] ? "" : "hidden",
270 'ignored' => L10n::t('ignored'),
274 if (Feature::isEnabled($conv->getProfileOwner(), 'commtag')) {
276 'add' => L10n::t("add tag"),
285 if ($conv->isWritable()) {
287 'like' => [L10n::t("I like this \x28toggle\x29"), L10n::t("like")],
288 'dislike' => Feature::isEnabled($conv->getProfileOwner(), 'dislike') ? [L10n::t("I don't like this \x28toggle\x29"), L10n::t("dislike")] : '',
291 $buttons['share'] = [L10n::t('Share this'), L10n::t('share')];
295 $comment = $this->getCommentBox($indent);
297 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
301 localize_item($item);
303 $body = prepare_body($item, true);
305 list($categories, $folders) = get_cats_and_terms($item);
308 $text_e = strip_tags($body);
309 $name_e = $profile_name;
311 if (!empty($item['content-warning']) && PConfig::get(local_user(), 'system', 'disable_cw', false)) {
312 $title_e = ucfirst($item['content-warning']);
314 $title_e = $item['title'];
317 $location_e = $location;
318 $owner_name_e = $this->getOwnerName();
320 // Disable features that aren't available in several networks
321 if (!in_array($item["network"], [NETWORK_DFRN, NETWORK_DIASPORA]) && isset($buttons["dislike"])) {
322 unset($buttons["dislike"]);
327 if (($item["network"] == NETWORK_FEED) && isset($buttons["like"])) {
328 unset($buttons["like"]);
331 if (($item["network"] == NETWORK_MAIL) && isset($buttons["like"])) {
332 unset($buttons["like"]);
336 'template' => $this->getTemplate(),
337 'type' => implode("", array_slice(explode("/", $item['verb']), -1)),
338 'suppress_tags' => Config::get('system', 'suppress_tags'),
339 'tags' => $item['tags'],
340 'hashtags' => $item['hashtags'],
341 'mentions' => $item['mentions'],
342 'txt_cats' => L10n::t('Categories:'),
343 'txt_folders' => L10n::t('Filed under:'),
344 'has_cats' => ((count($categories)) ? 'true' : ''),
345 'has_folders' => ((count($folders)) ? 'true' : ''),
346 'categories' => $categories,
347 'folders' => $folders,
350 'id' => $this->getId(),
351 'guid' => urlencode($item['guid']),
352 'isevent' => $isevent,
354 'linktitle' => L10n::t('View %s\'s profile @ %s', $profile_name, defaults($item, 'author-link', $item['url'])),
355 'olinktitle' => L10n::t('View %s\'s profile @ %s', htmlentities($this->getOwnerName()), defaults($item, 'owner-link', $item['url'])),
356 'to' => L10n::t('to'),
357 'via' => L10n::t('via'),
358 'wall' => L10n::t('Wall-to-Wall'),
359 'vwall' => L10n::t('via Wall-To-Wall:'),
360 'profile_url' => $profile_link,
361 'item_photo_menu' => item_photo_menu($item),
363 'thumb' => $a->remove_baseurl(proxy_url($item['author-avatar'], false, PROXY_SIZE_THUMB)),
364 'osparkle' => $osparkle,
365 'sparkle' => $sparkle,
367 'localtime' => DateTimeFormat::local($item['created'], 'r'),
368 'ago' => $item['app'] ? L10n::t('%s from %s', Temporal::getRelativeDate($item['created']), $item['app']) : Temporal::getRelativeDate($item['created']),
369 'app' => $item['app'],
370 'created' => Temporal::getRelativeDate($item['created']),
372 'location' => $location_e,
375 'owner_url' => $this->getOwnerUrl(),
376 'owner_photo' => $a->remove_baseurl(proxy_url($item['owner-avatar'], false, PROXY_SIZE_THUMB)),
377 'owner_name' => htmlentities($owner_name_e),
378 'plink' => get_plink($item),
379 'edpost' => Feature::isEnabled($conv->getProfileOwner(), 'edit_posts') ? $edpost : '',
380 'isstarred' => $isstarred,
381 'star' => Feature::isEnabled($conv->getProfileOwner(), 'star_posts') ? $star : '',
382 'ignore' => Feature::isEnabled($conv->getProfileOwner(), 'ignore_posts') ? $ignore : '',
384 'filer' => Feature::isEnabled($conv->getProfileOwner(), 'filing') ? $filer : '',
387 'like' => $responses['like']['output'],
388 'dislike' => $responses['dislike']['output'],
389 'responses' => $responses,
390 'switchcomment' => L10n::t('Comment'),
391 'comment' => $comment,
392 'previewing' => $conv->isPreview() ? ' preview ' : '',
393 'wait' => L10n::t('Please wait'),
394 'thread_level' => $thread_level,
396 'network' => $item["network"],
397 'network_name' => ContactSelector::networkToName($item['network'], $profile_link),
398 'received' => $item['received'],
399 'commented' => $item['commented'],
400 'created_date' => $item['created'],
403 $arr = ['item' => $item, 'output' => $tmp_item];
404 Addon::callHooks('display_item', $arr);
406 $result = $arr['output'];
408 $result['children'] = [];
409 $children = $this->getChildren();
410 $nb_children = count($children);
411 if ($nb_children > 0) {
412 foreach ($children as $child) {
413 $result['children'][] = $child->getTemplateData($conv_responses, $thread_level + 1);
416 if (($nb_children > 2) || ($thread_level > 1)) {
417 $result['children'][0]['comment_firstcollapsed'] = true;
418 $result['children'][0]['num_comments'] = L10n::tt('%d comment', '%d comments', $total_children);
419 $result['children'][0]['hidden_comments_num'] = $total_children;
420 $result['children'][0]['hidden_comments_text'] = L10n::tt('comment', 'comments', $total_children);
421 $result['children'][0]['hide_text'] = L10n::t('show more');
422 if ($thread_level > 1) {
423 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
425 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
430 if ($this->isToplevel()) {
431 $result['total_comments_num'] = "$total_children";
432 $result['total_comments_text'] = L10n::tt('comment', 'comments', $total_children);
435 $result['private'] = $item['private'];
436 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
438 if ($this->isThreaded()) {
439 $result['flatten'] = false;
440 $result['threaded'] = true;
442 $result['flatten'] = true;
443 $result['threaded'] = false;
452 public function getId()
454 return $this->getDataValue('id');
460 public function isThreaded()
462 return $this->threaded;
468 * @param object $item The child item to add
472 public function addChild(Post $item)
474 $item_id = $item->getId();
476 logger('[ERROR] Post::addChild : Item has no ID!!', LOGGER_DEBUG);
478 } elseif ($this->getChild($item->getId())) {
479 logger('[WARN] Post::addChild : Item already exists (' . $item->getId() . ').', LOGGER_DEBUG);
483 * Only add what will be displayed
485 if ($item->getDataValue('network') === NETWORK_MAIL && local_user() != $item->getDataValue('uid')) {
487 } elseif (activity_match($item->getDataValue('verb'), ACTIVITY_LIKE) || activity_match($item->getDataValue('verb'), ACTIVITY_DISLIKE)) {
491 $item->setParent($this);
492 $this->children[] = $item;
494 return end($this->children);
498 * Get a child by its ID
500 * @param integer $id The child id
504 public function getChild($id)
506 foreach ($this->getChildren() as $child) {
507 if ($child->getId() == $id) {
516 * Get all our children
520 public function getChildren()
522 return $this->children;
528 * @param object $item The item to set as parent
532 protected function setParent($item)
534 $parent = $this->getParent();
536 $parent->removeChild($this);
539 $this->parent = $item;
540 $this->setThread($item->getThread());
548 protected function removeParent()
550 $this->parent = null;
551 $this->thread = null;
557 * @param object $item The child to be removed
559 * @return boolean Success or failure
561 public function removeChild($item)
563 $id = $item->getId();
564 foreach ($this->getChildren() as $key => $child) {
565 if ($child->getId() == $id) {
566 $child->removeParent();
567 unset($this->children[$key]);
568 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
569 $this->children = array_values($this->children);
573 logger('[WARN] Item::removeChild : Item is not a child (' . $id . ').', LOGGER_DEBUG);
582 protected function getParent()
584 return $this->parent;
590 * @param object $conv The conversation
594 public function setThread($conv)
596 $previous_mode = ($this->thread ? $this->thread->getMode() : '');
598 $this->thread = $conv;
600 // Set it on our children too
601 foreach ($this->getChildren() as $child) {
602 $child->setThread($conv);
611 public function getThread()
613 return $this->thread;
619 * We shouldn't need this
623 public function getData()
631 * @param object $name key
633 * @return mixed value on success
636 public function getDataValue($name)
638 if (!isset($this->data[$name])) {
639 // logger('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".', LOGGER_DEBUG);
643 return $this->data[$name];
649 * @param object $name template name
653 private function setTemplate($name)
655 if (!x($this->available_templates, $name)) {
656 logger('[ERROR] Item::setTemplate : Template not available ("' . $name . '").', LOGGER_DEBUG);
660 $this->template = $this->available_templates[$name];
668 private function getTemplate()
670 return $this->template;
674 * Check if this is a toplevel post
678 private function isToplevel()
680 return $this->toplevel;
684 * Check if this is writable
688 private function isWritable()
690 $conv = $this->getThread();
693 // This will allow us to comment on wall-to-wall items owned by our friends
694 // and community forums even if somebody else wrote the post.
695 // bug #517 - this fixes for conversation owner
696 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == local_user()) {
700 // this fixes for visitors
701 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
703 return $this->writable;
707 * Count the total of our descendants
711 private function countDescendants()
713 $children = $this->getChildren();
714 $total = count($children);
716 foreach ($children as $child) {
717 $total += $child->countDescendants();
725 * Get the template for the comment box
729 private function getCommentBoxTemplate()
731 return $this->comment_box_template;
735 * Get the comment box
737 * @param string $indent Indent value
739 * @return mixed The comment box string (empty if no comment box)
742 private function getCommentBox($indent)
747 $conv = $this->getThread();
749 if (($conv->getMode() === 'network') && $this->isWallToWall()) {
753 if ($conv->isWritable() && $this->isWritable()) {
754 $qc = $qcomment = null;
757 * Hmmm, code depending on the presence of a particular addon?
758 * This should be better if done by a hook
760 if (in_array('qcomment', $a->addons)) {
761 $qc = ((local_user()) ? PConfig::get(local_user(), 'qcomment', 'words') : null);
762 $qcomment = (($qc) ? explode("\n", $qc) : null);
765 // Fetch the user id from the parent when the owner user is empty
766 $uid = $conv->getProfileOwner();
767 $parent_uid = $this->getDataValue('uid');
769 if (!is_null($parent_uid) && ($uid != $parent_uid)) {
773 $template = get_markup_template($this->getCommentBoxTemplate());
774 $comment_box = replace_macros($template, [
775 '$return_path' => $a->query_string,
776 '$threaded' => $this->isThreaded(),
778 '$type' => $conv->getMode() === 'profile' ? 'wall-comment' : 'net-comment',
779 '$id' => $this->getId(),
780 '$parent' => $this->getId(),
781 '$qcomment' => $qcomment,
782 '$profile_uid' => $uid,
783 '$mylink' => $a->remove_baseurl($a->contact['url']),
784 '$mytitle' => L10n::t('This is you'),
785 '$myphoto' => $a->remove_baseurl($a->contact['thumb']),
786 '$comment' => L10n::t('Comment'),
787 '$submit' => L10n::t('Submit'),
788 '$edbold' => L10n::t('Bold'),
789 '$editalic' => L10n::t('Italic'),
790 '$eduline' => L10n::t('Underline'),
791 '$edquote' => L10n::t('Quote'),
792 '$edcode' => L10n::t('Code'),
793 '$edimg' => L10n::t('Image'),
794 '$edurl' => L10n::t('Link'),
795 '$edvideo' => L10n::t('Video'),
796 '$preview' => ((Feature::isEnabled($conv->getProfileOwner(), 'preview')) ? L10n::t('Preview') : ''),
797 '$indent' => $indent,
798 '$sourceapp' => L10n::t($a->sourcename),
799 '$ww' => $conv->getMode() === 'network' ? $ww : '',
800 '$rand_num' => random_digits(12)
810 private function getRedirectUrl()
812 return $this->redirect_url;
816 * Check if we are a wall to wall item and set the relevant properties
820 protected function checkWallToWall()
823 $conv = $this->getThread();
824 $this->wall_to_wall = false;
826 if ($this->isToplevel()) {
827 if ($conv->getMode() !== 'profile') {
828 if ($this->getDataValue('wall') && !$this->getDataValue('self')) {
829 // On the network page, I am the owner. On the display page it will be the profile owner.
830 // This will have been stored in $a->page_contact by our calling page.
831 // Put this person as the wall owner of the wall-to-wall notice.
833 $this->owner_url = Contact::magicLink($a->page_contact['url']);
834 $this->owner_photo = $a->page_contact['thumb'];
835 $this->owner_name = $a->page_contact['name'];
836 $this->wall_to_wall = true;
837 } elseif ($this->getDataValue('owner-link')) {
838 $owner_linkmatch = (($this->getDataValue('owner-link')) && link_compare($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
839 $alias_linkmatch = (($this->getDataValue('alias')) && link_compare($this->getDataValue('alias'), $this->getDataValue('author-link')));
840 $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
842 if ((!$owner_linkmatch) && (!$alias_linkmatch) && (!$owner_namematch)) {
843 // The author url doesn't match the owner (typically the contact)
844 // and also doesn't match the contact alias.
845 // The name match is a hack to catch several weird cases where URLs are
846 // all over the park. It can be tricked, but this prevents you from
847 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
848 // well that it's the same Bob Smith.
849 // But it could be somebody else with the same name. It just isn't highly likely.
852 $this->owner_photo = $this->getDataValue('owner-avatar');
853 $this->owner_name = $this->getDataValue('owner-name');
854 $this->wall_to_wall = true;
855 $this->owner_url = Contact::magicLinkById($this->getDataValue('owner-id'));
861 if (!$this->wall_to_wall) {
862 $this->setTemplate('wall');
863 $this->owner_url = '';
864 $this->owner_photo = '';
865 $this->owner_name = '';
872 private function isWallToWall()
874 return $this->wall_to_wall;
880 private function getOwnerUrl()
882 return $this->owner_url;
888 private function getOwnerName()
890 return $this->owner_name;
896 private function isVisiting()
898 return $this->visiting;