3 * @file src/Object/Post.php
5 namespace Friendica\Object;
7 use Friendica\BaseObject;
8 use Friendica\Content\Feature;
9 use Friendica\Core\PConfig;
10 use Friendica\Database\DBM;
11 use Friendica\Model\Contact;
14 require_once 'include/dba.php';
15 require_once 'include/text.php';
16 require_once 'boot.php';
17 require_once 'include/conversation.php';
22 class Post extends BaseObject
24 private $data = array();
25 private $template = null;
26 private $available_templates = array(
27 'wall' => 'wall_thread.tpl',
28 'wall2wall' => 'wallwall_thread.tpl'
30 private $comment_box_template = 'comment_item.tpl';
31 private $toplevel = false;
32 private $writable = false;
33 private $children = array();
34 private $parent = null;
35 private $thread = null;
36 private $redirect_url = null;
37 private $owner_url = '';
38 private $owner_photo = '';
39 private $owner_name = '';
40 private $wall_to_wall = false;
41 private $threaded = false;
42 private $visiting = false;
47 * @param array $data data array
49 public function __construct(array $data)
54 $this->setTemplate('wall');
55 $this->toplevel = ($this->getId() == $this->getDataValue('parent'));
57 if (is_array($_SESSION['remote'])) {
58 foreach ($_SESSION['remote'] as $visitor) {
59 if ($visitor['cid'] == $this->getDataValue('contact-id')) {
60 $this->visiting = true;
66 $this->writable = ($this->getDataValue('writable') || $this->getDataValue('self'));
68 $ssl_state = ((local_user()) ? true : false);
69 $this->redirect_url = 'redir/' . $this->getDataValue('cid');
71 if (!$this->isToplevel()) {
72 $this->threaded = true;
75 // Prepare the children
76 if (count($data['children'])) {
77 foreach ($data['children'] as $item) {
79 * 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 items
88 if (($item['network'] == NETWORK_DIASPORA) && (local_user() == $item['uid'])) {
89 $item['writable'] = true;
92 $item['pagedrop'] = $data['pagedrop'];
93 $child = new Post($item);
94 $this->addChild($child);
100 * Get data in a form usable by a conversation template
102 * @param object $conv_responses conversation responses
103 * @param integer $thread_level default = 1
105 * @return mixed The data requested on success
108 public function getTemplateData($conv_responses, $thread_level = 1)
110 require_once "mod/proxy.php";
116 $item = $this->getData();
118 // If the time between "created" and "edited" differs we add
119 // a notice that the post was edited.
120 // Note: In some networks reshared items seem to have (sometimes) a difference
121 // between creation time and edit time of a second. Thats why we add the notice
122 // only if the difference is more than 1 second.
123 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
125 'label' => t('This entry was edited'),
126 'date' => datetime_convert('UTC', date_default_timezone_get(), $item['edited'], 'r'),
127 'relative' => relative_date($item['edited'])
136 $isstarred = "unstarred";
140 $total_children = $this->countDescendants();
142 $conv = $this->getThread();
144 $lock = ((($item['private'] == 1) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid'])
145 || strlen($item['deny_cid']) || strlen($item['deny_gid']))))
146 ? t('Private Message')
148 $shareable = ((in_array($conv->getProfileOwner(), [0, local_user()]) && ($item['private'] != 1)) ? true : false);
150 if (local_user() && link_compare($a->contact['url'], $item['author-link'])) {
151 if ($item["event-id"] != 0) {
152 $edpost = array("events/event/".$item['event-id'], t("Edit"));
154 $edpost = array("editpost/".$item['id'], t("Edit"));
160 if (($this->getDataValue('uid') == local_user()) || $this->isVisiting()) {
165 'dropping' => $dropping,
166 'pagedrop' => ((Feature::isEnabled($conv->getProfileOwner(), 'multi_delete')) ? $item['pagedrop'] : ''),
167 'select' => t('Select'),
168 'delete' => t('Delete'),
171 $filer = (($conv->getProfileOwner() == local_user()) ? t("save to folder") : false);
173 $diff_author = ((link_compare($item['url'], $item['author-link'])) ? false : true);
174 $profile_name = htmlentities(((strlen($item['author-name'])) && $diff_author) ? $item['author-name'] : $item['name']);
175 if ($item['author-link'] && (! $item['author-name'])) {
176 $profile_name = $item['author-link'];
180 $profile_link = best_link_url($item, $sp);
181 if ($profile_link === 'mailbox') {
186 $sparkle = ' sparkle';
188 $profile_link = zrl($profile_link);
191 if (!isset($item['author-thumb']) || ($item['author-thumb'] == "")) {
192 $author_contact = Contact::getDetailsByURL($item['author-link'], $conv->getProfileOwner());
193 if ($author_contact["thumb"]) {
194 $item['author-thumb'] = $author_contact["thumb"];
196 $item['author-thumb'] = $item['author-avatar'];
200 if (!isset($item['owner-thumb']) || ($item['owner-thumb'] == "")) {
201 $owner_contact = Contact::getDetailsByURL($item['owner-link'], $conv->getProfileOwner());
202 if ($owner_contact["thumb"]) {
203 $item['owner-thumb'] = $owner_contact["thumb"];
205 $item['owner-thumb'] = $item['owner-avatar'];
209 $locate = array('location' => $item['location'], 'coord' => $item['coord'], 'html' => '');
210 call_hooks('render_location', $locate);
211 $location = ((strlen($locate['html'])) ? $locate['html'] : render_location_dummy($locate));
217 /*foreach(explode(',',$item['tag']) as $tag){
229 // process action responses - e.g. like/dislike/attend/agree/whatever
230 $response_verbs = array('like', 'dislike');
232 if ($item['object-type'] === ACTIVITY_OBJ_EVENT) {
233 $response_verbs[] = 'attendyes';
234 $response_verbs[] = 'attendno';
235 $response_verbs[] = 'attendmaybe';
236 if ($conv->isWritable()) {
238 $attend = array( t('I will attend'), t('I will not attend'), t('I might attend'));
242 $responses = get_responses($conv_responses, $response_verbs, $this, $item);
244 foreach ($response_verbs as $value => $verbs) {
245 $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']) : '');
249 * We should avoid doing this all the time, but it depends on the conversation mode
250 * And the conv mode may change when we change the conv, or it changes its mode
251 * Maybe we should establish a way to be notified about conversation changes
253 $this->checkWallToWall();
255 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
256 $osparkle = ' sparkle';
259 if ($this->isToplevel()) {
260 if ($conv->getProfileOwner() == local_user()) {
261 $isstarred = (($item['starred']) ? "starred" : "unstarred");
264 'do' => t("add star"),
265 'undo' => t("remove star"),
266 'toggle' => t("toggle star status"),
267 'classdo' => (($item['starred']) ? "hidden" : ""),
268 'classundo' => (($item['starred']) ? "" : "hidden"),
269 'starred' => t('starred'),
271 $r = dba::select('thread', array('ignored'), array('uid' => $item['uid'], 'iid' => $item['id']), array('limit' => 1));
272 if (DBM::is_result($r)) {
274 'do' => t("ignore thread"),
275 'undo' => t("unignore thread"),
276 'toggle' => t("toggle ignore status"),
277 'classdo' => (($r['ignored']) ? "hidden" : ""),
278 'classundo' => (($r['ignored']) ? "" : "hidden"),
279 'ignored' => t('ignored'),
284 if (Feature::isEnabled($conv->getProfileOwner(), 'commtag')) {
286 'add' => t("add tag"),
295 if ($conv->isWritable()) {
297 'like' => array( t("I like this \x28toggle\x29"), t("like")),
298 'dislike' => ((Feature::isEnabled($conv->getProfileOwner(), 'dislike')) ? array( t("I don't like this \x28toggle\x29"), t("dislike")) : ''),
301 $buttons['share'] = array( t('Share this'), t('share'));
305 $comment = $this->getCommentBox($indent);
307 if (strcmp(datetime_convert('UTC', 'UTC', $item['created']), datetime_convert('UTC', 'UTC', 'now - 12 hours')) > 0) {
311 localize_item($item);
313 $body = prepare_body($item, true);
315 list($categories, $folders) = get_cats_and_terms($item);
318 $text_e = strip_tags($body);
319 $name_e = $profile_name;
320 $title_e = $item['title'];
321 $location_e = $location;
322 $owner_name_e = $this->getOwnerName();
324 // Disable features that aren't available in several networks
326 /// @todo Add NETWORK_DIASPORA when it will pass this information
327 if (!in_array($item["item_network"], array(NETWORK_DFRN)) && isset($buttons["dislike"])) {
328 unset($buttons["dislike"], $isevent);
332 if (($item["item_network"] == NETWORK_FEED) && isset($buttons["like"])) {
333 unset($buttons["like"]);
336 if (($item["item_network"] == NETWORK_MAIL) && isset($buttons["like"])) {
337 unset($buttons["like"]);
341 'template' => $this->getTemplate(),
342 'type' => implode("", array_slice(explode("/", $item['verb']), -1)),
343 'tags' => $item['tags'],
344 'hashtags' => $item['hashtags'],
345 'mentions' => $item['mentions'],
346 'txt_cats' => t('Categories:'),
347 'txt_folders' => t('Filed under:'),
348 'has_cats' => ((count($categories)) ? 'true' : ''),
349 'has_folders' => ((count($folders)) ? 'true' : ''),
350 'categories' => $categories,
351 'folders' => $folders,
354 'id' => $this->getId(),
355 'guid' => urlencode($item['guid']),
356 'isevent' => $isevent,
358 'linktitle' => sprintf(t('View %s\'s profile @ %s'), $profile_name, ((strlen($item['author-link'])) ? $item['author-link'] : $item['url'])),
359 'olinktitle' => sprintf(t('View %s\'s profile @ %s'), htmlentities($this->getOwnerName()), ((strlen($item['owner-link'])) ? $item['owner-link'] : $item['url'])),
362 'wall' => t('Wall-to-Wall'),
363 'vwall' => t('via Wall-To-Wall:'),
364 'profile_url' => $profile_link,
365 'item_photo_menu' => item_photo_menu($item),
367 'thumb' => $a->remove_baseurl(proxy_url($item['author-thumb'], false, PROXY_SIZE_THUMB)),
368 'osparkle' => $osparkle,
369 'sparkle' => $sparkle,
371 'localtime' => datetime_convert('UTC', date_default_timezone_get(), $item['created'], 'r'),
372 'ago' => (($item['app']) ? sprintf(t('%s from %s'), relative_date($item['created']), $item['app']) : relative_date($item['created'])),
373 'app' => $item['app'],
374 'created' => relative_date($item['created']),
376 'location' => $location_e,
379 'owner_url' => $this->getOwnerUrl(),
380 'owner_photo' => $a->remove_baseurl(proxy_url($item['owner-thumb'], false, PROXY_SIZE_THUMB)),
381 'owner_name' => htmlentities($owner_name_e),
382 'plink' => get_plink($item),
383 'edpost' => ((Feature::isEnabled($conv->getProfileOwner(), 'edit_posts')) ? $edpost : ''),
384 'isstarred' => $isstarred,
385 'star' => ((Feature::isEnabled($conv->getProfileOwner(), 'star_posts')) ? $star : ''),
386 'ignore' => ((Feature::isEnabled($conv->getProfileOwner(), 'ignore_posts')) ? $ignore : ''),
388 'filer' => ((Feature::isEnabled($conv->getProfileOwner(), 'filing')) ? $filer : ''),
391 'like' => $responses['like']['output'],
392 'dislike' => $responses['dislike']['output'],
393 'responses' => $responses,
394 'switchcomment' => t('Comment'),
395 'comment' => $comment,
396 'previewing' => ($conv->isPreview() ? ' preview ' : ''),
397 'wait' => t('Please wait'),
398 'thread_level' => $thread_level,
400 'network' => $item["item_network"],
401 'network_name' => network_to_name($item['item_network'], $profile_link),
402 'received' => $item['received'],
403 'commented' => $item['commented'],
404 'created_date' => $item['created'],
407 $arr = array('item' => $item, 'output' => $tmp_item);
408 call_hooks('display_item', $arr);
410 $result = $arr['output'];
412 $result['children'] = array();
413 $children = $this->getChildren();
414 $nb_children = count($children);
415 if ($nb_children > 0) {
416 foreach ($children as $child) {
417 $result['children'][] = $child->getTemplateData($conv_responses, $thread_level + 1);
420 if (($nb_children > 2) || ($thread_level > 1)) {
421 $result['children'][0]['comment_firstcollapsed'] = true;
422 $result['children'][0]['num_comments'] = sprintf(tt('%d comment', '%d comments', $total_children), $total_children);
423 $result['children'][0]['hidden_comments_num'] = $total_children;
424 $result['children'][0]['hidden_comments_text'] = tt('comment', 'comments', $total_children);
425 $result['children'][0]['hide_text'] = t('show more');
426 if ($thread_level > 1) {
427 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
429 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
434 if ($this->isToplevel()) {
435 $result['total_comments_num'] = "$total_children";
436 $result['total_comments_text'] = tt('comment', 'comments', $total_children);
439 $result['private'] = $item['private'];
440 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
442 if ($this->isThreaded()) {
443 $result['flatten'] = false;
444 $result['threaded'] = true;
446 $result['flatten'] = true;
447 $result['threaded'] = false;
456 public function getId()
458 return $this->getDataValue('id');
464 public function isThreaded()
466 return $this->threaded;
472 * @param object $item The child item to add
476 public function addChild(Post $item)
478 $item_id = $item->getId();
480 logger('[ERROR] Post::addChild : Item has no ID!!', LOGGER_DEBUG);
482 } elseif ($this->getChild($item->getId())) {
483 logger('[WARN] Post::addChild : Item already exists ('. $item->getId() .').', LOGGER_DEBUG);
487 * Only add what will be displayed
489 if ($item->getDataValue('network') === NETWORK_MAIL && local_user() != $item->getDataValue('uid')) {
491 } elseif (activity_match($item->getDataValue('verb'), ACTIVITY_LIKE) || activity_match($item->getDataValue('verb'), ACTIVITY_DISLIKE)) {
495 $item->setParent($this);
496 $this->children[] = $item;
498 return end($this->children);
502 * Get a child by its ID
504 * @param integer $id The child id
508 public function getChild($id)
510 foreach ($this->getChildren() as $child) {
511 if ($child->getId() == $id) {
520 * Get all our children
524 public function getChildren()
526 return $this->children;
532 * @param object $item The item to set as parent
536 protected function setParent($item)
538 $parent = $this->getParent();
540 $parent->removeChild($this);
543 $this->parent = $item;
544 $this->setThread($item->getThread());
552 protected function removeParent()
554 $this->parent = null;
555 $this->thread = null;
561 * @param object $item The child to be removed
563 * @return boolean Success or failure
565 public function removeChild($item)
567 $id = $item->getId();
568 foreach ($this->getChildren() as $key => $child) {
569 if ($child->getId() == $id) {
570 $child->removeParent();
571 unset($this->children[$key]);
572 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
573 $this->children = array_values($this->children);
577 logger('[WARN] Item::removeChild : Item is not a child ('. $id .').', LOGGER_DEBUG);
586 protected function getParent()
588 return $this->parent;
594 * @param object $conv The conversation
598 public function setThread($conv)
600 $previous_mode = ($this->thread ? $this->thread->getMode() : '');
602 $this->thread = $conv;
604 // Set it on our children too
605 foreach ($this->getChildren() as $child) {
606 $child->setThread($conv);
615 public function getThread()
617 return $this->thread;
623 * We shouldn't need this
627 public function getData()
635 * @param object $name key
637 * @return mixed value on success
640 public function getDataValue($name)
642 if (!isset($this->data[$name])) {
643 // logger('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".', LOGGER_DEBUG);
647 return $this->data[$name];
653 * @param object $name template name
657 private function setTemplate($name)
659 if (!x($this->available_templates, $name)) {
660 logger('[ERROR] Item::setTemplate : Template not available ("'. $name .'").', LOGGER_DEBUG);
664 $this->template = $this->available_templates[$name];
672 private function getTemplate()
674 return $this->template;
678 * Check if this is a toplevel post
682 private function isToplevel()
684 return $this->toplevel;
688 * Check if this is writable
692 private function isWritable()
694 $conv = $this->getThread();
697 // This will allow us to comment on wall-to-wall items owned by our friends
698 // and community forums even if somebody else wrote the post.
700 // bug #517 - this fixes for conversation owner
701 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == local_user()) {
705 // this fixes for visitors
706 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
708 return $this->writable;
712 * Count the total of our descendants
716 private function countDescendants()
718 $children = $this->getChildren();
719 $total = count($children);
721 foreach ($children as $child) {
722 $total += $child->countDescendants();
730 * Get the template for the comment box
734 private function getCommentBoxTemplate()
736 return $this->comment_box_template;
740 * Get the comment box
742 * @param string $indent Indent value
744 * @return mixed The comment box string (empty if no comment box)
747 private function getCommentBox($indent)
752 $conv = $this->getThread();
753 $template = get_markup_template($this->getCommentBoxTemplate());
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 plugin?
764 * This should be better if done by a hook
766 if (in_array('qcomment', $a->plugins)) {
767 $qc = ((local_user()) ? PConfig::get(local_user(), 'qcomment', 'words') : null);
768 $qcomment = (($qc) ? explode("\n", $qc) : null);
771 $comment_box = replace_macros(
774 '$return_path' => $a->query_string,
775 '$threaded' => $this->isThreaded(),
776 // '$jsreload' => (($conv->getMode() === 'display') ? $_SESSION['return_url'] : ''),
778 '$type' => (($conv->getMode() === 'profile') ? 'wall-comment' : 'net-comment'),
779 '$id' => $this->getId(),
780 '$parent' => $this->getId(),
781 '$qcomment' => $qcomment,
782 '$profile_uid' => $conv->getProfileOwner(),
783 '$mylink' => $a->remove_baseurl($a->contact['url']),
784 '$mytitle' => t('This is you'),
785 '$myphoto' => $a->remove_baseurl($a->contact['thumb']),
786 '$comment' => t('Comment'),
787 '$submit' => t('Submit'),
788 '$edbold' => t('Bold'),
789 '$editalic' => t('Italic'),
790 '$eduline' => t('Underline'),
791 '$edquote' => t('Quote'),
792 '$edcode' => t('Code'),
793 '$edimg' => t('Image'),
794 '$edurl' => t('Link'),
795 '$edvideo' => t('Video'),
796 '$preview' => ((Feature::isEnabled($conv->getProfileOwner(), 'preview')) ? t('Preview') : ''),
797 '$indent' => $indent,
798 '$sourceapp' => 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 = zrl($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.
850 // But it could be somebody else with the same name. It just isn't highly likely.
853 $this->owner_photo = $this->getDataValue('owner-avatar');
854 $this->owner_name = $this->getDataValue('owner-name');
855 $this->wall_to_wall = true;
856 // If it is our contact, use a friendly redirect link
857 if ((link_compare($this->getDataValue('owner-link'), $this->getDataValue('url')))
858 && ($this->getDataValue('network') === NETWORK_DFRN)
860 $this->owner_url = $this->getRedirectUrl();
862 $this->owner_url = zrl($this->getDataValue('owner-link'));
869 if (!$this->wall_to_wall) {
870 $this->setTemplate('wall');
871 $this->owner_url = '';
872 $this->owner_photo = '';
873 $this->owner_name = '';
880 private function isWallToWall()
882 return $this->wall_to_wall;
888 private function getOwnerUrl()
890 return $this->owner_url;
896 private function getOwnerName()
898 return $this->owner_name;
904 private function isVisiting()
906 return $this->visiting;