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 $notice, HTMLOutputter $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 instanceof Notice) {
  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 instanceof Notice) {
 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 $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 $notice, HTMLOutputter $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                     // Don't list repeats as separate notices in a conversation
 212                     if (!empty($notice->repeat_of)) {
 213                         continue;
 214                     }
 215
 216                     if ($notice->id == $this->notice->id) {
 217                         // Skip!
 218                         continue;
 219                     }
 220                     $cnt++;
 221                     if ($cnt > $max) {
 222                         // boo-yah
 223                         $moreCutoff = clone($notice);
 224                         break;
 225                     }
 226                     $notices[] = clone($notice); // *grumble* inefficient as hell
 227                     Event::handle('EndAddNoticeReply', array($this, $this->notice, $notice));
 228                 }
 229             }
 230
 231             if (Event::handle('StartShowThreadedNoticeTail', array($this, $this->notice, &$notices))) {
 232                 $threadActive = count($notices) > 0; // has this thread had any activity?
 233
 234                 $this->out->elementStart('ul', 'notices threaded-replies xoxo');
 235
 236                 if (Event::handle('StartShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive))) {
 237
 238                     // Show the repeats-button for this notice. If there are repeats,
 239                     // the show() function will return true, definitely setting our
 240                     // $threadActive flag, which will be used later to show a reply box.
 241                     $item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
 242                     $threadActive = $item->show() || $threadActive;
 243
 244                     Event::handle('EndShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive));
 245                 }
 246
 247                 if (count($notices)>0) {
 248                     if ($moreCutoff) {
 249                         $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out, count($notices));
 250                         $item->show();
 251                     }
 252                     foreach (array_reverse($notices) as $notice) {
 253                         if (Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice))) {
 254                             $item = new ThreadedNoticeListSubItem($notice, $this->notice, $this->out);
 255                             $item->show();
 256                             Event::handle('EndShowThreadedNoticeSub', array($this, $this->notice, $notice));
 257                         }
 258                     }
 259                 }
 260
 261                 if ($threadActive && Profile::current() instanceof Profile) {
 262                     // @fixme do a proper can-post check that's consistent
 263                     // with the JS side
 264                     $item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
 265                     $item->show();
 266                 }
 267                 $this->out->elementEnd('ul');
 268                 Event::handle('EndShowThreadedNoticeTail', array($this, $this->notice, $notices));
 269             }
 270         }
 271
 272         parent::showEnd();
 273     }
 274 }
 275
 276 // @todo FIXME: needs documentation.
 277 class ThreadedNoticeListSubItem extends NoticeListItem
 278 {
 279     protected $root = null;
 280
 281     function __construct(Notice $notice, $root, $out)
 282     {
 283         $this->root = $root;
 284         parent::__construct($notice, $out);
 285     }
 286
 287     function avatarSize()
 288     {
 289         return AVATAR_STREAM_SIZE; // @fixme would like something in between
 290     }
 291
 292     function showNoticeLocation()
 293     {
 294         //
 295     }
 296
 297     function showNoticeSource()
 298     {
 299         //
 300     }
 301
 302     function showContext()
 303     {
 304         //
 305     }
 306
 307     function getReplyProfiles()
 308     {
 309         $all = parent::getReplyProfiles();
 310
 311         $profiles = array();
 312
 313         $rootAuthor = $this->root->getProfile();
 314
 315         foreach ($all as $profile) {
 316             if ($profile->id != $rootAuthor->id) {
 317                 $profiles[] = $profile;
 318             }
 319         }
 320
 321         return $profiles;
 322     }
 323
 324     function showEnd()
 325     {
 326         $threadActive = null;   // unused here for now, but maybe in the future?
 327         if (Event::handle('StartShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive))) {
 328             $item = new ThreadedNoticeListInlineRepeatsItem($this->notice, $this->out);
 329             $hasRepeats = $item->show();
 330             Event::handle('EndShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive));
 331         }
 332         parent::showEnd();
 333     }
 334 }
 335
 336 /**
 337  * Placeholder for loading more replies...
 338  */
 339 class ThreadedNoticeListMoreItem extends NoticeListItem
 340 {
 341     protected $cnt;
 342
 343     function __construct(Notice $notice, HTMLOutputter $out, $cnt)
 344     {
 345         parent::__construct($notice, $out);
 346         $this->cnt = $cnt;
 347     }
 348
 349     /**
 350      * recipe function for displaying a single notice.
 351      *
 352      * This uses all the other methods to correctly display a notice. Override
 353      * it or one of the others to fine-tune the output.
 354      *
 355      * @return void
 356      */
 357     function show()
 358     {
 359         $this->showStart();
 360         $this->showMiniForm();
 361         $this->showEnd();
 362     }
 363
 364     /**
 365      * start a single notice.
 366      *
 367      * @return void
 368      */
 369     function showStart()
 370     {
 371         $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
 372     }
 373
 374     function showMiniForm()
 375     {
 376         $id = $this->notice->conversation;
 377         $url = common_local_url('conversation', array('id' => $id));
 378
 379         $n = Conversation::noticeCount($id) - 1;
 380
 381         // TRANS: Link to show replies for a notice.
 382         // TRANS: %d is the number of replies to a notice and used for plural.
 383         $msg = sprintf(_m('Show reply', 'Show all %d replies', $n), $n);
 384
 385         $this->out->element('a', array('href' => $url), $msg);
 386     }
 387 }
 388
 389 /**
 390  * Placeholder for reply form...
 391  * Same as get added at runtime via SN.U.NoticeInlineReplyPlaceholder
 392  */
 393 class ThreadedNoticeListReplyItem extends NoticeListItem
 394 {
 395     /**
 396      * recipe function for displaying a single notice.
 397      *
 398      * This uses all the other methods to correctly display a notice. Override
 399      * it or one of the others to fine-tune the output.
 400      *
 401      * @return void
 402      */
 403     function show()
 404     {
 405         $this->showStart();
 406         $this->showMiniForm();
 407         $this->showEnd();
 408     }
 409
 410     /**
 411      * start a single notice.
 412      *
 413      * @return void
 414      */
 415     function showStart()
 416     {
 417         $this->out->elementStart('li', array('class' => 'notice-reply-placeholder'));
 418     }
 419
 420     function showMiniForm()
 421     {
 422         $this->out->element('input', array('class' => 'placeholder',
 423                                            // TRANS: Field label for reply mini form.
 424                                            'value' => _('Write a reply...')));
 425     }
 426 }
 427
 428 /**
 429  * Placeholder for showing repeats...
 430  */
 431 class ThreadedNoticeListRepeatsItem extends NoticeListActorsItem
 432 {
 433     function getProfiles()
 434     {
 435         $repeats = $this->notice->getRepeats();
 436
 437         $profiles = array();
 438
 439         foreach ($repeats as $rep) {
 440             $profiles[] = $rep->profile_id;
 441         }
 442
 443         return $profiles;
 444     }
 445
 446     function magicList($items)
 447     {
 448         if (count($items) > 4) {
 449             return parent::magicList(array_slice($items, 0, 3));
 450         } else {
 451             return parent::magicList($items);
 452         }
 453     }
 454
 455     function getListMessage($count, $you)
 456     {
 457         if ($count == 1 && $you) {
 458             // darn first person being different from third person!
 459             // TRANS: List message for notice repeated by logged in user.
 460             return _m('REPEATLIST', 'You repeated this.');
 461         } else if ($count > 4) {
 462             // TRANS: List message for when more than 4 people repeat something.
 463             // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
 464             // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
 465             return sprintf(_m('%%s and %d other repeated this.',
 466                               '%%s and %d others repeated this.',
 467                               $count - 3),
 468                            $count - 3);
 469         } else {
 470             // TRANS: List message for repeated notices.
 471             // TRANS: %%s is a list of users who have repeated a notice.
 472             // TRANS: Plural is based on the number of of users that have repeated a notice.
 473             return sprintf(_m('%%s repeated this.',
 474                               '%%s repeated this.',
 475                               $count),
 476                            $count);
 477         }
 478     }
 479
 480     function showStart()
 481     {
 482         $this->out->elementStart('li', array('class' => 'notice-data notice-repeats'));
 483     }
 484
 485     function showEnd()
 486     {
 487         $this->out->elementEnd('li');
 488     }
 489 }
 490
 491 // @todo FIXME: needs documentation.
 492 class ThreadedNoticeListInlineRepeatsItem extends ThreadedNoticeListRepeatsItem
 493 {
 494     function showStart()
 495     {
 496         $this->out->elementStart('div', array('class' => 'notice-repeats'));
 497     }
 498
 499     function showEnd()
 500     {
 501         $this->out->elementEnd('div');
 502     }
 503 }