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 $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->showReplyLink();
157 $this->showRepeatForm();
158 $this->showDeleteLink();
159 Event::handle('EndShowNoticeOptionItems', array($this));
161 $this->out->elementEnd('div');
163 Event::handle('EndShowNoticeOptions', array($this));
168 * start a single notice.
174 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
175 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
176 $class = 'h-entry notice';
177 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
178 $class .= ' limited-scope';
180 if (!empty($this->notice->source)) {
181 $class .= ' notice-source-'.$this->notice->source;
183 $this->out->elementStart('li', array('class' => $class,
184 'id' => 'notice-' . $id));
185 Event::handle('EndOpenNoticeListItemElement', array($this));
190 * show the author of a notice
192 * By default, this shows the avatar and (linked) nickname of the author.
197 function showAuthor()
199 $attrs = array('href' => $this->profile->profileurl,
200 'class' => 'h-card p-author',
201 'title' => $this->profile->getNickname());
203 if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
204 $this->out->elementStart('a', $attrs);
205 $this->showAvatar($this->profile);
206 $this->out->text($this->profile->getStreamName());
207 $this->out->elementEnd('a');
208 Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
212 function showAddressees()
214 $pa = $this->getProfileAddressees();
217 $this->out->elementStart('ul', 'addressees');
219 foreach ($pa as $addr) {
220 $this->out->elementStart('li', 'h-card');
221 $text = $addr['text'];
222 unset($addr['text']);
223 $this->out->element('a', $addr, $text);
224 $this->out->elementEnd('li');
226 $this->out->elementEnd('ul', 'addressees');
230 function getProfileAddressees()
234 $attentions = $this->getReplyProfiles();
236 foreach ($attentions as $attn) {
237 $class = $attn->isGroup() ? 'group' : 'account';
238 $pa[] = array('href' => $attn->profileurl,
239 'title' => $attn->getNickname(),
240 'class' => "addressee {$class}",
241 'text' => $attn->getStreamName());
247 function getReplyProfiles()
249 return $this->notice->getReplyProfiles();
253 * show the nickname of the author
255 * Links to the author's profile page
259 function showNickname()
261 $this->out->raw('<span class="p-name">' .
262 htmlspecialchars($this->profile->getNickname()) .
267 * show the content of the notice
269 * Shows the content of the notice. This is pre-rendered for efficiency
270 * at save time. Some very old notices might not be pre-rendered, so
271 * they're rendered on the spot.
275 function showContent()
277 // FIXME: URL, image, video, audio
278 $this->out->elementStart('div', array('class' => 'e-content'));
279 if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
280 if ($this->notice->rendered) {
281 $this->out->raw($this->notice->rendered);
283 // XXX: may be some uncooked notices in the DB,
284 // we cook them right now. This should probably disappear in future
285 // versions (>> 0.4.x)
286 $this->out->raw(common_render_content($this->notice->content, $this->notice));
288 Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
290 $this->out->elementEnd('div');
293 function showNoticeAttachments() {
294 if (common_config('attachments', 'show_thumbs')) {
295 $al = new InlineAttachmentList($this->notice, $this->out);
301 * show the link to the main page for the notice
303 * Displays a local link to the rendered notice, with "relative" time.
307 function showNoticeLink()
309 $this->out->elementStart('a', array('rel' => 'bookmark',
310 'class' => 'u-url timestamp',
311 'href' => $this->notice->getLocalUrl()));
312 $this->out->element('time', array('class' => 'dt-published',
313 'datetime' => common_date_iso8601($this->notice->created),
314 // TRANS: Timestamp title (tooltip text) for NoticeListItem
315 'title' => common_exact_date($this->notice->created)),
316 common_date_string($this->notice->created));
317 $this->out->elementEnd('a');
321 * show the notice location
323 * shows the notice location in the correct language.
325 * If an URL is available, makes a link. Otherwise, just a span.
329 function showNoticeLocation()
331 $id = $this->notice->id;
333 $location = $this->notice->getLocation();
335 if (empty($location)) {
339 $name = $location->getName();
341 $lat = $this->notice->lat;
342 $lon = $this->notice->lon;
343 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
346 $latdms = $this->decimalDegreesToDMS(abs($lat));
347 $londms = $this->decimalDegreesToDMS(abs($lon));
348 // TRANS: Used in coordinates as abbreviation of north.
350 // TRANS: Used in coordinates as abbreviation of south.
352 // TRANS: Used in coordinates as abbreviation of east.
354 // TRANS: Used in coordinates as abbreviation of west.
357 // TRANS: Coordinates message.
358 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
359 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
360 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
361 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
362 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
363 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
364 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
367 $url = $location->getUrl();
369 $this->out->text(' ');
370 $this->out->elementStart('span', array('class' => 'location'));
371 // TRANS: Followed by geo location.
372 $this->out->text(_('at'));
373 $this->out->text(' ');
375 $this->out->element('abbr', array('class' => 'geo',
379 $xstr = new XMLStringer(false);
380 $xstr->elementStart('a', array('href' => $url,
381 'rel' => 'external'));
382 $xstr->element('abbr', array('class' => 'geo',
385 $xstr->elementEnd('a');
386 $this->out->raw($xstr->getString());
388 $this->out->elementEnd('span');
392 * @param number $dec decimal degrees
393 * @return array split into 'deg', 'min', and 'sec'
395 function decimalDegreesToDMS($dec)
398 $tempma = abs($dec) - abs($deg);
400 $tempma = $tempma * 3600;
401 $min = floor($tempma / 60);
402 $sec = $tempma - ($min*60);
404 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
408 * Show the source of the notice
410 * Either the name (and link) of the API client that posted the notice,
411 * or one of other other channels.
415 function showNoticeSource()
417 $ns = $this->notice->getSource();
420 // TRANS: A possible notice source (web interface).
421 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
422 $this->out->text(' ');
423 $this->out->elementStart('span', 'source');
424 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
425 // TRANS: Followed by notice source.
426 $this->out->text(_('from'));
427 $this->out->text(' ');
429 $name = $source_name;
433 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
434 $name = $source_name;
437 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
439 // if $ns->name and $ns->url are populated we have
440 // configured a source attr somewhere
441 if (!empty($name) && !empty($url)) {
442 $this->out->elementStart('span', 'device');
449 if (!empty($title)) {
450 $attrs['title'] = $title;
453 $this->out->element('a', $attrs, $name);
454 $this->out->elementEnd('span');
456 $this->out->element('span', 'device', $name);
459 $this->out->elementEnd('span');
464 * show link to notice this notice is a reply to
466 * If this notice is a reply, show a link to the notice it is replying to. The
467 * heavy lifting for figuring out replies happens at save time.
471 function showContext()
473 $this->out->element('a',
474 array('href' => $this->notice->getConversationUrl(),
475 'class' => 'conversation'),
476 // TRANS: Addition in notice list item if notice is part of a conversation.
481 * show a link to the author of repeat
485 function showRepeat()
487 if (!empty($this->repeat)) {
489 $repeater = Profile::getKV('id', $this->repeat->profile_id);
491 $attrs = array('href' => $repeater->profileurl,
492 'class' => 'h-card p-author',
493 'title' => $repeater->getFancyName());
495 $this->out->elementStart('span', 'repeat h-entry');
497 // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
498 $this->out->raw(_('Repeated by').' ');
500 $this->out->element('a', $attrs, $repeater->getNickname());
502 $this->out->elementEnd('span');
507 * show a link to reply to the current notice
509 * Should either do the reply in the current notice form (if available), or
510 * link out to the notice-posting form. A little flakey, doesn't always work.
514 function showReplyLink()
516 if (common_logged_in()) {
517 $this->out->text(' ');
518 $reply_url = common_local_url('newnotice',
519 array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
520 $this->out->elementStart('a', array('href' => $reply_url,
521 'class' => 'notice_reply',
522 // TRANS: Link title in notice list item to reply to a notice.
523 'title' => _('Reply to this notice.')));
524 // TRANS: Link text in notice list item to reply to a notice.
525 $this->out->text(_('Reply'));
526 $this->out->text(' ');
527 $this->out->element('span', 'notice_id', $this->notice->id);
528 $this->out->elementEnd('a');
533 * if the user is the author, let them delete the notice
537 function showDeleteLink()
539 $user = common_current_user();
541 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
544 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
545 $this->out->text(' ');
546 $deleteurl = common_local_url('deletenotice',
547 array('notice' => $todel->id));
548 $this->out->element('a', array('href' => $deleteurl,
549 'class' => 'notice_delete',
550 // TRANS: Link title in notice list item to delete a notice.
551 'title' => _('Delete this notice from the timeline.')),
552 // TRANS: Link text in notice list item to delete a notice.
558 * show the form to repeat a notice
562 function showRepeatForm()
564 if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
565 $this->notice->scope == Notice::SITE_SCOPE) {
566 $user = common_current_user();
568 $user->id != $this->notice->profile_id) {
569 $this->out->text(' ');
570 $profile = $user->getProfile();
571 if ($profile->hasRepeated($this->notice)) {
572 $this->out->element('span', array('class' => 'repeated',
573 // TRANS: Title for repeat form status in notice list when a notice has been repeated.
574 'title' => _('Notice repeated.')),
575 // TRANS: Repeat form status in notice list when a notice has been repeated.
578 $rf = new RepeatForm($this->out, $this->notice);
588 * Close the last elements in the notice list item
594 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
595 $this->out->elementEnd('li');
596 Event::handle('EndCloseNoticeListItemElement', array($this));
601 * Get the notice in question
603 * For hooks, etc., this may be useful
605 * @return Notice The notice we're showing
610 return $this->notice;