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, Action $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 Event::handle('EndShowNoticeItem', array($this));
111 function showNotice()
113 if (Event::handle('StartShowNoticeItemNotice', array($this))) {
114 $this->showNoticeHeaders();
115 $this->showContent();
116 $this->showNoticeFooter();
117 Event::handle('EndShowNoticeItemNotice', array($this));
121 function showNoticeHeaders()
123 $this->elementStart('section', array('class'=>'notice-headers'));
124 $this->showNoticeTitle();
126 $this->showAddressees();
127 $this->elementEnd('section');
130 function showNoticeFooter()
132 $this->elementStart('footer');
133 $this->showNoticeInfo();
134 $this->showNoticeAttachments();
135 $this->showNoticeOptions();
136 $this->elementEnd('footer');
139 function showNoticeTitle()
141 if (Event::handle('StartShowNoticeTitle', array($this))) {
142 $this->element('a', array('href' => $this->notice->getUrl(),
143 'class' => 'notice-title'),
144 $this->notice->getTitle());
145 Event::handle('EndShowNoticeTitle', array($this));
149 function showNoticeInfo()
151 if (Event::handle('StartShowNoticeInfo', array($this))) {
152 $this->showNoticeLink();
153 $this->showNoticeSource();
154 $this->showNoticeLocation();
155 $this->showPermalink();
157 Event::handle('EndShowNoticeInfo', array($this));
161 function showNoticeOptions()
163 if (Event::handle('StartShowNoticeOptions', array($this))) {
164 $user = common_current_user();
166 $this->out->elementStart('div', 'notice-options');
167 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
168 $this->showReplyLink();
169 $this->showRepeatForm();
170 $this->showDeleteLink();
171 Event::handle('EndShowNoticeOptionItems', array($this));
173 $this->out->elementEnd('div');
175 Event::handle('EndShowNoticeOptions', array($this));
180 * start a single notice.
186 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
187 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
188 $class = 'h-entry notice';
189 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
190 $class .= ' limited-scope';
192 if (!empty($this->notice->source)) {
193 $class .= ' notice-source-'.$this->notice->source;
195 $this->out->elementStart('li', array('class' => $class,
196 'id' => 'notice-' . $id));
197 Event::handle('EndOpenNoticeListItemElement', array($this));
202 * show the author of a notice
204 * By default, this shows the avatar and (linked) nickname of the author.
209 function showAuthor()
211 $attrs = array('href' => $this->profile->profileurl,
212 'class' => 'h-card p-author',
213 'title' => $this->profile->getNickname());
215 if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
216 $this->out->elementStart('a', $attrs);
217 $this->showAvatar($this->profile);
218 $this->out->text($this->profile->getStreamName());
219 $this->out->elementEnd('a');
220 Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
224 function showAddressees()
226 $pa = $this->getProfileAddressees();
229 $this->out->elementStart('ul', 'addressees');
231 foreach ($pa as $addr) {
232 $this->out->elementStart('li', 'h-card');
233 $text = $addr['text'];
234 unset($addr['text']);
235 $this->out->element('a', $addr, $text);
236 $this->out->elementEnd('li');
238 $this->out->elementEnd('ul', 'addressees');
242 function getProfileAddressees()
246 $attentions = $this->getReplyProfiles();
248 foreach ($attentions as $attn) {
249 $class = $attn->isGroup() ? 'group' : 'account';
250 $pa[] = array('href' => $attn->profileurl,
251 'title' => $attn->getNickname(),
252 'class' => "addressee {$class}",
253 'text' => $attn->getStreamName());
259 function getReplyProfiles()
261 return $this->notice->getReplyProfiles();
265 * show the nickname of the author
267 * Links to the author's profile page
271 function showNickname()
273 $this->out->raw('<span class="p-name">' .
274 htmlspecialchars($this->profile->getNickname()) .
279 * show the content of the notice
281 * Shows the content of the notice. This is pre-rendered for efficiency
282 * at save time. Some very old notices might not be pre-rendered, so
283 * they're rendered on the spot.
287 function showContent()
289 // FIXME: URL, image, video, audio
290 $this->out->elementStart('article', array('class' => 'e-content'));
291 if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
292 if ($this->notice->rendered) {
293 $this->out->raw($this->notice->rendered);
295 // XXX: may be some uncooked notices in the DB,
296 // we cook them right now. This should probably disappear in future
297 // versions (>> 0.4.x)
298 $this->out->raw(common_render_content($this->notice->content, $this->notice));
300 Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
302 $this->out->elementEnd('article');
305 function showNoticeAttachments() {
306 if (common_config('attachments', 'show_thumbs')) {
307 $al = new InlineAttachmentList($this->notice, $this->out);
313 * show the link to the main page for the notice
315 * Displays a local link to the rendered notice, with "relative" time.
319 function showNoticeLink()
321 $this->out->elementStart('a', array('rel' => 'bookmark',
322 'class' => 'timestamp',
323 'href' => Conversation::getUrlFromNotice($this->notice)));
324 $this->out->element('time', array('class' => 'dt-published',
325 'datetime' => common_date_iso8601($this->notice->created),
326 // TRANS: Timestamp title (tooltip text) for NoticeListItem
327 'title' => common_exact_date($this->notice->created)),
328 common_date_string($this->notice->created));
329 $this->out->elementEnd('a');
333 * show the notice location
335 * shows the notice location in the correct language.
337 * If an URL is available, makes a link. Otherwise, just a span.
341 function showNoticeLocation()
343 $id = $this->notice->id;
345 $location = $this->notice->getLocation();
347 if (empty($location)) {
351 $name = $location->getName();
353 $lat = $this->notice->lat;
354 $lon = $this->notice->lon;
355 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
358 $latdms = $this->decimalDegreesToDMS(abs($lat));
359 $londms = $this->decimalDegreesToDMS(abs($lon));
360 // TRANS: Used in coordinates as abbreviation of north.
362 // TRANS: Used in coordinates as abbreviation of south.
364 // TRANS: Used in coordinates as abbreviation of east.
366 // TRANS: Used in coordinates as abbreviation of west.
369 // TRANS: Coordinates message.
370 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
371 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
372 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
373 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
374 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
375 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
376 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
379 $url = $location->getUrl();
381 $this->out->text(' ');
382 $this->out->elementStart('span', array('class' => 'location'));
383 // TRANS: Followed by geo location.
384 $this->out->text(_('at'));
385 $this->out->text(' ');
387 $this->out->element('abbr', array('class' => 'geo',
391 $xstr = new XMLStringer(false);
392 $xstr->elementStart('a', array('href' => $url,
393 'rel' => 'external'));
394 $xstr->element('abbr', array('class' => 'geo',
397 $xstr->elementEnd('a');
398 $this->out->raw($xstr->getString());
400 $this->out->elementEnd('span');
404 * @param number $dec decimal degrees
405 * @return array split into 'deg', 'min', and 'sec'
407 function decimalDegreesToDMS($dec)
410 $tempma = abs($dec) - abs($deg);
412 $tempma = $tempma * 3600;
413 $min = floor($tempma / 60);
414 $sec = $tempma - ($min*60);
416 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
420 * Show the source of the notice
422 * Either the name (and link) of the API client that posted the notice,
423 * or one of other other channels.
427 function showNoticeSource()
429 $ns = $this->notice->getSource();
431 if (!$ns instanceof Notice_source) {
435 // TRANS: A possible notice source (web interface).
436 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
437 $this->out->text(' ');
438 $this->out->elementStart('span', 'source');
439 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
440 // TRANS: Followed by notice source.
441 $this->out->text(_('from'));
442 $this->out->text(' ');
444 $name = $source_name;
448 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
449 $name = $source_name;
452 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
454 // if $ns->name and $ns->url are populated we have
455 // configured a source attr somewhere
456 if (!empty($name) && !empty($url)) {
457 $this->out->elementStart('span', 'device');
464 if (!empty($title)) {
465 $attrs['title'] = $title;
468 $this->out->element('a', $attrs, $name);
469 $this->out->elementEnd('span');
471 $this->out->element('span', 'device', $name);
474 $this->out->elementEnd('span');
478 * show link to single-notice view for this notice item
480 * A permalink that goes to this specific object and nothing else
484 function showPermalink()
486 $class = 'permalink u-url';
487 if (!$this->notice->isLocal()) {
488 $class .= ' external';
491 $this->out->element('a',
492 array('href' => $this->notice->getUrl(),
494 // TRANS: Addition in notice list item for single-notice view.
496 } catch (InvalidUrlException $e) {
497 // no permalink available
502 * show a link to the author of repeat
506 function showRepeat()
508 if (!empty($this->repeat)) {
510 $repeater = Profile::getKV('id', $this->repeat->profile_id);
512 $attrs = array('href' => $repeater->profileurl,
513 'class' => 'h-card p-author',
514 'title' => $repeater->getFancyName());
516 $this->out->elementStart('span', 'repeat h-entry');
518 // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
519 $this->out->raw(_('Repeated by').' ');
521 $this->out->element('a', $attrs, $repeater->getNickname());
523 $this->out->elementEnd('span');
528 * show a link to reply to the current notice
530 * Should either do the reply in the current notice form (if available), or
531 * link out to the notice-posting form. A little flakey, doesn't always work.
535 function showReplyLink()
537 if (common_logged_in()) {
538 $this->out->text(' ');
539 $reply_url = common_local_url('newnotice',
540 array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
541 $this->out->elementStart('a', array('href' => $reply_url,
542 'class' => 'notice_reply',
543 // TRANS: Link title in notice list item to reply to a notice.
544 'title' => _('Reply to this notice.')));
545 // TRANS: Link text in notice list item to reply to a notice.
546 $this->out->text(_('Reply'));
547 $this->out->text(' ');
548 $this->out->element('span', 'notice_id', $this->notice->id);
549 $this->out->elementEnd('a');
554 * if the user is the author, let them delete the notice
558 function showDeleteLink()
560 $user = common_current_user();
562 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
565 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
566 $this->out->text(' ');
567 $deleteurl = common_local_url('deletenotice',
568 array('notice' => $todel->id));
569 $this->out->element('a', array('href' => $deleteurl,
570 'class' => 'notice_delete',
571 // TRANS: Link title in notice list item to delete a notice.
572 'title' => _('Delete this notice from the timeline.')),
573 // TRANS: Link text in notice list item to delete a notice.
579 * show the form to repeat a notice
583 function showRepeatForm()
585 if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
586 $this->notice->scope == Notice::SITE_SCOPE) {
587 $user = common_current_user();
589 $user->id != $this->notice->profile_id) {
590 $this->out->text(' ');
591 $profile = $user->getProfile();
592 if ($profile->hasRepeated($this->notice)) {
593 $this->out->element('span', array('class' => 'repeated',
594 // TRANS: Title for repeat form status in notice list when a notice has been repeated.
595 'title' => _('Notice repeated.')),
596 // TRANS: Repeat form status in notice list when a notice has been repeated.
599 $rf = new RepeatForm($this->out, $this->notice);
609 * Close the last elements in the notice list item
615 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
616 $this->out->elementEnd('li');
617 Event::handle('EndCloseNoticeListItemElement', array($this));
622 * Get the notice in question
624 * For hooks, etc., this may be useful
626 * @return Notice The notice we're showing
631 return $this->notice;