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';
71 * Also initializes the profile attribute.
73 * @param Notice $notice The notice we'll display
75 function __construct(Notice $notice, Action $out=null, array $prefs=array())
77 parent::__construct($out);
78 if (!empty($notice->repeat_of)) {
79 $original = Notice::getKV('id', $notice->repeat_of);
80 if (!$original instanceof Notice) { // could have been deleted
81 $this->notice = $notice;
83 $this->notice = $original;
84 $this->repeat = $notice;
87 $this->notice = $notice;
90 $this->profile = $this->notice->getProfile();
92 // integer preferences
93 foreach(array('maxchars') as $key) {
94 if (array_key_exists($key, $prefs)) {
95 $this->$key = (int)$prefs[$key];
98 // boolean preferences
99 foreach(array('addressees', 'attachments', 'options') as $key) {
100 if (array_key_exists($key, $prefs)) {
101 $this->$key = (bool)$prefs[$key];
104 // string preferences
105 foreach(array('id_prefix', 'item_tag') as $key) {
106 if (array_key_exists($key, $prefs)) {
107 $this->$key = $prefs[$key];
113 * recipe function for displaying a single notice.
115 * This uses all the other methods to correctly display a notice. Override
116 * it or one of the others to fine-tune the output.
122 if (empty($this->notice)) {
123 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
125 } else if (empty($this->profile)) {
126 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
131 if (Event::handle('StartShowNoticeItem', array($this))) {
133 Event::handle('EndShowNoticeItem', array($this));
138 function showNotice()
140 if (Event::handle('StartShowNoticeItemNotice', array($this))) {
141 $this->showNoticeHeaders();
142 $this->showContent();
143 $this->showNoticeFooter();
144 Event::handle('EndShowNoticeItemNotice', array($this));
148 function showNoticeHeaders()
150 $this->elementStart('section', array('class'=>'notice-headers'));
151 $this->showNoticeTitle();
153 if ($this->addressees) { $this->showAddressees(); }
154 $this->elementEnd('section');
157 function showNoticeFooter()
159 $this->elementStart('footer');
160 $this->showNoticeInfo();
161 if ($this->options) { $this->showNoticeOptions(); }
162 if ($this->attachments) { $this->showNoticeAttachments(); }
163 $this->elementEnd('footer');
166 function showNoticeTitle()
168 if (Event::handle('StartShowNoticeTitle', array($this))) {
169 $this->element('a', array('href' => $this->notice->getUrl(),
170 'class' => 'notice-title'),
171 $this->notice->getTitle());
172 Event::handle('EndShowNoticeTitle', array($this));
176 function showNoticeInfo()
178 if (Event::handle('StartShowNoticeInfo', array($this))) {
179 $this->showNoticeLink();
180 $this->showNoticeSource();
181 $this->showNoticeLocation();
182 $this->showPermalink();
183 Event::handle('EndShowNoticeInfo', array($this));
187 function showNoticeOptions()
189 if (Event::handle('StartShowNoticeOptions', array($this))) {
190 $user = common_current_user();
192 $this->out->elementStart('div', 'notice-options');
193 if (Event::handle('StartShowNoticeOptionItems', array($this))) {
194 $this->showReplyLink();
195 $this->showDeleteLink();
196 Event::handle('EndShowNoticeOptionItems', array($this));
198 $this->out->elementEnd('div');
200 Event::handle('EndShowNoticeOptions', array($this));
205 * start a single notice.
211 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
212 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
213 $class = 'h-entry notice';
214 if ($this->notice->scope != 0 && $this->notice->scope != 1) {
215 $class .= ' limited-scope';
217 if (!empty($this->notice->source)) {
218 $class .= ' notice-source-'.$this->notice->source;
220 $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
221 $this->out->elementStart($this->item_tag, array('class' => $class,
222 'id' => "${id_prefix}notice-${id}"));
223 Event::handle('EndOpenNoticeListItemElement', array($this));
228 * show the author of a notice
230 * By default, this shows the avatar and (linked) nickname of the author.
235 function showAuthor()
237 $attrs = array('href' => $this->profile->profileurl,
238 'class' => 'h-card p-author',
239 'title' => $this->profile->getNickname());
241 if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
242 $this->out->elementStart('a', $attrs);
243 $this->showAvatar($this->profile);
244 $this->out->text($this->profile->getStreamName());
245 $this->out->elementEnd('a');
246 Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
250 function showAddressees()
252 $pa = $this->getProfileAddressees();
255 $this->out->elementStart('ul', 'addressees');
257 foreach ($pa as $addr) {
258 $this->out->elementStart('li', 'h-card');
259 $text = $addr['text'];
260 unset($addr['text']);
261 $this->out->element('a', $addr, $text);
262 $this->out->elementEnd('li');
264 $this->out->elementEnd('ul', 'addressees');
268 function getProfileAddressees()
272 $attentions = $this->getReplyProfiles();
274 foreach ($attentions as $attn) {
275 $class = $attn->isGroup() ? 'group' : 'account';
276 $pa[] = array('href' => $attn->profileurl,
277 'title' => $attn->getNickname(),
278 'class' => "addressee {$class}",
279 'text' => $attn->getStreamName());
285 function getReplyProfiles()
287 return $this->notice->getReplyProfiles();
291 * show the nickname of the author
293 * Links to the author's profile page
297 function showNickname()
299 $this->out->raw('<span class="p-name">' .
300 htmlspecialchars($this->profile->getNickname()) .
305 * show the content of the notice
307 * Shows the content of the notice. This is pre-rendered for efficiency
308 * at save time. Some very old notices might not be pre-rendered, so
309 * they're rendered on the spot.
313 function showContent()
315 // FIXME: URL, image, video, audio
316 $this->out->elementStart('article', array('class' => 'e-content'));
317 if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
318 if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
319 $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
320 } elseif ($this->notice->rendered) {
321 $this->out->raw($this->notice->rendered);
323 // XXX: may be some uncooked notices in the DB,
324 // we cook them right now. This should probably disappear in future
325 // versions (>> 0.4.x)
326 $this->out->raw(common_render_content($this->notice->content, $this->notice));
328 Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
330 $this->out->elementEnd('article');
333 function showNoticeAttachments() {
334 if (common_config('attachments', 'show_thumbs')) {
335 $al = new InlineAttachmentList($this->notice, $this->out);
341 * show the link to the main page for the notice
343 * Displays a local link to the rendered notice, with "relative" time.
347 function showNoticeLink()
349 $this->out->elementStart('a', array('rel' => 'bookmark',
350 'class' => 'timestamp',
351 'href' => Conversation::getUrlFromNotice($this->notice)));
352 $this->out->element('time', array('class' => 'dt-published',
353 'datetime' => common_date_iso8601($this->notice->created),
354 // TRANS: Timestamp title (tooltip text) for NoticeListItem
355 'title' => common_exact_date($this->notice->created)),
356 common_date_string($this->notice->created));
357 $this->out->elementEnd('a');
361 * show the notice location
363 * shows the notice location in the correct language.
365 * If an URL is available, makes a link. Otherwise, just a span.
369 function showNoticeLocation()
371 $id = $this->notice->id;
373 $location = $this->notice->getLocation();
375 if (empty($location)) {
379 $name = $location->getName();
381 $lat = $this->notice->lat;
382 $lon = $this->notice->lon;
383 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
386 $latdms = $this->decimalDegreesToDMS(abs($lat));
387 $londms = $this->decimalDegreesToDMS(abs($lon));
388 // TRANS: Used in coordinates as abbreviation of north.
390 // TRANS: Used in coordinates as abbreviation of south.
392 // TRANS: Used in coordinates as abbreviation of east.
394 // TRANS: Used in coordinates as abbreviation of west.
397 // TRANS: Coordinates message.
398 // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
399 // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
400 // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
401 // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
402 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
403 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
404 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
407 $url = $location->getUrl();
409 $this->out->text(' ');
410 $this->out->elementStart('span', array('class' => 'location'));
411 // TRANS: Followed by geo location.
412 $this->out->text(_('at'));
413 $this->out->text(' ');
415 $this->out->element('abbr', array('class' => 'geo',
419 $xstr = new XMLStringer(false);
420 $xstr->elementStart('a', array('href' => $url,
421 'rel' => 'external'));
422 $xstr->element('abbr', array('class' => 'geo',
425 $xstr->elementEnd('a');
426 $this->out->raw($xstr->getString());
428 $this->out->elementEnd('span');
432 * @param number $dec decimal degrees
433 * @return array split into 'deg', 'min', and 'sec'
435 function decimalDegreesToDMS($dec)
438 $tempma = abs($dec) - abs($deg);
440 $tempma = $tempma * 3600;
441 $min = floor($tempma / 60);
442 $sec = $tempma - ($min*60);
444 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
448 * Show the source of the notice
450 * Either the name (and link) of the API client that posted the notice,
451 * or one of other other channels.
455 function showNoticeSource()
457 $ns = $this->notice->getSource();
459 if (!$ns instanceof Notice_source) {
463 // TRANS: A possible notice source (web interface).
464 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
465 $this->out->text(' ');
466 $this->out->elementStart('span', 'source');
467 // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
468 // TRANS: Followed by notice source.
469 $this->out->text(_('from'));
470 $this->out->text(' ');
472 $name = $source_name;
476 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
477 $name = $source_name;
480 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
482 // if $ns->name and $ns->url are populated we have
483 // configured a source attr somewhere
484 if (!empty($name) && !empty($url)) {
485 $this->out->elementStart('span', 'device');
492 if (!empty($title)) {
493 $attrs['title'] = $title;
496 $this->out->element('a', $attrs, $name);
497 $this->out->elementEnd('span');
499 $this->out->element('span', 'device', $name);
502 $this->out->elementEnd('span');
506 * show link to single-notice view for this notice item
508 * A permalink that goes to this specific object and nothing else
512 function showPermalink()
514 $class = 'permalink u-url';
515 if (!$this->notice->isLocal()) {
516 $class .= ' external';
519 $this->out->element('a',
520 array('href' => $this->notice->getUrl(),
522 // TRANS: Addition in notice list item for single-notice view.
524 } catch (InvalidUrlException $e) {
525 // no permalink available
530 * show a link to reply to the current notice
532 * Should either do the reply in the current notice form (if available), or
533 * link out to the notice-posting form. A little flakey, doesn't always work.
537 function showReplyLink()
539 if (common_logged_in()) {
540 $this->out->text(' ');
541 $reply_url = common_local_url('newnotice',
542 array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
543 $this->out->elementStart('a', array('href' => $reply_url,
544 'class' => 'notice_reply',
545 // TRANS: Link title in notice list item to reply to a notice.
546 'title' => _('Reply to this notice.')));
547 // TRANS: Link text in notice list item to reply to a notice.
548 $this->out->text(_('Reply'));
549 $this->out->text(' ');
550 $this->out->element('span', 'notice_id', $this->notice->id);
551 $this->out->elementEnd('a');
556 * if the user is the author, let them delete the notice
560 function showDeleteLink()
562 $user = common_current_user();
564 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
567 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
568 $this->out->text(' ');
569 $deleteurl = common_local_url('deletenotice',
570 array('notice' => $todel->id));
571 $this->out->element('a', array('href' => $deleteurl,
572 'class' => 'notice_delete popup',
573 // TRANS: Link title in notice list item to delete a notice.
574 'title' => _('Delete this notice from the timeline.')),
575 // TRANS: Link text in notice list item to delete a notice.
583 * Close the last elements in the notice list item
589 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
590 $this->out->elementEnd('li');
591 Event::handle('EndCloseNoticeListItemElement', array($this));
596 * Get the notice in question
598 * For hooks, etc., this may be useful
600 * @return Notice The notice we're showing
605 return $this->notice;