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     protected $item_tag = 'li';
  67
  68     /**
  69      * constructor
  70      *
  71      * Also initializes the profile attribute.
  72      *
  73      * @param Notice $notice The notice we'll display
  74      */
  75     function __construct(Notice $notice, Action $out=null, array $prefs=array())
  76     {
  77         parent::__construct($out);
  78         if (!empty($notice->repeat_of)) {
  79             $original = Notice::getKV('id', $notice->repeat_of);
  80             if (!$original instanceof Notice) { // could have been deleted
  81                 $this->notice = $notice;
  82             } else {
  83                 $this->notice = $original;
  84                 $this->repeat = $notice;
  85             }
  86         } else {
  87             $this->notice  = $notice;
  88         }
  89
  90         $this->profile = $this->notice->getProfile();
  91
  92         // integer preferences
  93         foreach(array('maxchars') as $key) {
  94             if (array_key_exists($key, $prefs)) {
  95                 $this->$key = (int)$prefs[$key];
  96             }
  97         }
  98         // boolean preferences
  99         foreach(array('addressees', 'attachments', 'options') as $key) {
 100             if (array_key_exists($key, $prefs)) {
 101                 $this->$key = (bool)$prefs[$key];
 102             }
 103         }
 104         // string preferences
 105         foreach(array('id_prefix', 'item_tag') as $key) {
 106             if (array_key_exists($key, $prefs)) {
 107                 $this->$key = $prefs[$key];
 108             }
 109         }
 110     }
 111
 112     /**
 113      * recipe function for displaying a single notice.
 114      *
 115      * This uses all the other methods to correctly display a notice. Override
 116      * it or one of the others to fine-tune the output.
 117      *
 118      * @return void
 119      */
 120     function show()
 121     {
 122         if (empty($this->notice)) {
 123             common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
 124             return;
 125         } else if (empty($this->profile)) {
 126             common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
 127             return;
 128         }
 129
 130         $this->showStart();
 131         if (Event::handle('StartShowNoticeItem', array($this))) {
 132             $this->showNotice();
 133             Event::handle('EndShowNoticeItem', array($this));
 134         }
 135         $this->showEnd();
 136     }
 137
 138     function showNotice()
 139     {
 140         if (Event::handle('StartShowNoticeItemNotice', array($this))) {
 141             $this->showNoticeHeaders();
 142             $this->showContent();
 143             $this->showNoticeFooter();
 144             Event::handle('EndShowNoticeItemNotice', array($this));
 145         }
 146     }
 147
 148     function showNoticeHeaders()
 149     {
 150         $this->elementStart('section', array('class'=>'notice-headers'));
 151         $this->showNoticeTitle();
 152         $this->showAuthor();
 153         if ($this->addressees) { $this->showAddressees(); }
 154         $this->elementEnd('section');
 155     }
 156
 157     function showNoticeFooter()
 158     {
 159         $this->elementStart('footer');
 160         $this->showNoticeInfo();
 161         if ($this->options) { $this->showNoticeOptions(); }
 162         if ($this->attachments) { $this->showNoticeAttachments(); }
 163         $this->elementEnd('footer');
 164     }
 165
 166     function showNoticeTitle()
 167     {
 168         if (Event::handle('StartShowNoticeTitle', array($this))) {
 169             $this->element('a', array('href' => $this->notice->getUrl(),
 170                                       'class' => 'notice-title'),
 171                            $this->notice->getTitle());
 172             Event::handle('EndShowNoticeTitle', array($this));
 173         }
 174     }
 175
 176     function showNoticeInfo()
 177     {
 178         if (Event::handle('StartShowNoticeInfo', array($this))) {
 179             $this->showNoticeLink();
 180             $this->showNoticeSource();
 181             $this->showNoticeLocation();
 182             $this->showPermalink();
 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->showDeleteLink();
 196                     Event::handle('EndShowNoticeOptionItems', array($this));
 197                 }
 198                 $this->out->elementEnd('div');
 199             }
 200             Event::handle('EndShowNoticeOptions', array($this));
 201         }
 202     }
 203
 204     /**
 205      * start a single notice.
 206      *
 207      * @return void
 208      */
 209     function showStart()
 210     {
 211         if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
 212             $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
 213             $class = 'h-entry notice';
 214             if ($this->notice->scope != 0 && $this->notice->scope != 1) {
 215                 $class .= ' limited-scope';
 216             }
 217             if (!empty($this->notice->source)) {
 218                 $class .= ' notice-source-'.$this->notice->source;
 219             }
 220             $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
 221             $this->out->elementStart($this->item_tag, array('class' => $class,
 222                                                  'id' => "${id_prefix}notice-${id}"));
 223             Event::handle('EndOpenNoticeListItemElement', array($this));
 224         }
 225     }
 226
 227     /**
 228      * show the author of a notice
 229      *
 230      * By default, this shows the avatar and (linked) nickname of the author.
 231      *
 232      * @return void
 233      */
 234
 235     function showAuthor()
 236     {
 237         $attrs = array('href' => $this->profile->profileurl,
 238                        'class' => 'h-card p-author',
 239                        'title' => $this->profile->getNickname());
 240
 241         if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
 242             $this->out->elementStart('a', $attrs);
 243             $this->showAvatar($this->profile);
 244             $this->out->text($this->profile->getStreamName());
 245             $this->out->elementEnd('a');
 246             Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
 247         }
 248     }
 249
 250     function showAddressees()
 251     {
 252         $pa = $this->getProfileAddressees();
 253
 254         if (!empty($pa)) {
 255             $this->out->elementStart('ul', 'addressees');
 256             $first = true;
 257             foreach ($pa as $addr) {
 258                 $this->out->elementStart('li', 'h-card');
 259                 $text = $addr['text'];
 260                 unset($addr['text']);
 261                 $this->out->element('a', $addr, $text);
 262                 $this->out->elementEnd('li');
 263             }
 264             $this->out->elementEnd('ul', 'addressees');
 265         }
 266     }
 267
 268     function getProfileAddressees()
 269     {
 270         $pa = array();
 271
 272         $attentions = $this->getReplyProfiles();
 273
 274         foreach ($attentions as $attn) {
 275             $class = $attn->isGroup() ? 'group' : 'account';
 276             $pa[] = array('href' => $attn->profileurl,
 277                           'title' => $attn->getNickname(),
 278                           'class' => "addressee {$class}",
 279                           'text' => $attn->getStreamName());
 280         }
 281
 282         return $pa;
 283     }
 284
 285     function getReplyProfiles()
 286     {
 287         return $this->notice->getReplyProfiles();
 288     }
 289
 290     /**
 291      * show the nickname of the author
 292      *
 293      * Links to the author's profile page
 294      *
 295      * @return void
 296      */
 297     function showNickname()
 298     {
 299         $this->out->raw('<span class="p-name">' .
 300                         htmlspecialchars($this->profile->getNickname()) .
 301                         '</span>');
 302     }
 303
 304     /**
 305      * show the content of the notice
 306      *
 307      * Shows the content of the notice. This is pre-rendered for efficiency
 308      * at save time. Some very old notices might not be pre-rendered, so
 309      * they're rendered on the spot.
 310      *
 311      * @return void
 312      */
 313     function showContent()
 314     {
 315         // FIXME: URL, image, video, audio
 316         $this->out->elementStart('article', array('class' => 'e-content'));
 317         if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
 318             if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
 319                 $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
 320             } elseif ($this->notice->rendered) {
 321                 $this->out->raw($this->notice->rendered);
 322             } else {
 323                 // XXX: may be some uncooked notices in the DB,
 324                 // we cook them right now. This should probably disappear in future
 325                 // versions (>> 0.4.x)
 326                 $this->out->raw(common_render_content($this->notice->content, $this->notice));
 327             }
 328             Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
 329         }
 330         $this->out->elementEnd('article');
 331     }
 332
 333     function showNoticeAttachments() {
 334         if (common_config('attachments', 'show_thumbs')) {
 335             $al = new InlineAttachmentList($this->notice, $this->out);
 336             $al->show();
 337         }
 338     }
 339
 340     /**
 341      * show the link to the main page for the notice
 342      *
 343      * Displays a local link to the rendered notice, with "relative" time.
 344      *
 345      * @return void
 346      */
 347     function showNoticeLink()
 348     {
 349         $this->out->elementStart('a', array('rel' => 'bookmark',
 350                                             'class' => 'timestamp',
 351                                             'href' => Conversation::getUrlFromNotice($this->notice)));
 352         $this->out->element('time', array('class' => 'dt-published',
 353                                           'datetime' => common_date_iso8601($this->notice->created),
 354                                           // TRANS: Timestamp title (tooltip text) for NoticeListItem
 355                                           'title' => common_exact_date($this->notice->created)),
 356                             common_date_string($this->notice->created));
 357         $this->out->elementEnd('a');
 358     }
 359
 360     /**
 361      * show the notice location
 362      *
 363      * shows the notice location in the correct language.
 364      *
 365      * If an URL is available, makes a link. Otherwise, just a span.
 366      *
 367      * @return void
 368      */
 369     function showNoticeLocation()
 370     {
 371         return;
 372         try {
 373             $location = Notice_location::locFromStored($this->notice);
 374         } catch (NoResultException $e) {
 375             return;
 376         } catch (ServerException $e) {
 377             return;
 378         }
 379
 380         $name = $location->getName();
 381
 382         $lat = $location->lat;
 383         $lon = $location->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 reply to the current notice
 532      *
 533      * Should either do the reply in the current notice form (if available), or
 534      * link out to the notice-posting form. A little flakey, doesn't always work.
 535      *
 536      * @return void
 537      */
 538     function showReplyLink()
 539     {
 540         if (common_logged_in()) {
 541             $this->out->text(' ');
 542             $reply_url = common_local_url('newnotice',
 543                                           array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
 544             $this->out->elementStart('a', array('href' => $reply_url,
 545                                                 'class' => 'notice_reply',
 546                                                 // TRANS: Link title in notice list item to reply to a notice.
 547                                                 'title' => _('Reply to this notice.')));
 548             // TRANS: Link text in notice list item to reply to a notice.
 549             $this->out->text(_('Reply'));
 550             $this->out->text(' ');
 551             $this->out->element('span', 'notice_id', $this->notice->id);
 552             $this->out->elementEnd('a');
 553         }
 554     }
 555
 556     /**
 557      * if the user is the author, let them delete the notice
 558      *
 559      * @return void
 560      */
 561     function showDeleteLink()
 562     {
 563         $user = common_current_user();
 564
 565         $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
 566
 567         if (!empty($user) &&
 568             ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 569             $this->out->text(' ');
 570             $deleteurl = common_local_url('deletenotice',
 571                                           array('notice' => $todel->id));
 572             $this->out->element('a', array('href' => $deleteurl,
 573                                            'class' => 'notice_delete popup',
 574                                            // TRANS: Link title in notice list item to delete a notice.
 575                                            'title' => _('Delete this notice from the timeline.')),
 576                                            // TRANS: Link text in notice list item to delete a notice.
 577                                            _('Delete'));
 578         }
 579     }
 580
 581     /**
 582      * finish the notice
 583      *
 584      * Close the last elements in the notice list item
 585      *
 586      * @return void
 587      */
 588     function showEnd()
 589     {
 590         if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
 591             $this->out->elementEnd('li');
 592             Event::handle('EndCloseNoticeListItemElement', array($this));
 593         }
 594     }
 595
 596     /**
 597      * Get the notice in question
 598      *
 599      * For hooks, etc., this may be useful
 600      *
 601      * @return Notice The notice we're showing
 602      */
 603
 604     function getNotice()
 605     {
 606         return $this->notice;
 607     }
 608 }