3 * StatusNet, the distributed open-source microblogging tool
5 * widget for displaying a list of notices
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @copyright 2008 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 require_once INSTALLDIR.'/lib/favorform.php';
36 require_once INSTALLDIR.'/lib/disfavorform.php';
37 require_once INSTALLDIR.'/lib/attachmentlist.php';
40 * widget for displaying a list of notices
42 * There are a number of actions that display a list of notices, in
43 * reverse chronological order. This widget abstracts out most of the
44 * code for UI for notice lists. It's overridden to hide some
45 * data for e.g. the profile page.
49 * @author Evan Prodromou <evan@status.net>
50 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51 * @link http://status.net/
54 * @see ProfileNoticeList
57 class NoticeList extends Widget
59 /** the current stream of notices being displayed. */
66 * @param Notice $notice stream of notices from DB_DataObject
69 function __construct($notice, $out=null)
71 parent::__construct($out);
72 $this->notice = $notice;
76 * show the list of notices
78 * "Uses up" the stream by looping through it. So, probably can't
79 * be called twice on the same list.
81 * @return int count of notices listed.
86 $this->out->elementStart('div', array('id' =>'notices_primary'));
87 $this->out->element('h2', null, _('Notices'));
88 $this->out->elementStart('ol', array('class' => 'notices xoxo'));
92 while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
95 if ($cnt > NOTICES_PER_PAGE) {
100 $item = $this->newListItem($this->notice);
102 } catch (Exception $e) {
103 // we log exceptions and continue
104 common_log(LOG_ERR, $e->getMessage());
109 $this->out->elementEnd('ol');
110 $this->out->elementEnd('div');
116 * returns a new list item for the current notice
118 * Recipe (factory?) method; overridden by sub-classes to give
119 * a different list item class.
121 * @param Notice $notice the current notice
123 * @return NoticeListItem a list item for displaying the notice
126 function newListItem($notice)
128 return new NoticeListItem($notice, $this->out);
133 * widget for displaying a single notice
135 * This widget has the core smarts for showing a single notice: what to display,
136 * where, and under which circumstances. Its key method is show(); this is a recipe
137 * that calls all the other show*() methods to build up a single notice. The
138 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
139 * author info (since that's implicit by the data in the page).
143 * @author Evan Prodromou <evan@status.net>
144 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
145 * @link http://status.net/
147 * @see ProfileNoticeListItem
150 class NoticeListItem extends Widget
152 /** The notice this item will show. */
156 /** The notice that was repeated. */
160 /** The profile of the author of the notice, extracted once for convenience. */
167 * Also initializes the profile attribute.
169 * @param Notice $notice The notice we'll display
172 function __construct($notice, $out=null)
174 parent::__construct($out);
175 if (!empty($notice->repeat_of)) {
176 $original = Notice::staticGet('id', $notice->repeat_of);
177 if (empty($original)) { // could have been deleted
178 $this->notice = $notice;
180 $this->notice = $original;
181 $this->repeat = $notice;
184 $this->notice = $notice;
186 $this->profile = $this->notice->getProfile();
190 * recipe function for displaying a single notice.
192 * This uses all the other methods to correctly display a notice. Override
193 * it or one of the others to fine-tune the output.
200 if (empty($this->notice)) {
201 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
203 } else if (empty($this->profile)) {
204 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
209 if (Event::handle('StartShowNoticeItem', array($this))) {
211 $this->showNoticeAttachments();
212 $this->showNoticeInfo();
213 $this->showNoticeOptions();
214 Event::handle('EndShowNoticeItem', array($this));
219 function showNotice()
221 $this->out->elementStart('div', 'entry-title');
223 $this->showContent();
224 $this->out->elementEnd('div');
227 function showNoticeInfo()
229 $this->out->elementStart('div', 'entry-content');
230 if (Event::handle('StartShowNoticeInfo', array($this))) {
231 $this->showNoticeLink();
232 $this->showNoticeSource();
233 $this->showNoticeLocation();
234 $this->showContext();
236 Event::handle('EndShowNoticeInfo', array($this));
239 $this->out->elementEnd('div');
242 function showNoticeOptions()
244 if (Event::handle('StartShowNoticeOptions', array($this))) {
245 $user = common_current_user();
247 $this->out->elementStart('div', 'notice-options');
248 $this->showFaveForm();
249 $this->showReplyLink();
250 $this->showRepeatForm();
251 $this->showDeleteLink();
252 $this->out->elementEnd('div');
254 Event::handle('EndShowNoticeOptions', array($this));
259 * start a single notice.
267 // TODO: add notice_type class e.g., notice_video, notice_image
268 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
269 $this->out->elementStart('li', array('class' => 'hentry notice',
270 'id' => 'notice-' . $id));
274 * show the "favorite" form
279 function showFaveForm()
281 if (Event::handle('StartShowFaveForm', array($this))) {
282 $user = common_current_user();
284 if ($user->hasFave($this->notice)) {
285 $disfavor = new DisfavorForm($this->out, $this->notice);
288 $favor = new FavorForm($this->out, $this->notice);
292 Event::handle('EndShowFaveForm', array($this));
297 * show the author of a notice
299 * By default, this shows the avatar and (linked) nickname of the author.
304 function showAuthor()
306 $this->out->elementStart('span', 'vcard author');
307 $attrs = array('href' => $this->profile->profileurl,
309 if (!empty($this->profile->fullname)) {
310 $attrs['title'] = $this->profile->getFancyName();
312 $this->out->elementStart('a', $attrs);
314 $this->out->text(' ');
315 $this->showNickname();
316 $this->out->elementEnd('a');
317 $this->out->elementEnd('span');
321 * show the avatar of the notice's author
323 * This will use the default avatar if no avatar is assigned for the author.
324 * It makes a link to the author's profile.
329 function showAvatar()
331 $avatar_size = AVATAR_STREAM_SIZE;
333 $avatar = $this->profile->getAvatar($avatar_size);
335 $this->out->element('img', array('src' => ($avatar) ?
336 $avatar->displayUrl() :
337 Avatar::defaultImage($avatar_size),
338 'class' => 'avatar photo',
339 'width' => $avatar_size,
340 'height' => $avatar_size,
342 ($this->profile->fullname) ?
343 $this->profile->fullname :
344 $this->profile->nickname));
348 * show the nickname of the author
350 * Links to the author's profile page
355 function showNickname()
357 $this->out->raw('<span class="nickname fn">' .
358 htmlspecialchars($this->profile->nickname) .
363 * show the content of the notice
365 * Shows the content of the notice. This is pre-rendered for efficiency
366 * at save time. Some very old notices might not be pre-rendered, so
367 * they're rendered on the spot.
372 function showContent()
374 // FIXME: URL, image, video, audio
375 $this->out->elementStart('p', array('class' => 'entry-content'));
376 if ($this->notice->rendered) {
377 $this->out->raw($this->notice->rendered);
379 // XXX: may be some uncooked notices in the DB,
380 // we cook them right now. This should probably disappear in future
381 // versions (>> 0.4.x)
382 $this->out->raw(common_render_content($this->notice->content, $this->notice));
384 $this->out->elementEnd('p');
387 function showNoticeAttachments() {
388 if (common_config('attachments', 'show_thumbs')) {
389 $al = new InlineAttachmentList($this->notice, $this->out);
395 * show the link to the main page for the notice
397 * Displays a link to the page for a notice, with "relative" time. Tries to
398 * get remote notice URLs correct, but doesn't always succeed.
403 function showNoticeLink()
405 $noticeurl = $this->notice->bestUrl();
407 // above should always return an URL
409 assert(!empty($noticeurl));
411 $this->out->elementStart('a', array('rel' => 'bookmark',
412 'class' => 'timestamp',
413 'href' => $noticeurl));
414 $dt = common_date_iso8601($this->notice->created);
415 $this->out->element('abbr', array('class' => 'published',
417 common_date_string($this->notice->created));
418 $this->out->elementEnd('a');
422 * show the notice location
424 * shows the notice location in the correct language.
426 * If an URL is available, makes a link. Otherwise, just a span.
431 function showNoticeLocation()
433 $id = $this->notice->id;
435 $location = $this->notice->getLocation();
437 if (empty($location)) {
441 $name = $location->getName();
443 $lat = $this->notice->lat;
444 $lon = $this->notice->lon;
445 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
448 $latdms = $this->decimalDegreesToDMS(abs($lat));
449 $londms = $this->decimalDegreesToDMS(abs($lon));
450 // TRANS: Used in coordinates as abbreviation of north
452 // TRANS: Used in coordinates as abbreviation of south
454 // TRANS: Used in coordinates as abbreviation of east
456 // TRANS: Used in coordinates as abbreviation of west
459 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
460 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
461 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
464 $url = $location->getUrl();
466 $this->out->text(' ');
467 $this->out->elementStart('span', array('class' => 'location'));
468 $this->out->text(_('at'));
469 $this->out->text(' ');
471 $this->out->element('abbr', array('class' => 'geo',
475 $xstr = new XMLStringer(false);
476 $xstr->elementStart('a', array('href' => $url,
477 'rel' => 'external'));
478 $xstr->element('abbr', array('class' => 'geo',
481 $xstr->elementEnd('a');
482 $this->out->raw($xstr->getString());
484 $this->out->elementEnd('span');
488 * @param number $dec decimal degrees
489 * @return array split into 'deg', 'min', and 'sec'
491 function decimalDegreesToDMS($dec)
494 $tempma = abs($dec) - abs($deg);
496 $tempma = $tempma * 3600;
497 $min = floor($tempma / 60);
498 $sec = $tempma - ($min*60);
500 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
504 * Show the source of the notice
506 * Either the name (and link) of the API client that posted the notice,
507 * or one of other other channels.
512 function showNoticeSource()
514 $ns = $this->notice->getSource();
517 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _('web')) : _($ns->name);
518 $this->out->text(' ');
519 $this->out->elementStart('span', 'source');
520 // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
521 $this->out->text(_('from'));
522 $this->out->text(' ');
524 $name = $source_name;
528 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
529 $name = $source_name;
532 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
534 // if $ns->name and $ns->url are populated we have
535 // configured a source attr somewhere
536 if (!empty($name) && !empty($url)) {
538 $this->out->elementStart('span', 'device');
545 if (!empty($title)) {
546 $attrs['title'] = $title;
549 $this->out->element('a', $attrs, $name);
550 $this->out->elementEnd('span');
552 $this->out->element('span', 'device', $name);
555 $this->out->elementEnd('span');
560 * show link to notice this notice is a reply to
562 * If this notice is a reply, show a link to the notice it is replying to. The
563 * heavy lifting for figuring out replies happens at save time.
568 function showContext()
570 if ($this->notice->hasConversation()) {
571 $conv = Conversation::staticGet(
573 $this->notice->conversation
575 $convurl = $conv->uri;
576 if (!empty($convurl)) {
577 $this->out->text(' ');
581 'href' => $convurl.'#notice-'.$this->notice->id,
582 'class' => 'response'),
587 "Couldn't find Conversation ID %d to make 'in context'"
588 . "link for Notice ID %d",
589 $this->notice->conversation,
592 common_log(LOG_WARNING, $msg);
598 * show a link to the author of repeat
603 function showRepeat()
605 if (!empty($this->repeat)) {
607 $repeater = Profile::staticGet('id', $this->repeat->profile_id);
609 $attrs = array('href' => $repeater->profileurl,
612 if (!empty($repeater->fullname)) {
613 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
616 $this->out->elementStart('span', 'repeat vcard');
618 $this->out->raw(_('Repeated by'));
620 $this->out->elementStart('a', $attrs);
621 $this->out->element('span', 'fn nickname', $repeater->nickname);
622 $this->out->elementEnd('a');
624 $this->out->elementEnd('span');
629 * show a link to reply to the current notice
631 * Should either do the reply in the current notice form (if available), or
632 * link out to the notice-posting form. A little flakey, doesn't always work.
637 function showReplyLink()
639 if (common_logged_in()) {
640 $this->out->text(' ');
641 $reply_url = common_local_url('newnotice',
642 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
643 $this->out->elementStart('a', array('href' => $reply_url,
644 'class' => 'notice_reply',
645 'title' => _('Reply to this notice')));
646 $this->out->text(_('Reply'));
647 $this->out->text(' ');
648 $this->out->element('span', 'notice_id', $this->notice->id);
649 $this->out->elementEnd('a');
654 * if the user is the author, let them delete the notice
659 function showDeleteLink()
661 $user = common_current_user();
663 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
666 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
667 $this->out->text(' ');
668 $deleteurl = common_local_url('deletenotice',
669 array('notice' => $todel->id));
670 $this->out->element('a', array('href' => $deleteurl,
671 'class' => 'notice_delete',
672 'title' => _('Delete this notice')), _('Delete'));
677 * show the form to repeat a notice
682 function showRepeatForm()
684 $user = common_current_user();
685 if ($user && $user->id != $this->notice->profile_id) {
686 $this->out->text(' ');
687 $profile = $user->getProfile();
688 if ($profile->hasRepeated($this->notice->id)) {
689 $this->out->element('span', array('class' => 'repeated',
690 'title' => _('Notice repeated')),
693 $rf = new RepeatForm($this->out, $this->notice);
702 * Close the last elements in the notice list item
709 $this->out->elementEnd('li');