lib/noticelist.php

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