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