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
70 * Also initializes the profile attribute.
72 * @param Notice $notice The notice we'll display
74 function __construct(Notice $notice, Action $out=null, array $prefs=array())
76 parent::__construct($out);
77 if (!empty($notice->repeat_of)) {
78 $original = Notice::getKV('id', $notice->repeat_of);
79 if (!$original instanceof Notice) { // could have been deleted
80 $this->notice = $notice;
82 $this->notice = $original;
83 $this->repeat = $notice;
86 $this->notice = $notice;
89 $this->profile = $this->notice->getProfile();
91 // integer preferences
92 foreach(array('maxchars') as $key) {
93 if (array_key_exists($key, $prefs)) {
94 $this->$key = (int)$prefs[$key];
97 // boolean preferences
98 foreach(array('addressees', 'attachments', 'options') as $key) {
99 if (array_key_exists($key, $prefs)) {
100 $this->$key = (bool)$prefs[$key];
103 // string preferences
104 foreach(array('id_prefix') as $key) {
105 if (array_key_exists($key, $prefs)) {
106 $this->$key = $prefs[$key];
112 * recipe function for displaying a single notice.
114 * This uses all the other methods to correctly display a notice. Override
115 * it or one of the others to fine-tune the output.
121 if (empty($this->notice)) {
122 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
124 } else if (empty($this->profile)) {
125 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
130 if (Event::handle('StartShowNoticeItem', array($this))) {
132 Event::handle('EndShowNoticeItem', array($this));
137 function showNotice()
139 if (Event::handle('StartShowNoticeItemNotice', array($this))) {
140 $this->showNoticeHeaders();
141 $this->showContent();
142 $this->showNoticeFooter();
143 Event::handle('EndShowNoticeItemNotice', array($this));
147 function showNoticeHeaders()
149 $this->elementStart('section', array('class'=>'notice-headers'));
150 $this->showNoticeTitle();
152 if ($this->addressees) { $this->showAddressees(); }
153 $this->elementEnd('section');
156 function showNoticeFooter()
158 $this->elementStart('footer');
159 $this->showNoticeInfo();
160 if ($this->attachments) { $this->showNoticeAttachments(); }
161 if ($this->options) { $this->showNoticeOptions(); }
162 $this->elementEnd('footer');
165 function showNoticeTitle()
167 if (Event::handle('StartShowNoticeTitle', array($this))) {
168 $this->element('a', array('href' => $this->notice->getUrl(),
169 'class' => 'notice-title'),
170 $this->notice->getTitle());
171 Event::handle('EndShowNoticeTitle', array($this));
175 function showNoticeInfo()
177 if (Event::handle('StartShowNoticeInfo', array($this))) {
178 $this->showNoticeLink();
179 $this->showNoticeSource();
180 $this->showNoticeLocation();
181 $this->showPermalink();
183 Event::handle('EndShowNoticeInfo', array($this));
187 function showNoticeOptions()
189 if (Event::handle('StartShowNoticeOptions', array($this))) {
190 $user = common_current_user();
192 if ($user instanceof User) {
193 $this->out->elementStart('div', 'notice-options');
194 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
195 $this->showReplyLink();
196 $this->showRepeatForm();
197 $this->showDeleteLink();
198 Event::handle('EndShowNoticeOptionItems', array($this));
200 $this->out->elementEnd('div');
203 Event::handle('EndShowNoticeOptions', array($this));
208 * start a single notice.
214 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
215 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
216 $class = 'h-entry notice';
217 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
218 $class .= ' limited-scope';
220 if (!empty($this->notice->source)) {
221 $class .= ' notice-source-'.$this->notice->source;
223 $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
224 $this->out->elementStart('li', array('class' => $class,
225 'id' => "${id_prefix}notice-${id}"));
226 Event::handle('EndOpenNoticeListItemElement', array($this));
231 * show the author of a notice
233 * By default, this shows the avatar and (linked) nickname of the author.
238 function showAuthor()
240 $attrs = array('href' => $this->profile->profileurl,
241 'class' => 'h-card p-author',
242 'title' => $this->profile->getNickname());
244 if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
245 $this->out->elementStart('a', $attrs);
246 $this->showAvatar($this->profile);
247 $this->out->text($this->profile->getStreamName());
248 $this->out->elementEnd('a');
249 Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
253 function showAddressees()
255 $pa = $this->getProfileAddressees();
258 $this->out->elementStart('ul', 'addressees');
260 foreach ($pa as $addr) {
261 $this->out->elementStart('li', 'h-card');
262 $text = $addr['text'];
263 unset($addr['text']);
264 $this->out->element('a', $addr, $text);
265 $this->out->elementEnd('li');
267 $this->out->elementEnd('ul', 'addressees');
271 function getProfileAddressees()
275 $attentions = $this->getReplyProfiles();
277 foreach ($attentions as $attn) {
278 $class = $attn->isGroup() ? 'group' : 'account';
279 $pa[] = array('href' => $attn->profileurl,
280 'title' => $attn->getNickname(),
281 'class' => "addressee {$class}",
282 'text' => $attn->getStreamName());
288 function getReplyProfiles()
290 return $this->notice->getReplyProfiles();
294 * show the nickname of the author
296 * Links to the author's profile page
300 function showNickname()
302 $this->out->raw('<span class="p-name">' .
303 htmlspecialchars($this->profile->getNickname()) .
308 * show the content of the notice
310 * Shows the content of the notice. This is pre-rendered for efficiency
311 * at save time. Some very old notices might not be pre-rendered, so
312 * they're rendered on the spot.
316 function showContent()
318 // FIXME: URL, image, video, audio
319 $this->out->elementStart('article', array('class' => 'e-content'));
320 if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
321 if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
322 $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
323 } elseif ($this->notice->rendered) {
324 $this->out->raw($this->notice->rendered);
326 // XXX: may be some uncooked notices in the DB,
327 // we cook them right now. This should probably disappear in future
328 // versions (>> 0.4.x)
329 $this->out->raw(common_render_content($this->notice->content, $this->notice));
331 Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
333 $this->out->elementEnd('article');
336 function showNoticeAttachments() {
337 if (common_config('attachments', 'show_thumbs')) {
338 $al = new InlineAttachmentList($this->notice, $this->out);
344 * show the link to the main page for the notice
346 * Displays a local link to the rendered notice, with "relative" time.
350 function showNoticeLink()
352 $this->out->elementStart('a', array('rel' => 'bookmark',
353 'class' => 'timestamp',
354 'href' => Conversation::getUrlFromNotice($this->notice)));
355 $this->out->element('time', array('class' => 'dt-published',
356 'datetime' => common_date_iso8601($this->notice->created),
357 // TRANS: Timestamp title (tooltip text) for NoticeListItem
358 'title' => common_exact_date($this->notice->created)),
359 common_date_string($this->notice->created));
360 $this->out->elementEnd('a');
364 * show the notice location
366 * shows the notice location in the correct language.
368 * If an URL is available, makes a link. Otherwise, just a span.
372 function showNoticeLocation()
374 $id = $this->notice->id;
376 $location = $this->notice->getLocation();
378 if (empty($location)) {
382 $name = $location->getName();
384 $lat = $this->notice->lat;
385 $lon = $this->notice->lon;
386 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
389 $latdms = $this->decimalDegreesToDMS(abs($lat));
390 $londms = $this->decimalDegreesToDMS(abs($lon));
391 // TRANS: Used in coordinates as abbreviation of north.
393 // TRANS: Used in coordinates as abbreviation of south.
395 // TRANS: Used in coordinates as abbreviation of east.
397 // TRANS: Used in coordinates as abbreviation of west.
400 // TRANS: Coordinates message.
401 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
402 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
403 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
404 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
405 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
406 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
407 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
410 $url = $location->getUrl();
412 $this->out->text(' ');
413 $this->out->elementStart('span', array('class' => 'location'));
414 // TRANS: Followed by geo location.
415 $this->out->text(_('at'));
416 $this->out->text(' ');
418 $this->out->element('abbr', array('class' => 'geo',
422 $xstr = new XMLStringer(false);
423 $xstr->elementStart('a', array('href' => $url,
424 'rel' => 'external'));
425 $xstr->element('abbr', array('class' => 'geo',
428 $xstr->elementEnd('a');
429 $this->out->raw($xstr->getString());
431 $this->out->elementEnd('span');
435 * @param number $dec decimal degrees
436 * @return array split into 'deg', 'min', and 'sec'
438 function decimalDegreesToDMS($dec)
441 $tempma = abs($dec) - abs($deg);
443 $tempma = $tempma * 3600;
444 $min = floor($tempma / 60);
445 $sec = $tempma - ($min*60);
447 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
451 * Show the source of the notice
453 * Either the name (and link) of the API client that posted the notice,
454 * or one of other other channels.
458 function showNoticeSource()
460 $ns = $this->notice->getSource();
462 if (!$ns instanceof Notice_source) {
466 // TRANS: A possible notice source (web interface).
467 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
468 $this->out->text(' ');
469 $this->out->elementStart('span', 'source');
470 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
471 // TRANS: Followed by notice source.
472 $this->out->text(_('from'));
473 $this->out->text(' ');
475 $name = $source_name;
479 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
480 $name = $source_name;
483 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
485 // if $ns->name and $ns->url are populated we have
486 // configured a source attr somewhere
487 if (!empty($name) && !empty($url)) {
488 $this->out->elementStart('span', 'device');
495 if (!empty($title)) {
496 $attrs['title'] = $title;
499 $this->out->element('a', $attrs, $name);
500 $this->out->elementEnd('span');
502 $this->out->element('span', 'device', $name);
505 $this->out->elementEnd('span');
509 * show link to single-notice view for this notice item
511 * A permalink that goes to this specific object and nothing else
515 function showPermalink()
517 $class = 'permalink u-url';
518 if (!$this->notice->isLocal()) {
519 $class .= ' external';
522 $this->out->element('a',
523 array('href' => $this->notice->getUrl(),
525 // TRANS: Addition in notice list item for single-notice view.
527 } catch (InvalidUrlException $e) {
528 // no permalink available
533 * show a link to the author of repeat
537 function showRepeat()
539 if (!empty($this->repeat)) {
541 $repeater = Profile::getKV('id', $this->repeat->profile_id);
543 $attrs = array('href' => $repeater->profileurl,
544 'class' => 'h-card p-author',
545 'title' => $repeater->getFancyName());
547 $this->out->elementStart('span', 'repeat h-entry');
549 // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
550 $this->out->raw(_('Repeated by').' ');
552 $this->out->element('a', $attrs, $repeater->getNickname());
554 $this->out->elementEnd('span');
559 * show a link to reply to the current notice
561 * Should either do the reply in the current notice form (if available), or
562 * link out to the notice-posting form. A little flakey, doesn't always work.
566 function showReplyLink()
568 if (common_logged_in()) {
569 $this->out->text(' ');
570 $reply_url = common_local_url('newnotice',
571 array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
572 $this->out->elementStart('a', array('href' => $reply_url,
573 'class' => 'notice_reply',
574 // TRANS: Link title in notice list item to reply to a notice.
575 'title' => _('Reply to this notice.')));
576 // TRANS: Link text in notice list item to reply to a notice.
577 $this->out->text(_('Reply'));
578 $this->out->text(' ');
579 $this->out->element('span', 'notice_id', $this->notice->id);
580 $this->out->elementEnd('a');
585 * if the user is the author, let them delete the notice
589 function showDeleteLink()
591 $user = common_current_user();
593 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
596 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
597 $this->out->text(' ');
598 $deleteurl = common_local_url('deletenotice',
599 array('notice' => $todel->id));
600 $this->out->element('a', array('href' => $deleteurl,
601 'class' => 'notice_delete',
602 // TRANS: Link title in notice list item to delete a notice.
603 'title' => _('Delete this notice from the timeline.')),
604 // TRANS: Link text in notice list item to delete a notice.
610 * show the form to repeat a notice
614 function showRepeatForm()
616 if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
617 $this->notice->scope == Notice::SITE_SCOPE) {
618 $user = common_current_user();
620 $user->id != $this->notice->profile_id) {
621 $this->out->text(' ');
622 $profile = $user->getProfile();
623 if ($profile->hasRepeated($this->notice)) {
624 $this->out->element('span', array('class' => 'repeated',
625 // TRANS: Title for repeat form status in notice list when a notice has been repeated.
626 'title' => _('Notice repeated.')),
627 // TRANS: Repeat form status in notice list when a notice has been repeated.
630 $rf = new RepeatForm($this->out, $this->notice);
640 * Close the last elements in the notice list item
646 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
647 $this->out->elementEnd('li');
648 Event::handle('EndCloseNoticeListItemElement', array($this));
653 * Get the notice in question
655 * For hooks, etc., this may be useful
657 * @return Notice The notice we're showing
662 return $this->notice;