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