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\L10n;
12 use Friendica\Core\PConfig;
13 use Friendica\Database\DBM;
14 use Friendica\Model\Contact;
15 use Friendica\Model\Profile;
18 require_once 'include/dba.php';
19 require_once 'include/text.php';
20 require_once 'boot.php';
21 require_once 'include/conversation.php';
26 class Post extends BaseObject
29 private $template = null;
30 private $available_templates = [
31 'wall' => 'wall_thread.tpl',
32 'wall2wall' => 'wallwall_thread.tpl'
34 private $comment_box_template = 'comment_item.tpl';
35 private $toplevel = false;
36 private $writable = false;
37 private $children = [];
38 private $parent = null;
39 private $thread = null;
40 private $redirect_url = null;
41 private $owner_url = '';
42 private $owner_photo = '';
43 private $owner_name = '';
44 private $wall_to_wall = false;
45 private $threaded = false;
46 private $visiting = false;
51 * @param array $data data array
53 public function __construct(array $data)
58 $this->setTemplate('wall');
59 $this->toplevel = $this->getId() == $this->getDataValue('parent');
61 if (x($_SESSION, 'remote') && is_array($_SESSION['remote'])) {
62 foreach ($_SESSION['remote'] as $visitor) {
63 if ($visitor['cid'] == $this->getDataValue('contact-id')) {
64 $this->visiting = true;
70 $this->writable = $this->getDataValue('writable') || $this->getDataValue('self');
71 $this->redirect_url = 'redir/' . $this->getDataValue('cid');
73 if (!$this->isToplevel()) {
74 $this->threaded = true;
77 // Prepare the children
78 if (count($data['children'])) {
79 foreach ($data['children'] as $item) {
80 // Only add will be displayed
81 if ($item['network'] === NETWORK_MAIL && local_user() != $item['uid']) {
83 } elseif (!visible_activity($item)) {
87 // You can always comment on Diaspora and OStatus items
88 // The empty network can happen with your local (self) contact
89 if (in_array($item['network'], ['', NETWORK_OSTATUS, NETWORK_DIASPORA]) && (local_user() == $item['uid'])) {
90 $item['writable'] = true;
93 $item['pagedrop'] = $data['pagedrop'];
94 $child = new Post($item);
95 $this->addChild($child);
101 * Get data in a form usable by a conversation template
103 * @param object $conv_responses conversation responses
104 * @param integer $thread_level default = 1
106 * @return mixed The data requested on success
109 public function getTemplateData($conv_responses, $thread_level = 1)
111 require_once "mod/proxy.php";
117 $item = $this->getData();
119 // If the time between "created" and "edited" differs we add
120 // a notice that the post was edited.
121 // Note: In some networks reshared items seem to have (sometimes) a difference
122 // between creation time and edit time of a second. Thats why we add the notice
123 // only if the difference is more than 1 second.
124 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
126 'label' => t('This entry was edited'),
127 'date' => datetime_convert('UTC', date_default_timezone_get(), $item['edited'], 'r'),
128 'relative' => relative_date($item['edited'])
137 $isstarred = "unstarred";
141 $total_children = $this->countDescendants();
143 $conv = $this->getThread();
145 $lock = ((($item['private'] == 1) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid'])
146 || strlen($item['deny_cid']) || strlen($item['deny_gid']))))
147 ? t('Private Message')
149 $shareable = in_array($conv->getProfileOwner(), [0, local_user()]) && $item['private'] != 1;
151 if (local_user() && link_compare($a->contact['url'], $item['author-link'])) {
152 if ($item["event-id"] != 0) {
153 $edpost = ["events/event/" . $item['event-id'], t("Edit")];
155 $edpost = ["editpost/" . $item['id'], t("Edit")];
157 $dropping = in_array($item['uid'], [0, local_user()]);
162 // Editing on items of not subscribed users isn't currently possible
163 // There are some issues on editing that prevent this.
164 // But also it is an issue of the supported protocols that doesn't allow editing at all.
165 if ($item['uid'] == 0) {
169 if (($this->getDataValue('uid') == local_user()) || $this->isVisiting()) {
174 'dropping' => $dropping,
175 'pagedrop' => ((Feature::isEnabled($conv->getProfileOwner(), 'multi_delete')) ? $item['pagedrop'] : ''),
176 'select' => t('Select'),
177 'delete' => t('Delete'),
180 $filer = (($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) ? t("save to folder") : false);
182 $diff_author = !link_compare($item['url'], $item['author-link']);
183 $profile_name = htmlentities(((strlen($item['author-name'])) && $diff_author) ? $item['author-name'] : $item['name']);
184 if ($item['author-link'] && (!$item['author-name'])) {
185 $profile_name = $item['author-link'];
189 $profile_link = best_link_url($item, $sp);
190 if ($profile_link === 'mailbox') {
195 $sparkle = ' sparkle';
197 $profile_link = Profile::zrl($profile_link);
200 if (!isset($item['author-thumb']) || ($item['author-thumb'] == "")) {
201 $author_contact = Contact::getDetailsByURL($item['author-link'], $conv->getProfileOwner());
202 if ($author_contact["thumb"]) {
203 $item['author-thumb'] = $author_contact["thumb"];
205 $item['author-thumb'] = $item['author-avatar'];
209 if (!isset($item['owner-thumb']) || ($item['owner-thumb'] == "")) {
210 $owner_contact = Contact::getDetailsByURL($item['owner-link'], $conv->getProfileOwner());
211 if ($owner_contact["thumb"]) {
212 $item['owner-thumb'] = $owner_contact["thumb"];
214 $item['owner-thumb'] = $item['owner-avatar'];
218 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
219 Addon::callHooks('render_location', $locate);
220 $location = ((strlen($locate['html'])) ? $locate['html'] : render_location_dummy($locate));
222 // process action responses - e.g. like/dislike/attend/agree/whatever
223 $response_verbs = ['like', 'dislike'];
227 if ($item['object-type'] === ACTIVITY_OBJ_EVENT) {
228 $response_verbs[] = 'attendyes';
229 $response_verbs[] = 'attendno';
230 $response_verbs[] = 'attendmaybe';
231 if ($conv->isWritable()) {
233 $attend = [t('I will attend'), t('I will not attend'), t('I might attend')];
237 $responses = get_responses($conv_responses, $response_verbs, $this, $item);
239 foreach ($response_verbs as $value => $verbs) {
240 $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']) : '';
244 * We should avoid doing this all the time, but it depends on the conversation mode
245 * And the conv mode may change when we change the conv, or it changes its mode
246 * Maybe we should establish a way to be notified about conversation changes
248 $this->checkWallToWall();
250 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
251 $osparkle = ' sparkle';
256 if ($this->isToplevel()) {
257 if ($conv->getProfileOwner() == local_user() && ($item['uid'] != 0)) {
258 $isstarred = (($item['starred']) ? "starred" : "unstarred");
261 'do' => t("add star"),
262 'undo' => t("remove star"),
263 'toggle' => t("toggle star status"),
264 'classdo' => $item['starred'] ? "hidden" : "",
265 'classundo' => $item['starred'] ? "" : "hidden",
266 'starred' => t('starred'),
269 $thread = dba::selectFirst('thread', ['ignored'], ['uid' => $item['uid'], 'iid' => $item['id']]);
270 if (DBM::is_result($thread)) {
272 'do' => t("ignore thread"),
273 'undo' => t("unignore thread"),
274 'toggle' => t("toggle ignore status"),
275 'classdo' => $thread['ignored'] ? "hidden" : "",
276 'classundo' => $thread['ignored'] ? "" : "hidden",
277 'ignored' => t('ignored'),
281 if (Feature::isEnabled($conv->getProfileOwner(), 'commtag')) {
283 'add' => t("add tag"),
292 if ($conv->isWritable()) {
294 'like' => [t("I like this \x28toggle\x29"), t("like")],
295 'dislike' => Feature::isEnabled($conv->getProfileOwner(), 'dislike') ? [t("I don't like this \x28toggle\x29"), t("dislike")] : '',
298 $buttons['share'] = [t('Share this'), t('share')];
301 // If a contact isn't writable, we cannot send a like or dislike to it
302 if (!$item['writable']) {
303 unset($buttons["like"]);
304 unset($buttons["dislike"]);
308 $comment = $this->getCommentBox($indent);
310 if (strcmp(datetime_convert('UTC', 'UTC', $item['created']), datetime_convert('UTC', 'UTC', 'now - 12 hours')) > 0) {
314 localize_item($item);
316 $body = prepare_body($item, true);
318 list($categories, $folders) = get_cats_and_terms($item);
321 $text_e = strip_tags($body);
322 $name_e = $profile_name;
323 $title_e = $item['title'];
324 $location_e = $location;
325 $owner_name_e = $this->getOwnerName();
327 // Disable features that aren't available in several networks
328 if (!in_array($item["item_network"], [NETWORK_DFRN, NETWORK_DIASPORA]) && isset($buttons["dislike"])) {
329 unset($buttons["dislike"]);
334 if (($item["item_network"] == NETWORK_FEED) && isset($buttons["like"])) {
335 unset($buttons["like"]);
338 if (($item["item_network"] == NETWORK_MAIL) && isset($buttons["like"])) {
339 unset($buttons["like"]);
343 'template' => $this->getTemplate(),
344 'type' => implode("", array_slice(explode("/", $item['verb']), -1)),
345 'tags' => $item['tags'],
346 'hashtags' => $item['hashtags'],
347 'mentions' => $item['mentions'],
348 'txt_cats' => t('Categories:'),
349 'txt_folders' => t('Filed under:'),
350 'has_cats' => ((count($categories)) ? 'true' : ''),
351 'has_folders' => ((count($folders)) ? 'true' : ''),
352 'categories' => $categories,
353 'folders' => $folders,
356 'id' => $this->getId(),
357 'guid' => urlencode($item['guid']),
358 'isevent' => $isevent,
360 'linktitle' => t('View %s\'s profile @ %s', $profile_name, defaults($item, 'author-link', $item['url'])),
361 'olinktitle' => t('View %s\'s profile @ %s', htmlentities($this->getOwnerName()), defaults($item, 'owner-link', $item['url'])),
364 'wall' => t('Wall-to-Wall'),
365 'vwall' => t('via Wall-To-Wall:'),
366 'profile_url' => $profile_link,
367 'item_photo_menu' => item_photo_menu($item),
369 'thumb' => $a->remove_baseurl(proxy_url($item['author-thumb'], false, PROXY_SIZE_THUMB)),
370 'osparkle' => $osparkle,
371 'sparkle' => $sparkle,
373 'localtime' => datetime_convert('UTC', date_default_timezone_get(), $item['created'], 'r'),
374 'ago' => $item['app'] ? t('%s from %s', relative_date($item['created']), $item['app']) : relative_date($item['created']),
375 'app' => $item['app'],
376 'created' => relative_date($item['created']),
378 'location' => $location_e,
381 'owner_url' => $this->getOwnerUrl(),
382 'owner_photo' => $a->remove_baseurl(proxy_url($item['owner-thumb'], false, PROXY_SIZE_THUMB)),
383 'owner_name' => htmlentities($owner_name_e),
384 'plink' => get_plink($item),
385 'edpost' => Feature::isEnabled($conv->getProfileOwner(), 'edit_posts') ? $edpost : '',
386 'isstarred' => $isstarred,
387 'star' => Feature::isEnabled($conv->getProfileOwner(), 'star_posts') ? $star : '',
388 'ignore' => Feature::isEnabled($conv->getProfileOwner(), 'ignore_posts') ? $ignore : '',
390 'filer' => Feature::isEnabled($conv->getProfileOwner(), 'filing') ? $filer : '',
393 'like' => $responses['like']['output'],
394 'dislike' => $responses['dislike']['output'],
395 'responses' => $responses,
396 'switchcomment' => t('Comment'),
397 'comment' => $comment,
398 'previewing' => $conv->isPreview() ? ' preview ' : '',
399 'wait' => t('Please wait'),
400 'thread_level' => $thread_level,
402 'network' => $item["item_network"],
403 'network_name' => ContactSelector::networkToName($item['item_network'], $profile_link),
404 'received' => $item['received'],
405 'commented' => $item['commented'],
406 'created_date' => $item['created'],
409 $arr = ['item' => $item, 'output' => $tmp_item];
410 Addon::callHooks('display_item', $arr);
412 $result = $arr['output'];
414 $result['children'] = [];
415 $children = $this->getChildren();
416 $nb_children = count($children);
417 if ($nb_children > 0) {
418 foreach ($children as $child) {
419 $result['children'][] = $child->getTemplateData($conv_responses, $thread_level + 1);
422 if (($nb_children > 2) || ($thread_level > 1)) {
423 $result['children'][0]['comment_firstcollapsed'] = true;
424 $result['children'][0]['num_comments'] = L10n::tt('%d comment', '%d comments', $total_children);
425 $result['children'][0]['hidden_comments_num'] = $total_children;
426 $result['children'][0]['hidden_comments_text'] = L10n::tt('comment', 'comments', $total_children);
427 $result['children'][0]['hide_text'] = t('show more');
428 if ($thread_level > 1) {
429 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
431 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
436 if ($this->isToplevel()) {
437 $result['total_comments_num'] = "$total_children";
438 $result['total_comments_text'] = L10n::tt('comment', 'comments', $total_children);
441 $result['private'] = $item['private'];
442 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
444 if ($this->isThreaded()) {
445 $result['flatten'] = false;
446 $result['threaded'] = true;
448 $result['flatten'] = true;
449 $result['threaded'] = false;
458 public function getId()
460 return $this->getDataValue('id');
466 public function isThreaded()
468 return $this->threaded;
474 * @param object $item The child item to add
478 public function addChild(Post $item)
480 $item_id = $item->getId();
482 logger('[ERROR] Post::addChild : Item has no ID!!', LOGGER_DEBUG);
484 } elseif ($this->getChild($item->getId())) {
485 logger('[WARN] Post::addChild : Item already exists (' . $item->getId() . ').', LOGGER_DEBUG);
489 * Only add what will be displayed
491 if ($item->getDataValue('network') === NETWORK_MAIL && local_user() != $item->getDataValue('uid')) {
493 } elseif (activity_match($item->getDataValue('verb'), ACTIVITY_LIKE) || activity_match($item->getDataValue('verb'), ACTIVITY_DISLIKE)) {
497 $item->setParent($this);
498 $this->children[] = $item;
500 return end($this->children);
504 * Get a child by its ID
506 * @param integer $id The child id
510 public function getChild($id)
512 foreach ($this->getChildren() as $child) {
513 if ($child->getId() == $id) {
522 * Get all our children
526 public function getChildren()
528 return $this->children;
534 * @param object $item The item to set as parent
538 protected function setParent($item)
540 $parent = $this->getParent();
542 $parent->removeChild($this);
545 $this->parent = $item;
546 $this->setThread($item->getThread());
554 protected function removeParent()
556 $this->parent = null;
557 $this->thread = null;
563 * @param object $item The child to be removed
565 * @return boolean Success or failure
567 public function removeChild($item)
569 $id = $item->getId();
570 foreach ($this->getChildren() as $key => $child) {
571 if ($child->getId() == $id) {
572 $child->removeParent();
573 unset($this->children[$key]);
574 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
575 $this->children = array_values($this->children);
579 logger('[WARN] Item::removeChild : Item is not a child (' . $id . ').', LOGGER_DEBUG);
588 protected function getParent()
590 return $this->parent;
596 * @param object $conv The conversation
600 public function setThread($conv)
602 $previous_mode = ($this->thread ? $this->thread->getMode() : '');
604 $this->thread = $conv;
606 // Set it on our children too
607 foreach ($this->getChildren() as $child) {
608 $child->setThread($conv);
617 public function getThread()
619 return $this->thread;
625 * We shouldn't need this
629 public function getData()
637 * @param object $name key
639 * @return mixed value on success
642 public function getDataValue($name)
644 if (!isset($this->data[$name])) {
645 // logger('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".', LOGGER_DEBUG);
649 return $this->data[$name];
655 * @param object $name template name
659 private function setTemplate($name)
661 if (!x($this->available_templates, $name)) {
662 logger('[ERROR] Item::setTemplate : Template not available ("' . $name . '").', LOGGER_DEBUG);
666 $this->template = $this->available_templates[$name];
674 private function getTemplate()
676 return $this->template;
680 * Check if this is a toplevel post
684 private function isToplevel()
686 return $this->toplevel;
690 * Check if this is writable
694 private function isWritable()
696 $conv = $this->getThread();
699 // This will allow us to comment on wall-to-wall items owned by our friends
700 // and community forums even if somebody else wrote the post.
701 // bug #517 - this fixes for conversation owner
702 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == local_user()) {
706 // this fixes for visitors
707 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
709 return $this->writable;
713 * Count the total of our descendants
717 private function countDescendants()
719 $children = $this->getChildren();
720 $total = count($children);
722 foreach ($children as $child) {
723 $total += $child->countDescendants();
731 * Get the template for the comment box
735 private function getCommentBoxTemplate()
737 return $this->comment_box_template;
741 * Get the comment box
743 * @param string $indent Indent value
745 * @return mixed The comment box string (empty if no comment box)
748 private function getCommentBox($indent)
753 $conv = $this->getThread();
755 if (($conv->getMode() === 'network') && $this->isWallToWall()) {
759 if ($conv->isWritable() && $this->isWritable()) {
760 $qc = $qcomment = null;
763 * Hmmm, code depending on the presence of a particular addon?
764 * This should be better if done by a hook
766 if (in_array('qcomment', $a->addons)) {
767 $qc = ((local_user()) ? PConfig::get(local_user(), 'qcomment', 'words') : null);
768 $qcomment = (($qc) ? explode("\n", $qc) : null);
771 // Fetch the user id from the parent when the owner user is empty
772 $uid = $conv->getProfileOwner();
773 $parent_uid = $this->getDataValue('uid');
775 if (!is_null($parent_uid) && ($uid != $parent_uid)) {
779 $template = get_markup_template($this->getCommentBoxTemplate());
780 $comment_box = replace_macros($template, [
781 '$return_path' => $a->query_string,
782 '$threaded' => $this->isThreaded(),
784 '$type' => $conv->getMode() === 'profile' ? 'wall-comment' : 'net-comment',
785 '$id' => $this->getId(),
786 '$parent' => $this->getId(),
787 '$qcomment' => $qcomment,
788 '$profile_uid' => $uid,
789 '$mylink' => $a->remove_baseurl($a->contact['url']),
790 '$mytitle' => t('This is you'),
791 '$myphoto' => $a->remove_baseurl($a->contact['thumb']),
792 '$comment' => t('Comment'),
793 '$submit' => t('Submit'),
794 '$edbold' => t('Bold'),
795 '$editalic' => t('Italic'),
796 '$eduline' => t('Underline'),
797 '$edquote' => t('Quote'),
798 '$edcode' => t('Code'),
799 '$edimg' => t('Image'),
800 '$edurl' => t('Link'),
801 '$edvideo' => t('Video'),
802 '$preview' => ((Feature::isEnabled($conv->getProfileOwner(), 'preview')) ? t('Preview') : ''),
803 '$indent' => $indent,
804 '$sourceapp' => t($a->sourcename),
805 '$ww' => $conv->getMode() === 'network' ? $ww : '',
806 '$rand_num' => random_digits(12)
816 private function getRedirectUrl()
818 return $this->redirect_url;
822 * Check if we are a wall to wall item and set the relevant properties
826 protected function checkWallToWall()
829 $conv = $this->getThread();
830 $this->wall_to_wall = false;
832 if ($this->isToplevel()) {
833 if ($conv->getMode() !== 'profile') {
834 if ($this->getDataValue('wall') && !$this->getDataValue('self')) {
835 // On the network page, I am the owner. On the display page it will be the profile owner.
836 // This will have been stored in $a->page_contact by our calling page.
837 // Put this person as the wall owner of the wall-to-wall notice.
839 $this->owner_url = Profile::zrl($a->page_contact['url']);
840 $this->owner_photo = $a->page_contact['thumb'];
841 $this->owner_name = $a->page_contact['name'];
842 $this->wall_to_wall = true;
843 } elseif ($this->getDataValue('owner-link')) {
844 $owner_linkmatch = (($this->getDataValue('owner-link')) && link_compare($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
845 $alias_linkmatch = (($this->getDataValue('alias')) && link_compare($this->getDataValue('alias'), $this->getDataValue('author-link')));
846 $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
848 if ((!$owner_linkmatch) && (!$alias_linkmatch) && (!$owner_namematch)) {
849 // The author url doesn't match the owner (typically the contact)
850 // and also doesn't match the contact alias.
851 // The name match is a hack to catch several weird cases where URLs are
852 // all over the park. It can be tricked, but this prevents you from
853 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
854 // well that it's the same Bob Smith.
855 // But it could be somebody else with the same name. It just isn't highly likely.
858 $this->owner_photo = $this->getDataValue('owner-avatar');
859 $this->owner_name = $this->getDataValue('owner-name');
860 $this->wall_to_wall = true;
861 // If it is our contact, use a friendly redirect link
862 if ($this->getDataValue('network') === NETWORK_DFRN
863 && link_compare($this->getDataValue('owner-link'), $this->getDataValue('url'))
865 $this->owner_url = $this->getRedirectUrl();
867 $this->owner_url = Profile::zrl($this->getDataValue('owner-link'));
874 if (!$this->wall_to_wall) {
875 $this->setTemplate('wall');
876 $this->owner_url = '';
877 $this->owner_photo = '';
878 $this->owner_name = '';
885 private function isWallToWall()
887 return $this->wall_to_wall;
893 private function getOwnerUrl()
895 return $this->owner_url;
901 private function getOwnerName()
903 return $this->owner_name;
909 private function isVisiting()
911 return $this->visiting;