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->showNoticeInfo();
212 $this->showNoticeOptions();
213 Event::handle('EndShowNoticeItem', array($this));
218 function showNotice()
220 $this->out->elementStart('div', 'entry-title');
222 $this->showContent();
223 $this->out->elementEnd('div');
226 function showNoticeInfo()
228 $this->out->elementStart('div', 'entry-content');
229 if (Event::handle('StartShowNoticeInfo', array($this))) {
230 $this->showNoticeLink();
231 $this->showNoticeSource();
232 $this->showNoticeLocation();
233 $this->showContext();
235 Event::handle('EndShowNoticeInfo', array($this));
238 $this->out->elementEnd('div');
241 function showNoticeOptions()
243 if (Event::handle('StartShowNoticeOptions', array($this))) {
244 $user = common_current_user();
246 $this->out->elementStart('div', 'notice-options');
247 $this->showFaveForm();
248 $this->showReplyLink();
249 $this->showRepeatForm();
250 $this->showDeleteLink();
251 $this->out->elementEnd('div');
253 Event::handle('EndShowNoticeOptions', array($this));
258 * start a single notice.
266 // TODO: add notice_type class e.g., notice_video, notice_image
267 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
268 $this->out->elementStart('li', array('class' => 'hentry notice',
269 'id' => 'notice-' . $id));
273 * show the "favorite" form
278 function showFaveForm()
280 if (Event::handle('StartShowFaveForm', array($this))) {
281 $user = common_current_user();
283 if ($user->hasFave($this->notice)) {
284 $disfavor = new DisfavorForm($this->out, $this->notice);
287 $favor = new FavorForm($this->out, $this->notice);
291 Event::handle('EndShowFaveForm', array($this));
296 * show the author of a notice
298 * By default, this shows the avatar and (linked) nickname of the author.
303 function showAuthor()
305 $this->out->elementStart('span', 'vcard author');
306 $attrs = array('href' => $this->profile->profileurl,
308 if (!empty($this->profile->fullname)) {
309 $attrs['title'] = $this->profile->getFancyName();
311 $this->out->elementStart('a', $attrs);
313 $this->out->text(' ');
314 $this->showNickname();
315 $this->out->elementEnd('a');
316 $this->out->elementEnd('span');
320 * show the avatar of the notice's author
322 * This will use the default avatar if no avatar is assigned for the author.
323 * It makes a link to the author's profile.
328 function showAvatar()
330 $avatar_size = AVATAR_STREAM_SIZE;
332 $avatar = $this->profile->getAvatar($avatar_size);
334 $this->out->element('img', array('src' => ($avatar) ?
335 $avatar->displayUrl() :
336 Avatar::defaultImage($avatar_size),
337 'class' => 'avatar photo',
338 'width' => $avatar_size,
339 'height' => $avatar_size,
341 ($this->profile->fullname) ?
342 $this->profile->fullname :
343 $this->profile->nickname));
347 * show the nickname of the author
349 * Links to the author's profile page
354 function showNickname()
356 $this->out->raw('<span class="nickname fn">' .
357 htmlspecialchars($this->profile->nickname) .
362 * show the content of the notice
364 * Shows the content of the notice. This is pre-rendered for efficiency
365 * at save time. Some very old notices might not be pre-rendered, so
366 * they're rendered on the spot.
371 function showContent()
373 // FIXME: URL, image, video, audio
374 $this->out->elementStart('p', array('class' => 'entry-content'));
375 if ($this->notice->rendered) {
376 $this->out->raw($this->notice->rendered);
378 // XXX: may be some uncooked notices in the DB,
379 // we cook them right now. This should probably disappear in future
380 // versions (>> 0.4.x)
381 $this->out->raw(common_render_content($this->notice->content, $this->notice));
383 $this->out->elementEnd('p');
387 * show the link to the main page for the notice
389 * Displays a link to the page for a notice, with "relative" time. Tries to
390 * get remote notice URLs correct, but doesn't always succeed.
395 function showNoticeLink()
397 $noticeurl = $this->notice->bestUrl();
399 // above should always return an URL
401 assert(!empty($noticeurl));
403 $this->out->elementStart('a', array('rel' => 'bookmark',
404 'class' => 'timestamp',
405 'href' => $noticeurl));
406 $dt = common_date_iso8601($this->notice->created);
407 $this->out->element('abbr', array('class' => 'published',
409 common_date_string($this->notice->created));
410 $this->out->elementEnd('a');
414 * show the notice location
416 * shows the notice location in the correct language.
418 * If an URL is available, makes a link. Otherwise, just a span.
423 function showNoticeLocation()
425 $id = $this->notice->id;
427 $location = $this->notice->getLocation();
429 if (empty($location)) {
433 $name = $location->getName();
435 $lat = $this->notice->lat;
436 $lon = $this->notice->lon;
437 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
440 $latdms = $this->decimalDegreesToDMS(abs($lat));
441 $londms = $this->decimalDegreesToDMS(abs($lon));
442 // TRANS: Used in coordinates as abbreviation of north
444 // TRANS: Used in coordinates as abbreviation of south
446 // TRANS: Used in coordinates as abbreviation of east
448 // TRANS: Used in coordinates as abbreviation of west
451 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
452 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
453 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
456 $url = $location->getUrl();
458 $this->out->text(' ');
459 $this->out->elementStart('span', array('class' => 'location'));
460 $this->out->text(_('at'));
461 $this->out->text(' ');
463 $this->out->element('abbr', array('class' => 'geo',
467 $xstr = new XMLStringer(false);
468 $xstr->elementStart('a', array('href' => $url,
469 'rel' => 'external'));
470 $xstr->element('abbr', array('class' => 'geo',
473 $xstr->elementEnd('a');
474 $this->out->raw($xstr->getString());
476 $this->out->elementEnd('span');
480 * @param number $dec decimal degrees
481 * @return array split into 'deg', 'min', and 'sec'
483 function decimalDegreesToDMS($dec)
486 $tempma = abs($dec) - abs($deg);
488 $tempma = $tempma * 3600;
489 $min = floor($tempma / 60);
490 $sec = $tempma - ($min*60);
492 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
496 * Show the source of the notice
498 * Either the name (and link) of the API client that posted the notice,
499 * or one of other other channels.
504 function showNoticeSource()
506 $ns = $this->notice->getSource();
509 $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _('web')) : _($ns->name);
510 $this->out->text(' ');
511 $this->out->elementStart('span', 'source');
512 // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
513 $this->out->text(_('from'));
514 $this->out->text(' ');
516 $name = $source_name;
520 if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
521 $name = $source_name;
524 Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
526 // if $ns->name and $ns->url are populated we have
527 // configured a source attr somewhere
528 if (!empty($name) && !empty($url)) {
530 $this->out->elementStart('span', 'device');
537 if (!empty($title)) {
538 $attrs['title'] = $title;
541 $this->out->element('a', $attrs, $name);
542 $this->out->elementEnd('span');
544 $this->out->element('span', 'device', $name);
547 $this->out->elementEnd('span');
552 * show link to notice this notice is a reply to
554 * If this notice is a reply, show a link to the notice it is replying to. The
555 * heavy lifting for figuring out replies happens at save time.
560 function showContext()
562 if ($this->notice->hasConversation()) {
563 $conv = Conversation::staticGet(
565 $this->notice->conversation
567 $convurl = $conv->uri;
568 if (!empty($convurl)) {
569 $this->out->text(' ');
573 'href' => $convurl.'#notice-'.$this->notice->id,
574 'class' => 'response'),
579 "Couldn't find Conversation ID %d to make 'in context'"
580 . "link for Notice ID %d",
581 $this->notice->conversation,
584 common_log(LOG_WARNING, $msg);
590 * show a link to the author of repeat
595 function showRepeat()
597 if (!empty($this->repeat)) {
599 $repeater = Profile::staticGet('id', $this->repeat->profile_id);
601 $attrs = array('href' => $repeater->profileurl,
604 if (!empty($repeater->fullname)) {
605 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
608 $this->out->elementStart('span', 'repeat vcard');
610 $this->out->raw(_('Repeated by'));
612 $this->out->elementStart('a', $attrs);
613 $this->out->element('span', 'fn nickname', $repeater->nickname);
614 $this->out->elementEnd('a');
616 $this->out->elementEnd('span');
621 * show a link to reply to the current notice
623 * Should either do the reply in the current notice form (if available), or
624 * link out to the notice-posting form. A little flakey, doesn't always work.
629 function showReplyLink()
631 if (common_logged_in()) {
632 $this->out->text(' ');
633 $reply_url = common_local_url('newnotice',
634 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
635 $this->out->elementStart('a', array('href' => $reply_url,
636 'class' => 'notice_reply',
637 'title' => _('Reply to this notice')));
638 $this->out->text(_('Reply'));
639 $this->out->text(' ');
640 $this->out->element('span', 'notice_id', $this->notice->id);
641 $this->out->elementEnd('a');
646 * if the user is the author, let them delete the notice
651 function showDeleteLink()
653 $user = common_current_user();
655 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
658 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
659 $this->out->text(' ');
660 $deleteurl = common_local_url('deletenotice',
661 array('notice' => $todel->id));
662 $this->out->element('a', array('href' => $deleteurl,
663 'class' => 'notice_delete',
664 'title' => _('Delete this notice')), _('Delete'));
669 * show the form to repeat a notice
674 function showRepeatForm()
676 $user = common_current_user();
677 if ($user && $user->id != $this->notice->profile_id) {
678 $this->out->text(' ');
679 $profile = $user->getProfile();
680 if ($profile->hasRepeated($this->notice->id)) {
681 $this->out->element('span', array('class' => 'repeated',
682 'title' => _('Notice repeated')),
685 $rf = new RepeatForm($this->out, $this->notice);
694 * Close the last elements in the notice list item
701 $this->out->elementEnd('li');