3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * An item in a notice list
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Evan Prodromou <evan@status.net>
26 * @copyright 2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * widget for displaying a single notice
40 * This widget has the core smarts for showing a single notice: what to display,
41 * where, and under which circumstances. Its key method is show(); this is a recipe
42 * that calls all the other show*() methods to build up a single notice. The
43 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
44 * author info (since that's implicit by the data in the page).
48 * @author Evan Prodromou <evan@status.net>
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50 * @link http://status.net/
52 * @see ProfileNoticeListItem
54 class NoticeListItem extends Widget
56 /** The notice this item will show. */
59 /** The notice that was repeated. */
62 /** The profile of the author of the notice, extracted once for convenience. */
68 * Also initializes the profile attribute.
70 * @param Notice $notice The notice we'll display
72 function __construct($notice, $out=null)
74 parent::__construct($out);
75 if (!empty($notice->repeat_of)) {
76 $original = Notice::staticGet('id', $notice->repeat_of);
77 if (empty($original)) { // could have been deleted
78 $this->notice = $notice;
80 $this->notice = $original;
81 $this->repeat = $notice;
84 $this->notice = $notice;
86 $this->profile = $this->notice->getProfile();
90 * recipe function for displaying a single notice.
92 * This uses all the other methods to correctly display a notice. Override
93 * it or one of the others to fine-tune the output.
99 if (empty($this->notice)) {
100 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
102 } else if (empty($this->profile)) {
103 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
108 if (Event::handle('StartShowNoticeItem', array($this))) {
110 $this->showNoticeAttachments();
111 $this->showNoticeInfo();
112 $this->showNoticeOptions();
113 Event::handle('EndShowNoticeItem', array($this));
118 function showNotice()
120 $this->out->elementStart('div', 'entry-title');
122 $this->showContent();
123 $this->out->elementEnd('div');
126 function showNoticeInfo()
128 $this->out->elementStart('div', 'entry-content');
129 if (Event::handle('StartShowNoticeInfo', array($this))) {
130 $this->showNoticeLink();
131 $this->showNoticeSource();
132 $this->showNoticeLocation();
133 $this->showContext();
135 Event::handle('EndShowNoticeInfo', array($this));
138 $this->out->elementEnd('div');
141 function showNoticeOptions()
143 if (Event::handle('StartShowNoticeOptions', array($this))) {
144 $user = common_current_user();
146 $this->out->elementStart('div', 'notice-options');
147 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
148 $this->showFaveForm();
149 $this->showReplyLink();
150 $this->showRepeatForm();
151 $this->showDeleteLink();
152 Event::handle('EndShowNoticeOptionItems', array($this));
154 $this->out->elementEnd('div');
156 Event::handle('EndShowNoticeOptions', array($this));
161 * start a single notice.
167 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
168 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
169 $class = 'hentry notice';
170 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
171 $class .= ' limited-scope';
173 if (!empty($this->notice->source)) {
174 $class .= ' notice-source-'.$this->notice->source;
176 $this->out->elementStart('li', array('class' => $class,
177 'id' => 'notice-' . $id));
178 Event::handle('EndOpenNoticeListItemElement', array($this));
183 * show the "favorite" form
187 function showFaveForm()
189 if (Event::handle('StartShowFaveForm', array($this))) {
190 $user = common_current_user();
192 if ($user->hasFave($this->notice)) {
193 $disfavor = new DisfavorForm($this->out, $this->notice);
196 $favor = new FavorForm($this->out, $this->notice);
200 Event::handle('EndShowFaveForm', array($this));
205 * show the author of a notice
207 * By default, this shows the avatar and (linked) nickname of the author.
212 function showAuthor()
214 $this->out->elementStart('div', 'author');
216 $this->out->elementStart('span', 'vcard author');
218 $attrs = array('href' => $this->profile->profileurl,
220 'title' => $this->profile->nickname);
222 $this->out->elementStart('a', $attrs);
224 $this->out->text(' ');
225 $user = common_current_user();
226 if (!empty($user) && $user->streamNicknames()) {
227 $this->out->element('span',array('class' => 'fn'),
228 $this->profile->nickname);
230 $this->out->element('span',array('class' => 'fn'),
231 $this->profile->getBestName());
233 $this->out->elementEnd('a');
235 $this->out->elementEnd('span');
237 $this->showAddressees();
239 $this->out->elementEnd('div');
242 function showAddressees()
244 $ga = $this->getGroupAddressees();
245 $pa = $this->getProfileAddressees();
247 $a = array_merge($ga, $pa);
250 $this->out->elementStart('span', 'addressees');
252 foreach ($a as $addr) {
254 // TRANS: Separator in profile addressees list.
255 $this->out->text(_m('SEPARATOR',', '));
257 // Start of profile addressees list.
260 $text = $addr['text'];
261 unset($addr['text']);
262 $this->out->element('a', $addr, $text);
264 $this->out->elementEnd('span', 'addressees');
268 function getGroupAddressees()
272 $groups = $this->getGroups();
274 $user = common_current_user();
276 $streamNicknames = !empty($user) && $user->streamNicknames();
278 foreach ($groups as $group) {
279 $ga[] = array('href' => $group->homeUrl(),
280 'title' => $group->nickname,
281 'class' => 'addressee group',
282 'text' => ($streamNicknames) ? $group->nickname : $group->getBestName());
290 return $this->notice->getGroups();
293 function getProfileAddressees()
297 $replies = $this->getReplyProfiles();
299 $user = common_current_user();
301 $streamNicknames = !empty($user) && $user->streamNicknames();
303 foreach ($replies as $reply) {
304 $pa[] = array('href' => $reply->profileurl,
305 'title' => $reply->nickname,
306 'class' => 'addressee account',
307 'text' => ($streamNicknames) ? $reply->nickname : $reply->getBestName());
313 function getReplyProfiles()
315 return $this->notice->getReplyProfiles();
319 * show the avatar of the notice's author
321 * This will use the default avatar if no avatar is assigned for the author.
322 * It makes a link to the author's profile.
326 function showAvatar()
328 $avatar_size = $this->avatarSize();
330 $avatar = $this->profile->getAvatar($avatar_size);
332 $this->out->element('img', array('src' => ($avatar) ?
333 $avatar->displayUrl() :
334 Avatar::defaultImage($avatar_size),
335 'class' => 'avatar photo',
336 'width' => $avatar_size,
337 'height' => $avatar_size,
339 ($this->profile->fullname) ?
340 $this->profile->fullname :
341 $this->profile->nickname));
344 function avatarSize()
346 return AVATAR_STREAM_SIZE;
350 * show the nickname of the author
352 * Links to the author's profile page
356 function showNickname()
358 $this->out->raw('<span class="nickname fn">' .
359 htmlspecialchars($this->profile->nickname) .
364 * show the content of the notice
366 * Shows the content of the notice. This is pre-rendered for efficiency
367 * at save time. Some very old notices might not be pre-rendered, so
368 * they're rendered on the spot.
372 function showContent()
374 // FIXME: URL, image, video, audio
375 $this->out->elementStart('p', array('class' => 'entry-content'));
376 if ($this->notice->rendered) {
377 $this->out->raw($this->notice->rendered);
379 // XXX: may be some uncooked notices in the DB,
380 // we cook them right now. This should probably disappear in future
381 // versions (>> 0.4.x)
382 $this->out->raw(common_render_content($this->notice->content, $this->notice));
384 $this->out->elementEnd('p');
387 function showNoticeAttachments() {
388 if (common_config('attachments', 'show_thumbs')) {
389 $al = new InlineAttachmentList($this->notice, $this->out);
395 * show the link to the main page for the notice
397 * Displays a link to the page for a notice, with "relative" time. Tries to
398 * get remote notice URLs correct, but doesn't always succeed.
402 function showNoticeLink()
404 $noticeurl = $this->notice->bestUrl();
406 // above should always return an URL
408 assert(!empty($noticeurl));
410 $this->out->elementStart('a', array('rel' => 'bookmark',
411 'class' => 'timestamp',
412 'href' => $noticeurl));
413 $dt = common_date_iso8601($this->notice->created);
414 $this->out->element('abbr', array('class' => 'published',
416 common_date_string($this->notice->created));
417 $this->out->elementEnd('a');
421 * show the notice location
423 * shows the notice location in the correct language.
425 * If an URL is available, makes a link. Otherwise, just a span.
429 function showNoticeLocation()
431 $id = $this->notice->id;
433 $location = $this->notice->getLocation();
435 if (empty($location)) {
439 $name = $location->getName();
441 $lat = $this->notice->lat;
442 $lon = $this->notice->lon;
443 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
446 $latdms = $this->decimalDegreesToDMS(abs($lat));
447 $londms = $this->decimalDegreesToDMS(abs($lon));
448 // TRANS: Used in coordinates as abbreviation of north.
450 // TRANS: Used in coordinates as abbreviation of south.
452 // TRANS: Used in coordinates as abbreviation of east.
454 // TRANS: Used in coordinates as abbreviation of west.
457 // TRANS: Coordinates message.
458 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
459 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
460 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
461 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
462 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
463 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
464 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
467 $url = $location->getUrl();
469 $this->out->text(' ');
470 $this->out->elementStart('span', array('class' => 'location'));
471 // TRANS: Followed by geo location.
472 $this->out->text(_('at'));
473 $this->out->text(' ');
475 $this->out->element('abbr', array('class' => 'geo',
479 $xstr = new XMLStringer(false);
480 $xstr->elementStart('a', array('href' => $url,
481 'rel' => 'external'));
482 $xstr->element('abbr', array('class' => 'geo',
485 $xstr->elementEnd('a');
486 $this->out->raw($xstr->getString());
488 $this->out->elementEnd('span');
492 * @param number $dec decimal degrees
493 * @return array split into 'deg', 'min', and 'sec'
495 function decimalDegreesToDMS($dec)
498 $tempma = abs($dec) - abs($deg);
500 $tempma = $tempma * 3600;
501 $min = floor($tempma / 60);
502 $sec = $tempma - ($min*60);
504 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
508 * Show the source of the notice
510 * Either the name (and link) of the API client that posted the notice,
511 * or one of other other channels.
515 function showNoticeSource()
517 $ns = $this->notice->getSource();
520 // TRANS: A possible notice source (web interface).
521 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
522 $this->out->text(' ');
523 $this->out->elementStart('span', 'source');
524 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
525 // TRANS: Followed by notice source.
526 $this->out->text(_('from'));
527 $this->out->text(' ');
529 $name = $source_name;
533 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
534 $name = $source_name;
537 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
539 // if $ns->name and $ns->url are populated we have
540 // configured a source attr somewhere
541 if (!empty($name) && !empty($url)) {
542 $this->out->elementStart('span', 'device');
549 if (!empty($title)) {
550 $attrs['title'] = $title;
553 $this->out->element('a', $attrs, $name);
554 $this->out->elementEnd('span');
556 $this->out->element('span', 'device', $name);
559 $this->out->elementEnd('span');
564 * show link to notice this notice is a reply to
566 * If this notice is a reply, show a link to the notice it is replying to. The
567 * heavy lifting for figuring out replies happens at save time.
571 function showContext()
573 if ($this->notice->hasConversation()) {
574 $conv = Conversation::staticGet(
576 $this->notice->conversation
578 $convurl = $conv->uri;
579 if (!empty($convurl)) {
580 $this->out->text(' ');
584 'href' => $convurl.'#notice-'.$this->notice->id,
585 'class' => 'response'),
586 // TRANS: Addition in notice list item if notice is part of a conversation.
591 "Couldn't find Conversation ID %d to make 'in context'"
592 . "link for Notice ID %d",
593 $this->notice->conversation,
596 common_log(LOG_WARNING, $msg);
602 * show a link to the author of repeat
606 function showRepeat()
608 if (!empty($this->repeat)) {
610 $repeater = Profile::staticGet('id', $this->repeat->profile_id);
612 $attrs = array('href' => $repeater->profileurl,
615 if (!empty($repeater->fullname)) {
616 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
619 $this->out->elementStart('span', 'repeat vcard');
621 // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
622 $this->out->raw(_('Repeated by'));
623 $this->out->raw(' ');
625 $this->out->elementStart('a', $attrs);
626 $this->out->element('span', 'fn nickname', $repeater->nickname);
627 $this->out->elementEnd('a');
629 $this->out->elementEnd('span');
634 * show a link to reply to the current notice
636 * Should either do the reply in the current notice form (if available), or
637 * link out to the notice-posting form. A little flakey, doesn't always work.
641 function showReplyLink()
643 if (common_logged_in()) {
644 $this->out->text(' ');
645 $reply_url = common_local_url('newnotice',
646 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
647 $this->out->elementStart('a', array('href' => $reply_url,
648 'class' => 'notice_reply',
649 // TRANS: Link title in notice list item to reply to a notice.
650 'title' => _('Reply to this notice.')));
651 // TRANS: Link text in notice list item to reply to a notice.
652 $this->out->text(_('Reply'));
653 $this->out->text(' ');
654 $this->out->element('span', 'notice_id', $this->notice->id);
655 $this->out->elementEnd('a');
660 * if the user is the author, let them delete the notice
664 function showDeleteLink()
666 $user = common_current_user();
668 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
671 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
672 $this->out->text(' ');
673 $deleteurl = common_local_url('deletenotice',
674 array('notice' => $todel->id));
675 $this->out->element('a', array('href' => $deleteurl,
676 'class' => 'notice_delete',
677 // TRANS: Link title in notice list item to delete a notice.
678 'title' => _('Delete this notice from the timeline.')),
679 // TRANS: Link text in notice list item to delete a notice.
685 * show the form to repeat a notice
689 function showRepeatForm()
691 if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
692 $this->notice->scope == Notice::SITE_SCOPE) {
693 $user = common_current_user();
695 $user->id != $this->notice->profile_id) {
696 $this->out->text(' ');
697 $profile = $user->getProfile();
698 if ($profile->hasRepeated($this->notice->id)) {
699 $this->out->element('span', array('class' => 'repeated',
700 // TRANS: Title for repeat form status in notice list when a notice has been repeated.
701 'title' => _('Notice repeated.')),
702 // TRANS: Repeat form status in notice list when a notice has been repeated.
705 $rf = new RepeatForm($this->out, $this->notice);
715 * Close the last elements in the notice list item
721 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
722 $this->out->elementEnd('li');
723 Event::handle('EndCloseNoticeListItemElement', array($this));
728 * Get the notice in question
730 * For hooks, etc., this may be useful
732 * @return Notice The notice we're showing
737 return $this->notice;