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('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * widget for displaying a single notice
  39  *
  40  * This widget has the core smarts for showing a single notice: what to display,
  41  * where, and under which circumstances. Its key method is show(); this is a recipe
  42  * that calls all the other show*() methods to build up a single notice. The
  43  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
  44  * author info (since that's implicit by the data in the page).
  45  *
  46  * @category UI
  47  * @package  StatusNet
  48  * @author   Evan Prodromou <evan@status.net>
  49  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  50  * @link     http://status.net/
  51  * @see      NoticeList
  52  * @see      ProfileNoticeListItem
  53  */
  54 class NoticeListItem extends Widget
  55 {
  56     /** The notice this item will show. */
  57     var $notice = null;
  58
  59     /** The notice that was repeated. */
  60     var $repeat = null;
  61
  62     /** The profile of the author of the notice, extracted once for convenience. */
  63     var $profile = null;
  64
  65     /**
  66      * constructor
  67      *
  68      * Also initializes the profile attribute.
  69      *
  70      * @param Notice $notice The notice we'll display
  71      */
  72     function __construct($notice, $out=null)
  73     {
  74         parent::__construct($out);
  75         if (!empty($notice->repeat_of)) {
  76             $original = Notice::staticGet('id', $notice->repeat_of);
  77             if (empty($original)) { // could have been deleted
  78                 $this->notice = $notice;
  79             } else {
  80                 $this->notice = $original;
  81                 $this->repeat = $notice;
  82             }
  83         } else {
  84             $this->notice  = $notice;
  85         }
  86         $this->profile = $this->notice->getProfile();
  87     }
  88
  89     /**
  90      * recipe function for displaying a single notice.
  91      *
  92      * This uses all the other methods to correctly display a notice. Override
  93      * it or one of the others to fine-tune the output.
  94      *
  95      * @return void
  96      */
  97     function show()
  98     {
  99         if (empty($this->notice)) {
 100             common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
 101             return;
 102         } else if (empty($this->profile)) {
 103             common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
 104             return;
 105         }
 106
 107         $this->showStart();
 108         if (Event::handle('StartShowNoticeItem', array($this))) {
 109             $this->showNotice();
 110             $this->showNoticeAttachments();
 111             $this->showNoticeInfo();
 112             $this->showNoticeOptions();
 113             Event::handle('EndShowNoticeItem', array($this));
 114         }
 115         $this->showEnd();
 116     }
 117
 118     function showNotice()
 119     {
 120         $this->out->elementStart('div', 'entry-title');
 121         $this->showAuthor();
 122         $this->showContent();
 123         $this->out->elementEnd('div');
 124     }
 125
 126     function showNoticeInfo()
 127     {
 128         $this->out->elementStart('div', 'entry-content');
 129         if (Event::handle('StartShowNoticeInfo', array($this))) {
 130             $this->showNoticeLink();
 131             $this->showNoticeSource();
 132             $this->showNoticeLocation();
 133             $this->showContext();
 134             $this->showRepeat();
 135             Event::handle('EndShowNoticeInfo', array($this));
 136         }
 137
 138         $this->out->elementEnd('div');
 139     }
 140
 141     function showNoticeOptions()
 142     {
 143         if (Event::handle('StartShowNoticeOptions', array($this))) {
 144             $user = common_current_user();
 145             if ($user) {
 146                 $this->out->elementStart('div', 'notice-options');
 147                 $this->showFaveForm();
 148                 $this->showReplyLink();
 149                 $this->showRepeatForm();
 150                 $this->showDeleteLink();
 151                 $this->out->elementEnd('div');
 152             }
 153             Event::handle('EndShowNoticeOptions', array($this));
 154         }
 155     }
 156
 157     /**
 158      * start a single notice.
 159      *
 160      * @return void
 161      */
 162     function showStart()
 163     {
 164         if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
 165             $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
 166             $class = 'hentry notice';
 167             if ($this->notice->scope != 0 && $this->notice->scope != 1) {
 168                 $class .= ' limited-scope';
 169             }
 170             $this->out->elementStart('li', array('class' => $class,
 171                                                  'id' => 'notice-' . $id));
 172             Event::handle('EndOpenNoticeListItemElement', array($this));
 173         }
 174     }
 175
 176     /**
 177      * show the "favorite" form
 178      *
 179      * @return void
 180      */
 181     function showFaveForm()
 182     {
 183         if (Event::handle('StartShowFaveForm', array($this))) {
 184             $user = common_current_user();
 185             if ($user) {
 186                 if ($user->hasFave($this->notice)) {
 187                     $disfavor = new DisfavorForm($this->out, $this->notice);
 188                     $disfavor->show();
 189                 } else {
 190                     $favor = new FavorForm($this->out, $this->notice);
 191                     $favor->show();
 192                 }
 193             }
 194             Event::handle('EndShowFaveForm', array($this));
 195         }
 196     }
 197
 198     /**
 199      * show the author of a notice
 200      *
 201      * By default, this shows the avatar and (linked) nickname of the author.
 202      *
 203      * @return void
 204      */
 205
 206     function showAuthor()
 207     {
 208         $this->out->elementStart('div', 'author');
 209
 210         $this->out->elementStart('span', 'vcard author');
 211
 212         $attrs = array('href' => $this->profile->profileurl,
 213                        'class' => 'url',
 214                        'title' => $this->profile->nickname);
 215
 216         $this->out->elementStart('a', $attrs);
 217         $this->showAvatar();
 218         $this->out->text(' ');
 219         $this->out->element('span',array('class' => 'nickname fn'),
 220                             $this->profile->getBestName());
 221         $this->out->elementEnd('a');
 222
 223         $this->out->elementEnd('span');
 224
 225         $this->showAddressees();
 226
 227         $this->out->elementEnd('div');
 228     }
 229
 230     function showAddressees()
 231     {
 232         $this->out->elementStart('span', 'addressees');
 233
 234         $cnt = $this->showGroupAddressees(true);
 235         $cnt = $this->showProfileAddressees($cnt == 0);
 236
 237         $this->out->elementEnd('span', 'addressees');
 238     }
 239
 240     function showGroupAddressees($first)
 241     {
 242         $groups = $this->getGroups();
 243
 244         foreach ($groups as $group) {
 245             if (!$first) {
 246                 $this->out->text(', ');
 247             } else {
 248                 $this->out->text(' ▶ ');
 249                 $first = false;
 250             }
 251             $this->out->element('a', array('href' => $group->homeUrl(),
 252                                            'title' => $group->nickname,
 253                                            'class' => 'addressee group'),
 254                                 $group->getBestName());
 255         }
 256
 257         return count($groups);
 258     }
 259
 260     function getGroups()
 261     {
 262         return $this->notice->getGroups();
 263     }
 264
 265     function showProfileAddressees($first)
 266     {
 267         $replies = $this->getReplyProfiles();
 268
 269         foreach ($replies as $reply) {
 270             if (!$first) {
 271                 $this->out->text(', ');
 272             } else {
 273                 $this->out->text(' ▶ ');
 274                 $first = false;
 275             }
 276             $this->out->element('a', array('href' => $reply->profileurl,
 277                                            'title' => $reply->nickname,
 278                                            'class' => 'addressee account'),
 279                                 $reply->getBestName());
 280         }
 281
 282         return count($replies);
 283     }
 284
 285     function getReplyProfiles()
 286     {
 287         return $this->notice->getReplyProfiles();
 288     }
 289
 290     /**
 291      * show the avatar of the notice's author
 292      *
 293      * This will use the default avatar if no avatar is assigned for the author.
 294      * It makes a link to the author's profile.
 295      *
 296      * @return void
 297      */
 298     function showAvatar()
 299     {
 300         $avatar_size = $this->avatarSize();
 301
 302         $avatar = $this->profile->getAvatar($avatar_size);
 303
 304         $this->out->element('img', array('src' => ($avatar) ?
 305                                          $avatar->displayUrl() :
 306                                          Avatar::defaultImage($avatar_size),
 307                                          'class' => 'avatar photo',
 308                                          'width' => $avatar_size,
 309                                          'height' => $avatar_size,
 310                                          'alt' =>
 311                                          ($this->profile->fullname) ?
 312                                          $this->profile->fullname :
 313                                          $this->profile->nickname));
 314     }
 315
 316     function avatarSize()
 317     {
 318         return AVATAR_STREAM_SIZE;
 319     }
 320
 321     /**
 322      * show the nickname of the author
 323      *
 324      * Links to the author's profile page
 325      *
 326      * @return void
 327      */
 328     function showNickname()
 329     {
 330         $this->out->raw('<span class="nickname fn">' .
 331                         htmlspecialchars($this->profile->nickname) .
 332                         '</span>');
 333     }
 334
 335     /**
 336      * show the content of the notice
 337      *
 338      * Shows the content of the notice. This is pre-rendered for efficiency
 339      * at save time. Some very old notices might not be pre-rendered, so
 340      * they're rendered on the spot.
 341      *
 342      * @return void
 343      */
 344     function showContent()
 345     {
 346         // FIXME: URL, image, video, audio
 347         $this->out->elementStart('p', array('class' => 'entry-content'));
 348         if ($this->notice->rendered) {
 349             $this->out->raw($this->notice->rendered);
 350         } else {
 351             // XXX: may be some uncooked notices in the DB,
 352             // we cook them right now. This should probably disappear in future
 353             // versions (>> 0.4.x)
 354             $this->out->raw(common_render_content($this->notice->content, $this->notice));
 355         }
 356         $this->out->elementEnd('p');
 357     }
 358
 359     function showNoticeAttachments() {
 360         if (common_config('attachments', 'show_thumbs')) {
 361             $al = new InlineAttachmentList($this->notice, $this->out);
 362             $al->show();
 363         }
 364     }
 365
 366     /**
 367      * show the link to the main page for the notice
 368      *
 369      * Displays a link to the page for a notice, with "relative" time. Tries to
 370      * get remote notice URLs correct, but doesn't always succeed.
 371      *
 372      * @return void
 373      */
 374     function showNoticeLink()
 375     {
 376         $noticeurl = $this->notice->bestUrl();
 377
 378         // above should always return an URL
 379
 380         assert(!empty($noticeurl));
 381
 382         $this->out->elementStart('a', array('rel' => 'bookmark',
 383                                             'class' => 'timestamp',
 384                                             'href' => $noticeurl));
 385         $dt = common_date_iso8601($this->notice->created);
 386         $this->out->element('abbr', array('class' => 'published',
 387                                           'title' => $dt),
 388                             common_date_string($this->notice->created));
 389         $this->out->elementEnd('a');
 390     }
 391
 392     /**
 393      * show the notice location
 394      *
 395      * shows the notice location in the correct language.
 396      *
 397      * If an URL is available, makes a link. Otherwise, just a span.
 398      *
 399      * @return void
 400      */
 401     function showNoticeLocation()
 402     {
 403         $id = $this->notice->id;
 404
 405         $location = $this->notice->getLocation();
 406
 407         if (empty($location)) {
 408             return;
 409         }
 410
 411         $name = $location->getName();
 412
 413         $lat = $this->notice->lat;
 414         $lon = $this->notice->lon;
 415         $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
 416
 417         if (empty($name)) {
 418             $latdms = $this->decimalDegreesToDMS(abs($lat));
 419             $londms = $this->decimalDegreesToDMS(abs($lon));
 420             // TRANS: Used in coordinates as abbreviation of north.
 421             $north = _('N');
 422             // TRANS: Used in coordinates as abbreviation of south.
 423             $south = _('S');
 424             // TRANS: Used in coordinates as abbreviation of east.
 425             $east = _('E');
 426             // TRANS: Used in coordinates as abbreviation of west.
 427             $west = _('W');
 428             $name = sprintf(
 429                 // TRANS: Coordinates message.
 430                 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
 431                 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
 432                 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
 433                 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
 434                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
 435                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
 436                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
 437         }
 438
 439         $url  = $location->getUrl();
 440
 441         $this->out->text(' ');
 442         $this->out->elementStart('span', array('class' => 'location'));
 443         // TRANS: Followed by geo location.
 444         $this->out->text(_('at'));
 445         $this->out->text(' ');
 446         if (empty($url)) {
 447             $this->out->element('abbr', array('class' => 'geo',
 448                                               'title' => $latlon),
 449                                 $name);
 450         } else {
 451             $xstr = new XMLStringer(false);
 452             $xstr->elementStart('a', array('href' => $url,
 453                                            'rel' => 'external'));
 454             $xstr->element('abbr', array('class' => 'geo',
 455                                          'title' => $latlon),
 456                            $name);
 457             $xstr->elementEnd('a');
 458             $this->out->raw($xstr->getString());
 459         }
 460         $this->out->elementEnd('span');
 461     }
 462
 463     /**
 464      * @param number $dec decimal degrees
 465      * @return array split into 'deg', 'min', and 'sec'
 466      */
 467     function decimalDegreesToDMS($dec)
 468     {
 469         $deg = intval($dec);
 470         $tempma = abs($dec) - abs($deg);
 471
 472         $tempma = $tempma * 3600;
 473         $min = floor($tempma / 60);
 474         $sec = $tempma - ($min*60);
 475
 476         return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
 477     }
 478
 479     /**
 480      * Show the source of the notice
 481      *
 482      * Either the name (and link) of the API client that posted the notice,
 483      * or one of other other channels.
 484      *
 485      * @return void
 486      */
 487     function showNoticeSource()
 488     {
 489         $ns = $this->notice->getSource();
 490
 491         if ($ns) {
 492             // TRANS: A possible notice source (web interface).
 493             $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
 494             $this->out->text(' ');
 495             $this->out->elementStart('span', 'source');
 496             // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
 497             // TRANS: Followed by notice source.
 498             $this->out->text(_('from'));
 499             $this->out->text(' ');
 500
 501             $name  = $source_name;
 502             $url   = $ns->url;
 503             $title = null;
 504
 505             if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
 506                 $name = $source_name;
 507                 $url  = $ns->url;
 508             }
 509             Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
 510
 511             // if $ns->name and $ns->url are populated we have
 512             // configured a source attr somewhere
 513             if (!empty($name) && !empty($url)) {
 514                 $this->out->elementStart('span', 'device');
 515
 516                 $attrs = array(
 517                     'href' => $url,
 518                     'rel' => 'external'
 519                 );
 520
 521                 if (!empty($title)) {
 522                     $attrs['title'] = $title;
 523                 }
 524
 525                 $this->out->element('a', $attrs, $name);
 526                 $this->out->elementEnd('span');
 527             } else {
 528                 $this->out->element('span', 'device', $name);
 529             }
 530
 531             $this->out->elementEnd('span');
 532         }
 533     }
 534
 535     /**
 536      * show link to notice this notice is a reply to
 537      *
 538      * If this notice is a reply, show a link to the notice it is replying to. The
 539      * heavy lifting for figuring out replies happens at save time.
 540      *
 541      * @return void
 542      */
 543     function showContext()
 544     {
 545         if ($this->notice->hasConversation()) {
 546             $conv = Conversation::staticGet(
 547                 'id',
 548                 $this->notice->conversation
 549             );
 550             $convurl = $conv->uri;
 551             if (!empty($convurl)) {
 552                 $this->out->text(' ');
 553                 $this->out->element(
 554                     'a',
 555                     array(
 556                     'href' => $convurl.'#notice-'.$this->notice->id,
 557                     'class' => 'response'),
 558                     // TRANS: Addition in notice list item if notice is part of a conversation.
 559                     _('in context')
 560                 );
 561             } else {
 562                 $msg = sprintf(
 563                     "Couldn't find Conversation ID %d to make 'in context'"
 564                     . "link for Notice ID %d",
 565                     $this->notice->conversation,
 566                     $this->notice->id
 567                 );
 568                 common_log(LOG_WARNING, $msg);
 569             }
 570         }
 571     }
 572
 573     /**
 574      * show a link to the author of repeat
 575      *
 576      * @return void
 577      */
 578     function showRepeat()
 579     {
 580         if (!empty($this->repeat)) {
 581
 582             $repeater = Profile::staticGet('id', $this->repeat->profile_id);
 583
 584             $attrs = array('href' => $repeater->profileurl,
 585                            'class' => 'url');
 586
 587             if (!empty($repeater->fullname)) {
 588                 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
 589             }
 590
 591             $this->out->elementStart('span', 'repeat vcard');
 592
 593             // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
 594             $this->out->raw(_('Repeated by'));
 595
 596             $this->out->elementStart('a', $attrs);
 597             $this->out->element('span', 'fn nickname', $repeater->nickname);
 598             $this->out->elementEnd('a');
 599
 600             $this->out->elementEnd('span');
 601         }
 602     }
 603
 604     /**
 605      * show a link to reply to the current notice
 606      *
 607      * Should either do the reply in the current notice form (if available), or
 608      * link out to the notice-posting form. A little flakey, doesn't always work.
 609      *
 610      * @return void
 611      */
 612     function showReplyLink()
 613     {
 614         if (common_logged_in()) {
 615             $this->out->text(' ');
 616             $reply_url = common_local_url('newnotice',
 617                                           array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
 618             $this->out->elementStart('a', array('href' => $reply_url,
 619                                                 'class' => 'notice_reply',
 620                                                 // TRANS: Link title in notice list item to reply to a notice.
 621                                                 'title' => _('Reply to this notice')));
 622             // TRANS: Link text in notice list item to reply to a notice.
 623             $this->out->text(_('Reply'));
 624             $this->out->text(' ');
 625             $this->out->element('span', 'notice_id', $this->notice->id);
 626             $this->out->elementEnd('a');
 627         }
 628     }
 629
 630     /**
 631      * if the user is the author, let them delete the notice
 632      *
 633      * @return void
 634      */
 635     function showDeleteLink()
 636     {
 637         $user = common_current_user();
 638
 639         $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
 640
 641         if (!empty($user) &&
 642             ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 643             $this->out->text(' ');
 644             $deleteurl = common_local_url('deletenotice',
 645                                           array('notice' => $todel->id));
 646             $this->out->element('a', array('href' => $deleteurl,
 647                                            'class' => 'notice_delete',
 648                                            // TRANS: Link title in notice list item to delete a notice.
 649                                            'title' => _('Delete this notice')),
 650                                            // TRANS: Link text in notice list item to delete a notice.
 651                                            _('Delete'));
 652         }
 653     }
 654
 655     /**
 656      * show the form to repeat a notice
 657      *
 658      * @return void
 659      */
 660     function showRepeatForm()
 661     {
 662         if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
 663             $this->notice->scope == Notice::SITE_SCOPE) {
 664             $user = common_current_user();
 665             if (!empty($user) &&
 666                 $user->id != $this->notice->profile_id) {
 667                 $this->out->text(' ');
 668                 $profile = $user->getProfile();
 669                 if ($profile->hasRepeated($this->notice->id)) {
 670                     $this->out->element('span', array('class' => 'repeated',
 671                                                       // TRANS: Title for repeat form status in notice list when a notice has been repeated.
 672                                                       'title' => _('Notice repeated.')),
 673                                         // TRANS: Repeat form status in notice list when a notice has been repeated.
 674                                         _('Repeated'));
 675                 } else {
 676                     $rf = new RepeatForm($this->out, $this->notice);
 677                     $rf->show();
 678                 }
 679             }
 680         }
 681     }
 682
 683     /**
 684      * finish the notice
 685      *
 686      * Close the last elements in the notice list item
 687      *
 688      * @return void
 689      */
 690     function showEnd()
 691     {
 692         if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
 693             $this->out->elementEnd('li');
 694             Event::handle('EndCloseNoticeListItemElement', array($this));
 695         }
 696     }
 697 }