lib/noticelistitem.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * An item in a notice list
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Widget
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * widget for displaying a single notice
  35  *
  36  * This widget has the core smarts for showing a single notice: what to display,
  37  * where, and under which circumstances. Its key method is show(); this is a recipe
  38  * that calls all the other show*() methods to build up a single notice. The
  39  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
  40  * author info (since that's implicit by the data in the page).
  41  *
  42  * @category UI
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  * @see      NoticeList
  48  * @see      ProfileNoticeListItem
  49  */
  50 class NoticeListItem extends Widget
  51 {
  52     /** The notice this item will show. */
  53     var $notice = null;
  54
  55     /** The notice that was repeated. */
  56     var $repeat = null;
  57
  58     /** The profile of the author of the notice, extracted once for convenience. */
  59     var $profile = null;
  60
  61     protected $addressees = true;
  62     protected $attachments = true;
  63     protected $id_prefix = null;
  64     protected $options = true;
  65     protected $maxchars = 0;   // if <= 0 it means use full posts
  66
  67     /**
  68      * constructor
  69      *
  70      * Also initializes the profile attribute.
  71      *
  72      * @param Notice $notice The notice we'll display
  73      */
  74     function __construct(Notice $notice, Action $out=null, array $prefs=array())
  75     {
  76         parent::__construct($out);
  77         if (!empty($notice->repeat_of)) {
  78             $original = Notice::getKV('id', $notice->repeat_of);
  79             if (!$original instanceof Notice) { // could have been deleted
  80                 $this->notice = $notice;
  81             } else {
  82                 $this->notice = $original;
  83                 $this->repeat = $notice;
  84             }
  85         } else {
  86             $this->notice  = $notice;
  87         }
  88
  89         $this->profile = $this->notice->getProfile();
  90
  91         // integer preferences
  92         foreach(array('maxchars') as $key) {
  93             if (array_key_exists($key, $prefs)) {
  94                 $this->$key = (int)$prefs[$key];
  95             }
  96         }
  97         // boolean preferences
  98         foreach(array('addressees', 'attachments', 'options') as $key) {
  99             if (array_key_exists($key, $prefs)) {
 100                 $this->$key = (bool)$prefs[$key];
 101             }
 102         }
 103         // string preferences
 104         foreach(array('id_prefix') as $key) {
 105             if (array_key_exists($key, $prefs)) {
 106                 $this->$key = $prefs[$key];
 107             }
 108         }
 109     }
 110
 111     /**
 112      * recipe function for displaying a single notice.
 113      *
 114      * This uses all the other methods to correctly display a notice. Override
 115      * it or one of the others to fine-tune the output.
 116      *
 117      * @return void
 118      */
 119     function show()
 120     {
 121         if (empty($this->notice)) {
 122             common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
 123             return;
 124         } else if (empty($this->profile)) {
 125             common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
 126             return;
 127         }
 128
 129         $this->showStart();
 130         if (Event::handle('StartShowNoticeItem', array($this))) {
 131             $this->showNotice();
 132             Event::handle('EndShowNoticeItem', array($this));
 133         }
 134         $this->showEnd();
 135     }
 136
 137     function showNotice()
 138     {
 139         if (Event::handle('StartShowNoticeItemNotice', array($this))) {
 140             $this->showNoticeHeaders();
 141             $this->showContent();
 142             $this->showNoticeFooter();
 143             Event::handle('EndShowNoticeItemNotice', array($this));
 144         }
 145     }
 146
 147     function showNoticeHeaders()
 148     {
 149         $this->elementStart('section', array('class'=>'notice-headers'));
 150         $this->showNoticeTitle();
 151         $this->showAuthor();
 152         if ($this->addressees) { $this->showAddressees(); }
 153         $this->elementEnd('section');
 154     }
 155
 156     function showNoticeFooter()
 157     {
 158         $this->elementStart('footer');
 159         $this->showNoticeInfo();
 160         if ($this->attachments) { $this->showNoticeAttachments(); }
 161         if ($this->options) { $this->showNoticeOptions(); }
 162         $this->elementEnd('footer');
 163     }
 164
 165     function showNoticeTitle()
 166     {
 167         if (Event::handle('StartShowNoticeTitle', array($this))) {
 168             $this->element('a', array('href' => $this->notice->getUrl(),
 169                                       'class' => 'notice-title'),
 170                            $this->notice->getTitle());
 171             Event::handle('EndShowNoticeTitle', array($this));
 172         }
 173     }
 174
 175     function showNoticeInfo()
 176     {
 177         if (Event::handle('StartShowNoticeInfo', array($this))) {
 178             $this->showNoticeLink();
 179             $this->showNoticeSource();
 180             $this->showNoticeLocation();
 181             $this->showPermalink();
 182             $this->showRepeat();
 183             Event::handle('EndShowNoticeInfo', array($this));
 184         }
 185     }
 186
 187     function showNoticeOptions()
 188     {
 189         if (Event::handle('StartShowNoticeOptions', array($this))) {
 190             $user = common_current_user();
 191             if ($user) {
 192                 $this->out->elementStart('div', 'notice-options');
 193                 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
 194                     $this->showReplyLink();
 195                     $this->showRepeatForm();
 196                     $this->showDeleteLink();
 197                     Event::handle('EndShowNoticeOptionItems', array($this));
 198                 }
 199                 $this->out->elementEnd('div');
 200             }
 201             Event::handle('EndShowNoticeOptions', array($this));
 202         }
 203     }
 204
 205     /**
 206      * start a single notice.
 207      *
 208      * @return void
 209      */
 210     function showStart()
 211     {
 212         if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
 213             $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
 214             $class = 'h-entry notice';
 215             if ($this->notice->scope != 0 && $this->notice->scope != 1) {
 216                 $class .= ' limited-scope';
 217             }
 218             if (!empty($this->notice->source)) {
 219                 $class .= ' notice-source-'.$this->notice->source;
 220             }
 221             $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
 222             $this->out->elementStart('li', array('class' => $class,
 223                                                  'id' => "${id_prefix}notice-${id}"));
 224             Event::handle('EndOpenNoticeListItemElement', array($this));
 225         }
 226     }
 227
 228     /**
 229      * show the author of a notice
 230      *
 231      * By default, this shows the avatar and (linked) nickname of the author.
 232      *
 233      * @return void
 234      */
 235
 236     function showAuthor()
 237     {
 238         $attrs = array('href' => $this->profile->profileurl,
 239                        'class' => 'h-card p-author',
 240                        'title' => $this->profile->getNickname());
 241
 242         if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
 243             $this->out->elementStart('a', $attrs);
 244             $this->showAvatar($this->profile);
 245             $this->out->text($this->profile->getStreamName());
 246             $this->out->elementEnd('a');
 247             Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
 248         }
 249     }
 250
 251     function showAddressees()
 252     {
 253         $pa = $this->getProfileAddressees();
 254
 255         if (!empty($pa)) {
 256             $this->out->elementStart('ul', 'addressees');
 257             $first = true;
 258             foreach ($pa as $addr) {
 259                 $this->out->elementStart('li', 'h-card');
 260                 $text = $addr['text'];
 261                 unset($addr['text']);
 262                 $this->out->element('a', $addr, $text);
 263                 $this->out->elementEnd('li');
 264             }
 265             $this->out->elementEnd('ul', 'addressees');
 266         }
 267     }
 268
 269     function getProfileAddressees()
 270     {
 271         $pa = array();
 272
 273         $attentions = $this->getReplyProfiles();
 274
 275         foreach ($attentions as $attn) {
 276             $class = $attn->isGroup() ? 'group' : 'account';
 277             $pa[] = array('href' => $attn->profileurl,
 278                           'title' => $attn->getNickname(),
 279                           'class' => "addressee {$class}",
 280                           'text' => $attn->getStreamName());
 281         }
 282
 283         return $pa;
 284     }
 285
 286     function getReplyProfiles()
 287     {
 288         return $this->notice->getReplyProfiles();
 289     }
 290
 291     /**
 292      * show the nickname of the author
 293      *
 294      * Links to the author's profile page
 295      *
 296      * @return void
 297      */
 298     function showNickname()
 299     {
 300         $this->out->raw('<span class="p-name">' .
 301                         htmlspecialchars($this->profile->getNickname()) .
 302                         '</span>');
 303     }
 304
 305     /**
 306      * show the content of the notice
 307      *
 308      * Shows the content of the notice. This is pre-rendered for efficiency
 309      * at save time. Some very old notices might not be pre-rendered, so
 310      * they're rendered on the spot.
 311      *
 312      * @return void
 313      */
 314     function showContent()
 315     {
 316         // FIXME: URL, image, video, audio
 317         $this->out->elementStart('article', array('class' => 'e-content'));
 318         if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
 319             if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
 320                 $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
 321             } elseif ($this->notice->rendered) {
 322                 $this->out->raw($this->notice->rendered);
 323             } else {
 324                 // XXX: may be some uncooked notices in the DB,
 325                 // we cook them right now. This should probably disappear in future
 326                 // versions (>> 0.4.x)
 327                 $this->out->raw(common_render_content($this->notice->content, $this->notice));
 328             }
 329             Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
 330         }
 331         $this->out->elementEnd('article');
 332     }
 333
 334     function showNoticeAttachments() {
 335         if (common_config('attachments', 'show_thumbs')) {
 336             $al = new InlineAttachmentList($this->notice, $this->out);
 337             $al->show();
 338         }
 339     }
 340
 341     /**
 342      * show the link to the main page for the notice
 343      *
 344      * Displays a local link to the rendered notice, with "relative" time.
 345      *
 346      * @return void
 347      */
 348     function showNoticeLink()
 349     {
 350         $this->out->elementStart('a', array('rel' => 'bookmark',
 351                                             'class' => 'timestamp',
 352                                             'href' => Conversation::getUrlFromNotice($this->notice)));
 353         $this->out->element('time', array('class' => 'dt-published',
 354                                           'datetime' => common_date_iso8601($this->notice->created),
 355                                           // TRANS: Timestamp title (tooltip text) for NoticeListItem
 356                                           'title' => common_exact_date($this->notice->created)),
 357                             common_date_string($this->notice->created));
 358         $this->out->elementEnd('a');
 359     }
 360
 361     /**
 362      * show the notice location
 363      *
 364      * shows the notice location in the correct language.
 365      *
 366      * If an URL is available, makes a link. Otherwise, just a span.
 367      *
 368      * @return void
 369      */
 370     function showNoticeLocation()
 371     {
 372         $id = $this->notice->id;
 373
 374         $location = $this->notice->getLocation();
 375
 376         if (empty($location)) {
 377             return;
 378         }
 379
 380         $name = $location->getName();
 381
 382         $lat = $this->notice->lat;
 383         $lon = $this->notice->lon;
 384         $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
 385
 386         if (empty($name)) {
 387             $latdms = $this->decimalDegreesToDMS(abs($lat));
 388             $londms = $this->decimalDegreesToDMS(abs($lon));
 389             // TRANS: Used in coordinates as abbreviation of north.
 390             $north = _('N');
 391             // TRANS: Used in coordinates as abbreviation of south.
 392             $south = _('S');
 393             // TRANS: Used in coordinates as abbreviation of east.
 394             $east = _('E');
 395             // TRANS: Used in coordinates as abbreviation of west.
 396             $west = _('W');
 397             $name = sprintf(
 398                 // TRANS: Coordinates message.
 399                 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
 400                 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
 401                 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
 402                 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
 403                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
 404                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
 405                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
 406         }
 407
 408         $url  = $location->getUrl();
 409
 410         $this->out->text(' ');
 411         $this->out->elementStart('span', array('class' => 'location'));
 412         // TRANS: Followed by geo location.
 413         $this->out->text(_('at'));
 414         $this->out->text(' ');
 415         if (empty($url)) {
 416             $this->out->element('abbr', array('class' => 'geo',
 417                                               'title' => $latlon),
 418                                 $name);
 419         } else {
 420             $xstr = new XMLStringer(false);
 421             $xstr->elementStart('a', array('href' => $url,
 422                                            'rel' => 'external'));
 423             $xstr->element('abbr', array('class' => 'geo',
 424                                          'title' => $latlon),
 425                            $name);
 426             $xstr->elementEnd('a');
 427             $this->out->raw($xstr->getString());
 428         }
 429         $this->out->elementEnd('span');
 430     }
 431
 432     /**
 433      * @param number $dec decimal degrees
 434      * @return array split into 'deg', 'min', and 'sec'
 435      */
 436     function decimalDegreesToDMS($dec)
 437     {
 438         $deg = intval($dec);
 439         $tempma = abs($dec) - abs($deg);
 440
 441         $tempma = $tempma * 3600;
 442         $min = floor($tempma / 60);
 443         $sec = $tempma - ($min*60);
 444
 445         return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
 446     }
 447
 448     /**
 449      * Show the source of the notice
 450      *
 451      * Either the name (and link) of the API client that posted the notice,
 452      * or one of other other channels.
 453      *
 454      * @return void
 455      */
 456     function showNoticeSource()
 457     {
 458         $ns = $this->notice->getSource();
 459
 460         if (!$ns instanceof Notice_source) {
 461             return false;
 462         }
 463
 464         // TRANS: A possible notice source (web interface).
 465         $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
 466         $this->out->text(' ');
 467         $this->out->elementStart('span', 'source');
 468         // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
 469         // TRANS: Followed by notice source.
 470         $this->out->text(_('from'));
 471         $this->out->text(' ');
 472
 473         $name  = $source_name;
 474         $url   = $ns->url;
 475         $title = null;
 476
 477         if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
 478             $name = $source_name;
 479             $url  = $ns->url;
 480         }
 481         Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
 482
 483         // if $ns->name and $ns->url are populated we have
 484         // configured a source attr somewhere
 485         if (!empty($name) && !empty($url)) {
 486             $this->out->elementStart('span', 'device');
 487
 488             $attrs = array(
 489                 'href' => $url,
 490                 'rel' => 'external'
 491             );
 492
 493             if (!empty($title)) {
 494                 $attrs['title'] = $title;
 495             }
 496
 497             $this->out->element('a', $attrs, $name);
 498             $this->out->elementEnd('span');
 499         } else {
 500             $this->out->element('span', 'device', $name);
 501         }
 502
 503         $this->out->elementEnd('span');
 504     }
 505
 506     /**
 507      * show link to single-notice view for this notice item
 508      *
 509      * A permalink that goes to this specific object and nothing else
 510      *
 511      * @return void
 512      */
 513     function showPermalink()
 514     {
 515         $class = 'permalink u-url';
 516         if (!$this->notice->isLocal()) {
 517             $class .= ' external';
 518         }
 519         try {
 520             $this->out->element('a',
 521                         array('href' => $this->notice->getUrl(),
 522                               'class' => $class),
 523                         // TRANS: Addition in notice list item for single-notice view.
 524                         _('permalink'));
 525         } catch (InvalidUrlException $e) {
 526             // no permalink available
 527         }
 528     }
 529
 530     /**
 531      * show a link to the author of repeat
 532      *
 533      * @return void
 534      */
 535     function showRepeat()
 536     {
 537         if (!empty($this->repeat)) {
 538
 539             $repeater = Profile::getKV('id', $this->repeat->profile_id);
 540
 541             $attrs = array('href' => $repeater->profileurl,
 542                            'class' => 'h-card p-author',
 543                            'title' => $repeater->getFancyName());
 544
 545             $this->out->elementStart('span', 'repeat h-entry');
 546
 547             // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
 548             $this->out->raw(_('Repeated by').' ');
 549
 550             $this->out->element('a', $attrs, $repeater->getNickname());
 551
 552             $this->out->elementEnd('span');
 553         }
 554     }
 555
 556     /**
 557      * show a link to reply to the current notice
 558      *
 559      * Should either do the reply in the current notice form (if available), or
 560      * link out to the notice-posting form. A little flakey, doesn't always work.
 561      *
 562      * @return void
 563      */
 564     function showReplyLink()
 565     {
 566         if (common_logged_in()) {
 567             $this->out->text(' ');
 568             $reply_url = common_local_url('newnotice',
 569                                           array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
 570             $this->out->elementStart('a', array('href' => $reply_url,
 571                                                 'class' => 'notice_reply',
 572                                                 // TRANS: Link title in notice list item to reply to a notice.
 573                                                 'title' => _('Reply to this notice.')));
 574             // TRANS: Link text in notice list item to reply to a notice.
 575             $this->out->text(_('Reply'));
 576             $this->out->text(' ');
 577             $this->out->element('span', 'notice_id', $this->notice->id);
 578             $this->out->elementEnd('a');
 579         }
 580     }
 581
 582     /**
 583      * if the user is the author, let them delete the notice
 584      *
 585      * @return void
 586      */
 587     function showDeleteLink()
 588     {
 589         $user = common_current_user();
 590
 591         $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
 592
 593         if (!empty($user) &&
 594             ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 595             $this->out->text(' ');
 596             $deleteurl = common_local_url('deletenotice',
 597                                           array('notice' => $todel->id));
 598             $this->out->element('a', array('href' => $deleteurl,
 599                                            'class' => 'notice_delete',
 600                                            // TRANS: Link title in notice list item to delete a notice.
 601                                            'title' => _('Delete this notice from the timeline.')),
 602                                            // TRANS: Link text in notice list item to delete a notice.
 603                                            _('Delete'));
 604         }
 605     }
 606
 607     /**
 608      * show the form to repeat a notice
 609      *
 610      * @return void
 611      */
 612     function showRepeatForm()
 613     {
 614         if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
 615             $this->notice->scope == Notice::SITE_SCOPE) {
 616             $user = common_current_user();
 617             if (!empty($user) &&
 618                 $user->id != $this->notice->profile_id) {
 619                 $this->out->text(' ');
 620                 $profile = $user->getProfile();
 621                 if ($profile->hasRepeated($this->notice)) {
 622                     $this->out->element('span', array('class' => 'repeated',
 623                                                       // TRANS: Title for repeat form status in notice list when a notice has been repeated.
 624                                                       'title' => _('Notice repeated.')),
 625                                         // TRANS: Repeat form status in notice list when a notice has been repeated.
 626                                         _('Repeated'));
 627                 } else {
 628                     $rf = new RepeatForm($this->out, $this->notice);
 629                     $rf->show();
 630                 }
 631             }
 632         }
 633     }
 634
 635     /**
 636      * finish the notice
 637      *
 638      * Close the last elements in the notice list item
 639      *
 640      * @return void
 641      */
 642     function showEnd()
 643     {
 644         if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
 645             $this->out->elementEnd('li');
 646             Event::handle('EndCloseNoticeListItemElement', array($this));
 647         }
 648     }
 649
 650     /**
 651      * Get the notice in question
 652      *
 653      * For hooks, etc., this may be useful
 654      *
 655      * @return Notice The notice we're showing
 656      */
 657
 658     function getNotice()
 659     {
 660         return $this->notice;
 661     }
 662 }