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, HTMLOutputter $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, HTMLOutputter $out=null, $profile=null)
179 parent::__construct($notice, $out);
180 $this->userProfile = $profile;
183 function initialItems()
188 function showContext()
196 * Close the last elements in the notice list item
202 $max = $this->initialItems();
203 if (!$this->repeat) {
204 $stream = new ConversationNoticeStream($this->notice->conversation, $this->userProfile);
205 $notice = $stream->getNotices(0, $max + 2);
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)) {
216 if ($notice->id == $this->notice->id) {
223 $moreCutoff = clone($notice);
226 $notices[] = clone($notice); // *grumble* inefficient as hell
227 Event::handle('EndAddNoticeReply', array($this, $this->notice, $notice));
231 if (Event::handle('StartShowThreadedNoticeTail', array($this, $this->notice, &$notices))) {
232 $this->out->elementStart('ul', 'notices threaded-replies xoxo');
234 $item = new ThreadedNoticeListFavesItem($this->notice, $this->out);
235 $hasFaves = $item->show();
237 $item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
238 $hasRepeats = $item->show();
243 $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out, count($notices));
246 foreach (array_reverse($notices) as $notice) {
247 if (Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice))) {
248 $item = new ThreadedNoticeListSubItem($notice, $this->notice, $this->out);
250 Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice));
255 if ($notices || $hasFaves || $hasRepeats) {
256 // @fixme do a proper can-post check that's consistent
258 if (common_current_user()) {
259 $item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
263 $this->out->elementEnd('ul');
264 Event::handle('EndShowThreadedNoticeTail', array($this, $this->notice, $notices));
272 // @todo FIXME: needs documentation.
273 class ThreadedNoticeListSubItem extends NoticeListItem
275 protected $root = null;
277 function __construct(Notice $notice, $root, $out)
280 parent::__construct($notice, $out);
283 function avatarSize()
285 return AVATAR_STREAM_SIZE; // @fixme would like something in between
288 function showNoticeLocation()
293 function showNoticeSource()
298 function showContext()
303 function getReplyProfiles()
305 $all = parent::getReplyProfiles();
309 $rootAuthor = $this->root->getProfile();
311 foreach ($all as $profile) {
312 if ($profile->id != $rootAuthor->id) {
313 $profiles[] = $profile;
322 $item = new ThreadedNoticeListInlineFavesItem($this->notice, $this->out);
323 $hasFaves = $item->show();
324 $item = new ThreadedNoticeListInlineRepeatsItem($this->notice, $this->out);
325 $hasRepeats = $item->show();
331 * Placeholder for loading more replies...
333 class ThreadedNoticeListMoreItem extends NoticeListItem
337 function __construct(Notice $notice, HTMLOutputter $out, $cnt)
339 parent::__construct($notice, $out);
344 * recipe function for displaying a single notice.
346 * This uses all the other methods to correctly display a notice. Override
347 * it or one of the others to fine-tune the output.
354 $this->showMiniForm();
359 * start a single notice.
365 $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
368 function showMiniForm()
370 $id = $this->notice->conversation;
371 $url = common_local_url('conversation', array('id' => $id));
373 $n = Conversation::noticeCount($id) - 1;
375 // TRANS: Link to show replies for a notice.
376 // TRANS: %d is the number of replies to a notice and used for plural.
377 $msg = sprintf(_m('Show reply', 'Show all %d replies', $n), $n);
379 $this->out->element('a', array('href' => $url), $msg);
384 * Placeholder for reply form...
385 * Same as get added at runtime via SN.U.NoticeInlineReplyPlaceholder
387 class ThreadedNoticeListReplyItem extends NoticeListItem
390 * recipe function for displaying a single notice.
392 * This uses all the other methods to correctly display a notice. Override
393 * it or one of the others to fine-tune the output.
400 $this->showMiniForm();
405 * start a single notice.
411 $this->out->elementStart('li', array('class' => 'notice-reply-placeholder'));
414 function showMiniForm()
416 $this->out->element('input', array('class' => 'placeholder',
417 // TRANS: Field label for reply mini form.
418 'value' => _('Write a reply...')));
423 * Placeholder for showing faves...
425 abstract class NoticeListActorsItem extends NoticeListItem
428 * @return array of profile IDs
430 abstract function getProfiles();
432 abstract function getListMessage($count, $you);
438 $cur = common_current_user();
439 foreach ($this->getProfiles() as $id) {
440 if ($cur && $cur->id == $id) {
442 // TRANS: Reference to the logged in user in favourite list.
443 array_unshift($links, _m('FAVELIST', 'You'));
445 $profile = Profile::getKV('id', $id);
446 if ($profile instanceof Profile) {
447 $links[] = sprintf('<a class="h-card" href="%s">%s</a>',
448 htmlspecialchars($profile->getUrl()),
449 htmlspecialchars($profile->getBestName()));
455 $count = count($links);
456 $msg = $this->getListMessage($count, $you);
457 $out = sprintf($msg, $this->magicList($links));
460 $this->out->raw($out);
468 function magicList($items)
470 if (count($items) == 0) {
472 } else if (count($items) == 1) {
475 $first = array_slice($items, 0, -1);
476 $last = array_slice($items, -1, 1);
477 // TRANS: Separator in list of user names like "Jim, Bob, Mary".
478 $separator = _(', ');
479 // TRANS: For building a list such as "Jim, Bob, Mary and 5 others like this".
480 // TRANS: %1$s is a list of users, separated by a separator (default: ", "), %2$s is the last user in the list.
481 return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode($separator, $first), implode($separator, $last));
487 * Placeholder for showing faves...
489 class ThreadedNoticeListFavesItem extends NoticeListActorsItem
491 function getProfiles()
493 $faves = $this->notice->getFaves();
495 foreach ($faves as $fave) {
496 $profiles[] = $fave->user_id;
501 function magicList($items)
503 if (count($items) > 4) {
504 return parent::magicList(array_slice($items, 0, 3));
506 return parent::magicList($items);
510 function getListMessage($count, $you)
512 if ($count == 1 && $you) {
513 // darn first person being different from third person!
514 // TRANS: List message for notice favoured by logged in user.
515 return _m('FAVELIST', 'You like this.');
516 } else if ($count > 4) {
517 // TRANS: List message for when more than 4 people like something.
518 // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
519 // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
520 return sprintf(_m('%%s and %d others like this.',
521 '%%s and %d others like this.',
525 // TRANS: List message for favoured notices.
526 // TRANS: %%s is a list of users liking a notice.
527 // TRANS: Plural is based on the number of of users that have favoured a notice.
528 return sprintf(_m('%%s likes this.',
537 $this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
542 $this->out->elementEnd('li');
546 // @todo FIXME: needs documentation.
547 class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
551 $this->out->elementStart('div', array('class' => 'notice-faves'));
556 $this->out->elementEnd('div');
561 * Placeholder for showing repeats...
563 class ThreadedNoticeListRepeatsItem extends NoticeListActorsItem
565 function getProfiles()
567 $repeats = $this->notice->getRepeats();
571 foreach ($repeats as $rep) {
572 $profiles[] = $rep->profile_id;
578 function magicList($items)
580 if (count($items) > 4) {
581 return parent::magicList(array_slice($items, 0, 3));
583 return parent::magicList($items);
587 function getListMessage($count, $you)
589 if ($count == 1 && $you) {
590 // darn first person being different from third person!
591 // TRANS: List message for notice repeated by logged in user.
592 return _m('REPEATLIST', 'You repeated this.');
593 } else if ($count > 4) {
594 // TRANS: List message for when more than 4 people repeat something.
595 // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
596 // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
597 return sprintf(_m('%%s and %d other repeated this.',
598 '%%s and %d others repeated this.',
602 // TRANS: List message for favoured notices.
603 // TRANS: %%s is a list of users liking a notice.
604 // TRANS: Plural is based on the number of of users that have favoured a notice.
605 return sprintf(_m('%%s repeated this.',
606 '%%s repeated this.',
614 $this->out->elementStart('li', array('class' => 'notice-data notice-repeats'));
619 $this->out->elementEnd('li');
623 // @todo FIXME: needs documentation.
624 class ThreadedNoticeListInlineRepeatsItem extends ThreadedNoticeListRepeatsItem
628 $this->out->elementStart('div', array('class' => 'notice-repeats'));
633 $this->out->elementEnd('div');