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 (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
 277             if ($this->notice->rendered) {
 278                 $this->out->raw($this->notice->rendered);
 279             } else {
 280                 // XXX: may be some uncooked notices in the DB,
 281                 // we cook them right now. This should probably disappear in future
 282                 // versions (>> 0.4.x)
 283                 $this->out->raw(common_render_content($this->notice->content, $this->notice));
 284             }
 285             Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
 286         }
 287         $this->out->elementEnd('div');
 288     }
 289
 290     function showNoticeAttachments() {
 291         if (common_config('attachments', 'show_thumbs')) {
 292             $al = new InlineAttachmentList($this->notice, $this->out);
 293             $al->show();
 294         }
 295     }
 296
 297     /**
 298      * show the link to the main page for the notice
 299      *
 300      * Displays a local link to the rendered notice, with "relative" time.
 301      *
 302      * @return void
 303      */
 304     function showNoticeLink()
 305     {
 306         $this->out->elementStart('a', array('rel' => 'bookmark',
 307                                             'class' => 'u-url timestamp',
 308                                             'href' => $this->notice->getLocalUrl()));
 309         $this->out->element('time', array('class' => 'dt-published',
 310                                           'datetime' => common_date_iso8601($this->notice->created),
 311                                           // TRANS: Timestamp title (tooltip text) for NoticeListItem
 312                                           'title' => common_exact_date($this->notice->created)),
 313                             common_date_string($this->notice->created));
 314         $this->out->elementEnd('a');
 315     }
 316
 317     /**
 318      * show the notice location
 319      *
 320      * shows the notice location in the correct language.
 321      *
 322      * If an URL is available, makes a link. Otherwise, just a span.
 323      *
 324      * @return void
 325      */
 326     function showNoticeLocation()
 327     {
 328         $id = $this->notice->id;
 329
 330         $location = $this->notice->getLocation();
 331
 332         if (empty($location)) {
 333             return;
 334         }
 335
 336         $name = $location->getName();
 337
 338         $lat = $this->notice->lat;
 339         $lon = $this->notice->lon;
 340         $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
 341
 342         if (empty($name)) {
 343             $latdms = $this->decimalDegreesToDMS(abs($lat));
 344             $londms = $this->decimalDegreesToDMS(abs($lon));
 345             // TRANS: Used in coordinates as abbreviation of north.
 346             $north = _('N');
 347             // TRANS: Used in coordinates as abbreviation of south.
 348             $south = _('S');
 349             // TRANS: Used in coordinates as abbreviation of east.
 350             $east = _('E');
 351             // TRANS: Used in coordinates as abbreviation of west.
 352             $west = _('W');
 353             $name = sprintf(
 354                 // TRANS: Coordinates message.
 355                 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
 356                 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
 357                 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
 358                 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
 359                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
 360                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
 361                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
 362         }
 363
 364         $url  = $location->getUrl();
 365
 366         $this->out->text(' ');
 367         $this->out->elementStart('span', array('class' => 'location'));
 368         // TRANS: Followed by geo location.
 369         $this->out->text(_('at'));
 370         $this->out->text(' ');
 371         if (empty($url)) {
 372             $this->out->element('abbr', array('class' => 'geo',
 373                                               'title' => $latlon),
 374                                 $name);
 375         } else {
 376             $xstr = new XMLStringer(false);
 377             $xstr->elementStart('a', array('href' => $url,
 378                                            'rel' => 'external'));
 379             $xstr->element('abbr', array('class' => 'geo',
 380                                          'title' => $latlon),
 381                            $name);
 382             $xstr->elementEnd('a');
 383             $this->out->raw($xstr->getString());
 384         }
 385         $this->out->elementEnd('span');
 386     }
 387
 388     /**
 389      * @param number $dec decimal degrees
 390      * @return array split into 'deg', 'min', and 'sec'
 391      */
 392     function decimalDegreesToDMS($dec)
 393     {
 394         $deg = intval($dec);
 395         $tempma = abs($dec) - abs($deg);
 396
 397         $tempma = $tempma * 3600;
 398         $min = floor($tempma / 60);
 399         $sec = $tempma - ($min*60);
 400
 401         return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
 402     }
 403
 404     /**
 405      * Show the source of the notice
 406      *
 407      * Either the name (and link) of the API client that posted the notice,
 408      * or one of other other channels.
 409      *
 410      * @return void
 411      */
 412     function showNoticeSource()
 413     {
 414         $ns = $this->notice->getSource();
 415
 416         if ($ns) {
 417             // TRANS: A possible notice source (web interface).
 418             $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
 419             $this->out->text(' ');
 420             $this->out->elementStart('span', 'source');
 421             // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
 422             // TRANS: Followed by notice source.
 423             $this->out->text(_('from'));
 424             $this->out->text(' ');
 425
 426             $name  = $source_name;
 427             $url   = $ns->url;
 428             $title = null;
 429
 430             if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
 431                 $name = $source_name;
 432                 $url  = $ns->url;
 433             }
 434             Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
 435
 436             // if $ns->name and $ns->url are populated we have
 437             // configured a source attr somewhere
 438             if (!empty($name) && !empty($url)) {
 439                 $this->out->elementStart('span', 'device');
 440
 441                 $attrs = array(
 442                     'href' => $url,
 443                     'rel' => 'external'
 444                 );
 445
 446                 if (!empty($title)) {
 447                     $attrs['title'] = $title;
 448                 }
 449
 450                 $this->out->element('a', $attrs, $name);
 451                 $this->out->elementEnd('span');
 452             } else {
 453                 $this->out->element('span', 'device', $name);
 454             }
 455
 456             $this->out->elementEnd('span');
 457         }
 458     }
 459
 460     /**
 461      * show link to notice this notice is a reply to
 462      *
 463      * If this notice is a reply, show a link to the notice it is replying to. The
 464      * heavy lifting for figuring out replies happens at save time.
 465      *
 466      * @return void
 467      */
 468     function showContext()
 469     {
 470         $this->out->element('a',
 471                             array('href' => $this->notice->getConversationUrl(),
 472                                   'class' => 'conversation'),
 473                             // TRANS: Addition in notice list item if notice is part of a conversation.
 474                             _('in context'));
 475     }
 476
 477     /**
 478      * show a link to the author of repeat
 479      *
 480      * @return void
 481      */
 482     function showRepeat()
 483     {
 484         if (!empty($this->repeat)) {
 485
 486             $repeater = Profile::getKV('id', $this->repeat->profile_id);
 487
 488             $attrs = array('href' => $repeater->profileurl,
 489                            'class' => 'h-card p-author',
 490                            'title' => $repeater->getFancyName());
 491
 492             $this->out->elementStart('span', 'repeat h-entry');
 493
 494             // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
 495             $this->out->raw(_('Repeated by').' ');
 496
 497             $this->out->element('a', $attrs, $repeater->getNickname());
 498
 499             $this->out->elementEnd('span');
 500         }
 501     }
 502
 503     /**
 504      * show a link to reply to the current notice
 505      *
 506      * Should either do the reply in the current notice form (if available), or
 507      * link out to the notice-posting form. A little flakey, doesn't always work.
 508      *
 509      * @return void
 510      */
 511     function showReplyLink()
 512     {
 513         if (common_logged_in()) {
 514             $this->out->text(' ');
 515             $reply_url = common_local_url('newnotice',
 516                                           array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
 517             $this->out->elementStart('a', array('href' => $reply_url,
 518                                                 'class' => 'notice_reply',
 519                                                 // TRANS: Link title in notice list item to reply to a notice.
 520                                                 'title' => _('Reply to this notice.')));
 521             // TRANS: Link text in notice list item to reply to a notice.
 522             $this->out->text(_('Reply'));
 523             $this->out->text(' ');
 524             $this->out->element('span', 'notice_id', $this->notice->id);
 525             $this->out->elementEnd('a');
 526         }
 527     }
 528
 529     /**
 530      * if the user is the author, let them delete the notice
 531      *
 532      * @return void
 533      */
 534     function showDeleteLink()
 535     {
 536         $user = common_current_user();
 537
 538         $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
 539
 540         if (!empty($user) &&
 541             ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 542             $this->out->text(' ');
 543             $deleteurl = common_local_url('deletenotice',
 544                                           array('notice' => $todel->id));
 545             $this->out->element('a', array('href' => $deleteurl,
 546                                            'class' => 'notice_delete',
 547                                            // TRANS: Link title in notice list item to delete a notice.
 548                                            'title' => _('Delete this notice from the timeline.')),
 549                                            // TRANS: Link text in notice list item to delete a notice.
 550                                            _('Delete'));
 551         }
 552     }
 553
 554     /**
 555      * show the form to repeat a notice
 556      *
 557      * @return void
 558      */
 559     function showRepeatForm()
 560     {
 561         if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
 562             $this->notice->scope == Notice::SITE_SCOPE) {
 563             $user = common_current_user();
 564             if (!empty($user) &&
 565                 $user->id != $this->notice->profile_id) {
 566                 $this->out->text(' ');
 567                 $profile = $user->getProfile();
 568                 if ($profile->hasRepeated($this->notice)) {
 569                     $this->out->element('span', array('class' => 'repeated',
 570                                                       // TRANS: Title for repeat form status in notice list when a notice has been repeated.
 571                                                       'title' => _('Notice repeated.')),
 572                                         // TRANS: Repeat form status in notice list when a notice has been repeated.
 573                                         _('Repeated'));
 574                 } else {
 575                     $rf = new RepeatForm($this->out, $this->notice);
 576                     $rf->show();
 577                 }
 578             }
 579         }
 580     }
 581
 582     /**
 583      * finish the notice
 584      *
 585      * Close the last elements in the notice list item
 586      *
 587      * @return void
 588      */
 589     function showEnd()
 590     {
 591         if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
 592             $this->out->elementEnd('li');
 593             Event::handle('EndCloseNoticeListItemElement', array($this));
 594         }
 595     }
 596
 597     /**
 598      * Get the notice in question
 599      *
 600      * For hooks, etc., this may be useful
 601      *
 602      * @return Notice The notice we're showing
 603      */
 604
 605     function getNotice()
 606     {
 607         return $this->notice;
 608     }
 609 }