3 * Laconica, 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@controlyourself.ca>
25 * @author Sarven Capadisli <csarven@controlyourself.ca>
26 * @copyright 2008 Control Yourself, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://laconi.ca/
31 if (!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@controlyourself.ca>
50 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51 * @link http://laconi.ca/
55 * @see ProfileNoticeList
58 class NoticeList extends Widget
60 /** the current stream of notices being displayed. */
67 * @param Notice $notice stream of notices from DB_DataObject
70 function __construct($notice, $out=null)
72 parent::__construct($out);
73 $this->notice = $notice;
77 * show the list of notices
79 * "Uses up" the stream by looping through it. So, probably can't
80 * be called twice on the same list.
82 * @return int count of notices listed.
87 $this->out->elementStart('div', array('id' =>'notices_primary'));
88 $this->out->element('h2', null, _('Notices'));
89 $this->out->elementStart('ul', array('class' => 'notices'));
93 while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
96 if ($cnt > NOTICES_PER_PAGE) {
100 $item = $this->newListItem($this->notice);
104 $this->out->elementEnd('ul');
105 $this->out->elementEnd('div');
111 * returns a new list item for the current notice
113 * Recipe (factory?) method; overridden by sub-classes to give
114 * a different list item class.
116 * @param Notice $notice the current notice
118 * @return NoticeListItem a list item for displaying the notice
121 function newListItem($notice)
123 return new NoticeListItem($notice, $this->out);
128 * widget for displaying a single notice
130 * This widget has the core smarts for showing a single notice: what to display,
131 * where, and under which circumstances. Its key method is show(); this is a recipe
132 * that calls all the other show*() methods to build up a single notice. The
133 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
134 * author info (since that's implicit by the data in the page).
138 * @author Evan Prodromou <evan@controlyourself.ca>
139 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
140 * @link http://laconi.ca/
142 * @see ProfileNoticeListItem
145 class NoticeListItem extends Widget
147 /** The notice this item will show. */
151 /** The profile of the author of the notice, extracted once for convenience. */
158 * Also initializes the profile attribute.
160 * @param Notice $notice The notice we'll display
163 function __construct($notice, $out=null)
165 parent::__construct($out);
166 $this->notice = $notice;
167 $this->profile = $notice->getProfile();
171 * recipe function for displaying a single notice.
173 * This uses all the other methods to correctly display a notice. Override
174 * it or one of the others to fine-tune the output.
183 $this->showNoticeAttachmentsIcon();
184 $this->showNoticeInfo();
185 $this->showNoticeOptions();
186 $this->showNoticeAttachments();
190 function showNotice()
192 $this->out->elementStart('div', 'entry-title');
194 $this->showContent();
195 $this->out->elementEnd('div');
198 function showNoticeAttachments() {
199 if ($this->isUsedInList()) {
202 $al = new AttachmentList($this->notice, $this->out);
206 function isUsedInList() {
207 return 'shownotice' !== $this->out->args['action'];
210 function attachmentCount() {
211 $f2p = new File_to_post;
212 $f2p->post_id = $this->notice->id;
214 $file->joinAdd($f2p);
216 $file->selectAdd('file.id as id');
217 return $file->find(true);
220 function showNoticeAttachmentsIcon()
222 if (!($this->isUsedInList() && ($count = $this->attachmentCount()))) {
226 $href = common_local_url('shownotice', array('notice' => $this->notice->id)) . '#attachments';
228 $this->out->elementStart('p', 'entry-attachments');
229 $this->out->element('a', array('href' => $href, 'title' => "# of attachments: $count"), $count === 1 ? '' : $count);
230 $this->out->elementEnd('p');
233 function showNoticeInfo()
235 $this->out->elementStart('div', 'entry-content');
236 $this->showNoticeLink();
237 $this->showNoticeSource();
238 $this->showContext();
239 $this->out->elementEnd('div');
242 function showNoticeOptions()
244 $user = common_current_user();
246 $this->out->elementStart('div', 'notice-options');
247 $this->showFaveForm();
248 $this->showReplyLink();
249 $this->showDeleteLink();
250 $this->out->elementEnd('div');
255 * start a single notice.
263 // TODO: add notice_type class e.g., notice_video, notice_image
264 $this->out->elementStart('li', array('class' => 'hentry notice',
265 'id' => 'notice-' . $this->notice->id));
269 * show the "favorite" form
274 function showFaveForm()
276 $user = common_current_user();
278 if ($user->hasFave($this->notice)) {
279 $disfavor = new DisfavorForm($this->out, $this->notice);
282 $favor = new FavorForm($this->out, $this->notice);
289 * show the author of a notice
291 * By default, this shows the avatar and (linked) nickname of the author.
296 function showAuthor()
298 $this->out->elementStart('span', 'vcard author');
299 $attrs = array('href' => $this->profile->profileurl,
301 if (!empty($this->profile->fullname)) {
302 $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ') ';
304 $this->out->elementStart('a', $attrs);
306 $this->showNickname();
307 $this->out->elementEnd('a');
308 $this->out->elementEnd('span');
312 * show the avatar of the notice's author
314 * This will use the default avatar if no avatar is assigned for the author.
315 * It makes a link to the author's profile.
320 function showAvatar()
322 if ('shownotice' === $this->out->trimmed('action')) {
323 $avatar_size = AVATAR_PROFILE_SIZE;
325 $avatar_size = AVATAR_STREAM_SIZE;
327 $avatar = $this->profile->getAvatar($avatar_size);
329 $this->out->element('img', array('src' => ($avatar) ?
330 $avatar->displayUrl() :
331 Avatar::defaultImage($avatar_size),
332 'class' => 'avatar photo',
333 'width' => $avatar_size,
334 'height' => $avatar_size,
336 ($this->profile->fullname) ?
337 $this->profile->fullname :
338 $this->profile->nickname));
342 * show the nickname of the author
344 * Links to the author's profile page
349 function showNickname()
351 $this->out->element('span', array('class' => 'nickname fn'),
352 $this->profile->nickname);
356 * show the content of the notice
358 * Shows the content of the notice. This is pre-rendered for efficiency
359 * at save time. Some very old notices might not be pre-rendered, so
360 * they're rendered on the spot.
365 function showContent()
367 // FIXME: URL, image, video, audio
368 $this->out->elementStart('p', array('class' => 'entry-content'));
369 if ($this->notice->rendered) {
370 $this->out->raw($this->notice->rendered);
372 // XXX: may be some uncooked notices in the DB,
373 // we cook them right now. This should probably disappear in future
374 // versions (>> 0.4.x)
375 $this->out->raw(common_render_content($this->notice->content, $this->notice));
377 $this->out->elementEnd('p');
381 * show the link to the main page for the notice
383 * Displays a link to the page for a notice, with "relative" time. Tries to
384 * get remote notice URLs correct, but doesn't always succeed.
389 function showNoticeLink()
391 $noticeurl = common_local_url('shownotice',
392 array('notice' => $this->notice->id));
393 // XXX: we need to figure this out better. Is this right?
394 if (strcmp($this->notice->uri, $noticeurl) != 0 &&
395 preg_match('/^http/', $this->notice->uri)) {
396 $noticeurl = $this->notice->uri;
398 $this->out->elementStart('dl', 'timestamp');
399 $this->out->element('dt', null, _('Published'));
400 $this->out->elementStart('dd', null);
401 $this->out->elementStart('a', array('rel' => 'bookmark',
402 'href' => $noticeurl));
403 $dt = common_date_iso8601($this->notice->created);
404 $this->out->element('abbr', array('class' => 'published',
406 common_date_string($this->notice->created));
407 $this->out->elementEnd('a');
408 $this->out->elementEnd('dd');
409 $this->out->elementEnd('dl');
413 * Show the source of the notice
415 * Either the name (and link) of the API client that posted the notice,
416 * or one of other other channels.
421 function showNoticeSource()
423 if ($this->notice->source) {
424 $this->out->elementStart('dl', 'device');
425 $this->out->element('dt', null, _('From'));
426 $source_name = _($this->notice->source);
427 switch ($this->notice->source) {
434 $this->out->element('dd', null, $source_name);
437 $ns = Notice_source::staticGet($this->notice->source);
439 $this->out->elementStart('dd', null);
440 $this->out->element('a', array('href' => $ns->url,
441 'rel' => 'external'),
443 $this->out->elementEnd('dd');
445 $this->out->element('dd', null, $source_name);
449 $this->out->elementEnd('dl');
454 * show link to notice this notice is a reply to
456 * If this notice is a reply, show a link to the notice it is replying to. The
457 * heavy lifting for figuring out replies happens at save time.
462 function showContext()
464 // XXX: also show context if there are replies to this notice
465 if (!empty($this->notice->conversation)
466 && $this->notice->conversation != $this->notice->id) {
467 $convurl = common_local_url('conversation',
468 array('id' => $this->notice->conversation));
469 $this->out->elementStart('dl', 'response');
470 $this->out->element('dt', null, _('To'));
471 $this->out->elementStart('dd');
472 $this->out->element('a', array('href' => $convurl),
474 $this->out->elementEnd('dd');
475 $this->out->elementEnd('dl');
480 * show a link to reply to the current notice
482 * Should either do the reply in the current notice form (if available), or
483 * link out to the notice-posting form. A little flakey, doesn't always work.
488 function showReplyLink()
490 if (common_logged_in()) {
491 $reply_url = common_local_url('newnotice',
492 array('replyto' => $this->profile->nickname));
494 $this->out->elementStart('dl', 'notice_reply');
495 $this->out->element('dt', null, _('Reply to this notice'));
496 $this->out->elementStart('dd');
497 $this->out->elementStart('a', array('href' => $reply_url,
498 'title' => _('Reply to this notice')));
499 $this->out->text(_('Reply'));
500 $this->out->element('span', 'notice_id', $this->notice->id);
501 $this->out->elementEnd('a');
502 $this->out->elementEnd('dd');
503 $this->out->elementEnd('dl');
508 * if the user is the author, let them delete the notice
513 function showDeleteLink()
515 $user = common_current_user();
516 if ($user && $this->notice->profile_id == $user->id) {
517 $deleteurl = common_local_url('deletenotice',
518 array('notice' => $this->notice->id));
519 $this->out->elementStart('dl', 'notice_delete');
520 $this->out->element('dt', null, _('Delete this notice'));
521 $this->out->elementStart('dd');
522 $this->out->element('a', array('href' => $deleteurl,
523 'title' => _('Delete this notice')), _('Delete'));
524 $this->out->elementEnd('dd');
525 $this->out->elementEnd('dl');
532 * Close the last elements in the notice list item
539 $this->out->elementEnd('li');