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.
195 if (Event::handle('StartShowNoticeItem', array($this))) {
197 $this->showNoticeInfo();
198 $this->showNoticeOptions();
199 Event::handle('EndShowNoticeItem', array($this));
204 function showNotice()
206 $this->out->elementStart('div', 'entry-title');
208 $this->showContent();
209 $this->out->elementEnd('div');
212 function showNoticeInfo()
214 $this->out->elementStart('div', 'entry-content');
215 $this->showNoticeLink();
216 $this->showNoticeSource();
217 $this->showNoticeLocation();
218 $this->showContext();
220 $this->out->elementEnd('div');
223 function showNoticeOptions()
225 $user = common_current_user();
227 $this->out->elementStart('div', 'notice-options');
228 $this->showFaveForm();
229 $this->showReplyLink();
230 $this->showRepeatForm();
231 $this->showDeleteLink();
232 $this->out->elementEnd('div');
237 * start a single notice.
245 // TODO: add notice_type class e.g., notice_video, notice_image
246 $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
247 $this->out->elementStart('li', array('class' => 'hentry notice',
248 'id' => 'notice-' . $id));
252 * show the "favorite" form
257 function showFaveForm()
259 $user = common_current_user();
261 if ($user->hasFave($this->notice)) {
262 $disfavor = new DisfavorForm($this->out, $this->notice);
265 $favor = new FavorForm($this->out, $this->notice);
272 * show the author of a notice
274 * By default, this shows the avatar and (linked) nickname of the author.
279 function showAuthor()
281 $this->out->elementStart('span', 'vcard author');
282 $attrs = array('href' => $this->profile->profileurl,
284 if (!empty($this->profile->fullname)) {
285 $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
287 $this->out->elementStart('a', $attrs);
289 $this->showNickname();
290 $this->out->elementEnd('a');
291 $this->out->elementEnd('span');
295 * show the avatar of the notice's author
297 * This will use the default avatar if no avatar is assigned for the author.
298 * It makes a link to the author's profile.
303 function showAvatar()
305 if ('shownotice' === $this->out->trimmed('action')) {
306 $avatar_size = AVATAR_PROFILE_SIZE;
308 $avatar_size = AVATAR_STREAM_SIZE;
310 $avatar = $this->profile->getAvatar($avatar_size);
312 $this->out->element('img', array('src' => ($avatar) ?
313 $avatar->displayUrl() :
314 Avatar::defaultImage($avatar_size),
315 'class' => 'avatar photo',
316 'width' => $avatar_size,
317 'height' => $avatar_size,
319 ($this->profile->fullname) ?
320 $this->profile->fullname :
321 $this->profile->nickname));
325 * show the nickname of the author
327 * Links to the author's profile page
332 function showNickname()
334 $this->out->element('span', array('class' => 'nickname fn'),
335 $this->profile->nickname);
339 * show the content of the notice
341 * Shows the content of the notice. This is pre-rendered for efficiency
342 * at save time. Some very old notices might not be pre-rendered, so
343 * they're rendered on the spot.
348 function showContent()
350 // FIXME: URL, image, video, audio
351 $this->out->elementStart('p', array('class' => 'entry-content'));
352 if ($this->notice->rendered) {
353 $this->out->raw($this->notice->rendered);
355 // XXX: may be some uncooked notices in the DB,
356 // we cook them right now. This should probably disappear in future
357 // versions (>> 0.4.x)
358 $this->out->raw(common_render_content($this->notice->content, $this->notice));
360 $this->out->elementEnd('p');
364 * show the link to the main page for the notice
366 * Displays a link to the page for a notice, with "relative" time. Tries to
367 * get remote notice URLs correct, but doesn't always succeed.
372 function showNoticeLink()
374 if($this->notice->is_local){
375 $noticeurl = common_local_url('shownotice',
376 array('notice' => $this->notice->id));
378 $noticeurl = $this->notice->uri;
380 $this->out->elementStart('a', array('rel' => 'bookmark',
381 'class' => 'timestamp',
382 'href' => $noticeurl));
383 $dt = common_date_iso8601($this->notice->created);
384 $this->out->element('abbr', array('class' => 'published',
386 common_date_string($this->notice->created));
387 $this->out->elementEnd('a');
391 * show the notice location
393 * shows the notice location in the correct language.
395 * If an URL is available, makes a link. Otherwise, just a span.
400 function showNoticeLocation()
402 $id = $this->notice->id;
404 $location = $this->notice->getLocation();
406 if (empty($location)) {
410 $name = $location->getName();
412 $lat = $this->notice->lat;
413 $lon = $this->notice->lon;
414 $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
417 $latdms = $this->decimalDegreesToDMS(abs($lat));
418 $londms = $this->decimalDegreesToDMS(abs($lon));
420 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
421 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0?_('N'):_('S')),
422 $londms['deg'],$londms['min'], $londms['sec'],($lon>0?_('E'):_('W')));
425 $url = $location->getUrl();
427 $this->out->elementStart('span', array('class' => 'location'));
428 $this->out->text(_('at'));
430 $this->out->element('span', array('class' => 'geo',
434 $this->out->element('a', array('class' => 'geo',
439 $this->out->elementEnd('span');
442 function decimalDegreesToDMS($dec)
445 $vars = explode(".",$dec);
447 $tempma = "0.".$vars[1];
449 $tempma = $tempma * 3600;
450 $min = floor($tempma / 60);
451 $sec = $tempma - ($min*60);
453 return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
457 * Show the source of the notice
459 * Either the name (and link) of the API client that posted the notice,
460 * or one of other other channels.
465 function showNoticeSource()
467 if ($this->notice->source) {
468 $this->out->elementStart('span', 'source');
469 $this->out->text(_('from'));
470 $source_name = _($this->notice->source);
471 switch ($this->notice->source) {
478 $this->out->element('span', 'device', $source_name);
481 $ns = Notice_source::staticGet($this->notice->source);
483 $this->out->elementStart('span', 'device');
484 $this->out->element('a', array('href' => $ns->url,
485 'rel' => 'external'),
487 $this->out->elementEnd('span');
489 $this->out->element('span', 'device', $source_name);
493 $this->out->elementEnd('span');
498 * show link to notice this notice is a reply to
500 * If this notice is a reply, show a link to the notice it is replying to. The
501 * heavy lifting for figuring out replies happens at save time.
506 function showContext()
508 $hasConversation = false;
509 if( !empty($this->notice->conversation)
510 && $this->notice->conversation != $this->notice->id){
511 $hasConversation = true;
513 $conversation = Notice::conversationStream($this->notice->id, 1, 1);
514 if($conversation->N > 0){
515 $hasConversation = true;
518 if ($hasConversation){
519 $convurl = common_local_url('conversation',
520 array('id' => $this->notice->conversation));
521 $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
522 'class' => 'response'),
528 * show a link to the author of repeat
533 function showRepeat()
535 if (!empty($this->repeat)) {
537 $repeater = Profile::staticGet('id', $this->repeat->profile_id);
539 $attrs = array('href' => $repeater->profileurl,
542 if (!empty($repeater->fullname)) {
543 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
546 $this->out->elementStart('span', 'repeat vcard');
548 $this->out->raw(_('Repeated by'));
550 $avatar = $repeater->getAvatar(AVATAR_MINI_SIZE);
552 $this->out->elementStart('a', $attrs);
554 $this->out->element('span', 'nickname', $repeater->nickname);
555 $this->out->elementEnd('a');
557 $this->out->elementEnd('span');
562 * show a link to reply to the current notice
564 * Should either do the reply in the current notice form (if available), or
565 * link out to the notice-posting form. A little flakey, doesn't always work.
570 function showReplyLink()
572 if (common_logged_in()) {
573 $reply_url = common_local_url('newnotice',
574 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
575 $this->out->elementStart('a', array('href' => $reply_url,
576 'class' => 'notice_reply',
577 'title' => _('Reply to this notice')));
578 $this->out->text(_('Reply'));
579 $this->out->element('span', 'notice_id', $this->notice->id);
580 $this->out->elementEnd('a');
585 * if the user is the author, let them delete the notice
590 function showDeleteLink()
592 $user = common_current_user();
594 $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
597 ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
599 $deleteurl = common_local_url('deletenotice',
600 array('notice' => $todel->id));
601 $this->out->element('a', array('href' => $deleteurl,
602 'class' => 'notice_delete',
603 'title' => _('Delete this notice')), _('Delete'));
608 * show the form to repeat a notice
613 function showRepeatForm()
615 $user = common_current_user();
616 if ($user && $user->id != $this->notice->profile_id) {
617 $profile = $user->getProfile();
618 if ($profile->hasRepeated($this->notice->id)) {
619 $this->out->element('span', array('class' => 'repeated',
620 'title' => _('Notice repeated')),
623 $rf = new RepeatForm($this->out, $this->notice);
632 * Close the last elements in the notice list item
639 $this->out->elementEnd('li');