3 * StatusNet, the distributed open-source microblogging tool
5 * widget for displaying a list of notices
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.
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.
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/>.
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/
30 if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
33 * widget for displaying a list of notices
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.
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/
47 * @see ProfileNoticeList
49 class ThreadedNoticeList extends NoticeList
51 protected $userProfile;
53 function __construct(Notice $notice, Action $out=null, $profile=-1)
55 parent::__construct($notice, $out);
56 if (is_int($profile) && $profile == -1) {
57 $profile = Profile::current();
59 $this->userProfile = $profile;
63 * show the list of notices
65 * "Uses up" the stream by looping through it. So, probably can't
66 * be called twice on the same list.
68 * @return int count of notices listed.
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'));
77 $notices = $this->notice->fetchAll();
78 $total = count($notices);
79 $notices = array_slice($notices, 0, NOTICES_PER_PAGE);
81 $allnotices = self::_allNotices($notices);
82 self::prefill($allnotices);
84 $conversations = array();
86 foreach ($notices as $notice) {
88 // Collapse repeats into their originals...
90 if ($notice->repeat_of) {
91 $orig = Notice::getKV('id', $notice->repeat_of);
92 if ($orig instanceof Notice) {
96 $convo = $notice->conversation;
97 if (!empty($conversations[$convo])) {
98 // Seen this convo already -- skip!
101 $conversations[$convo] = true;
103 // Get the convo's root notice
104 $root = $notice->conversationRoot($this->userProfile);
105 if ($root instanceof Notice) {
110 $item = $this->newListItem($notice);
112 } catch (Exception $e) {
113 // we log exceptions and continue
114 common_log(LOG_ERR, $e->getMessage());
119 $this->out->elementEnd('ol');
120 $this->out->elementEnd('div');
125 function _allNotices($notices)
128 foreach ($notices as $notice) {
129 $convId[] = $notice->conversation;
131 $convId = array_unique($convId);
132 $allMap = Notice::listGet('conversation', $convId);
134 foreach ($allMap as $convId => $convNotices) {
135 $allArray = array_merge($allArray, $convNotices);
141 * returns a new list item for the current notice
143 * Recipe (factory?) method; overridden by sub-classes to give
144 * a different list item class.
146 * @param Notice $notice the current notice
148 * @return NoticeListItem a list item for displaying the notice
150 function newListItem(Notice $notice)
152 return new ThreadedNoticeListItem($notice, $this->out, $this->userProfile);
157 * widget for displaying a single notice
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).
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/
171 * @see ProfileNoticeListItem
173 class ThreadedNoticeListItem extends NoticeListItem
175 protected $userProfile = null;
177 function __construct(Notice $notice, Action $out=null, $profile=null)
179 parent::__construct($notice, $out);
180 $this->userProfile = $profile;
183 function initialItems()
191 * Close the last elements in the notice list item
197 $max = $this->initialItems();
198 if (!$this->repeat) {
199 $stream = new ConversationNoticeStream($this->notice->conversation, $this->userProfile);
200 $notice = $stream->getNotices(0, $max + 2);
204 while ($notice->fetch()) {
205 if (Event::handle('StartAddNoticeReply', array($this, $this->notice, $notice))) {
206 // Don't list repeats as separate notices in a conversation
207 if (!empty($notice->repeat_of)) {
211 if ($notice->id == $this->notice->id) {
218 $moreCutoff = clone($notice);
221 $notices[] = clone($notice); // *grumble* inefficient as hell
222 Event::handle('EndAddNoticeReply', array($this, $this->notice, $notice));
226 if (Event::handle('StartShowThreadedNoticeTail', array($this, $this->notice, &$notices))) {
227 $threadActive = count($notices) > 0; // has this thread had any activity?
229 $this->out->elementStart('ul', 'notices threaded-replies xoxo');
231 if (Event::handle('StartShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive))) {
233 // Show the repeats-button for this notice. If there are repeats,
234 // the show() function will return true, definitely setting our
235 // $threadActive flag, which will be used later to show a reply box.
236 $item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
237 $threadActive = $item->show() || $threadActive;
239 Event::handle('EndShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive));
242 if (count($notices)>0) {
244 $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out, count($notices));
247 foreach (array_reverse($notices) as $notice) {
248 if (Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice))) {
249 $item = new ThreadedNoticeListSubItem($notice, $this->notice, $this->out);
251 Event::handle('EndShowThreadedNoticeSub', array($this, $this->notice, $notice));
256 Event::handle('EndShowThreadedNoticeTail', array($this, $this->notice, $notices));
257 $this->out->elementEnd('ul');
265 // @todo FIXME: needs documentation.
266 class ThreadedNoticeListSubItem extends NoticeListItem
268 protected $root = null;
270 function __construct(Notice $notice, $root, $out)
273 parent::__construct($notice, $out);
276 function avatarSize()
278 return AVATAR_STREAM_SIZE; // @fixme would like something in between
281 function showNoticeLocation()
286 function showNoticeSource()
291 function getReplyProfiles()
293 $all = parent::getReplyProfiles();
297 $rootAuthor = $this->root->getProfile();
299 foreach ($all as $profile) {
300 if ($profile->id != $rootAuthor->id) {
301 $profiles[] = $profile;
310 $threadActive = null; // unused here for now, but maybe in the future?
311 if (Event::handle('StartShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive))) {
312 $item = new ThreadedNoticeListInlineRepeatsItem($this->notice, $this->out);
313 $hasRepeats = $item->show();
314 Event::handle('EndShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive));
321 * Placeholder for loading more replies...
323 class ThreadedNoticeListMoreItem extends NoticeListItem
327 function __construct(Notice $notice, Action $out, $cnt)
329 parent::__construct($notice, $out);
334 * recipe function for displaying a single notice.
336 * This uses all the other methods to correctly display a notice. Override
337 * it or one of the others to fine-tune the output.
344 $this->showMiniForm();
349 * start a single notice.
355 $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
360 $this->out->elementEnd('li');
363 function showMiniForm()
365 $id = $this->notice->conversation;
366 $url = common_local_url('conversation', array('id' => $id));
368 $n = Conversation::noticeCount($id) - 1;
370 // TRANS: Link to show replies for a notice.
371 // TRANS: %d is the number of replies to a notice and used for plural.
372 $msg = sprintf(_m('Show reply', 'Show all %d replies', $n), $n);
374 $this->out->element('a', array('href' => $url), $msg);
379 * Placeholder for showing repeats...
381 class ThreadedNoticeListRepeatsItem extends NoticeListActorsItem
383 function getProfiles()
385 $repeats = $this->notice->getRepeats();
389 foreach ($repeats as $rep) {
390 $profiles[] = $rep->profile_id;
396 function magicList($items)
398 if (count($items) > 4) {
399 return parent::magicList(array_slice($items, 0, 3));
401 return parent::magicList($items);
405 function getListMessage($count, $you)
407 if ($count == 1 && $you) {
408 // darn first person being different from third person!
409 // TRANS: List message for notice repeated by logged in user.
410 return _m('REPEATLIST', 'You repeated this.');
411 } else if ($count > 4) {
412 // TRANS: List message for when more than 4 people repeat something.
413 // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
414 // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
415 return sprintf(_m('%%s and %d other repeated this.',
416 '%%s and %d others repeated this.',
420 // TRANS: List message for repeated notices.
421 // TRANS: %%s is a list of users who have repeated a notice.
422 // TRANS: Plural is based on the number of of users that have repeated a notice.
423 return sprintf(_m('%%s repeated this.',
424 '%%s repeated this.',
432 $this->out->elementStart('li', array('class' => 'notice-data notice-repeats'));
437 $this->out->elementEnd('li');
441 // @todo FIXME: needs documentation.
442 class ThreadedNoticeListInlineRepeatsItem extends ThreadedNoticeListRepeatsItem
446 $this->out->elementStart('div', array('class' => 'notice-repeats'));
451 $this->out->elementEnd('div');