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