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     /**
 151      * finish the notice
 152      *
 153      * Close the last elements in the notice list item
 154      *
 155      * @return void
 156      */
 157
 158     function showEnd()
 159     {
 160         $notice = Notice::conversationStream($this->notice->conversation, 0, self::INITIAL_ITEMS + 2);
 161         $notices = array();
 162         $cnt = 0;
 163         $moreCutoff = null;
 164         while ($notice->fetch()) {
 165             if ($notice->id == $this->notice->id) {
 166                 // Skip!
 167                 continue;
 168             }
 169             $cnt++;
 170             if ($cnt > self::INITIAL_ITEMS) {
 171                 // boo-yah
 172                 $moreCutoff = clone($notice);
 173                 break;
 174             }
 175             $notices[] = clone($notice); // *grumble* inefficient as hell
 176         }
 177
 178         if ($notices) {
 179             $this->out->elementStart('ul', 'notices threaded-notices xoxo');
 180             if ($moreCutoff) {
 181                 $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out);
 182                 $item->show();
 183             }
 184             foreach (array_reverse($notices) as $notice) {
 185                 $item = new ThreadedNoticeListSubItem($notice, $this->out);
 186                 $item->show();
 187             }
 188             $this->out->elementEnd('ul');
 189         }
 190
 191         parent::showEnd();
 192     }
 193 }
 194
 195 class ThreadedNoticeListSubItem extends NoticeListItem
 196 {
 197
 198     function avatarSize()
 199     {
 200         return AVATAR_STREAM_SIZE; // @fixme would like something in between
 201     }
 202
 203     function showNoticeLocation()
 204     {
 205         //
 206     }
 207
 208     function showNoticeSource()
 209     {
 210         //
 211     }
 212 }
 213
 214 /**
 215  * Placeholder for loading more replies...
 216  */
 217 class ThreadedNoticeListMoreItem extends NoticeListItem
 218 {
 219
 220     /**
 221      * recipe function for displaying a single notice.
 222      *
 223      * This uses all the other methods to correctly display a notice. Override
 224      * it or one of the others to fine-tune the output.
 225      *
 226      * @return void
 227      */
 228
 229     function show()
 230     {
 231         $this->showStart();
 232         $this->showMiniForm();
 233         $this->showEnd();
 234     }
 235
 236     /**
 237      * start a single notice.
 238      *
 239      * @return void
 240      */
 241
 242     function showStart()
 243     {
 244         if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
 245             $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
 246             $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
 247         }
 248     }
 249
 250     function showMiniForm()
 251     {
 252         $id = $this->notice->conversation;
 253         $url = common_local_url('conversation', array('id' => $id)) . '#notice-' . $this->notice->id;
 254
 255         $notice = new Notice();
 256         $notice->conversation = $id;
 257         $n = $notice->count() - 1;
 258         $msg = sprintf(_m('Show all %d comment', 'Show all %d comments', $n), $n);
 259
 260         $this->out->element('a', array('href' => $url), $msg);
 261
 262         // @fixme replace this with an ajax-friendly form pair?
 263         /*
 264         $this->out->elementStart('form',
 265                                  array('id' => $id,
 266                                        'class' => 'replyform',
 267                                        'method' => 'post',
 268                                        'action' => $url));
 269         $this->out->hidden('token', common_session_token());
 270         $this->out->hidden("$id-inreplyto", $replyToId, "inreplyto");
 271         $this->out->element('textarea', array('name' => 'status_textarea'));
 272         $this->out->elementStart('div', array('class' => 'controls'));
 273         $this->out->submit("$id-submit", _m('Send reply'));
 274         $this->out->elementEnd('div');
 275         $this->out->elementEnd('form');
 276          */
 277     }
 278 }