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('GNUSOCIAL')) { exit(1); }
34 * widget for displaying a single notice
36 * This widget has the core smarts for showing a single notice: what to display,
37 * where, and under which circumstances. Its key method is show(); this is a recipe
38 * that calls all the other show*() methods to build up a single notice. The
39 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
40 * author info (since that's implicit by the data in the page).
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/
48 * @see ProfileNoticeListItem
50 class NoticeListItem extends Widget
52 /** The notice this item will show. */
55 /** The notice that was repeated. */
58 /** The profile of the author of the notice, extracted once for convenience. */
64 * Also initializes the profile attribute.
66 * @param Notice $notice The notice we'll display
68 function __construct(Notice $notice, HTMLOutputter $out=null)
70 parent::__construct($out);
71 if (!empty($notice->repeat_of)) {
72 $original = Notice::getKV('id', $notice->repeat_of);
73 if (!$original instanceof Notice) { // could have been deleted
74 $this->notice = $notice;
76 $this->notice = $original;
77 $this->repeat = $notice;
80 $this->notice = $notice;
82 $this->profile = $this->notice->getProfile();
86 * recipe function for displaying a single notice.
88 * This uses all the other methods to correctly display a notice. Override
89 * it or one of the others to fine-tune the output.
95 if (empty($this->notice)) {
96 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
98 } else if (empty($this->profile)) {
99 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
104 if (Event::handle('StartShowNoticeItem', array($this))) {
106 $this->showNoticeAttachments();
107 $this->showNoticeInfo();
108 $this->showNoticeOptions();
109 Event::handle('EndShowNoticeItem', array($this));
114 function showNotice()
116 $this->showNoticeTitle();
118 $this->showAddressees();
119 $this->showContent();
122 function showNoticeTitle()
124 if (Event::handle('StartShowNoticeTitle', array($this))) {
125 $this->element('a', array('href' => $this->notice->getUrl(),
126 'class' => 'p-name metadata'),
127 $this->notice->getTitle());
128 Event::handle('EndShowNoticeTitle', array($this));
132 function showNoticeInfo()
134 $this->out->elementStart('div', 'entry-metadata');
135 if (Event::handle('StartShowNoticeInfo', array($this))) {
136 $this->showNoticeLink();
137 $this->showNoticeSource();
138 $this->showNoticeLocation();
139 if ($this->notice->hasConversation()) {
140 $this->showContext();
143 Event::handle('EndShowNoticeInfo', array($this));
146 $this->out->elementEnd('div');
149 function showNoticeOptions()
151 if (Event::handle('StartShowNoticeOptions', array($this))) {
152 $user = common_current_user();
154 $this->out->elementStart('div', 'notice-options');
155 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
156 $this->showFaveForm();
157 $this->showReplyLink();
158 $this->showRepeatForm();
159 $this->showDeleteLink();
160 Event::handle('EndShowNoticeOptionItems', array($this));
162 $this->out->elementEnd('div');
164 Event::handle('EndShowNoticeOptions', array($this));
169 * start a single notice.
175 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
176 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
177 $class = 'h-entry notice';
178 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
179 $class .= ' limited-scope';
181 if (!empty($this->notice->source)) {
182 $class .= ' notice-source-'.$this->notice->source;
184 $this->out->elementStart('li', array('class' => $class,
185 'id' => 'notice-' . $id));
186 Event::handle('EndOpenNoticeListItemElement', array($this));
191 * show the "favorite" form
195 function showFaveForm()
197 if (Event::handle('StartShowFaveForm', array($this))) {
198 $user = common_current_user();
200 if ($user->hasFave($this->notice)) {
201 $disfavor = new DisfavorForm($this->out, $this->notice);
204 $favor = new FavorForm($this->out, $this->notice);
208 Event::handle('EndShowFaveForm', array($this));
213 * show the author of a notice
215 * By default, this shows the avatar and (linked) nickname of the author.
220 function showAuthor()
222 $attrs = array('href' => $this->profile->profileurl,
223 'class' => 'h-card p-author',
224 'title' => $this->profile->getNickname());
226 $this->out->elementStart('a', $attrs);
227 $this->showAvatar($this->profile);
228 $this->out->text($this->profile->getStreamName());
229 $this->out->elementEnd('a');
232 function showAddressees()
234 $pa = $this->getProfileAddressees();
237 $this->out->elementStart('ul', 'addressees');
239 foreach ($pa as $addr) {
240 $this->out->elementStart('li', 'h-card');
241 $text = $addr['text'];
242 unset($addr['text']);
243 $this->out->element('a', $addr, $text);
244 $this->out->elementEnd('li');
246 $this->out->elementEnd('ul', 'addressees');
250 function getProfileAddressees()
254 $attentions = $this->getReplyProfiles();
256 foreach ($attentions as $attn) {
257 $class = $attn->isGroup() ? 'group' : 'account';
258 $pa[] = array('href' => $attn->profileurl,
259 'title' => $attn->getNickname(),
260 'class' => "addressee {$class}",
261 'text' => $attn->getStreamName());
267 function getReplyProfiles()
269 return $this->notice->getReplyProfiles();
273 * show the nickname of the author
275 * Links to the author's profile page
279 function showNickname()
281 $this->out->raw('<span class="p-name">' .
282 htmlspecialchars($this->profile->getNickname()) .
287 * show the content of the notice
289 * Shows the content of the notice. This is pre-rendered for efficiency
290 * at save time. Some very old notices might not be pre-rendered, so
291 * they're rendered on the spot.
295 function showContent()
297 // FIXME: URL, image, video, audio
298 $this->out->elementStart('div', array('class' => 'e-content'));
299 if ($this->notice->rendered) {
300 $this->out->raw($this->notice->rendered);
302 // XXX: may be some uncooked notices in the DB,
303 // we cook them right now. This should probably disappear in future
304 // versions (>> 0.4.x)
305 $this->out->raw(common_render_content($this->notice->content, $this->notice));
307 $this->out->elementEnd('div');
310 function showNoticeAttachments() {
311 if (common_config('attachments', 'show_thumbs')) {
312 $al = new InlineAttachmentList($this->notice, $this->out);
318 * show the link to the main page for the notice
320 * Displays a local link to the rendered notice, with "relative" time.
324 function showNoticeLink()
326 $this->out->elementStart('a', array('rel' => 'bookmark',
327 'class' => 'u-url timestamp',
328 'href' => $this->notice->getLocalUrl()));
329 $this->out->element('time', array('class' => 'dt-published',
330 'datetime' => common_date_iso8601($this->notice->created),
331 // TRANS: Timestamp title (tooltip text) for NoticeListItem
332 'title' => common_exact_date($this->notice->created)),
333 common_date_string($this->notice->created));
334 $this->out->elementEnd('a');
338 * show the notice location
340 * shows the notice location in the correct language.
342 * If an URL is available, makes a link. Otherwise, just a span.
346 function showNoticeLocation()
348 $id = $this->notice->id;
350 $location = $this->notice->getLocation();
352 if (empty($location)) {
356 $name = $location->getName();
358 $lat = $this->notice->lat;
359 $lon = $this->notice->lon;
360 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
363 $latdms = $this->decimalDegreesToDMS(abs($lat));
364 $londms = $this->decimalDegreesToDMS(abs($lon));
365 // TRANS: Used in coordinates as abbreviation of north.
367 // TRANS: Used in coordinates as abbreviation of south.
369 // TRANS: Used in coordinates as abbreviation of east.
371 // TRANS: Used in coordinates as abbreviation of west.
374 // TRANS: Coordinates message.
375 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
376 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
377 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
378 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
379 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
380 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
381 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
384 $url = $location->getUrl();
386 $this->out->text(' ');
387 $this->out->elementStart('span', array('class' => 'location'));
388 // TRANS: Followed by geo location.
389 $this->out->text(_('at'));
390 $this->out->text(' ');
392 $this->out->element('abbr', array('class' => 'geo',
396 $xstr = new XMLStringer(false);
397 $xstr->elementStart('a', array('href' => $url,
398 'rel' => 'external'));
399 $xstr->element('abbr', array('class' => 'geo',
402 $xstr->elementEnd('a');
403 $this->out->raw($xstr->getString());
405 $this->out->elementEnd('span');
409 * @param number $dec decimal degrees
410 * @return array split into 'deg', 'min', and 'sec'
412 function decimalDegreesToDMS($dec)
415 $tempma = abs($dec) - abs($deg);
417 $tempma = $tempma * 3600;
418 $min = floor($tempma / 60);
419 $sec = $tempma - ($min*60);
421 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
425 * Show the source of the notice
427 * Either the name (and link) of the API client that posted the notice,
428 * or one of other other channels.
432 function showNoticeSource()
434 $ns = $this->notice->getSource();
437 // TRANS: A possible notice source (web interface).
438 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
439 $this->out->text(' ');
440 $this->out->elementStart('span', 'source');
441 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
442 // TRANS: Followed by notice source.
443 $this->out->text(_('from'));
444 $this->out->text(' ');
446 $name = $source_name;
450 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
451 $name = $source_name;
454 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
456 // if $ns->name and $ns->url are populated we have
457 // configured a source attr somewhere
458 if (!empty($name) && !empty($url)) {
459 $this->out->elementStart('span', 'device');
466 if (!empty($title)) {
467 $attrs['title'] = $title;
470 $this->out->element('a', $attrs, $name);
471 $this->out->elementEnd('span');
473 $this->out->element('span', 'device', $name);
476 $this->out->elementEnd('span');
481 * show link to notice this notice is a reply to
483 * If this notice is a reply, show a link to the notice it is replying to. The
484 * heavy lifting for figuring out replies happens at save time.
488 function showContext()
490 $this->out->element('a',
491 array('href' => $this->notice->getConversationUrl(),
492 'class' => 'conversation'),
493 // TRANS: Addition in notice list item if notice is part of a conversation.
498 * show a link to the author of repeat
502 function showRepeat()
504 if (!empty($this->repeat)) {
506 $repeater = Profile::getKV('id', $this->repeat->profile_id);
508 $attrs = array('href' => $repeater->profileurl,
509 'class' => 'h-card p-author',
510 'title' => $repeater->getFancyName());
512 $this->out->elementStart('span', 'repeat h-entry');
514 // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
515 $this->out->raw(_('Repeated by').' ');
517 $this->out->element('a', $attrs, $repeater->getNickname());
519 $this->out->elementEnd('span');
524 * show a link to reply to the current notice
526 * Should either do the reply in the current notice form (if available), or
527 * link out to the notice-posting form. A little flakey, doesn't always work.
531 function showReplyLink()
533 if (common_logged_in()) {
534 $this->out->text(' ');
535 $reply_url = common_local_url('newnotice',
536 array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
537 $this->out->elementStart('a', array('href' => $reply_url,
538 'class' => 'notice_reply',
539 // TRANS: Link title in notice list item to reply to a notice.
540 'title' => _('Reply to this notice.')));
541 // TRANS: Link text in notice list item to reply to a notice.
542 $this->out->text(_('Reply'));
543 $this->out->text(' ');
544 $this->out->element('span', 'notice_id', $this->notice->id);
545 $this->out->elementEnd('a');
550 * if the user is the author, let them delete the notice
554 function showDeleteLink()
556 $user = common_current_user();
558 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
561 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
562 $this->out->text(' ');
563 $deleteurl = common_local_url('deletenotice',
564 array('notice' => $todel->id));
565 $this->out->element('a', array('href' => $deleteurl,
566 'class' => 'notice_delete',
567 // TRANS: Link title in notice list item to delete a notice.
568 'title' => _('Delete this notice from the timeline.')),
569 // TRANS: Link text in notice list item to delete a notice.
575 * show the form to repeat a notice
579 function showRepeatForm()
581 if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
582 $this->notice->scope == Notice::SITE_SCOPE) {
583 $user = common_current_user();
585 $user->id != $this->notice->profile_id) {
586 $this->out->text(' ');
587 $profile = $user->getProfile();
588 if ($profile->hasRepeated($this->notice)) {
589 $this->out->element('span', array('class' => 'repeated',
590 // TRANS: Title for repeat form status in notice list when a notice has been repeated.
591 'title' => _('Notice repeated.')),
592 // TRANS: Repeat form status in notice list when a notice has been repeated.
595 $rf = new RepeatForm($this->out, $this->notice);
605 * Close the last elements in the notice list item
611 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
612 $this->out->elementEnd('li');
613 Event::handle('EndCloseNoticeListItemElement', array($this));
618 * Get the notice in question
620 * For hooks, etc., this may be useful
622 * @return Notice The notice we're showing
627 return $this->notice;