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