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.
266 if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
267 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
268 $this->out->elementStart('li', array('class' => 'hentry notice',
269 'id' => 'notice-' . $id));
270 Event::handle('EndOpenNoticeListItemElement', array($this));
275 * show the "favorite" form
280 function showFaveForm()
282 if (Event::handle('StartShowFaveForm', array($this))) {
283 $user = common_current_user();
285 if ($user->hasFave($this->notice)) {
286 $disfavor = new DisfavorForm($this->out, $this->notice);
289 $favor = new FavorForm($this->out, $this->notice);
293 Event::handle('EndShowFaveForm', array($this));
298 * show the author of a notice
300 * By default, this shows the avatar and (linked) nickname of the author.
305 function showAuthor()
307 $this->out->elementStart('span', 'vcard author');
308 $attrs = array('href' => $this->profile->profileurl,
310 if (!empty($this->profile->fullname)) {
311 $attrs['title'] = $this->profile->getFancyName();
313 $this->out->elementStart('a', $attrs);
315 $this->out->text(' ');
316 $this->showNickname();
317 $this->out->elementEnd('a');
318 $this->out->elementEnd('span');
322 * show the avatar of the notice's author
324 * This will use the default avatar if no avatar is assigned for the author.
325 * It makes a link to the author's profile.
330 function showAvatar()
332 $avatar_size = $this->avatarSize();
334 $avatar = $this->profile->getAvatar($avatar_size);
336 $this->out->element('img', array('src' => ($avatar) ?
337 $avatar->displayUrl() :
338 Avatar::defaultImage($avatar_size),
339 'class' => 'avatar photo',
340 'width' => $avatar_size,
341 'height' => $avatar_size,
343 ($this->profile->fullname) ?
344 $this->profile->fullname :
345 $this->profile->nickname));
348 function avatarSize()
350 return AVATAR_STREAM_SIZE;
354 * show the nickname of the author
356 * Links to the author's profile page
361 function showNickname()
363 $this->out->raw('<span class="nickname fn">' .
364 htmlspecialchars($this->profile->nickname) .
369 * show the content of the notice
371 * Shows the content of the notice. This is pre-rendered for efficiency
372 * at save time. Some very old notices might not be pre-rendered, so
373 * they're rendered on the spot.
378 function showContent()
380 // FIXME: URL, image, video, audio
381 $this->out->elementStart('p', array('class' => 'entry-content'));
382 if ($this->notice->rendered) {
383 $this->out->raw($this->notice->rendered);
385 // XXX: may be some uncooked notices in the DB,
386 // we cook them right now. This should probably disappear in future
387 // versions (>> 0.4.x)
388 $this->out->raw(common_render_content($this->notice->content, $this->notice));
390 $this->out->elementEnd('p');
393 function showNoticeAttachments() {
394 if (common_config('attachments', 'show_thumbs')) {
395 $al = new InlineAttachmentList($this->notice, $this->out);
401 * show the link to the main page for the notice
403 * Displays a link to the page for a notice, with "relative" time. Tries to
404 * get remote notice URLs correct, but doesn't always succeed.
409 function showNoticeLink()
411 $noticeurl = $this->notice->bestUrl();
413 // above should always return an URL
415 assert(!empty($noticeurl));
417 $this->out->elementStart('a', array('rel' => 'bookmark',
418 'class' => 'timestamp',
419 'href' => $noticeurl));
420 $dt = common_date_iso8601($this->notice->created);
421 $this->out->element('abbr', array('class' => 'published',
423 common_date_string($this->notice->created));
424 $this->out->elementEnd('a');
428 * show the notice location
430 * shows the notice location in the correct language.
432 * If an URL is available, makes a link. Otherwise, just a span.
437 function showNoticeLocation()
439 $id = $this->notice->id;
441 $location = $this->notice->getLocation();
443 if (empty($location)) {
447 $name = $location->getName();
449 $lat = $this->notice->lat;
450 $lon = $this->notice->lon;
451 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
454 $latdms = $this->decimalDegreesToDMS(abs($lat));
455 $londms = $this->decimalDegreesToDMS(abs($lon));
456 // TRANS: Used in coordinates as abbreviation of north
458 // TRANS: Used in coordinates as abbreviation of south
460 // TRANS: Used in coordinates as abbreviation of east
462 // TRANS: Used in coordinates as abbreviation of west
465 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
466 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
467 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
470 $url = $location->getUrl();
472 $this->out->text(' ');
473 $this->out->elementStart('span', array('class' => 'location'));
474 $this->out->text(_('at'));
475 $this->out->text(' ');
477 $this->out->element('abbr', array('class' => 'geo',
481 $xstr = new XMLStringer(false);
482 $xstr->elementStart('a', array('href' => $url,
483 'rel' => 'external'));
484 $xstr->element('abbr', array('class' => 'geo',
487 $xstr->elementEnd('a');
488 $this->out->raw($xstr->getString());
490 $this->out->elementEnd('span');
494 * @param number $dec decimal degrees
495 * @return array split into 'deg', 'min', and 'sec'
497 function decimalDegreesToDMS($dec)
500 $tempma = abs($dec) - abs($deg);
502 $tempma = $tempma * 3600;
503 $min = floor($tempma / 60);
504 $sec = $tempma - ($min*60);
506 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
510 * Show the source of the notice
512 * Either the name (and link) of the API client that posted the notice,
513 * or one of other other channels.
518 function showNoticeSource()
520 $ns = $this->notice->getSource();
523 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _('web')) : _($ns->name);
524 $this->out->text(' ');
525 $this->out->elementStart('span', 'source');
526 // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
527 $this->out->text(_('from'));
528 $this->out->text(' ');
530 $name = $source_name;
534 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
535 $name = $source_name;
538 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
540 // if $ns->name and $ns->url are populated we have
541 // configured a source attr somewhere
542 if (!empty($name) && !empty($url)) {
544 $this->out->elementStart('span', 'device');
551 if (!empty($title)) {
552 $attrs['title'] = $title;
555 $this->out->element('a', $attrs, $name);
556 $this->out->elementEnd('span');
558 $this->out->element('span', 'device', $name);
561 $this->out->elementEnd('span');
566 * show link to notice this notice is a reply to
568 * If this notice is a reply, show a link to the notice it is replying to. The
569 * heavy lifting for figuring out replies happens at save time.
574 function showContext()
576 if ($this->notice->hasConversation()) {
577 $conv = Conversation::staticGet(
579 $this->notice->conversation
581 $convurl = $conv->uri;
582 if (!empty($convurl)) {
583 $this->out->text(' ');
587 'href' => $convurl.'#notice-'.$this->notice->id,
588 'class' => 'response'),
593 "Couldn't find Conversation ID %d to make 'in context'"
594 . "link for Notice ID %d",
595 $this->notice->conversation,
598 common_log(LOG_WARNING, $msg);
604 * show a link to the author of repeat
609 function showRepeat()
611 if (!empty($this->repeat)) {
613 $repeater = Profile::staticGet('id', $this->repeat->profile_id);
615 $attrs = array('href' => $repeater->profileurl,
618 if (!empty($repeater->fullname)) {
619 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
622 $this->out->elementStart('span', 'repeat vcard');
624 $this->out->raw(_('Repeated by'));
626 $this->out->elementStart('a', $attrs);
627 $this->out->element('span', 'fn nickname', $repeater->nickname);
628 $this->out->elementEnd('a');
630 $this->out->elementEnd('span');
635 * show a link to reply to the current notice
637 * Should either do the reply in the current notice form (if available), or
638 * link out to the notice-posting form. A little flakey, doesn't always work.
643 function showReplyLink()
645 if (common_logged_in()) {
646 $this->out->text(' ');
647 $reply_url = common_local_url('newnotice',
648 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
649 $this->out->elementStart('a', array('href' => $reply_url,
650 'class' => 'notice_reply',
651 'title' => _('Reply to this notice')));
652 $this->out->text(_('Reply'));
653 $this->out->text(' ');
654 $this->out->element('span', 'notice_id', $this->notice->id);
655 $this->out->elementEnd('a');
660 * if the user is the author, let them delete the notice
665 function showDeleteLink()
667 $user = common_current_user();
669 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
672 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
673 $this->out->text(' ');
674 $deleteurl = common_local_url('deletenotice',
675 array('notice' => $todel->id));
676 $this->out->element('a', array('href' => $deleteurl,
677 'class' => 'notice_delete',
678 'title' => _('Delete this notice')), _('Delete'));
683 * show the form to repeat a notice
688 function showRepeatForm()
690 $user = common_current_user();
691 if ($user && $user->id != $this->notice->profile_id) {
692 $this->out->text(' ');
693 $profile = $user->getProfile();
694 if ($profile->hasRepeated($this->notice->id)) {
695 $this->out->element('span', array('class' => 'repeated',
696 'title' => _('Notice repeated')),
699 $rf = new RepeatForm($this->out, $this->notice);
708 * Close the last elements in the notice list item
715 if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
716 $this->out->elementEnd('li');
717 Event::handle('EndCloseNoticeListItemElement', array($this));