lib/threadednoticelist.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    Brion Vibber <brion@status.net>
  25  * @copyright 2011 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * widget for displaying a list of notices
  36  *
  37  * There are a number of actions that display a list of notices, in
  38  * reverse chronological order. This widget abstracts out most of the
  39  * code for UI for notice lists. It's overridden to hide some
  40  * data for e.g. the profile 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      Notice
  48  * @see      NoticeListItem
  49  * @see      ProfileNoticeList
  50  */
  51 class ThreadedNoticeList extends NoticeList
  52 {
  53     protected $userProfile;
  54
  55     function __construct($notice, $out=null, $profile=-1)
  56     {
  57         parent::__construct($notice, $out);
  58         if (is_int($profile) && $profile == -1) {
  59             $profile = Profile::current();
  60         }
  61         $this->userProfile = $profile;
  62     }
  63
  64     /**
  65      * show the list of notices
  66      *
  67      * "Uses up" the stream by looping through it. So, probably can't
  68      * be called twice on the same list.
  69      *
  70      * @return int count of notices listed.
  71      */
  72     function show()
  73     {
  74         $this->out->elementStart('div', array('id' =>'notices_primary'));
  75         // TRANS: Header for Notices section.
  76         $this->out->element('h2', null, _m('HEADER','Notices'));
  77         $this->out->elementStart('ol', array('class' => 'notices threaded-notices xoxo'));
  78
  79                 $notices = $this->notice->fetchAll();
  80                 $notices = array_slice($notices, 0, NOTICES_PER_PAGE);
  81
  82         $this->prefill($notices);
  83
  84         $cnt = 0;
  85         $conversations = array();
  86
  87         foreach ($notices as $notice) {
  88
  89             // Collapse repeats into their originals...
  90
  91             if ($notice->repeat_of) {
  92                 $orig = Notice::staticGet('id', $notice->repeat_of);
  93                 if ($orig) {
  94                     $notice = $orig;
  95                 }
  96             }
  97             $convo = $notice->conversation;
  98             if (!empty($conversations[$convo])) {
  99                 // Seen this convo already -- skip!
 100                 continue;
 101             }
 102             $conversations[$convo] = true;
 103
 104             // Get the convo's root notice
 105             $root = $notice->conversationRoot($this->userProfile);
 106             if ($root) {
 107                 $notice = $root;
 108             }
 109
 110             try {
 111                 $item = $this->newListItem($notice);
 112                 $item->show();
 113             } catch (Exception $e) {
 114                 // we log exceptions and continue
 115                 common_log(LOG_ERR, $e->getMessage());
 116                 continue;
 117             }
 118         }
 119
 120         $this->out->elementEnd('ol');
 121         $this->out->elementEnd('div');
 122
 123         return $cnt;
 124     }
 125
 126     /**
 127      * returns a new list item for the current notice
 128      *
 129      * Recipe (factory?) method; overridden by sub-classes to give
 130      * a different list item class.
 131      *
 132      * @param Notice $notice the current notice
 133      *
 134      * @return NoticeListItem a list item for displaying the notice
 135      */
 136     function newListItem($notice)
 137     {
 138         return new ThreadedNoticeListItem($notice, $this->out, $this->userProfile);
 139     }
 140 }
 141
 142 /**
 143  * widget for displaying a single notice
 144  *
 145  * This widget has the core smarts for showing a single notice: what to display,
 146  * where, and under which circumstances. Its key method is show(); this is a recipe
 147  * that calls all the other show*() methods to build up a single notice. The
 148  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 149  * author info (since that's implicit by the data in the page).
 150  *
 151  * @category UI
 152  * @package  StatusNet
 153  * @author   Evan Prodromou <evan@status.net>
 154  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 155  * @link     http://status.net/
 156  * @see      NoticeList
 157  * @see      ProfileNoticeListItem
 158  */
 159 class ThreadedNoticeListItem extends NoticeListItem
 160 {
 161     protected $userProfile = null;
 162
 163     function __construct($notice, $out=null, $profile=null)
 164     {
 165         parent::__construct($notice, $out);
 166         $this->userProfile = $profile;
 167     }
 168
 169     function initialItems()
 170     {
 171         return 3;
 172     }
 173
 174     function showContext()
 175     {
 176         // Silence!
 177     }
 178
 179     /**
 180      * finish the notice
 181      *
 182      * Close the last elements in the notice list item
 183      *
 184      * @return void
 185      */
 186     function showEnd()
 187     {
 188         $max = $this->initialItems();
 189         if (!$this->repeat) {
 190             $stream = new ConversationNoticeStream($this->notice->conversation, $this->userProfile);
 191             $notice = $stream->getNotices(0, $max + 2);
 192             $notices = array();
 193             $cnt = 0;
 194             $moreCutoff = null;
 195             while ($notice->fetch()) {
 196                 if (Event::handle('StartAddNoticeReply', array($this, $this->notice, $notice))) {
 197                     if ($notice->id == $this->notice->id) {
 198                         // Skip!
 199                         continue;
 200                     }
 201                     $cnt++;
 202                     if ($cnt > $max) {
 203                         // boo-yah
 204                         $moreCutoff = clone($notice);
 205                         break;
 206                     }
 207                     $notices[] = clone($notice); // *grumble* inefficient as hell
 208                     Event::handle('EndAddNoticeReply', array($this, $this->notice, $notice));
 209                 }
 210             }
 211
 212             if (Event::handle('StartShowThreadedNoticeTail', array($this, $this->notice, &$notices))) {
 213                 $this->out->elementStart('ul', 'notices threaded-replies xoxo');
 214
 215                 $item = new ThreadedNoticeListFavesItem($this->notice, $this->out);
 216                 $hasFaves = $item->show();
 217
 218                 $item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
 219                 $hasRepeats = $item->show();
 220
 221                 if ($notices) {
 222
 223                     if ($moreCutoff) {
 224                         $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out, count($notices));
 225                         $item->show();
 226                     }
 227                     // XXX: replicating NoticeList::prefill(), annoyingly
 228                     $this->prefill($notices);
 229                     foreach (array_reverse($notices) as $notice) {
 230                         if (Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice))) {
 231                             $item = new ThreadedNoticeListSubItem($notice, $this->notice, $this->out);
 232                             $item->show();
 233                             Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice));
 234                         }
 235                     }
 236                 }
 237
 238                 if ($notices || $hasFaves || $hasRepeats) {
 239                     // @fixme do a proper can-post check that's consistent
 240                     // with the JS side
 241                     if (common_current_user()) {
 242                         $item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
 243                         $item->show();
 244                     }
 245                 }
 246                 $this->out->elementEnd('ul');
 247                 Event::handle('EndShowThreadedNoticeTail', array($this, $this->notice, $notices));
 248             }
 249         }
 250
 251         parent::showEnd();
 252     }
 253
 254     function prefill(&$notices)
 255     {
 256         // Prefill the profiles
 257         Notice::fillProfiles($notices);
 258     }
 259 }
 260
 261 // @todo FIXME: needs documentation.
 262 class ThreadedNoticeListSubItem extends NoticeListItem
 263 {
 264     protected $root = null;
 265
 266     function __construct($notice, $root, $out)
 267     {
 268         $this->root = $root;
 269         parent::__construct($notice, $out);
 270     }
 271
 272     function avatarSize()
 273     {
 274         return AVATAR_STREAM_SIZE; // @fixme would like something in between
 275     }
 276
 277     function showNoticeLocation()
 278     {
 279         //
 280     }
 281
 282     function showNoticeSource()
 283     {
 284         //
 285     }
 286
 287     function showContext()
 288     {
 289         //
 290     }
 291
 292     function getReplyProfiles()
 293     {
 294         $all = parent::getReplyProfiles();
 295
 296         $profiles = array();
 297
 298         $rootAuthor = $this->root->getProfile();
 299
 300         foreach ($all as $profile) {
 301             if ($profile->id != $rootAuthor->id) {
 302                 $profiles[] = $profile;
 303             }
 304         }
 305
 306         return $profiles;
 307     }
 308
 309     function showEnd()
 310     {
 311         $item = new ThreadedNoticeListInlineFavesItem($this->notice, $this->out);
 312         $hasFaves = $item->show();
 313         parent::showEnd();
 314     }
 315 }
 316
 317 /**
 318  * Placeholder for loading more replies...
 319  */
 320 class ThreadedNoticeListMoreItem extends NoticeListItem
 321 {
 322     protected $cnt;
 323
 324     function __construct($notice, $out, $cnt)
 325     {
 326         parent::__construct($notice, $out);
 327         $this->cnt = $cnt;
 328     }
 329
 330     /**
 331      * recipe function for displaying a single notice.
 332      *
 333      * This uses all the other methods to correctly display a notice. Override
 334      * it or one of the others to fine-tune the output.
 335      *
 336      * @return void
 337      */
 338     function show()
 339     {
 340         $this->showStart();
 341         $this->showMiniForm();
 342         $this->showEnd();
 343     }
 344
 345     /**
 346      * start a single notice.
 347      *
 348      * @return void
 349      */
 350     function showStart()
 351     {
 352         $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
 353     }
 354
 355     function showMiniForm()
 356     {
 357         $id = $this->notice->conversation;
 358         $url = common_local_url('conversationreplies', array('id' => $id));
 359
 360         $n = Conversation::noticeCount($id) - 1;
 361
 362         // TRANS: Link to show replies for a notice.
 363         // TRANS: %d is the number of replies to a notice and used for plural.
 364         $msg = sprintf(_m('Show reply', 'Show all %d replies', $n), $n);
 365
 366         $this->out->element('a', array('href' => $url), $msg);
 367     }
 368 }
 369
 370 /**
 371  * Placeholder for reply form...
 372  * Same as get added at runtime via SN.U.NoticeInlineReplyPlaceholder
 373  */
 374 class ThreadedNoticeListReplyItem extends NoticeListItem
 375 {
 376     /**
 377      * recipe function for displaying a single notice.
 378      *
 379      * This uses all the other methods to correctly display a notice. Override
 380      * it or one of the others to fine-tune the output.
 381      *
 382      * @return void
 383      */
 384     function show()
 385     {
 386         $this->showStart();
 387         $this->showMiniForm();
 388         $this->showEnd();
 389     }
 390
 391     /**
 392      * start a single notice.
 393      *
 394      * @return void
 395      */
 396     function showStart()
 397     {
 398         $this->out->elementStart('li', array('class' => 'notice-reply-placeholder'));
 399     }
 400
 401     function showMiniForm()
 402     {
 403         $this->out->element('input', array('class' => 'placeholder',
 404                                            // TRANS: Field label for reply mini form.
 405                                            'value' => _('Write a reply...')));
 406     }
 407 }
 408
 409 /**
 410  * Placeholder for showing faves...
 411  */
 412 abstract class NoticeListActorsItem extends NoticeListItem
 413 {
 414     /**
 415      * @return array of profile IDs
 416      */
 417     abstract function getProfiles();
 418
 419     abstract function getListMessage($count, $you);
 420
 421     function show()
 422     {
 423         $links = array();
 424         $you = false;
 425         $cur = common_current_user();
 426         foreach ($this->getProfiles() as $id) {
 427             if ($cur && $cur->id == $id) {
 428                 $you = true;
 429                 // TRANS: Reference to the logged in user in favourite list.
 430                 array_unshift($links, _m('FAVELIST', 'You'));
 431             } else {
 432                 $profile = Profile::staticGet('id', $id);
 433                 if ($profile) {
 434                     $links[] = sprintf('<a href="%s">%s</a>',
 435                                        htmlspecialchars($profile->profileurl),
 436                                        htmlspecialchars($profile->getBestName()));
 437                 }
 438             }
 439         }
 440
 441         if ($links) {
 442             $count = count($links);
 443             $msg = $this->getListMessage($count, $you);
 444             $out = sprintf($msg, $this->magicList($links));
 445
 446             $this->showStart();
 447             $this->out->raw($out);
 448             $this->showEnd();
 449             return $count;
 450         } else {
 451             return 0;
 452         }
 453     }
 454
 455     function magicList($items)
 456     {
 457         if (count($items) == 0) {
 458             return '';
 459         } else if (count($items) == 1) {
 460             return $items[0];
 461         } else {
 462             $first = array_slice($items, 0, -1);
 463             $last = array_slice($items, -1, 1);
 464             // TRANS: Separator in list of user names like "Jim, Bob, Mary".
 465             $separator = _(', ');
 466             // TRANS: For building a list such as "Jim, Bob, Mary and 5 others like this".
 467             // TRANS: %1$s is a list of users, separated by a separator (default: ", "), %2$s is the last user in the list.
 468             return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode($separator, $first), implode($separator, $last));
 469         }
 470     }
 471 }
 472
 473 /**
 474  * Placeholder for showing faves...
 475  */
 476 class ThreadedNoticeListFavesItem extends NoticeListActorsItem
 477 {
 478     function getProfiles()
 479     {
 480         $fave = Fave::byNotice($this->notice->id);
 481         $profiles = array();
 482         while ($fave->fetch()) {
 483             $profiles[] = $fave->user_id;
 484         }
 485         return $profiles;
 486     }
 487
 488     function magicList($items)
 489     {
 490         if (count($items) > 4) {
 491             return parent::magicList(array_slice($items, 0, 3));
 492         } else {
 493             return parent::magicList($items);
 494         }
 495     }
 496
 497     function getListMessage($count, $you)
 498     {
 499         if ($count == 1 && $you) {
 500             // darn first person being different from third person!
 501             // TRANS: List message for notice favoured by logged in user.
 502             return _m('FAVELIST', 'You like this.');
 503         } else if ($count > 4) {
 504             // TRANS: List message for when more than 4 people like something.
 505             // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
 506             // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
 507             return sprintf(_m('%%s and %d others like this.',
 508                               '%%s and %d others like this.',
 509                               $count),
 510                            $count - 3);
 511         } else {
 512             // TRANS: List message for favoured notices.
 513             // TRANS: %%s is a list of users liking a notice.
 514             // TRANS: Plural is based on the number of of users that have favoured a notice.
 515             return sprintf(_m('%%s likes this.',
 516                               '%%s like this.',
 517                               $count),
 518                            $count);
 519         }
 520     }
 521
 522     function showStart()
 523     {
 524         $this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
 525     }
 526
 527     function showEnd()
 528     {
 529         $this->out->elementEnd('li');
 530     }
 531 }
 532
 533 // @todo FIXME: needs documentation.
 534 class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
 535 {
 536     function showStart()
 537     {
 538         $this->out->elementStart('div', array('class' => 'entry-content notice-faves'));
 539     }
 540
 541     function showEnd()
 542     {
 543         $this->out->elementEnd('div');
 544     }
 545 }
 546
 547 /**
 548  * Placeholder for showing faves...
 549  */
 550 class ThreadedNoticeListRepeatsItem extends NoticeListActorsItem
 551 {
 552     function getProfiles()
 553     {
 554         $rep = $this->notice->repeatStream();
 555
 556         $profiles = array();
 557         while ($rep->fetch()) {
 558             $profiles[] = $rep->profile_id;
 559         }
 560         return $profiles;
 561     }
 562
 563     function getListMessage($count, $you)
 564     {
 565         if ($count == 1 && $you) {
 566             // darn first person being different from third person!
 567             // TRANS: List message for notice repeated by logged in user.
 568             return _m('REPEATLIST', 'You have repeated this notice.');
 569         } else {
 570             // TRANS: List message for repeated notices.
 571             // TRANS: %d is the number of users that have repeated a notice.
 572             return sprintf(_m('One person has repeated this notice.',
 573                               '%d people have repeated this notice.',
 574                               $count),
 575                            $count);
 576         }
 577     }
 578
 579     function showStart()
 580     {
 581         $this->out->elementStart('li', array('class' => 'notice-data notice-repeats'));
 582     }
 583
 584     function showEnd()
 585     {
 586         $this->out->elementEnd('li');
 587     }
 588 }