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