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. */
61 protected $addressees = true;
62 protected $attachments = true;
63 protected $id_prefix = null;
64 protected $options = true;
65 protected $maxchars = 0; // if <= 0 it means use full posts
66 protected $item_tag = 'li';
72 * Also initializes the profile attribute.
74 * @param Notice $notice The notice we'll display
76 function __construct(Notice $notice, Action $out=null, array $prefs=array())
78 parent::__construct($out);
79 if (!empty($notice->repeat_of)) {
80 $original = Notice::getKV('id', $notice->repeat_of);
81 if (!$original instanceof Notice) { // could have been deleted
82 $this->notice = $notice;
84 $this->notice = $original;
85 $this->repeat = $notice;
88 $this->notice = $notice;
91 $this->profile = $this->notice->getProfile();
93 // integer preferences
94 foreach(array('maxchars') as $key) {
95 if (array_key_exists($key, $prefs)) {
96 $this->$key = (int)$prefs[$key];
99 // boolean preferences
100 foreach(array('addressees', 'attachments', 'options') as $key) {
101 if (array_key_exists($key, $prefs)) {
102 $this->$key = (bool)$prefs[$key];
105 // string preferences
106 foreach(array('id_prefix', 'item_tag') as $key) {
107 if (array_key_exists($key, $prefs)) {
108 $this->$key = $prefs[$key];
114 * recipe function for displaying a single notice.
116 * This uses all the other methods to correctly display a notice. Override
117 * it or one of the others to fine-tune the output.
123 if (empty($this->notice)) {
124 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
126 } else if (empty($this->profile)) {
127 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
132 if (Event::handle('StartShowNoticeItem', array($this))) {
134 Event::handle('EndShowNoticeItem', array($this));
139 function showNotice()
141 if (Event::handle('StartShowNoticeItemNotice', array($this))) {
142 $this->showNoticeHeaders();
143 $this->showContent();
144 $this->showNoticeFooter();
145 Event::handle('EndShowNoticeItemNotice', array($this));
149 function showNoticeHeaders()
151 $this->elementStart('section', array('class'=>'notice-headers'));
152 $this->showNoticeTitle();
155 if (!empty($this->notice->reply_to) || count($this->getProfileAddressees()) > 0) {
156 $this->elementStart('div', array('class' => 'parents'));
159 } catch (NoParentNoticeException $e) {
161 } catch (InvalidUrlException $e) {
162 // parent had an invalid URL so we can't show it
164 if ($this->addressees) { $this->showAddressees(); }
165 $this->elementEnd('div');
167 $this->elementEnd('section');
170 function showNoticeFooter()
172 $this->elementStart('footer');
173 $this->showNoticeInfo();
174 if ($this->options) { $this->showNoticeOptions(); }
175 if ($this->attachments) { $this->showNoticeAttachments(); }
176 $this->elementEnd('footer');
179 function showNoticeTitle()
181 if (Event::handle('StartShowNoticeTitle', array($this))) {
182 $this->element('a', array('href' => $this->notice->getUri(),
183 'class' => 'p-name u-uid'),
184 $this->notice->getTitle());
185 Event::handle('EndShowNoticeTitle', array($this));
189 function showNoticeInfo()
191 if (Event::handle('StartShowNoticeInfo', array($this))) {
192 $this->showContextLink();
193 $this->showNoticeLink();
194 $this->showNoticeSource();
195 $this->showNoticeLocation();
196 $this->showPermalink();
197 Event::handle('EndShowNoticeInfo', array($this));
201 function showNoticeOptions()
203 if (Event::handle('StartShowNoticeOptions', array($this))) {
204 $user = common_current_user();
206 $this->out->elementStart('div', 'notice-options');
207 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
208 $this->showReplyLink();
209 $this->showDeleteLink();
210 Event::handle('EndShowNoticeOptionItems', array($this));
212 $this->out->elementEnd('div');
214 Event::handle('EndShowNoticeOptions', array($this));
219 * start a single notice.
225 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
226 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
227 $class = 'h-entry notice';
228 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
229 $class .= ' limited-scope';
231 if (!empty($this->notice->source)) {
232 $class .= ' notice-source-'.$this->notice->source;
234 $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
235 $this->out->elementStart($this->item_tag, array('class' => $class,
236 'id' => "${id_prefix}notice-${id}"));
237 Event::handle('EndOpenNoticeListItemElement', array($this));
242 * show the author of a notice
244 * By default, this shows the avatar and (linked) nickname of the author.
249 function showAuthor()
251 $attrs = array('href' => $this->profile->profileurl,
253 'title' => $this->profile->getNickname());
254 if(empty($this->repeat)) { $attrs['class'] .= ' p-author'; }
256 if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
257 $this->out->elementStart('a', $attrs);
258 $this->showAvatar($this->profile);
259 $this->out->text($this->profile->getStreamName());
260 $this->out->elementEnd('a');
261 Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
265 function showParent()
270 'href' => $this->notice->getParent()->getUrl(),
271 'class' => 'u-in-reply-to',
272 'rel' => 'in-reply-to'
278 function showAddressees()
280 $pa = $this->getProfileAddressees();
283 $this->out->elementStart('ul', 'addressees');
285 foreach ($pa as $addr) {
286 $this->out->elementStart('li', 'h-card');
287 $text = $addr['text'];
288 unset($addr['text']);
289 $this->out->element('a', $addr, $text);
290 $this->out->elementEnd('li');
292 $this->out->elementEnd('ul', 'addressees');
296 function getProfileAddressees()
298 if($this->pa) { return $this->pa; }
301 $attentions = $this->getAttentionProfiles();
303 foreach ($attentions as $attn) {
304 $class = $attn->isGroup() ? 'group' : 'account';
305 $profileurl = $attn->getUri();
306 if (common_valid_http_url($profileurl)) {
309 $profileurl = $attn->getUrl();
311 $this->pa[] = array('href' => $profileurl,
312 'title' => $attn->getNickname(),
313 'class' => "addressee {$class} p-name u-url",
314 'text' => $attn->getStreamName());
320 function getAttentionProfiles()
322 return $this->notice->getAttentionProfiles();
326 * show the nickname of the author
328 * Links to the author's profile page
332 function showNickname()
334 $this->out->raw('<span class="p-name">' .
335 htmlspecialchars($this->profile->getNickname()) .
340 * show the content of the notice
342 * Shows the content of the notice. This is pre-rendered for efficiency
343 * at save time. Some very old notices might not be pre-rendered, so
344 * they're rendered on the spot.
348 function showContent()
350 // FIXME: URL, image, video, audio
351 $this->out->elementStart('article', array('class' => 'e-content'));
352 if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
353 if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
354 $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
356 $this->out->raw($this->notice->getRendered());
358 Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
360 $this->out->elementEnd('article');
363 function showNoticeAttachments() {
364 if (common_config('attachments', 'show_thumbs')) {
365 $al = new InlineAttachmentList($this->notice, $this->out);
371 * show the link to the main page for the notice
373 * Displays a local link to the rendered notice, with "relative" time.
377 function showNoticeLink()
379 $this->out->element('time', array('class' => 'dt-published',
380 'datetime' => common_date_iso8601($this->notice->created),
381 'title' => common_exact_date($this->notice->created)),
382 common_date_string($this->notice->created));
386 * show the notice location
388 * shows the notice location in the correct language.
390 * If an URL is available, makes a link. Otherwise, just a span.
394 function showNoticeLocation()
398 $location = Notice_location::locFromStored($this->notice);
399 } catch (NoResultException $e) {
401 } catch (ServerException $e) {
405 $name = $location->getName();
407 $lat = $location->lat;
408 $lon = $location->lon;
409 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
412 $latdms = $this->decimalDegreesToDMS(abs($lat));
413 $londms = $this->decimalDegreesToDMS(abs($lon));
414 // TRANS: Used in coordinates as abbreviation of north.
416 // TRANS: Used in coordinates as abbreviation of south.
418 // TRANS: Used in coordinates as abbreviation of east.
420 // TRANS: Used in coordinates as abbreviation of west.
423 // TRANS: Coordinates message.
424 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
425 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
426 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
427 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
428 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
429 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
430 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
433 $url = $location->getUrl();
435 $this->out->text(' ');
436 $this->out->elementStart('span', array('class' => 'location'));
437 // TRANS: Followed by geo location.
438 $this->out->text(_('at'));
439 $this->out->text(' ');
441 $this->out->element('abbr', array('class' => 'geo',
445 $xstr = new XMLStringer(false);
446 $xstr->elementStart('a', array('href' => $url,
447 'rel' => 'external'));
448 $xstr->element('abbr', array('class' => 'geo',
451 $xstr->elementEnd('a');
452 $this->out->raw($xstr->getString());
454 $this->out->elementEnd('span');
458 * @param number $dec decimal degrees
459 * @return array split into 'deg', 'min', and 'sec'
461 function decimalDegreesToDMS($dec)
464 $tempma = abs($dec) - abs($deg);
466 $tempma = $tempma * 3600;
467 $min = floor($tempma / 60);
468 $sec = $tempma - ($min*60);
470 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
474 * Show the source of the notice
476 * Either the name (and link) of the API client that posted the notice,
477 * or one of other other channels.
481 function showNoticeSource()
483 $ns = $this->notice->getSource();
485 if (!$ns instanceof Notice_source) {
489 // TRANS: A possible notice source (web interface).
490 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
491 $this->out->text(' ');
492 $this->out->elementStart('span', 'source');
493 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
494 // TRANS: Followed by notice source.
495 $this->out->text(_('from'));
496 $this->out->text(' ');
498 $name = $source_name;
502 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
503 $name = $source_name;
506 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
508 // if $ns->name and $ns->url are populated we have
509 // configured a source attr somewhere
510 if (!empty($name) && !empty($url)) {
511 $this->out->elementStart('span', 'device');
518 if (!empty($title)) {
519 $attrs['title'] = $title;
522 $this->out->element('a', $attrs, $name);
523 $this->out->elementEnd('span');
525 $this->out->element('span', 'device', $name);
528 $this->out->elementEnd('span');
532 * show link to single-notice view for this notice item
534 * A permalink that goes to this specific object and nothing else
538 function showPermalink()
540 $class = 'permalink u-url';
541 if (!$this->notice->isLocal()) {
542 $class .= ' external';
547 $this->out->element('a',
548 array('href' => $this->repeat->getUrl(),
551 $class = str_replace('u-url', 'u-repost-of', $class);
553 } catch (InvalidUrlException $e) {
554 // no permalink available
558 $this->out->element('a',
559 array('href' => $this->notice->getUrl(true),
561 // TRANS: Addition in notice list item for single-notice view.
563 } catch (InvalidUrlException $e) {
564 // no permalink available
569 * Show link to conversation view.
571 function showContextLink()
573 $this->out->element('a', array('rel' => 'bookmark',
574 'class' => 'timestamp',
575 'href' => Conversation::getUrlFromNotice($this->notice)),
576 // TRANS: A link to the conversation view of a notice, on the local server.
577 _('In conversation'));
581 * show a link to reply to the current notice
583 * Should either do the reply in the current notice form (if available), or
584 * link out to the notice-posting form. A little flakey, doesn't always work.
588 function showReplyLink()
590 if (common_logged_in()) {
591 $this->out->text(' ');
592 $reply_url = common_local_url('newnotice',
593 array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
594 $this->out->elementStart('a', array('href' => $reply_url,
595 'class' => 'notice_reply',
596 // TRANS: Link title in notice list item to reply to a notice.
597 'title' => _('Reply to this notice.')));
598 // TRANS: Link text in notice list item to reply to a notice.
599 $this->out->text(_('Reply'));
600 $this->out->text(' ');
601 $this->out->element('span', 'notice_id', $this->notice->id);
602 $this->out->elementEnd('a');
607 * if the user is the author, let them delete the notice
611 function showDeleteLink()
613 $user = common_current_user();
615 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
618 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
619 $this->out->text(' ');
620 $deleteurl = common_local_url('deletenotice',
621 array('notice' => $todel->id));
622 $this->out->element('a', array('href' => $deleteurl,
623 'class' => 'notice_delete popup',
624 // TRANS: Link title in notice list item to delete a notice.
625 'title' => _('Delete this notice from the timeline.')),
626 // TRANS: Link text in notice list item to delete a notice.
634 * Close the last elements in the notice list item
640 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
641 $this->out->elementEnd('li');
642 Event::handle('EndCloseNoticeListItemElement', array($this));
647 * Get the notice in question
649 * For hooks, etc., this may be useful
651 * @return Notice The notice we're showing
656 return $this->notice;