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
  52 class ThreadedNoticeList extends NoticeList
  53 {
  54     /**
  55      * show the list of notices
  56      *
  57      * "Uses up" the stream by looping through it. So, probably can't
  58      * be called twice on the same list.
  59      *
  60      * @return int count of notices listed.
  61      */
  62
  63     function show()
  64     {
  65         $this->out->elementStart('div', array('id' =>'notices_primary'));
  66         $this->out->element('h2', null, _('Notices'));
  67         $this->out->elementStart('ol', array('class' => 'notices threaded-notices xoxo'));
  68
  69         $cnt = 0;
  70         $conversations = array();
  71         while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
  72             $cnt++;
  73
  74             if ($cnt > NOTICES_PER_PAGE) {
  75                 break;
  76             }
  77
  78             $convo = $this->notice->conversation;
  79             if (!empty($conversations[$convo])) {
  80                 // Seen this convo already -- skip!
  81                 continue;
  82             }
  83             $conversations[$convo] = true;
  84
  85             // Get the convo's root notice
  86             // @fixme stream goes in wrong direction, this needs sane caching
  87             //$notice = Notice::conversationStream($convo, 0, 1);
  88             //$notice->fetch();
  89             $notice = new Notice();
  90             $notice->conversation = $this->notice->conversation;
  91             $notice->orderBy('CREATED');
  92             $notice->limit(1);
  93             $notice->find(true);
  94
  95             try {
  96                 $item = $this->newListItem($notice);
  97                 $item->show();
  98             } catch (Exception $e) {
  99                 // we log exceptions and continue
 100                 common_log(LOG_ERR, $e->getMessage());
 101                 continue;
 102             }
 103         }
 104
 105         $this->out->elementEnd('ol');
 106         $this->out->elementEnd('div');
 107
 108         return $cnt;
 109     }
 110
 111     /**
 112      * returns a new list item for the current notice
 113      *
 114      * Recipe (factory?) method; overridden by sub-classes to give
 115      * a different list item class.
 116      *
 117      * @param Notice $notice the current notice
 118      *
 119      * @return NoticeListItem a list item for displaying the notice
 120      */
 121
 122     function newListItem($notice)
 123     {
 124         return new ThreadedNoticeListItem($notice, $this->out);
 125     }
 126 }
 127
 128 /**
 129  * widget for displaying a single notice
 130  *
 131  * This widget has the core smarts for showing a single notice: what to display,
 132  * where, and under which circumstances. Its key method is show(); this is a recipe
 133  * that calls all the other show*() methods to build up a single notice. The
 134  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 135  * author info (since that's implicit by the data in the page).
 136  *
 137  * @category UI
 138  * @package  StatusNet
 139  * @author   Evan Prodromou <evan@status.net>
 140  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 141  * @link     http://status.net/
 142  * @see      NoticeList
 143  * @see      ProfileNoticeListItem
 144  */
 145
 146 class ThreadedNoticeListItem extends NoticeListItem
 147 {
 148     const INITIAL_ITEMS = 3;
 149
 150     function showContext()
 151     {
 152         // Silence!
 153     }
 154
 155     /**
 156      * finish the notice
 157      *
 158      * Close the last elements in the notice list item
 159      *
 160      * @return void
 161      */
 162
 163     function showEnd()
 164     {
 165         if (!$this->repeat) {
 166             $notice = Notice::conversationStream($this->notice->conversation, 0, self::INITIAL_ITEMS + 2);
 167             $notices = array();
 168             $cnt = 0;
 169             $moreCutoff = null;
 170             while ($notice->fetch()) {
 171                 if ($notice->id == $this->notice->id) {
 172                     // Skip!
 173                     continue;
 174                 }
 175                 $cnt++;
 176                 if ($cnt > self::INITIAL_ITEMS) {
 177                     // boo-yah
 178                     $moreCutoff = clone($notice);
 179                     break;
 180                 }
 181                 $notices[] = clone($notice); // *grumble* inefficient as hell
 182             }
 183
 184             $this->out->elementStart('ul', 'notices threaded-replies xoxo');
 185             $item = new ThreadedNoticeListFavesItem($this->notice, $this->out);
 186             $hasFaves = $item->show();
 187             if ($notices) {
 188                 if ($moreCutoff) {
 189                     $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out);
 190                     $item->show();
 191                 }
 192                 foreach (array_reverse($notices) as $notice) {
 193                     $item = new ThreadedNoticeListSubItem($notice, $this->out);
 194                     $item->show();
 195                 }
 196             }
 197             if ($notices || $hasFaves) {
 198                 // @fixme do a proper can-post check that's consistent
 199                 // with the JS side
 200                 if (common_current_user()) {
 201                     $item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
 202                     $item->show();
 203                 }
 204             }
 205             $this->out->elementEnd('ul');
 206         }
 207
 208         parent::showEnd();
 209     }
 210 }
 211
 212 class ThreadedNoticeListSubItem extends NoticeListItem
 213 {
 214
 215     function avatarSize()
 216     {
 217         return AVATAR_STREAM_SIZE; // @fixme would like something in between
 218     }
 219
 220     function showNoticeLocation()
 221     {
 222         //
 223     }
 224
 225     function showNoticeSource()
 226     {
 227         //
 228     }
 229
 230     function showContext()
 231     {
 232         //
 233     }
 234
 235     function showEnd()
 236     {
 237         $item = new ThreadedNoticeListInlineFavesItem($this->notice, $this->out);
 238         $hasFaves = $item->show();
 239         parent::showEnd();
 240     }
 241 }
 242
 243 /**
 244  * Placeholder for loading more replies...
 245  */
 246 class ThreadedNoticeListMoreItem extends NoticeListItem
 247 {
 248
 249     /**
 250      * recipe function for displaying a single notice.
 251      *
 252      * This uses all the other methods to correctly display a notice. Override
 253      * it or one of the others to fine-tune the output.
 254      *
 255      * @return void
 256      */
 257
 258     function show()
 259     {
 260         $this->showStart();
 261         $this->showMiniForm();
 262         $this->showEnd();
 263     }
 264
 265     /**
 266      * start a single notice.
 267      *
 268      * @return void
 269      */
 270
 271     function showStart()
 272     {
 273         $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
 274     }
 275
 276     function showMiniForm()
 277     {
 278         $id = $this->notice->conversation;
 279         $url = common_local_url('conversation', array('id' => $id)) . '#notice-' . $this->notice->id;
 280
 281         $notice = new Notice();
 282         $notice->conversation = $id;
 283         $n = $notice->count() - 1;
 284         $msg = sprintf(_m('Show %d reply', 'Show all %d replies', $n), $n);
 285
 286         $this->out->element('a', array('href' => $url), $msg);
 287     }
 288 }
 289
 290
 291 /**
 292  * Placeholder for reply form...
 293  * Same as get added at runtime via SN.U.NoticeInlineReplyPlaceholder
 294  */
 295 class ThreadedNoticeListReplyItem extends NoticeListItem
 296 {
 297
 298     /**
 299      * recipe function for displaying a single notice.
 300      *
 301      * This uses all the other methods to correctly display a notice. Override
 302      * it or one of the others to fine-tune the output.
 303      *
 304      * @return void
 305      */
 306
 307     function show()
 308     {
 309         $this->showStart();
 310         $this->showMiniForm();
 311         $this->showEnd();
 312     }
 313
 314     /**
 315      * start a single notice.
 316      *
 317      * @return void
 318      */
 319
 320     function showStart()
 321     {
 322         $this->out->elementStart('li', array('class' => 'notice-reply-placeholder'));
 323     }
 324
 325     function showMiniForm()
 326     {
 327         $this->out->element('input', array('class' => 'placeholder',
 328                                            'value' => _('Write a reply...')));
 329     }
 330 }
 331
 332 /**
 333  * Placeholder for showing faves...
 334  */
 335 class ThreadedNoticeListFavesItem extends NoticeListItem
 336 {
 337     function show()
 338     {
 339         // @fixme caching & scalability!
 340         $fave = new Fave();
 341         $fave->notice_id = $this->notice->id;
 342         $fave->find();
 343
 344         $cur = common_current_user();
 345         $profiles = array();
 346         $you = false;
 347         while ($fave->fetch()) {
 348             if ($cur && $cur->id == $fave->user_id) {
 349                 $you = true;
 350             } else {
 351                 $profiles[] = $fave->user_id;
 352             }
 353         }
 354
 355         $links = array();
 356         if ($you) {
 357             $links[] = _m('FAVELIST', 'You');
 358         }
 359         foreach ($profiles as $id) {
 360             $profile = Profile::staticGet('id', $id);
 361             if ($profile) {
 362                 $links[] = sprintf('<a href="%s" title="%s">%s</a>',
 363                                    htmlspecialchars($profile->profileurl),
 364                                    htmlspecialchars($profile->getBestName()),
 365                                    htmlspecialchars($profile->nickname));
 366             }
 367         }
 368
 369         if ($links) {
 370             $count = count($links);
 371             if ($count == 1 && $you) {
 372                 // darn first person being different from third person!
 373                 $msg = _m('FAVELIST', 'You have favored this notice.');
 374             } else {
 375                 // if 'you' is the first item,
 376                 $msg = _m('FAVELIST', '%1$s has favored this notice.', '%1$s have favored this notice.', $count);
 377             }
 378             $out = sprintf($msg, $this->magicList($links));
 379
 380             $this->showStart();
 381             $this->out->raw($out);
 382             $this->showEnd();
 383             return $count;
 384         } else {
 385             return 0;
 386         }
 387     }
 388
 389     function showStart()
 390     {
 391         $this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
 392     }
 393
 394     function showEnd()
 395     {
 396         $this->out->elementEnd('li');
 397     }
 398
 399     function magicList($items)
 400     {
 401         if (count($items) == 0) {
 402             return '';
 403         } else if (count($items) == 1) {
 404             return $items[0];
 405         } else {
 406             $first = array_slice($items, 0, -1);
 407             $last = array_slice($items, -1, 1);
 408             // TRANS For building a list such as "You, bob, mary and 5 others have favored this notice".
 409             return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode(', ', $first), implode(', ', $last));
 410         }
 411     }
 412 }
 413
 414 class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
 415 {
 416     function showStart()
 417     {
 418         $this->out->elementStart('div', array('class' => 'entry-content notice-faves'));
 419     }
 420
 421     function showEnd()
 422     {
 423         $this->out->elementEnd('div');
 424     }
 425 }