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) {
99 $item = $this->newListItem($this->notice);
103 $this->out->elementEnd('ol');
104 $this->out->elementEnd('div');
110 * returns a new list item for the current notice
112 * Recipe (factory?) method; overridden by sub-classes to give
113 * a different list item class.
115 * @param Notice $notice the current notice
117 * @return NoticeListItem a list item for displaying the notice
120 function newListItem($notice)
122 return new NoticeListItem($notice, $this->out);
127 * widget for displaying a single notice
129 * This widget has the core smarts for showing a single notice: what to display,
130 * where, and under which circumstances. Its key method is show(); this is a recipe
131 * that calls all the other show*() methods to build up a single notice. The
132 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
133 * author info (since that's implicit by the data in the page).
137 * @author Evan Prodromou <evan@status.net>
138 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
139 * @link http://status.net/
141 * @see ProfileNoticeListItem
144 class NoticeListItem extends Widget
146 /** The notice this item will show. */
150 /** The notice that was repeated. */
154 /** The profile of the author of the notice, extracted once for convenience. */
161 * Also initializes the profile attribute.
163 * @param Notice $notice The notice we'll display
166 function __construct($notice, $out=null)
168 parent::__construct($out);
169 if (!empty($notice->repeat_of)) {
170 $original = Notice::staticGet('id', $notice->repeat_of);
171 if (empty($original)) { // could have been deleted
172 $this->notice = $notice;
174 $this->notice = $original;
175 $this->repeat = $notice;
178 $this->notice = $notice;
180 $this->profile = $this->notice->getProfile();
184 * recipe function for displaying a single notice.
186 * This uses all the other methods to correctly display a notice. Override
187 * it or one of the others to fine-tune the output.
194 if (empty($this->notice)) {
195 common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
197 } else if (empty($this->profile)) {
198 common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
203 if (Event::handle('StartShowNoticeItem', array($this))) {
205 $this->showNoticeInfo();
206 $this->showNoticeOptions();
207 Event::handle('EndShowNoticeItem', array($this));
212 function showNotice()
214 $this->out->elementStart('div', 'entry-title');
216 $this->showContent();
217 $this->out->elementEnd('div');
220 function showNoticeInfo()
222 $this->out->elementStart('div', 'entry-content');
223 $this->showNoticeLink();
224 $this->showNoticeSource();
225 $this->showNoticeLocation();
226 $this->showContext();
228 $this->out->elementEnd('div');
231 function showNoticeOptions()
233 $user = common_current_user();
235 $this->out->elementStart('div', 'notice-options');
236 $this->showFaveForm();
237 $this->showReplyLink();
238 $this->showRepeatForm();
239 $this->showDeleteLink();
240 $this->out->elementEnd('div');
245 * start a single notice.
253 // TODO: add notice_type class e.g., notice_video, notice_image
254 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
255 $this->out->elementStart('li', array('class' => 'hentry notice',
256 'id' => 'notice-' . $id));
260 * show the "favorite" form
265 function showFaveForm()
267 $user = common_current_user();
269 if ($user->hasFave($this->notice)) {
270 $disfavor = new DisfavorForm($this->out, $this->notice);
273 $favor = new FavorForm($this->out, $this->notice);
280 * show the author of a notice
282 * By default, this shows the avatar and (linked) nickname of the author.
287 function showAuthor()
289 $this->out->elementStart('span', 'vcard author');
290 $attrs = array('href' => $this->profile->profileurl,
292 if (!empty($this->profile->fullname)) {
293 $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
295 $this->out->elementStart('a', $attrs);
297 $this->showNickname();
298 $this->out->elementEnd('a');
299 $this->out->elementEnd('span');
303 * show the avatar of the notice's author
305 * This will use the default avatar if no avatar is assigned for the author.
306 * It makes a link to the author's profile.
311 function showAvatar()
313 if ('shownotice' === $this->out->trimmed('action')) {
314 $avatar_size = AVATAR_PROFILE_SIZE;
316 $avatar_size = AVATAR_STREAM_SIZE;
318 $avatar = $this->profile->getAvatar($avatar_size);
320 $this->out->element('img', array('src' => ($avatar) ?
321 $avatar->displayUrl() :
322 Avatar::defaultImage($avatar_size),
323 'class' => 'avatar photo',
324 'width' => $avatar_size,
325 'height' => $avatar_size,
327 ($this->profile->fullname) ?
328 $this->profile->fullname :
329 $this->profile->nickname));
333 * show the nickname of the author
335 * Links to the author's profile page
340 function showNickname()
342 $this->out->element('span', array('class' => 'nickname fn'),
343 $this->profile->nickname);
347 * show the content of the notice
349 * Shows the content of the notice. This is pre-rendered for efficiency
350 * at save time. Some very old notices might not be pre-rendered, so
351 * they're rendered on the spot.
356 function showContent()
358 // FIXME: URL, image, video, audio
359 $this->out->elementStart('p', array('class' => 'entry-content'));
360 if ($this->notice->rendered) {
361 $this->out->raw($this->notice->rendered);
363 // XXX: may be some uncooked notices in the DB,
364 // we cook them right now. This should probably disappear in future
365 // versions (>> 0.4.x)
366 $this->out->raw(common_render_content($this->notice->content, $this->notice));
368 $this->out->elementEnd('p');
372 * show the link to the main page for the notice
374 * Displays a link to the page for a notice, with "relative" time. Tries to
375 * get remote notice URLs correct, but doesn't always succeed.
380 function showNoticeLink()
382 if($this->notice->is_local == Notice::LOCAL_PUBLIC || $this->notice->is_local == Notice::LOCAL_NONPUBLIC){
383 $noticeurl = common_local_url('shownotice',
384 array('notice' => $this->notice->id));
386 $noticeurl = $this->notice->uri;
388 $this->out->elementStart('a', array('rel' => 'bookmark',
389 'class' => 'timestamp',
390 'href' => $noticeurl));
391 $dt = common_date_iso8601($this->notice->created);
392 $this->out->element('abbr', array('class' => 'published',
394 common_date_string($this->notice->created));
395 $this->out->elementEnd('a');
399 * show the notice location
401 * shows the notice location in the correct language.
403 * If an URL is available, makes a link. Otherwise, just a span.
408 function showNoticeLocation()
410 $id = $this->notice->id;
412 $location = $this->notice->getLocation();
414 if (empty($location)) {
418 $name = $location->getName();
420 $lat = $this->notice->lat;
421 $lon = $this->notice->lon;
422 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
425 $latdms = $this->decimalDegreesToDMS(abs($lat));
426 $londms = $this->decimalDegreesToDMS(abs($lon));
428 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
429 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0?_('N'):_('S')),
430 $londms['deg'],$londms['min'], $londms['sec'],($lon>0?_('E'):_('W')));
433 $url = $location->getUrl();
435 $this->out->elementStart('span', array('class' => 'location'));
436 $this->out->text(_('at'));
438 $this->out->element('span', array('class' => 'geo',
442 $this->out->element('a', array('class' => 'geo',
447 $this->out->elementEnd('span');
450 function decimalDegreesToDMS($dec)
453 $vars = explode(".",$dec);
455 $tempma = "0.".$vars[1];
457 $tempma = $tempma * 3600;
458 $min = floor($tempma / 60);
459 $sec = $tempma - ($min*60);
461 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
465 * Show the source of the notice
467 * Either the name (and link) of the API client that posted the notice,
468 * or one of other other channels.
473 function showNoticeSource()
475 if ($this->notice->source) {
476 $this->out->elementStart('span', 'source');
477 $this->out->text(_('from'));
478 $source_name = _($this->notice->source);
479 switch ($this->notice->source) {
486 $this->out->element('span', 'device', $source_name);
489 $ns = Notice_source::staticGet($this->notice->source);
491 $this->out->elementStart('span', 'device');
492 $this->out->element('a', array('href' => $ns->url,
493 'rel' => 'external'),
495 $this->out->elementEnd('span');
497 $this->out->element('span', 'device', $source_name);
501 $this->out->elementEnd('span');
506 * show link to notice this notice is a reply to
508 * If this notice is a reply, show a link to the notice it is replying to. The
509 * heavy lifting for figuring out replies happens at save time.
514 function showContext()
516 $hasConversation = false;
517 if( !empty($this->notice->conversation)
518 && $this->notice->conversation != $this->notice->id){
519 $hasConversation = true;
521 $conversation = Notice::conversationStream($this->notice->id, 1, 1);
522 if($conversation->N > 0){
523 $hasConversation = true;
526 if ($hasConversation){
527 $convurl = common_local_url('conversation',
528 array('id' => $this->notice->conversation));
529 $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
530 'class' => 'response'),
536 * show a link to the author of repeat
541 function showRepeat()
543 if (!empty($this->repeat)) {
545 $repeater = Profile::staticGet('id', $this->repeat->profile_id);
547 $attrs = array('href' => $repeater->profileurl,
550 if (!empty($repeater->fullname)) {
551 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
554 $this->out->elementStart('span', 'repeat vcard');
556 $this->out->raw(_('Repeated by'));
558 $avatar = $repeater->getAvatar(AVATAR_MINI_SIZE);
560 $this->out->elementStart('a', $attrs);
562 $this->out->element('span', 'nickname', $repeater->nickname);
563 $this->out->elementEnd('a');
565 $this->out->elementEnd('span');
570 * show a link to reply to the current notice
572 * Should either do the reply in the current notice form (if available), or
573 * link out to the notice-posting form. A little flakey, doesn't always work.
578 function showReplyLink()
580 if (common_logged_in()) {
581 $reply_url = common_local_url('newnotice',
582 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
583 $this->out->elementStart('a', array('href' => $reply_url,
584 'class' => 'notice_reply',
585 'title' => _('Reply to this notice')));
586 $this->out->text(_('Reply'));
587 $this->out->element('span', 'notice_id', $this->notice->id);
588 $this->out->elementEnd('a');
593 * if the user is the author, let them delete the notice
598 function showDeleteLink()
600 $user = common_current_user();
602 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
605 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
607 $deleteurl = common_local_url('deletenotice',
608 array('notice' => $todel->id));
609 $this->out->element('a', array('href' => $deleteurl,
610 'class' => 'notice_delete',
611 'title' => _('Delete this notice')), _('Delete'));
616 * show the form to repeat a notice
621 function showRepeatForm()
623 $user = common_current_user();
624 if ($user && $user->id != $this->notice->profile_id) {
625 $profile = $user->getProfile();
626 if ($profile->hasRepeated($this->notice->id)) {
627 $this->out->element('span', array('class' => 'repeated',
628 'title' => _('Notice repeated')),
631 $rf = new RepeatForm($this->out, $this->notice);
640 * Close the last elements in the notice list item
647 $this->out->elementEnd('li');