]> git.mxchange.org Git - friendica.git/blob - object/Item.php
Diabook pink
[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                         'via' => t('via'),
233                         'wall' => t('Wall-to-Wall'),
234                         'vwall' => t('via Wall-To-Wall:'),
235                         'profile_url' => $profile_link,
236                         'item_photo_menu' => item_photo_menu($item),
237                         'name' => template_escape($profile_name),
238                         'thumb' => $profile_avatar,
239                         'osparkle' => $osparkle,
240                         'sparkle' => $sparkle,
241                         'title' => template_escape($item['title']),
242                         'localtime' => datetime_convert('UTC', date_default_timezone_get(), $item['created'], 'r'),
243                         'ago' => (($item['app']) ? sprintf( t('%s from %s'),relative_date($item['created']),$item['app']) : relative_date($item['created'])),
244                         'lock' => $lock,
245                         'location' => template_escape($location),
246                         'indent' => $indent,
247                         'shiny' => $shiny,
248                         'owner_url' => $this->get_owner_url(),
249                         'owner_photo' => $this->get_owner_photo(),
250                         'owner_name' => template_escape($this->get_owner_name()),
251                         'plink' => get_plink($item),
252                         'edpost' => $edpost,
253                         'isstarred' => $isstarred,
254                         'star' => $star,
255                         'filer' => $filer,
256                         'drop' => $drop,
257                         'vote' => $buttons,
258                         'like' => $like,
259                         'dislike' => $dislike,
260                         'switchcomment' => t('Comment'),
261                         'comment' => $this->get_comment_box($indent),
262                         'previewing' => ($conv->is_preview() ? ' preview ' : ''),
263                         'wait' => t('Please wait'),
264                         'thread_level' => $thread_level
265                 );
266
267                 $arr = array('item' => $item, 'output' => $tmp_item);
268                 call_hooks('display_item', $arr);
269
270                 $result = $arr['output'];
271
272                 $result['children'] = array();
273                 $children = $this->get_children();
274                 $nb_children = count($children);
275                 if($nb_children > 0) {
276                         foreach($children as $child) {
277                                 $result['children'][] = $child->get_template_data($alike, $dlike, $thread_level + 1);
278                         }
279                         // Collapse
280                         if(($nb_children > 2) || ($thread_level > 1)) {
281                                 $result['children'][0]['comment_firstcollapsed'] = true;
282                                 $result['children'][0]['num_comments'] = sprintf( tt('%d comment','%d comments',$total_children),$total_children );
283                                 $result['children'][0]['hidden_comments_num'] = $total_children;
284                                 $result['children'][0]['hidden_comments_text'] = tt('comment', 'comments', $total_children);
285                                 $result['children'][0]['hide_text'] = t('show more');
286                                 if($thread_level > 1) {
287                                         $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
288                                 }
289                                 else {
290                                         $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
291                                 }
292                         }
293                 }
294                 
295         if ($this->is_toplevel()) {
296             $result['total_comments_num'] = "$total_children";
297             $result['total_comments_text'] = tt('comment', 'comments', $total_children);
298         }
299         
300                 $result['private'] = $item['private'];
301                 $result['toplevel'] = ($this->is_toplevel() ? 'toplevel_item' : '');
302
303                 if($this->is_threaded()) {
304                         $result['flatten'] = false;
305                         $result['threaded'] = true;
306                 }
307                 else {
308                         $result['flatten'] = true;
309                         $result['threaded'] = false;
310                 }
311
312                 return $result;
313         }
314         
315         public function get_id() {
316                 return $this->get_data_value('id');
317         }
318
319         public function is_threaded() {
320                 return $this->threaded;
321         }
322
323         /**
324          * Add a child item
325          */
326         public function add_child($item) {
327                 $item_id = $item->get_id();
328                 if(!$item_id) {
329                         logger('[ERROR] Item::add_child : Item has no ID!!', LOGGER_DEBUG);
330                         return false;
331                 }
332                 if($this->get_child($item->get_id())) {
333                         logger('[WARN] Item::add_child : Item already exists ('. $item->get_id() .').', LOGGER_DEBUG);
334                         return false;
335                 }
336                 /*
337                  * Only add what will be displayed
338                  */
339                 if($item->get_data_value('network') === NETWORK_MAIL && local_user() != $item->get_data_value('uid')) {
340                         return false;
341                 }
342                 if(activity_match($item->get_data_value('verb'),ACTIVITY_LIKE) || activity_match($item->get_data_value('verb'),ACTIVITY_DISLIKE)) {
343                         return false;
344                 }
345                 
346                 $item->set_parent($this);
347                 $this->children[] = $item;
348                 return end($this->children);
349         }
350
351         /**
352          * Get a child by its ID
353          */
354         public function get_child($id) {
355                 foreach($this->get_children() as $child) {
356                         if($child->get_id() == $id)
357                                 return $child;
358                 }
359                 return null;
360         }
361
362         /**
363          * Get all ou children
364          */
365         public function get_children() {
366                 return $this->children;
367         }
368
369         /**
370          * Set our parent
371          */
372         protected function set_parent($item) {
373                 $parent = $this->get_parent();
374                 if($parent) {
375                         $parent->remove_child($this);
376                 }
377                 $this->parent = $item;
378                 $this->set_conversation($item->get_conversation());
379         }
380
381         /**
382          * Remove our parent
383          */
384         protected function remove_parent() {
385                 $this->parent = null;
386                 $this->conversation = null;
387         }
388
389         /**
390          * Remove a child
391          */
392         public function remove_child($item) {
393                 $id = $item->get_id();
394                 foreach($this->get_children() as $key => $child) {
395                         if($child->get_id() == $id) {
396                                 $child->remove_parent();
397                                 unset($this->children[$key]);
398                                 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
399                                 $this->children = array_values($this->children);
400                                 return true;
401                         }
402                 }
403                 logger('[WARN] Item::remove_child : Item is not a child ('. $id .').', LOGGER_DEBUG);
404                 return false;
405         }
406
407         /**
408          * Get parent item
409          */
410         protected function get_parent() {
411                 return $this->parent;
412         }
413
414         /**
415          * set conversation
416          */
417         public function set_conversation($conv) {
418                 $previous_mode = ($this->conversation ? $this->conversation->get_mode() : '');
419                 
420                 $this->conversation = $conv;
421
422                 // Set it on our children too
423                 foreach($this->get_children() as $child)
424                         $child->set_conversation($conv);
425         }
426
427         /**
428          * get conversation
429          */
430         public function get_conversation() {
431                 return $this->conversation;
432         }
433
434         /**
435          * Get raw data
436          *
437          * We shouldn't need this
438          */
439         public function get_data() {
440                 return $this->data;
441         }
442
443         /**
444          * Get a data value
445          *
446          * Returns:
447          *      _ value on success
448          *      _ false on failure
449          */
450         public function get_data_value($name) {
451                 if(!isset($this->data[$name])) {
452                         logger('[ERROR] Item::get_data_value : Item has no value name "'. $name .'".', LOGGER_DEBUG);
453                         return false;
454                 }
455
456                 return $this->data[$name];
457         }
458
459         /**
460          * Set template
461          */
462         private function set_template($name) {
463                 if(!x($this->available_templates, $name)) {
464                         logger('[ERROR] Item::set_template : Template not available ("'. $name .'").', LOGGER_DEBUG);
465                         return false;
466                 }
467                 $this->template = $this->available_templates[$name];
468         }
469
470         /**
471          * Get template
472          */
473         private function get_template() {
474                 return $this->template;
475         }
476
477         /**
478          * Check if this is a toplevel post
479          */
480         private function is_toplevel() {
481                 return $this->toplevel;
482         }
483
484         /**
485          * Check if this is writable
486          */
487         private function is_writable() {
488                 $conv = $this->get_conversation();
489
490                 if($conv) {
491                         // This will allow us to comment on wall-to-wall items owned by our friends
492                         // and community forums even if somebody else wrote the post.
493                         return ($this->writable || ($this->is_visiting() && $conv->get_mode() == 'profile'));
494                 }
495                 return $this->writable;
496         }
497
498         /**
499          * Count the total of our descendants
500          */
501         private function count_descendants() {
502                 $children = $this->get_children();
503                 $total = count($children);
504                 if($total > 0) {
505                         foreach($children as $child) {
506                                 $total += $child->count_descendants();
507                         }
508                 }
509                 return $total;
510         }
511
512         /**
513          * Get the template for the comment box
514          */
515         private function get_comment_box_template() {
516                 return $this->comment_box_template;
517         }
518
519         /**
520          * Get the comment box
521          *
522          * Returns:
523          *      _ The comment box string (empty if no comment box)
524          *      _ false on failure
525          */
526         private function get_comment_box($indent) {
527                 $a = $this->get_app();
528                 if(!$this->is_toplevel() && !(get_config('system','thread_allow') && $a->theme_thread_allow)) {
529                         return '';
530                 }
531                 
532                 $comment_box = '';
533                 $conv = $this->get_conversation();
534                 $template = get_markup_template($this->get_comment_box_template());
535                 $ww = '';
536                 if( ($conv->get_mode() === 'network') && $this->is_wall_to_wall() )
537                         $ww = 'ww';
538
539                 if($conv->is_writable() && $this->is_writable()) {
540                         $qc = $qcomment =  null;
541
542                         /*
543                          * Hmmm, code depending on the presence of a particular plugin?
544                          * This should be better if done by a hook
545                          */
546                         if(in_array('qcomment',$a->plugins)) {
547                                 $qc = ((local_user()) ? get_pconfig(local_user(),'qcomment','words') : null);
548                                 $qcomment = (($qc) ? explode("\n",$qc) : null);
549                         }
550                         $comment_box = replace_macros($template,array(
551                                 '$return_path' => '',
552                                 '$threaded' => $this->is_threaded(),
553 //                              '$jsreload' => (($conv->get_mode() === 'display') ? $_SESSION['return_url'] : ''),
554                                 '$jsreload' => '',
555                                 '$type' => (($conv->get_mode() === 'profile') ? 'wall-comment' : 'net-comment'),
556                                 '$id' => $this->get_id(),
557                                 '$parent' => $this->get_id(),
558                                 '$qcomment' => $qcomment,
559                                 '$profile_uid' =>  $conv->get_profile_owner(),
560                                 '$mylink' => $a->contact['url'],
561                                 '$mytitle' => t('This is you'),
562                                 '$myphoto' => $a->contact['thumb'],
563                                 '$comment' => t('Comment'),
564                                 '$submit' => t('Submit'),
565                                 '$edbold' => t('Bold'),
566                                 '$editalic' => t('Italic'),
567                                 '$eduline' => t('Underline'),
568                                 '$edquote' => t('Quote'),
569                                 '$edcode' => t('Code'),
570                                 '$edimg' => t('Image'),
571                                 '$edurl' => t('Link'),
572                                 '$edvideo' => t('Video'),
573                                 '$preview' => t('Preview'),
574                                 '$indent' => $indent,
575                                 '$sourceapp' => t($a->sourcename),
576                                 '$ww' => (($conv->get_mode() === 'network') ? $ww : ''),
577                                 '$rand_num' => random_digits(12)
578                         ));
579                 }
580
581                 return $comment_box;
582         }
583
584         private function get_redirect_url() {
585                 return $this->redirect_url;
586         }
587
588         /**
589          * Check if we are a wall to wall item and set the relevant properties
590          */
591         protected function check_wall_to_wall() {
592                 $a = $this->get_app();
593                 $conv = $this->get_conversation();
594                 $this->wall_to_wall = false;
595                 
596                 if($this->is_toplevel()) {
597                         if( (! $this->get_data_value('self')) && ($conv->get_mode() !== 'profile')) {
598                                 if($this->get_data_value('wall')) {
599
600                                         // On the network page, I am the owner. On the display page it will be the profile owner.
601                                         // This will have been stored in $a->page_contact by our calling page.
602                                         // Put this person as the wall owner of the wall-to-wall notice.
603
604                                         $this->owner_url = zrl($a->page_contact['url']);
605                                         $this->owner_photo = $a->page_contact['thumb'];
606                                         $this->owner_name = $a->page_contact['name'];
607                                         $this->wall_to_wall = true;
608                                 }
609                                 else if($this->get_data_value('owner-link')) {
610
611                                         $owner_linkmatch = (($this->get_data_value('owner-link')) && link_compare($this->get_data_value('owner-link'),$this->get_data_value('author-link')));
612                                         $alias_linkmatch = (($this->get_data_value('alias')) && link_compare($this->get_data_value('alias'),$this->get_data_value('author-link')));
613                                         $owner_namematch = (($this->get_data_value('owner-name')) && $this->get_data_value('owner-name') == $this->get_data_value('author-name'));
614                                         if((! $owner_linkmatch) && (! $alias_linkmatch) && (! $owner_namematch)) {
615
616                                                 // The author url doesn't match the owner (typically the contact)
617                                                 // and also doesn't match the contact alias. 
618                                                 // The name match is a hack to catch several weird cases where URLs are 
619                                                 // all over the park. It can be tricked, but this prevents you from
620                                                 // seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
621                                                 // well that it's the same Bob Smith. 
622
623                                                 // But it could be somebody else with the same name. It just isn't highly likely. 
624                                                 
625
626                                                 $this->owner_photo = $this->get_data_value('owner-avatar');
627                                                 $this->owner_name = $this->get_data_value('owner-name');
628                                                 $this->wall_to_wall = true;
629                                                 // If it is our contact, use a friendly redirect link
630                                                 if((link_compare($this->get_data_value('owner-link'),$this->get_data_value('url'))) 
631                                                         && ($this->get_data_value('network') === NETWORK_DFRN)) {
632                                                         $this->owner_url = $this->get_redirect_url();
633                                                 }
634                                                 else
635                                                         $this->owner_url = zrl($this->get_data_value('owner-link'));
636                                         }
637                                 }
638                         }
639                 }
640
641                 if(!$this->wall_to_wall) {
642                         $this->set_template('wall');
643                         $this->owner_url = '';
644                         $this->owner_photo = '';
645                         $this->owner_name = '';
646                 }
647         }
648
649         private function is_wall_to_wall() {
650                 return $this->wall_to_wall;
651         }
652
653         private function get_owner_url() {
654                 return $this->owner_url;
655         }
656
657         private function get_owner_photo() {
658                 return $this->owner_photo;
659         }
660
661         private function get_owner_name() {
662                 return $this->owner_name;
663         }
664
665         private function is_visiting() {
666                 return $this->visiting;
667         }
668
669
670
671
672 }
673 ?>