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