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 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             if ($notices) {
 185                 $this->out->elementStart('ul', 'notices threaded-notices xoxo');
 186                 if ($moreCutoff) {
 187                     $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out);
 188                     $item->show();
 189                 }
 190                 foreach (array_reverse($notices) as $notice) {
 191                     $item = new ThreadedNoticeListSubItem($notice, $this->out);
 192                     $item->show();
 193                 }
 194                 $this->out->elementEnd('ul');
 195             }
 196         }
 197
 198         parent::showEnd();
 199     }
 200 }
 201
 202 class ThreadedNoticeListSubItem extends NoticeListItem
 203 {
 204
 205     function avatarSize()
 206     {
 207         return AVATAR_STREAM_SIZE; // @fixme would like something in between
 208     }
 209
 210     function showNoticeLocation()
 211     {
 212         //
 213     }
 214
 215     function showNoticeSource()
 216     {
 217         //
 218     }
 219
 220     function showContext()
 221     {
 222         //
 223     }
 224 }
 225
 226 /**
 227  * Placeholder for loading more replies...
 228  */
 229 class ThreadedNoticeListMoreItem extends NoticeListItem
 230 {
 231
 232     /**
 233      * recipe function for displaying a single notice.
 234      *
 235      * This uses all the other methods to correctly display a notice. Override
 236      * it or one of the others to fine-tune the output.
 237      *
 238      * @return void
 239      */
 240
 241     function show()
 242     {
 243         $this->showStart();
 244         $this->showMiniForm();
 245         $this->showEnd();
 246     }
 247
 248     /**
 249      * start a single notice.
 250      *
 251      * @return void
 252      */
 253
 254     function showStart()
 255     {
 256         if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
 257             $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
 258             $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
 259         }
 260     }
 261
 262     function showMiniForm()
 263     {
 264         $id = $this->notice->conversation;
 265         $url = common_local_url('conversation', array('id' => $id)) . '#notice-' . $this->notice->id;
 266
 267         $notice = new Notice();
 268         $notice->conversation = $id;
 269         $n = $notice->count() - 1;
 270         $msg = sprintf(_m('Show all %d comment', 'Show all %d comments', $n), $n);
 271
 272         $this->out->element('a', array('href' => $url), $msg);
 273
 274         // @fixme replace this with an ajax-friendly form pair?
 275         /*
 276         $this->out->elementStart('form',
 277                                  array('id' => $id,
 278                                        'class' => 'replyform',
 279                                        'method' => 'post',
 280                                        'action' => $url));
 281         $this->out->hidden('token', common_session_token());
 282         $this->out->hidden("$id-inreplyto", $replyToId, "inreplyto");
 283         $this->out->element('textarea', array('name' => 'status_textarea'));
 284         $this->out->elementStart('div', array('class' => 'controls'));
 285         $this->out->submit("$id-submit", _m('Send reply'));
 286         $this->out->elementEnd('div');
 287         $this->out->elementEnd('form');
 288          */
 289     }
 290 }