]> git.mxchange.org Git - friendica.git/blob - object/Item.php
Merge remote-tracking branch 'upstream/develop' into 1612-unused-indexes
[friendica.git] / object / Item.php
1 <?php
2 if(class_exists('Item'))
3         return;
4
5 require_once('object/BaseObject.php');
6 require_once('include/text.php');
7 require_once('include/diaspora.php');
8 require_once('boot.php');
9
10 /**
11  * An item
12  */
13 class Item extends BaseObject {
14         private $data = array();
15         private $template = null;
16         private $available_templates = array(
17                 'wall' => 'wall_thread.tpl',
18                 'wall2wall' => 'wallwall_thread.tpl'
19         );
20         private $comment_box_template = 'comment_item.tpl';
21         private $toplevel = false;
22         private $writable = false;
23         private $children = array();
24         private $parent = null;
25         private $conversation = null;
26         private $redirect_url = null;
27         private $owner_url = '';
28         private $owner_photo = '';
29         private $owner_name = '';
30         private $wall_to_wall = false;
31         private $threaded = false;
32         private $visiting = false;
33
34         public function __construct($data) {
35                 $a = $this->get_app();
36
37                 $this->data = $data;
38                 $this->set_template('wall');
39                 $this->toplevel = ($this->get_id() == $this->get_data_value('parent'));
40
41                 if (is_array($_SESSION['remote'])) {
42                         foreach ($_SESSION['remote'] as $visitor) {
43                                 if ($visitor['cid'] == $this->get_data_value('contact-id')) {
44                                         $this->visiting = true;
45                                         break;
46                                 }
47                         }
48                 }
49
50                 $this->writable = ($this->get_data_value('writable') || $this->get_data_value('self'));
51
52                 $ssl_state = ((local_user()) ? true : false);
53                 $this->redirect_url = 'redir/' . $this->get_data_value('cid') ;
54
55                 if (get_config('system','thread_allow') && $a->theme_thread_allow && !$this->is_toplevel()) {
56                         $this->threaded = true;
57                 }
58
59                 // Prepare the children
60                 if (count($data['children'])) {
61                         foreach ($data['children'] as $item) {
62                                 /*
63                                  * Only add will be displayed
64                                  */
65                                 if ($item['network'] === NETWORK_MAIL && local_user() != $item['uid']) {
66                                         continue;
67                                 } elseif (! visible_activity($item)) {
68                                         continue;
69                                 }
70
71                                 $item['pagedrop'] = $data['pagedrop'];
72                                 $child = new Item($item);
73                                 $this->add_child($child);
74                         }
75                 }
76         }
77
78         /**
79          * Get data in a form usable by a conversation template
80          *
81          * Returns:
82          *      _ The data requested on success
83          *      _ false on failure
84          */
85         public function get_template_data($conv_responses, $thread_level=1) {
86                 require_once("mod/proxy.php");
87
88                 $result = array();
89
90                 $a = $this->get_app();
91
92                 $item = $this->get_data();
93                 $edited = false;
94                 if (strcmp($item['created'], $item['edited'])<>0) {
95                         $edited = array(
96                                 'label'    => t('This entry was edited'),
97                                 'date'     => datetime_convert('UTC', date_default_timezone_get(), $item['edited'], 'r'),
98                                 'relative' => relative_date($item['edited'])
99                         );
100                 }
101                 $commentww = '';
102                 $sparkle = '';
103                 $buttons = '';
104                 $dropping = false;
105                 $star = false;
106                 $ignore = false;
107                 $isstarred = "unstarred";
108                 $indent = '';
109                 $shiny = '';
110                 $osparkle = '';
111                 $total_children = $this->count_descendants();
112
113                 $conv = $this->get_conversation();
114
115                 $lock = ((($item['private'] == 1) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid']) 
116                         || strlen($item['deny_cid']) || strlen($item['deny_gid']))))
117                         ? t('Private Message')
118                         : false);
119                 $shareable = ((($conv->get_profile_owner() == local_user()) && ($item['private'] != 1)) ? true : false);
120                 if (local_user() && link_compare($a->contact['url'],$item['author-link'])) {
121                         if ($item["event-id"] != 0) {
122                                 $edpost = array("events/event/".$item['event-id'], t("Edit"));
123                         } else {
124                                 $edpost = array("editpost/".$item['id'], t("Edit"));
125                         }
126                 } else {
127                         $edpost = false;
128                 }
129
130                 if (($this->get_data_value('uid') == local_user()) || $this->is_visiting()) {
131                         $dropping = true;
132                 }
133
134                 $drop = array(
135                         'dropping' => $dropping,
136                         'pagedrop' => ((feature_enabled($conv->get_profile_owner(),'multi_delete')) ? $item['pagedrop'] : ''),
137                         'select'   => t('Select'),
138                         'delete'   => t('Delete'),
139                 );
140
141                 $filer = (($conv->get_profile_owner() == local_user()) ? t("save to folder") : false);
142
143                 $diff_author    = ((link_compare($item['url'],$item['author-link'])) ? false : true);
144                 $profile_name   = htmlentities(((strlen($item['author-name']))   && $diff_author) ? $item['author-name']   : $item['name']);
145                 if ($item['author-link'] && (! $item['author-name'])) {
146                         $profile_name = $item['author-link'];
147                 }
148
149                 $sp = false;
150                 $profile_link = best_link_url($item,$sp);
151                 if ($profile_link === 'mailbox') {
152                         $profile_link = '';
153                 }
154
155                 if ($sp) {
156                         $sparkle = ' sparkle';
157                 } else {
158                         $profile_link = zrl($profile_link);
159                 }
160
161                 if (!isset($item['author-thumb']) OR ($item['author-thumb'] == "")) {
162                         $author_contact = get_contact_details_by_url($item['author-link'], $conv->get_profile_owner());
163                         if ($author_contact["thumb"]) {
164                                 $item['author-thumb'] = $author_contact["thumb"];
165                         } else {
166                                 $item['author-thumb'] = $item['author-avatar'];
167                         }
168                 }
169
170                 if (!isset($item['owner-thumb']) OR ($item['owner-thumb'] == "")) {
171                         $owner_contact = get_contact_details_by_url($item['owner-link'], $conv->get_profile_owner());
172                         if ($owner_contact["thumb"]) {
173                                 $item['owner-thumb'] = $owner_contact["thumb"];
174                         } else {
175                                 $item['owner-thumb'] = $item['owner-avatar'];
176                         }
177                 }
178
179                 $locate = array('location' => $item['location'], 'coord' => $item['coord'], 'html' => '');
180                 call_hooks('render_location',$locate);
181                 $location = ((strlen($locate['html'])) ? $locate['html'] : render_location_dummy($locate));
182
183                 $searchpath = "search?tag=";
184                 $tags=array();
185                 $hashtags = array();
186                 $mentions = array();
187
188
189                 /*foreach(explode(',',$item['tag']) as $tag){
190                         $tag = trim($tag);
191                         if ($tag!="") {
192                                 $t = bbcode($tag);
193                                 $tags[] = $t;
194                                 if($t[0] == '#')
195                                         $hashtags[] = $t;
196                                 elseif($t[0] == '@')
197                                         $mentions[] = $t;
198                         }
199                 }*/
200
201                 // process action responses - e.g. like/dislike/attend/agree/whatever
202                 $response_verbs = array('like');
203                 if (feature_enabled($conv->get_profile_owner(),'dislike')) {
204                         $response_verbs[] = 'dislike';
205                 }
206                 if ($item['object-type'] === ACTIVITY_OBJ_EVENT) {
207                         $response_verbs[] = 'attendyes';
208                         $response_verbs[] = 'attendno';
209                         $response_verbs[] = 'attendmaybe';
210                         if ($conv->is_writable()) {
211                                 $isevent = true;
212                                 $attend = array( t('I will attend'), t('I will not attend'), t('I might attend'));
213                         }
214                 }
215
216                 $responses = get_responses($conv_responses,$response_verbs,$this,$item);
217
218                 foreach ($response_verbs as $value=>$verbs) {
219                         $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']) : '');
220                 }
221
222                 /*
223                  * We should avoid doing this all the time, but it depends on the conversation mode
224                  * And the conv mode may change when we change the conv, or it changes its mode
225                  * Maybe we should establish a way to be notified about conversation changes
226                  */
227                 $this->check_wall_to_wall();
228
229                 if ($this->is_wall_to_wall() && ($this->get_owner_url() == $this->get_redirect_url())) {
230                         $osparkle = ' sparkle';
231                 }
232
233                 if ($this->is_toplevel()) {
234                         if ($conv->get_profile_owner() == local_user()) {
235                                 $isstarred = (($item['starred']) ? "starred" : "unstarred");
236
237                                 $star = array(
238                                         'do'        => t("add star"),
239                                         'undo'      => t("remove star"),
240                                         'toggle'    => t("toggle star status"),
241                                         'classdo'   => (($item['starred']) ? "hidden" : ""),
242                                         'classundo' => (($item['starred']) ? "" : "hidden"),
243                                         'starred'   =>  t('starred'),
244                                 );
245                                 $r = q("SELECT `ignored` FROM `thread` WHERE `uid` = %d AND `iid` = %d LIMIT 1",
246                                         intval($item['uid']),
247                                         intval($item['id'])
248                                 );
249                                 if (dbm::is_result($r)) {
250                                         $ignore = array(
251                                                 'do'        => t("ignore thread"),
252                                                 'undo'      => t("unignore thread"),
253                                                 'toggle'    => t("toggle ignore status"),
254                                                 'classdo'   => (($r[0]['ignored']) ? "hidden" : ""),
255                                                 'classundo' => (($r[0]['ignored']) ? "" : "hidden"),
256                                                 'ignored'   =>  t('ignored'),
257                                         );
258                                 }
259
260                                 $tagger = '';
261                                 if(feature_enabled($conv->get_profile_owner(),'commtag')) {
262                                         $tagger = array(
263                                                 'add'   => t("add tag"),
264                                                 'class' => "",
265                                         );
266                                 }
267                         }
268                 } else {
269                         $indent = 'comment';
270                 }
271
272                 if ($conv->is_writable()) {
273                         $buttons = array(
274                                 'like' => array( t("I like this \x28toggle\x29"), t("like")),
275                                 'dislike' => ((feature_enabled($conv->get_profile_owner(),'dislike')) ? array( t("I don't like this \x28toggle\x29"), t("dislike")) : ''),
276                         );
277                         if ($shareable) {
278                                 $buttons['share'] = array( t('Share this'), t('share'));
279                         }
280                 }
281
282                 $comment = $this->get_comment_box($indent);
283
284                 if (strcmp(datetime_convert('UTC','UTC',$item['created']),datetime_convert('UTC','UTC','now - 12 hours')) > 0){
285                         $shiny = 'shiny';
286                 }
287
288                 localize_item($item);
289
290                 if ($item["postopts"] and !get_config("system", "suppress_language")) {
291                         //$langdata = explode(";", $item["postopts"]);
292                         //$langstr = substr($langdata[0], 5)." (".round($langdata[1]*100, 1)."%)";
293                         $langstr = "";
294                         if (substr($item["postopts"], 0, 5) == "lang=") {
295                                 $postopts = substr($item["postopts"], 5);
296
297                                 $languages = explode(":", $postopts);
298
299                                 if (sizeof($languages) == 1) {
300                                         $languages = array();
301                                         $languages[] = $postopts;
302                                 }
303
304                                 foreach ($languages as $language) {
305                                         $langdata = explode(";", $language);
306                                         if ($langstr != "") {
307                                                 $langstr .= ", ";
308                                         }
309
310                                         //$langstr .= $langdata[0]." (".round($langdata[1]*100, 1)."%)";
311                                         $langstr .= round($langdata[1]*100, 1)."% ".$langdata[0];
312                                 }
313                         }
314                 }
315
316                 $body = prepare_body($item,true);
317
318                 list($categories, $folders) = get_cats_and_terms($item);
319
320                 if ($a->theme['template_engine'] === 'internal') {
321                         $body_e       = template_escape($body);
322                         $text_e       = strip_tags(template_escape($body));
323                         $name_e       = template_escape($profile_name);
324                         $title_e      = template_escape($item['title']);
325                         $location_e   = template_escape($location);
326                         $owner_name_e = template_escape($this->get_owner_name());
327                 } else {
328                         $body_e       = $body;
329                         $text_e       = strip_tags($body);
330                         $name_e       = $profile_name;
331                         $title_e      = $item['title'];
332                         $location_e   = $location;
333                         $owner_name_e = $this->get_owner_name();
334                 }
335
336                 // Disable features that aren't available in several networks
337
338                 /// @todo Add NETWORK_DIASPORA when it will pass this information
339                 if (!in_array($item["item_network"], array(NETWORK_DFRN)) AND isset($buttons["dislike"])) {
340                         unset($buttons["dislike"],$isevent);
341                         $tagger = '';
342                 }
343
344                 if (($item["item_network"] == NETWORK_FEED) AND isset($buttons["like"])) {
345                         unset($buttons["like"]);
346                 }
347
348                 if (($item["item_network"] == NETWORK_MAIL) AND isset($buttons["like"])) {
349                         unset($buttons["like"]);
350                 }
351
352                 // Diaspora isn't able to do likes on comments - but Hubzilla does
353                 /// @todo When Diaspora will pass this information we will remove these lines
354                 if (($item["item_network"] == NETWORK_DIASPORA) AND ($indent == 'comment') AND
355                         !Diaspora::is_redmatrix($item["owner-link"]) AND isset($buttons["like"])) {
356                         unset($buttons["like"]);
357                 }
358
359                 // Facebook can like comments - but it isn't programmed in the connector yet.
360                 if (($item["item_network"] == NETWORK_FACEBOOK) AND ($indent == 'comment') AND isset($buttons["like"])) {
361                         unset($buttons["like"]);
362                 }
363
364                 $tmp_item = array(
365                         'template'        => $this->get_template(),
366                         'type'            => implode("",array_slice(explode("/",$item['verb']),-1)),
367                         'tags'            => $item['tags'],
368                         'hashtags'        => $item['hashtags'],
369                         'mentions'        => $item['mentions'],
370                         'txt_cats'        => t('Categories:'),
371                         'txt_folders'     => t('Filed under:'),
372                         'has_cats'        => ((count($categories)) ? 'true' : ''),
373                         'has_folders'     => ((count($folders)) ? 'true' : ''),
374                         'categories'      => $categories,
375                         'folders'         => $folders,
376                         'body'            => $body_e,
377                         'text'            => $text_e,
378                         'id'              => $this->get_id(),
379                         'guid'            => urlencode($item['guid']),
380                         'isevent'         => $isevent,
381                         'attend'          => $attend,
382                         'linktitle'       => sprintf( t('View %s\'s profile @ %s'), $profile_name, ((strlen($item['author-link'])) ? $item['author-link'] : $item['url'])),
383                         'olinktitle'      => sprintf( t('View %s\'s profile @ %s'), htmlentities($this->get_owner_name()), ((strlen($item['owner-link'])) ? $item['owner-link'] : $item['url'])),
384                         'to'              => t('to'),
385                         'via'             => t('via'),
386                         'wall'            => t('Wall-to-Wall'),
387                         'vwall'           => t('via Wall-To-Wall:'),
388                         'profile_url'     => $profile_link,
389                         'item_photo_menu' => item_photo_menu($item),
390                         'name'            => $name_e,
391                         'thumb'           => $a->remove_baseurl(proxy_url($item['author-thumb'], false, PROXY_SIZE_THUMB)),
392                         'osparkle'        => $osparkle,
393                         'sparkle'         => $sparkle,
394                         'title'           => $title_e,
395                         'localtime'       => datetime_convert('UTC', date_default_timezone_get(), $item['created'], 'r'),
396                         'ago'             => (($item['app']) ? sprintf( t('%s from %s'),relative_date($item['created']),$item['app']) : relative_date($item['created'])),
397                         'app'             => $item['app'],
398                         'created'         => relative_date($item['created']),
399                         'lock'            => $lock,
400                         'location'        => $location_e,
401                         'indent'          => $indent,
402                         'shiny'           => $shiny,
403                         'owner_url'       => $this->get_owner_url(),
404                         'owner_photo'     => $a->remove_baseurl(proxy_url($item['owner-thumb'], false, PROXY_SIZE_THUMB)),
405                         'owner_name'      => htmlentities($owner_name_e),
406                         'plink'           => get_plink($item),
407                         'edpost'          => ((feature_enabled($conv->get_profile_owner(),'edit_posts')) ? $edpost : ''),
408                         'isstarred'       => $isstarred,
409                         'star'            => ((feature_enabled($conv->get_profile_owner(),'star_posts')) ? $star : ''),
410                         'ignore'          => ((feature_enabled($conv->get_profile_owner(),'ignore_posts')) ? $ignore : ''),
411                         'tagger'          => $tagger,
412                         'filer'           => ((feature_enabled($conv->get_profile_owner(),'filing')) ? $filer : ''),
413                         'drop'            => $drop,
414                         'vote'            => $buttons,
415                         'like'            => $responses['like']['output'],
416                         'dislike'         => $responses['dislike']['output'],
417                         'responses'       => $responses,
418                         'switchcomment'   => t('Comment'),
419                         'comment'         => $comment,
420                         'previewing'      => ($conv->is_preview() ? ' preview ' : ''),
421                         'wait'            => t('Please wait'),
422                         'thread_level'    => $thread_level,
423                         'postopts'        => $langstr,
424                         'edited'          => $edited,
425                         'network'         => $item["item_network"],
426                         'network_name'    => network_to_name($item['item_network'], $profile_link),
427                 );
428
429                 $arr = array('item' => $item, 'output' => $tmp_item);
430                 call_hooks('display_item', $arr);
431
432                 $result = $arr['output'];
433
434                 $result['children'] = array();
435                 $children = $this->get_children();
436                 $nb_children = count($children);
437                 if ($nb_children > 0) {
438                         foreach ($children as $child) {
439                                 $result['children'][] = $child->get_template_data($conv_responses, $thread_level + 1);
440                         }
441                         // Collapse
442                         if (($nb_children > 2) || ($thread_level > 1)) {
443                                 $result['children'][0]['comment_firstcollapsed'] = true;
444                                 $result['children'][0]['num_comments'] = sprintf( tt('%d comment','%d comments',$total_children),$total_children );
445                                 $result['children'][0]['hidden_comments_num'] = $total_children;
446                                 $result['children'][0]['hidden_comments_text'] = tt('comment', 'comments', $total_children);
447                                 $result['children'][0]['hide_text'] = t('show more');
448                                 if ($thread_level > 1) {
449                                         $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
450                                 } else {
451                                         $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
452                                 }
453                         }
454                 }
455
456         if ($this->is_toplevel()) {
457                 $result['total_comments_num'] = "$total_children";
458                 $result['total_comments_text'] = tt('comment', 'comments', $total_children);
459         }
460
461                 $result['private'] = $item['private'];
462                 $result['toplevel'] = ($this->is_toplevel() ? 'toplevel_item' : '');
463
464                 if ($this->is_threaded()) {
465                         $result['flatten'] = false;
466                         $result['threaded'] = true;
467                 } else {
468                         $result['flatten'] = true;
469                         $result['threaded'] = false;
470                 }
471
472                 return $result;
473         }
474
475         public function get_id() {
476                 return $this->get_data_value('id');
477         }
478
479         public function is_threaded() {
480                 return $this->threaded;
481         }
482
483         /**
484          * Add a child item
485          */
486         public function add_child(Item $item) {
487                 $item_id = $item->get_id();
488                 if (!$item_id) {
489                         logger('[ERROR] Item::add_child : Item has no ID!!', LOGGER_DEBUG);
490                         return false;
491                 } elseif ($this->get_child($item->get_id())) {
492                         logger('[WARN] Item::add_child : Item already exists ('. $item->get_id() .').', LOGGER_DEBUG);
493                         return false;
494                 }
495                 /*
496                  * Only add what will be displayed
497                  */
498                 if ($item->get_data_value('network') === NETWORK_MAIL && local_user() != $item->get_data_value('uid')) {
499                         return false;
500                 } elseif (activity_match($item->get_data_value('verb'),ACTIVITY_LIKE) || activity_match($item->get_data_value('verb'),ACTIVITY_DISLIKE)) {
501                         return false;
502                 }
503
504                 $item->set_parent($this);
505                 $this->children[] = $item;
506                 return end($this->children);
507         }
508
509         /**
510          * Get a child by its ID
511          */
512         public function get_child($id) {
513                 foreach ($this->get_children() as $child) {
514                         if ($child->get_id() == $id) {
515                                 return $child;
516                         }
517                 }
518                 return null;
519         }
520
521         /**
522          * Get all ou children
523          */
524         public function get_children() {
525                 return $this->children;
526         }
527
528         /**
529          * Set our parent
530          */
531         protected function set_parent($item) {
532                 $parent = $this->get_parent();
533                 if($parent) {
534                         $parent->remove_child($this);
535                 }
536                 $this->parent = $item;
537                 $this->set_conversation($item->get_conversation());
538         }
539
540         /**
541          * Remove our parent
542          */
543         protected function remove_parent() {
544                 $this->parent = null;
545                 $this->conversation = null;
546         }
547
548         /**
549          * Remove a child
550          */
551         public function remove_child($item) {
552                 $id = $item->get_id();
553                 foreach ($this->get_children() as $key => $child) {
554                         if ($child->get_id() == $id) {
555                                 $child->remove_parent();
556                                 unset($this->children[$key]);
557                                 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
558                                 $this->children = array_values($this->children);
559                                 return true;
560                         }
561                 }
562                 logger('[WARN] Item::remove_child : Item is not a child ('. $id .').', LOGGER_DEBUG);
563                 return false;
564         }
565
566         /**
567          * Get parent item
568          */
569         protected function get_parent() {
570                 return $this->parent;
571         }
572
573         /**
574          * set conversation
575          */
576         public function set_conversation($conv) {
577                 $previous_mode = ($this->conversation ? $this->conversation->get_mode() : '');
578
579                 $this->conversation = $conv;
580
581                 // Set it on our children too
582                 foreach ($this->get_children() as $child) {
583                         $child->set_conversation($conv);
584                 }
585         }
586
587         /**
588          * get conversation
589          */
590         public function get_conversation() {
591                 return $this->conversation;
592         }
593
594         /**
595          * Get raw data
596          *
597          * We shouldn't need this
598          */
599         public function get_data() {
600                 return $this->data;
601         }
602
603         /**
604          * Get a data value
605          *
606          * Returns:
607          *      _ value on success
608          *      _ false on failure
609          */
610         public function get_data_value($name) {
611                 if (!isset($this->data[$name])) {
612 //                      logger('[ERROR] Item::get_data_value : Item has no value name "'. $name .'".', LOGGER_DEBUG);
613                         return false;
614                 }
615
616                 return $this->data[$name];
617         }
618
619         /**
620          * Set template
621          */
622         private function set_template($name) {
623                 if (!x($this->available_templates, $name)) {
624                         logger('[ERROR] Item::set_template : Template not available ("'. $name .'").', LOGGER_DEBUG);
625                         return false;
626                 }
627
628                 $this->template = $this->available_templates[$name];
629         }
630
631         /**
632          * Get template
633          */
634         private function get_template() {
635                 return $this->template;
636         }
637
638         /**
639          * Check if this is a toplevel post
640          */
641         private function is_toplevel() {
642                 return $this->toplevel;
643         }
644
645         /**
646          * Check if this is writable
647          */
648         private function is_writable() {
649                 $conv = $this->get_conversation();
650
651                 if ($conv) {
652                         // This will allow us to comment on wall-to-wall items owned by our friends
653                         // and community forums even if somebody else wrote the post.
654
655                         // bug #517 - this fixes for conversation owner
656                         if ($conv->get_mode() == 'profile' && $conv->get_profile_owner() == local_user()) {
657                                 return true;
658                         }
659
660                         // this fixes for visitors
661                         return ($this->writable || ($this->is_visiting() && $conv->get_mode() == 'profile'));
662                 }
663                 return $this->writable;
664         }
665
666         /**
667          * Count the total of our descendants
668          */
669         private function count_descendants() {
670                 $children = $this->get_children();
671                 $total = count($children);
672                 if ($total > 0) {
673                         foreach ($children as $child) {
674                                 $total += $child->count_descendants();
675                         }
676                 }
677                 return $total;
678         }
679
680         /**
681          * Get the template for the comment box
682          */
683         private function get_comment_box_template() {
684                 return $this->comment_box_template;
685         }
686
687         /**
688          * Get the comment box
689          *
690          * Returns:
691          *      _ The comment box string (empty if no comment box)
692          *      _ false on failure
693          */
694         private function get_comment_box($indent) {
695                 $a = $this->get_app();
696                 if (!$this->is_toplevel() && !(get_config('system','thread_allow') && $a->theme_thread_allow)) {
697                         return '';
698                 }
699
700                 $comment_box = '';
701                 $conv = $this->get_conversation();
702                 $template = get_markup_template($this->get_comment_box_template());
703                 $ww = '';
704                 if ( ($conv->get_mode() === 'network') && $this->is_wall_to_wall() )
705                         $ww = 'ww';
706
707                 if ($conv->is_writable() && $this->is_writable()) {
708                         $qc = $qcomment =  null;
709
710                         /*
711                          * Hmmm, code depending on the presence of a particular plugin?
712                          * This should be better if done by a hook
713                          */
714                         if (in_array('qcomment',$a->plugins)) {
715                                 $qc = ((local_user()) ? get_pconfig(local_user(),'qcomment','words') : null);
716                                 $qcomment = (($qc) ? explode("\n",$qc) : null);
717                         }
718                         $comment_box = replace_macros($template,array(
719                                 '$return_path' => $a->query_string,
720                                 '$threaded'    => $this->is_threaded(),
721 //                              '$jsreload'    => (($conv->get_mode() === 'display') ? $_SESSION['return_url'] : ''),
722                                 '$jsreload'    => '',
723                                 '$type'        => (($conv->get_mode() === 'profile') ? 'wall-comment' : 'net-comment'),
724                                 '$id'          => $this->get_id(),
725                                 '$parent'      => $this->get_id(),
726                                 '$qcomment'    => $qcomment,
727                                 '$profile_uid' =>  $conv->get_profile_owner(),
728                                 '$mylink'      => $a->remove_baseurl($a->contact['url']),
729                                 '$mytitle'     => t('This is you'),
730                                 '$myphoto'     => $a->remove_baseurl($a->contact['thumb']),
731                                 '$comment'     => t('Comment'),
732                                 '$submit'      => t('Submit'),
733                                 '$edbold'      => t('Bold'),
734                                 '$editalic'    => t('Italic'),
735                                 '$eduline'     => t('Underline'),
736                                 '$edquote'     => t('Quote'),
737                                 '$edcode'      => t('Code'),
738                                 '$edimg'       => t('Image'),
739                                 '$edurl'       => t('Link'),
740                                 '$edvideo'     => t('Video'),
741                                 '$preview'     => ((feature_enabled($conv->get_profile_owner(),'preview')) ? t('Preview') : ''),
742                                 '$indent'      => $indent,
743                                 '$sourceapp'   => t($a->sourcename),
744                                 '$ww'          => (($conv->get_mode() === 'network') ? $ww : ''),
745                                 '$rand_num'    => random_digits(12)
746                         ));
747                 }
748
749                 return $comment_box;
750         }
751
752         private function get_redirect_url() {
753                 return $this->redirect_url;
754         }
755
756         /**
757          * Check if we are a wall to wall item and set the relevant properties
758          */
759         protected function check_wall_to_wall() {
760                 $a = $this->get_app();
761                 $conv = $this->get_conversation();
762                 $this->wall_to_wall = false;
763
764                 if($this->is_toplevel()) {
765                         if($conv->get_mode() !== 'profile') {
766                                 if($this->get_data_value('wall') AND !$this->get_data_value('self')) {
767                                         // On the network page, I am the owner. On the display page it will be the profile owner.
768                                         // This will have been stored in $a->page_contact by our calling page.
769                                         // Put this person as the wall owner of the wall-to-wall notice.
770
771                                         $this->owner_url = zrl($a->page_contact['url']);
772                                         $this->owner_photo = $a->page_contact['thumb'];
773                                         $this->owner_name = $a->page_contact['name'];
774                                         $this->wall_to_wall = true;
775                                 } elseif($this->get_data_value('owner-link')) {
776
777                                         $owner_linkmatch = (($this->get_data_value('owner-link')) && link_compare($this->get_data_value('owner-link'),$this->get_data_value('author-link')));
778                                         $alias_linkmatch = (($this->get_data_value('alias')) && link_compare($this->get_data_value('alias'),$this->get_data_value('author-link')));
779                                         $owner_namematch = (($this->get_data_value('owner-name')) && $this->get_data_value('owner-name') == $this->get_data_value('author-name'));
780
781                                         if ((! $owner_linkmatch) && (! $alias_linkmatch) && (! $owner_namematch)) {
782
783                                                 // The author url doesn't match the owner (typically the contact)
784                                                 // and also doesn't match the contact alias. 
785                                                 // The name match is a hack to catch several weird cases where URLs are 
786                                                 // all over the park. It can be tricked, but this prevents you from
787                                                 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
788                                                 // well that it's the same Bob Smith. 
789
790                                                 // But it could be somebody else with the same name. It just isn't highly likely. 
791
792
793                                                 $this->owner_photo = $this->get_data_value('owner-avatar');
794                                                 $this->owner_name = $this->get_data_value('owner-name');
795                                                 $this->wall_to_wall = true;
796                                                 // If it is our contact, use a friendly redirect link
797                                                 if ((link_compare($this->get_data_value('owner-link'),$this->get_data_value('url'))) 
798                                                         && ($this->get_data_value('network') === NETWORK_DFRN)) {
799                                                         $this->owner_url = $this->get_redirect_url();
800                                                 } else {
801                                                         $this->owner_url = zrl($this->get_data_value('owner-link'));
802                                                 }
803                                         }
804                                 }
805                         }
806                 }
807
808                 if (!$this->wall_to_wall) {
809                         $this->set_template('wall');
810                         $this->owner_url = '';
811                         $this->owner_photo = '';
812                         $this->owner_name = '';
813                 }
814         }
815
816         private function is_wall_to_wall() {
817                 return $this->wall_to_wall;
818         }
819
820         private function get_owner_url() {
821                 return $this->owner_url;
822         }
823
824         private function get_owner_photo() {
825                 return $this->owner_photo;
826         }
827
828         private function get_owner_name() {
829                 return $this->owner_name;
830         }
831
832         private function is_visiting() {
833                 return $this->visiting;
834         }
835
836 }
837 /// @TODO These are discouraged and should be removed:
838 ?>