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