]> git.mxchange.org Git - friendica.git/blob - object/Item.php
deleted: view/theme/smoothly/events_reminder.tpl
[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('boot.php');
8
9 /**
10  * An item
11  */
12 class Item extends BaseObject {
13         private $data = array();
14         private $template = null;
15         private $available_templates = array(
16                 'wall' => 'wall_thread.tpl',
17                 'wall2wall' => 'wallwall_thread.tpl'
18         );
19         private $comment_box_template = 'comment_item.tpl';
20         private $toplevel = false;
21         private $writable = false;
22         private $children = array();
23         private $parent = null;
24         private $conversation = null;
25         private $redirect_url = null;
26         private $owner_url = '';
27         private $owner_photo = '';
28         private $owner_name = '';
29         private $wall_to_wall = false;
30         private $threaded = false;
31         private $visiting = false;
32
33         public function __construct($data) {
34                 $a = $this->get_app();
35                 
36                 $this->data = $data;
37                 $this->set_template('wall');
38                 $this->toplevel = ($this->get_id() == $this->get_data_value('parent'));
39
40                 if(is_array($_SESSION['remote'])) {
41                         foreach($_SESSION['remote'] as $visitor) {
42                                 if($visitor['cid'] == $this->get_data_value('contact-id')) {
43                                         $this->visiting = true;
44                                         break;
45                                 }
46                         }
47                 }
48                 
49                 $this->writable = ($this->get_data_value('writable') || $this->get_data_value('self'));
50
51                 $ssl_state = ((local_user()) ? true : false);
52                 $this->redirect_url = $a->get_baseurl($ssl_state) . '/redir/' . $this->get_data_value('cid') ;
53
54                 if(get_config('system','thread_allow') && $a->theme_thread_allow && !$this->is_toplevel())
55                         $this->threaded = true;
56
57                 // Prepare the children
58                 if(count($data['children'])) {
59                         foreach($data['children'] as $item) {
60                                 /*
61                                  * Only add will be displayed
62                                  */
63                                 if($item['network'] === NETWORK_MAIL && local_user() != $item['uid']) {
64                                         continue;
65                                 }
66                                 if(! visible_activity($item)) {
67                                         continue;
68                                 }
69                                 $child = new Item($item);
70                                 $this->add_child($child);
71                         }
72                 }
73         }
74
75         /**
76          * Get data in a form usable by a conversation template
77          *
78          * Returns:
79          *      _ The data requested on success
80          *      _ false on failure
81          */
82         public function get_template_data($alike, $dlike, $thread_level=1) {
83                 $result = array();
84
85                 $a = $this->get_app();
86
87                 $item = $this->get_data();
88
89                 $commentww = '';
90                 $sparkle = '';
91                 $buttons = '';
92                 $dropping = false;
93                 $star = false;
94                 $isstarred = "unstarred";
95                 $indent = '';
96                 $shiny = '';
97                 $osparkle = '';
98                 $total_children = $this->count_descendants();
99
100                 $conv = $this->get_conversation();
101
102                 $lock = ((($item['private'] == 1) || (($item['uid'] == local_user()) && (strlen($item['allow_cid']) || strlen($item['allow_gid']) 
103                         || strlen($item['deny_cid']) || strlen($item['deny_gid']))))
104                         ? t('Private Message')
105                         : false);
106                 $shareable = ((($conv->get_profile_owner() == local_user()) && ($item['private'] != 1)) ? true : false);
107                 if(local_user() && link_compare($a->contact['url'],$item['author-link']))
108                         $edpost = array($a->get_baseurl($ssl_state)."/editpost/".$item['id'], t("Edit"));
109                 else
110                         $edpost = false;
111                 if(($this->get_data_value('uid') == local_user()) || $this->is_visiting())
112                         $dropping = true;
113
114                 $drop = array(
115                         'dropping' => $dropping,
116                         'pagedrop' => $item['pagedrop'],
117                         'select' => t('Select'), 
118                         'delete' => t('Delete'),
119                 );
120                 
121                 $filer = (($conv->get_profile_owner() == local_user()) ? t("save to folder") : false);
122
123                 $diff_author    = ((link_compare($item['url'],$item['author-link'])) ? false : true);
124                 $profile_name   = (((strlen($item['author-name']))   && $diff_author) ? $item['author-name']   : $item['name']);
125                 if($item['author-link'] && (! $item['author-name']))
126                         $profile_name = $item['author-link'];
127
128                 $sp = false;
129                 $profile_link = best_link_url($item,$sp);
130                 if($profile_link === 'mailbox')
131                         $profile_link = '';
132                 if($sp)
133                         $sparkle = ' sparkle';
134                 else
135                         $profile_link = zrl($profile_link);                 
136
137                 $normalised = normalise_link((strlen($item['author-link'])) ? $item['author-link'] : $item['url']);
138                 if(($normalised != 'mailbox') && (x($a->contacts,$normalised)))
139                         $profile_avatar = $a->contacts[$normalised]['thumb'];
140                 else
141                         $profile_avatar = (((strlen($item['author-avatar'])) && $diff_author) ? $item['author-avatar'] : $a->get_cached_avatar_image($this->get_data_value('thumb')));
142
143                 $locate = array('location' => $item['location'], 'coord' => $item['coord'], 'html' => '');
144                 call_hooks('render_location',$locate);
145                 $location = ((strlen($locate['html'])) ? $locate['html'] : render_location_google($locate));
146
147                 $tags=array();
148                 $hashtags = array();
149                 $mentions = array();
150                 foreach(explode(',',$item['tag']) as $tag){
151                         $tag = trim($tag);
152                         if ($tag!="") {
153                                 $t = bbcode($tag);
154                                 $tags[] = $t;
155                                 if($t[0] == '#')
156                                         $hashtags[] = $t;
157                                 elseif($t[0] == '@')
158                                         $mentions[] = $t;
159                         }
160
161                 }        
162
163                 $like    = ((x($alike,$item['uri'])) ? format_like($alike[$item['uri']],$alike[$item['uri'] . '-l'],'like',$item['uri']) : '');
164                 $dislike = ((x($dlike,$item['uri'])) ? format_like($dlike[$item['uri']],$dlike[$item['uri'] . '-l'],'dislike',$item['uri']) : '');
165
166                 /*
167                  * We should avoid doing this all the time, but it depends on the conversation mode
168                  * And the conv mode may change when we change the conv, or it changes its mode
169                  * Maybe we should establish a way to be notified about conversation changes
170                  */
171                 $this->check_wall_to_wall();
172                 
173                 if($this->is_wall_to_wall() && ($this->get_owner_url() == $this->get_redirect_url()))
174                         $osparkle = ' sparkle';
175                 
176                 if($this->is_toplevel()) {
177                         if($conv->get_profile_owner() == local_user()) {
178                                 $isstarred = (($item['starred']) ? "starred" : "unstarred");
179
180                                 $star = array(
181                                         'do' => t("add star"),
182                                         'undo' => t("remove star"),
183                                         'toggle' => t("toggle star status"),
184                                         'classdo' => (($item['starred']) ? "hidden" : ""),
185                                         'classundo' => (($item['starred']) ? "" : "hidden"),
186                                         'starred' =>  t('starred'),
187                                         'tagger' => t("add tag"),
188                                         'classtagger' => "",
189                                 );
190                         }
191                 } else {
192                         $indent = 'comment';
193                 }
194
195                 if($conv->is_writable()) {
196                         $buttons = array(
197                                 'like' => array( t("I like this \x28toggle\x29"), t("like")),
198                                 'dislike' => array( t("I don't like this \x28toggle\x29"), t("dislike")),
199                         );
200                         if ($shareable) $buttons['share'] = array( t('Share this'), t('share'));
201                 }
202
203                 if(strcmp(datetime_convert('UTC','UTC',$item['created']),datetime_convert('UTC','UTC','now - 12 hours')) > 0){
204                         $shiny = 'shiny';
205                 }
206
207                 localize_item($item);
208
209                 $body = prepare_body($item,true);
210
211         list($categories, $folders) = get_cats_and_terms($item);
212
213                 $tmp_item = array(
214                         'template' => $this->get_template(),
215                         
216                         'type' => implode("",array_slice(explode("/",$item['verb']),-1)),
217                         'tags' => $tags,
218             'hashtags' => $hashtags,
219             'mentions' => $mentions,
220                         'txt_cats' => t('Categories:'),
221                         'txt_folders' => t('Filed under:'),
222                         'has_cats' => ((count($categories)) ? 'true' : ''),
223                         'has_folders' => ((count($folders)) ? 'true' : ''),
224             'categories' => $categories,
225             'folders' => $folders,            
226                         'body' => template_escape($body),
227                         'text' => strip_tags(template_escape($body)),
228                         'id' => $this->get_id(),
229                         'linktitle' => sprintf( t('View %s\'s profile @ %s'), $profile_name, ((strlen($item['author-link'])) ? $item['author-link'] : $item['url'])),
230                         'olinktitle' => sprintf( t('View %s\'s profile @ %s'), $this->get_owner_name(), ((strlen($item['owner-link'])) ? $item['owner-link'] : $item['url'])),
231                         'to' => t('to'),
232                         'wall' => t('Wall-to-Wall'),
233                         'vwall' => t('via Wall-To-Wall:'),
234                         'profile_url' => $profile_link,
235                         'item_photo_menu' => item_photo_menu($item),
236                         'name' => template_escape($profile_name),
237                         'thumb' => $profile_avatar,
238                         'osparkle' => $osparkle,
239                         'sparkle' => $sparkle,
240                         'title' => template_escape($item['title']),
241                         'localtime' => datetime_convert('UTC', date_default_timezone_get(), $item['created'], 'r'),
242                         'ago' => (($item['app']) ? sprintf( t('%s from %s'),relative_date($item['created']),$item['app']) : relative_date($item['created'])),
243                         'lock' => $lock,
244                         'location' => template_escape($location),
245                         'indent' => $indent,
246                         'shiny' => $shiny,
247                         'owner_url' => $this->get_owner_url(),
248                         'owner_photo' => $this->get_owner_photo(),
249                         'owner_name' => template_escape($this->get_owner_name()),
250                         'plink' => get_plink($item),
251                         'edpost' => $edpost,
252                         'isstarred' => $isstarred,
253                         'star' => $star,
254                         'filer' => $filer,
255                         'drop' => $drop,
256                         'vote' => $buttons,
257                         'like' => $like,
258                         'dislike' => $dislike,
259                         'comment' => $this->get_comment_box($indent),
260                         'previewing' => ($conv->is_preview() ? ' preview ' : ''),
261                         'wait' => t('Please wait'),
262                         'thread_level' => $thread_level
263                 );
264
265                 $arr = array('item' => $item, 'output' => $tmp_item);
266                 call_hooks('display_item', $arr);
267
268                 $result = $arr['output'];
269
270                 $result['children'] = array();
271                 $children = $this->get_children();
272                 $nb_children = count($children);
273                 if($nb_children > 0) {
274                         foreach($children as $child) {
275                                 $result['children'][] = $child->get_template_data($alike, $dlike, $thread_level + 1);
276                         }
277                         // Collapse
278                         if(($nb_children > 2) || ($thread_level > 1)) {
279                                 $result['children'][0]['comment_firstcollapsed'] = true;
280                                 $result['children'][0]['num_comments'] = sprintf( tt('%d comment','%d comments',$total_children),$total_children );
281                                 $result['children'][0]['hidden_comments_num'] = $total_children;
282                                 $result['children'][0]['hidden_comments_text'] = tt('comment', 'comments', $total_children);
283                                 $result['children'][0]['hide_text'] = t('show more');
284                                 if($thread_level > 1) {
285                                         $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
286                                 }
287                                 else {
288                                         $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
289                                 }
290                         }
291                 }
292                 
293         if ($this->is_toplevel()) {
294             $result['total_comments_num'] = "$total_children";
295             $result['total_comments_text'] = tt('comment', 'comments', $total_children);
296         }
297         
298                 $result['private'] = $item['private'];
299                 $result['toplevel'] = ($this->is_toplevel() ? 'toplevel_item' : '');
300
301                 if($this->is_threaded()) {
302                         $result['flatten'] = false;
303                         $result['threaded'] = true;
304                 }
305                 else {
306                         $result['flatten'] = true;
307                         $result['threaded'] = false;
308                 }
309
310                 return $result;
311         }
312         
313         public function get_id() {
314                 return $this->get_data_value('id');
315         }
316
317         public function is_threaded() {
318                 return $this->threaded;
319         }
320
321         /**
322          * Add a child item
323          */
324         public function add_child($item) {
325                 $item_id = $item->get_id();
326                 if(!$item_id) {
327                         logger('[ERROR] Item::add_child : Item has no ID!!', LOGGER_DEBUG);
328                         return false;
329                 }
330                 if($this->get_child($item->get_id())) {
331                         logger('[WARN] Item::add_child : Item already exists ('. $item->get_id() .').', LOGGER_DEBUG);
332                         return false;
333                 }
334                 /*
335                  * Only add what will be displayed
336                  */
337                 if($item->get_data_value('network') === NETWORK_MAIL && local_user() != $item->get_data_value('uid')) {
338                         return false;
339                 }
340                 if(activity_match($item->get_data_value('verb'),ACTIVITY_LIKE) || activity_match($item->get_data_value('verb'),ACTIVITY_DISLIKE)) {
341                         return false;
342                 }
343                 
344                 $item->set_parent($this);
345                 $this->children[] = $item;
346                 return end($this->children);
347         }
348
349         /**
350          * Get a child by its ID
351          */
352         public function get_child($id) {
353                 foreach($this->get_children() as $child) {
354                         if($child->get_id() == $id)
355                                 return $child;
356                 }
357                 return null;
358         }
359
360         /**
361          * Get all ou children
362          */
363         public function get_children() {
364                 return $this->children;
365         }
366
367         /**
368          * Set our parent
369          */
370         protected function set_parent($item) {
371                 $parent = $this->get_parent();
372                 if($parent) {
373                         $parent->remove_child($this);
374                 }
375                 $this->parent = $item;
376                 $this->set_conversation($item->get_conversation());
377         }
378
379         /**
380          * Remove our parent
381          */
382         protected function remove_parent() {
383                 $this->parent = null;
384                 $this->conversation = null;
385         }
386
387         /**
388          * Remove a child
389          */
390         public function remove_child($item) {
391                 $id = $item->get_id();
392                 foreach($this->get_children() as $key => $child) {
393                         if($child->get_id() == $id) {
394                                 $child->remove_parent();
395                                 unset($this->children[$key]);
396                                 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
397                                 $this->children = array_values($this->children);
398                                 return true;
399                         }
400                 }
401                 logger('[WARN] Item::remove_child : Item is not a child ('. $id .').', LOGGER_DEBUG);
402                 return false;
403         }
404
405         /**
406          * Get parent item
407          */
408         protected function get_parent() {
409                 return $this->parent;
410         }
411
412         /**
413          * set conversation
414          */
415         public function set_conversation($conv) {
416                 $previous_mode = ($this->conversation ? $this->conversation->get_mode() : '');
417                 
418                 $this->conversation = $conv;
419
420                 // Set it on our children too
421                 foreach($this->get_children() as $child)
422                         $child->set_conversation($conv);
423         }
424
425         /**
426          * get conversation
427          */
428         public function get_conversation() {
429                 return $this->conversation;
430         }
431
432         /**
433          * Get raw data
434          *
435          * We shouldn't need this
436          */
437         public function get_data() {
438                 return $this->data;
439         }
440
441         /**
442          * Get a data value
443          *
444          * Returns:
445          *      _ value on success
446          *      _ false on failure
447          */
448         public function get_data_value($name) {
449                 if(!isset($this->data[$name])) {
450                         logger('[ERROR] Item::get_data_value : Item has no value name "'. $name .'".', LOGGER_DEBUG);
451                         return false;
452                 }
453
454                 return $this->data[$name];
455         }
456
457         /**
458          * Set template
459          */
460         private function set_template($name) {
461                 if(!x($this->available_templates, $name)) {
462                         logger('[ERROR] Item::set_template : Template not available ("'. $name .'").', LOGGER_DEBUG);
463                         return false;
464                 }
465                 $this->template = $this->available_templates[$name];
466         }
467
468         /**
469          * Get template
470          */
471         private function get_template() {
472                 return $this->template;
473         }
474
475         /**
476          * Check if this is a toplevel post
477          */
478         private function is_toplevel() {
479                 return $this->toplevel;
480         }
481
482         /**
483          * Check if this is writable
484          */
485         private function is_writable() {
486                 $conv = $this->get_conversation();
487
488                 if($conv) {
489                         // This will allow us to comment on wall-to-wall items owned by our friends
490                         // and community forums even if somebody else wrote the post.
491                         return ($this->writable || ($this->is_visiting() && $conv->get_mode() == 'profile'));
492                 }
493                 return $this->writable;
494         }
495
496         /**
497          * Count the total of our descendants
498          */
499         private function count_descendants() {
500                 $children = $this->get_children();
501                 $total = count($children);
502                 if($total > 0) {
503                         foreach($children as $child) {
504                                 $total += $child->count_descendants();
505                         }
506                 }
507                 return $total;
508         }
509
510         /**
511          * Get the template for the comment box
512          */
513         private function get_comment_box_template() {
514                 return $this->comment_box_template;
515         }
516
517         /**
518          * Get the comment box
519          *
520          * Returns:
521          *      _ The comment box string (empty if no comment box)
522          *      _ false on failure
523          */
524         private function get_comment_box($indent) {
525                 $a = $this->get_app();
526                 if(!$this->is_toplevel() && !(get_config('system','thread_allow') && $a->theme_thread_allow)) {
527                         return '';
528                 }
529                 
530                 $comment_box = '';
531                 $conv = $this->get_conversation();
532                 $template = get_markup_template($this->get_comment_box_template());
533                 $ww = '';
534                 if( ($conv->get_mode() === 'network') && $this->is_wall_to_wall() )
535                         $ww = 'ww';
536
537                 if($conv->is_writable() && $this->is_writable()) {
538                         $qc = $qcomment =  null;
539
540                         /*
541                          * Hmmm, code depending on the presence of a particular plugin?
542                          * This should be better if done by a hook
543                          */
544                         if(in_array('qcomment',$a->plugins)) {
545                                 $qc = ((local_user()) ? get_pconfig(local_user(),'qcomment','words') : null);
546                                 $qcomment = (($qc) ? explode("\n",$qc) : null);
547                         }
548                         $comment_box = replace_macros($template,array(
549                                 '$return_path' => '',
550                                 '$threaded' => $this->is_threaded(),
551 //                              '$jsreload' => (($conv->get_mode() === 'display') ? $_SESSION['return_url'] : ''),
552                                 '$jsreload' => '',
553                                 '$type' => (($conv->get_mode() === 'profile') ? 'wall-comment' : 'net-comment'),
554                                 '$id' => $this->get_id(),
555                                 '$parent' => $this->get_id(),
556                                 '$qcomment' => $qcomment,
557                                 '$profile_uid' =>  $conv->get_profile_owner(),
558                                 '$mylink' => $a->contact['url'],
559                                 '$mytitle' => t('This is you'),
560                                 '$myphoto' => $a->contact['thumb'],
561                                 '$comment' => t('Comment'),
562                                 '$submit' => t('Submit'),
563                                 '$edbold' => t('Bold'),
564                                 '$editalic' => t('Italic'),
565                                 '$eduline' => t('Underline'),
566                                 '$edquote' => t('Quote'),
567                                 '$edcode' => t('Code'),
568                                 '$edimg' => t('Image'),
569                                 '$edurl' => t('Link'),
570                                 '$edvideo' => t('Video'),
571                                 '$preview' => t('Preview'),
572                                 '$indent' => $indent,
573                                 '$sourceapp' => t($a->sourcename),
574                                 '$ww' => (($conv->get_mode() === 'network') ? $ww : ''),
575                                 '$rand_num' => random_digits(12)
576                         ));
577                 }
578
579                 return $comment_box;
580         }
581
582         private function get_redirect_url() {
583                 return $this->redirect_url;
584         }
585
586         /**
587          * Check if we are a wall to wall item and set the relevant properties
588          */
589         protected function check_wall_to_wall() {
590                 $a = $this->get_app();
591                 $conv = $this->get_conversation();
592                 $this->wall_to_wall = false;
593                 
594                 if($this->is_toplevel()) {
595                         if( (! $this->get_data_value('self')) && ($conv->get_mode() !== 'profile')) {
596                                 if($this->get_data_value('wall')) {
597
598                                         // On the network page, I am the owner. On the display page it will be the profile owner.
599                                         // This will have been stored in $a->page_contact by our calling page.
600                                         // Put this person as the wall owner of the wall-to-wall notice.
601
602                                         $this->owner_url = zrl($a->page_contact['url']);
603                                         $this->owner_photo = $a->page_contact['thumb'];
604                                         $this->owner_name = $a->page_contact['name'];
605                                         $this->wall_to_wall = true;
606                                 }
607                                 else if($this->get_data_value('owner-link')) {
608
609                                         $owner_linkmatch = (($this->get_data_value('owner-link')) && link_compare($this->get_data_value('owner-link'),$this->get_data_value('author-link')));
610                                         $alias_linkmatch = (($this->get_data_value('alias')) && link_compare($this->get_data_value('alias'),$this->get_data_value('author-link')));
611                                         $owner_namematch = (($this->get_data_value('owner-name')) && $this->get_data_value('owner-name') == $this->get_data_value('author-name'));
612                                         if((! $owner_linkmatch) && (! $alias_linkmatch) && (! $owner_namematch)) {
613
614                                                 // The author url doesn't match the owner (typically the contact)
615                                                 // and also doesn't match the contact alias. 
616                                                 // The name match is a hack to catch several weird cases where URLs are 
617                                                 // all over the park. It can be tricked, but this prevents you from
618                                                 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
619                                                 // well that it's the same Bob Smith. 
620
621                                                 // But it could be somebody else with the same name. It just isn't highly likely. 
622                                                 
623
624                                                 $this->owner_photo = $this->get_data_value('owner-avatar');
625                                                 $this->owner_name = $this->get_data_value('owner-name');
626                                                 $this->wall_to_wall = true;
627                                                 // If it is our contact, use a friendly redirect link
628                                                 if((link_compare($this->get_data_value('owner-link'),$this->get_data_value('url'))) 
629                                                         && ($this->get_data_value('network') === NETWORK_DFRN)) {
630                                                         $this->owner_url = $this->get_redirect_url();
631                                                 }
632                                                 else
633                                                         $this->owner_url = zrl($this->get_data_value('owner-link'));
634                                         }
635                                 }
636                         }
637                 }
638
639                 if(!$this->wall_to_wall) {
640                         $this->set_template('wall');
641                         $this->owner_url = '';
642                         $this->owner_photo = '';
643                         $this->owner_name = '';
644                 }
645         }
646
647         private function is_wall_to_wall() {
648                 return $this->wall_to_wall;
649         }
650
651         private function get_owner_url() {
652                 return $this->owner_url;
653         }
654
655         private function get_owner_photo() {
656                 return $this->owner_photo;
657         }
658
659         private function get_owner_name() {
660                 return $this->owner_name;
661         }
662
663         private function is_visiting() {
664                 return $this->visiting;
665         }
666
667
668
669
670 }
671 ?>