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                 $total = count($notices);
  81                 $notices = array_slice($notices, 0, NOTICES_PER_PAGE);
  82
  83         $this->prefill($notices);
  84
  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 $total;
 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         $profiles = Notice::fillProfiles($notices);
 258         Profile::fillAvatars($profiles, AVATAR_MINI_SIZE);
 259     }
 260 }
 261
 262 // @todo FIXME: needs documentation.
 263 class ThreadedNoticeListSubItem extends NoticeListItem
 264 {
 265     protected $root = null;
 266
 267     function __construct($notice, $root, $out)
 268     {
 269         $this->root = $root;
 270         parent::__construct($notice, $out);
 271     }
 272
 273     function avatarSize()
 274     {
 275         return AVATAR_STREAM_SIZE; // @fixme would like something in between
 276     }
 277
 278     function showNoticeLocation()
 279     {
 280         //
 281     }
 282
 283     function showNoticeSource()
 284     {
 285         //
 286     }
 287
 288     function showContext()
 289     {
 290         //
 291     }
 292
 293     function getReplyProfiles()
 294     {
 295         $all = parent::getReplyProfiles();
 296
 297         $profiles = array();
 298
 299         $rootAuthor = $this->root->getProfile();
 300
 301         foreach ($all as $profile) {
 302             if ($profile->id != $rootAuthor->id) {
 303                 $profiles[] = $profile;
 304             }
 305         }
 306
 307         return $profiles;
 308     }
 309
 310     function showEnd()
 311     {
 312         $item = new ThreadedNoticeListInlineFavesItem($this->notice, $this->out);
 313         $hasFaves = $item->show();
 314         parent::showEnd();
 315     }
 316 }
 317
 318 /**
 319  * Placeholder for loading more replies...
 320  */
 321 class ThreadedNoticeListMoreItem extends NoticeListItem
 322 {
 323     protected $cnt;
 324
 325     function __construct($notice, $out, $cnt)
 326     {
 327         parent::__construct($notice, $out);
 328         $this->cnt = $cnt;
 329     }
 330
 331     /**
 332      * recipe function for displaying a single notice.
 333      *
 334      * This uses all the other methods to correctly display a notice. Override
 335      * it or one of the others to fine-tune the output.
 336      *
 337      * @return void
 338      */
 339     function show()
 340     {
 341         $this->showStart();
 342         $this->showMiniForm();
 343         $this->showEnd();
 344     }
 345
 346     /**
 347      * start a single notice.
 348      *
 349      * @return void
 350      */
 351     function showStart()
 352     {
 353         $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
 354     }
 355
 356     function showMiniForm()
 357     {
 358         $id = $this->notice->conversation;
 359         $url = common_local_url('conversationreplies', array('id' => $id));
 360
 361         $n = Conversation::noticeCount($id) - 1;
 362
 363         // TRANS: Link to show replies for a notice.
 364         // TRANS: %d is the number of replies to a notice and used for plural.
 365         $msg = sprintf(_m('Show reply', 'Show all %d replies', $n), $n);
 366
 367         $this->out->element('a', array('href' => $url), $msg);
 368     }
 369 }
 370
 371 /**
 372  * Placeholder for reply form...
 373  * Same as get added at runtime via SN.U.NoticeInlineReplyPlaceholder
 374  */
 375 class ThreadedNoticeListReplyItem extends NoticeListItem
 376 {
 377     /**
 378      * recipe function for displaying a single notice.
 379      *
 380      * This uses all the other methods to correctly display a notice. Override
 381      * it or one of the others to fine-tune the output.
 382      *
 383      * @return void
 384      */
 385     function show()
 386     {
 387         $this->showStart();
 388         $this->showMiniForm();
 389         $this->showEnd();
 390     }
 391
 392     /**
 393      * start a single notice.
 394      *
 395      * @return void
 396      */
 397     function showStart()
 398     {
 399         $this->out->elementStart('li', array('class' => 'notice-reply-placeholder'));
 400     }
 401
 402     function showMiniForm()
 403     {
 404         $this->out->element('input', array('class' => 'placeholder',
 405                                            // TRANS: Field label for reply mini form.
 406                                            'value' => _('Write a reply...')));
 407     }
 408 }
 409
 410 /**
 411  * Placeholder for showing faves...
 412  */
 413 abstract class NoticeListActorsItem extends NoticeListItem
 414 {
 415     /**
 416      * @return array of profile IDs
 417      */
 418     abstract function getProfiles();
 419
 420     abstract function getListMessage($count, $you);
 421
 422     function show()
 423     {
 424         $links = array();
 425         $you = false;
 426         $cur = common_current_user();
 427         foreach ($this->getProfiles() as $id) {
 428             if ($cur && $cur->id == $id) {
 429                 $you = true;
 430                 // TRANS: Reference to the logged in user in favourite list.
 431                 array_unshift($links, _m('FAVELIST', 'You'));
 432             } else {
 433                 $profile = Profile::staticGet('id', $id);
 434                 if ($profile) {
 435                     $links[] = sprintf('<a href="%s">%s</a>',
 436                                        htmlspecialchars($profile->profileurl),
 437                                        htmlspecialchars($profile->getBestName()));
 438                 }
 439             }
 440         }
 441
 442         if ($links) {
 443             $count = count($links);
 444             $msg = $this->getListMessage($count, $you);
 445             $out = sprintf($msg, $this->magicList($links));
 446
 447             $this->showStart();
 448             $this->out->raw($out);
 449             $this->showEnd();
 450             return $count;
 451         } else {
 452             return 0;
 453         }
 454     }
 455
 456     function magicList($items)
 457     {
 458         if (count($items) == 0) {
 459             return '';
 460         } else if (count($items) == 1) {
 461             return $items[0];
 462         } else {
 463             $first = array_slice($items, 0, -1);
 464             $last = array_slice($items, -1, 1);
 465             // TRANS: Separator in list of user names like "Jim, Bob, Mary".
 466             $separator = _(', ');
 467             // TRANS: For building a list such as "Jim, Bob, Mary and 5 others like this".
 468             // TRANS: %1$s is a list of users, separated by a separator (default: ", "), %2$s is the last user in the list.
 469             return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode($separator, $first), implode($separator, $last));
 470         }
 471     }
 472 }
 473
 474 /**
 475  * Placeholder for showing faves...
 476  */
 477 class ThreadedNoticeListFavesItem extends NoticeListActorsItem
 478 {
 479     function getProfiles()
 480     {
 481         $fave = Fave::byNotice($this->notice->id);
 482         $profiles = array();
 483         while ($fave->fetch()) {
 484             $profiles[] = $fave->user_id;
 485         }
 486         return $profiles;
 487     }
 488
 489     function magicList($items)
 490     {
 491         if (count($items) > 4) {
 492             return parent::magicList(array_slice($items, 0, 3));
 493         } else {
 494             return parent::magicList($items);
 495         }
 496     }
 497
 498     function getListMessage($count, $you)
 499     {
 500         if ($count == 1 && $you) {
 501             // darn first person being different from third person!
 502             // TRANS: List message for notice favoured by logged in user.
 503             return _m('FAVELIST', 'You like this.');
 504         } else if ($count > 4) {
 505             // TRANS: List message for when more than 4 people like something.
 506             // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
 507             // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
 508             return sprintf(_m('%%s and %d others like this.',
 509                               '%%s and %d others like this.',
 510                               $count),
 511                            $count - 3);
 512         } else {
 513             // TRANS: List message for favoured notices.
 514             // TRANS: %%s is a list of users liking a notice.
 515             // TRANS: Plural is based on the number of of users that have favoured a notice.
 516             return sprintf(_m('%%s likes this.',
 517                               '%%s like this.',
 518                               $count),
 519                            $count);
 520         }
 521     }
 522
 523     function showStart()
 524     {
 525         $this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
 526     }
 527
 528     function showEnd()
 529     {
 530         $this->out->elementEnd('li');
 531     }
 532 }
 533
 534 // @todo FIXME: needs documentation.
 535 class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
 536 {
 537     function showStart()
 538     {
 539         $this->out->elementStart('div', array('class' => 'entry-content notice-faves'));
 540     }
 541
 542     function showEnd()
 543     {
 544         $this->out->elementEnd('div');
 545     }
 546 }
 547
 548 /**
 549  * Placeholder for showing faves...
 550  */
 551 class ThreadedNoticeListRepeatsItem extends NoticeListActorsItem
 552 {
 553     function getProfiles()
 554     {
 555         $rep = $this->notice->repeatStream();
 556
 557         $profiles = array();
 558         while ($rep->fetch()) {
 559             $profiles[] = $rep->profile_id;
 560         }
 561         return $profiles;
 562     }
 563
 564     function getListMessage($count, $you)
 565     {
 566         if ($count == 1 && $you) {
 567             // darn first person being different from third person!
 568             // TRANS: List message for notice repeated by logged in user.
 569             return _m('REPEATLIST', 'You have repeated this notice.');
 570         } else {
 571             // TRANS: List message for repeated notices.
 572             // TRANS: %d is the number of users that have repeated a notice.
 573             return sprintf(_m('One person has repeated this notice.',
 574                               '%d people have repeated this notice.',
 575                               $count),
 576                            $count);
 577         }
 578     }
 579
 580     function showStart()
 581     {
 582         $this->out->elementStart('li', array('class' => 'notice-data notice-repeats'));
 583     }
 584
 585     function showEnd()
 586     {
 587         $this->out->elementEnd('li');
 588     }
 589 }