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