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';
39 * widget for displaying a list of notices
41 * There are a number of actions that display a list of notices, in
42 * reverse chronological order. This widget abstracts out most of the
43 * code for UI for notice lists. It's overridden to hide some
44 * data for e.g. the profile page.
48 * @author Evan Prodromou <evan@controlyourself.ca>
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50 * @link http://laconi.ca/
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('ul', array('class' => 'notices'));
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('ul');
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@controlyourself.ca>
138 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
139 * @link http://laconi.ca/
141 * @see ProfileNoticeListItem
144 class NoticeListItem extends Widget
146 /** The notice this item will show. */
150 /** The profile of the author of the notice, extracted once for convenience. */
157 * Also initializes the profile attribute.
159 * @param Notice $notice The notice we'll display
162 function __construct($notice, $out=null)
164 parent::__construct($out);
165 $this->notice = $notice;
166 $this->profile = $notice->getProfile();
170 * recipe function for displaying a single notice.
172 * This uses all the other methods to correctly display a notice. Override
173 * it or one of the others to fine-tune the output.
182 $this->showNoticeAttachments();
183 $this->showNoticeInfo();
184 $this->showNoticeOptions();
188 function showNotice()
190 $this->out->elementStart('div', 'entry-title');
192 $this->showContent();
193 $this->out->elementEnd('div');
196 function showNoticeAttachments()
198 $f2p = new File_to_post;
199 $f2p->post_id = $this->notice->id;
201 $file->joinAdd($f2p);
203 $file->selectAdd('file.id as id');
204 $count = $file->find(true);
207 $href = common_local_url('attachment', array('attachment' => $file->id));
208 $att_class = 'attachment';
210 $href = common_local_url('attachments', array('notice' => $this->notice->id));
211 $att_class = 'attachments';
214 $clip = theme_path('images/icons/clip', 'base');
215 if ('shownotice' === $this->out->args['action']) {
229 $this->out->elementStart('div', 'entry-attachments');
231 $this->out->elementStart('p', array('class' => 'entry-attachments', 'style' => "float: right; width: $width_att; background: url($clip) no-repeat; text-align: right; height: $height;"));
232 $this->out->element('a', array('class' => $att_class, 'style' => "text-decoration: none; padding-top: $top; display: block; height: $height;", 'href' => $href, 'title' => "# of attachments: $count"), $count === 1 ? '' : $count);
235 $this->out->elementEnd('p');
238 function showNoticeInfo()
240 $this->out->elementStart('div', 'entry-content');
241 $this->showNoticeLink();
242 $this->showNoticeSource();
243 $this->showContext();
244 $this->out->elementEnd('div');
247 function showNoticeOptions()
249 $user = common_current_user();
251 $this->out->elementStart('div', 'notice-options');
252 $this->showFaveForm();
253 $this->showReplyLink();
254 $this->showDeleteLink();
255 $this->out->elementEnd('div');
260 * start a single notice.
268 // TODO: add notice_type class e.g., notice_video, notice_image
269 $this->out->elementStart('li', array('class' => 'hentry notice',
270 'id' => 'notice-' . $this->notice->id));
274 * show the "favorite" form
279 function showFaveForm()
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);
294 * show the author of a notice
296 * By default, this shows the avatar and (linked) nickname of the author.
301 function showAuthor()
303 $this->out->elementStart('span', 'vcard author');
304 $attrs = array('href' => $this->profile->profileurl,
306 if (!empty($this->profile->fullname)) {
307 $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ') ';
309 $this->out->elementStart('a', $attrs);
311 $this->showNickname();
312 $this->out->elementEnd('a');
313 $this->out->elementEnd('span');
317 * show the avatar of the notice's author
319 * This will use the default avatar if no avatar is assigned for the author.
320 * It makes a link to the author's profile.
325 function showAvatar()
327 if ('shownotice' === $this->out->trimmed('action')) {
328 $avatar_size = AVATAR_PROFILE_SIZE;
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->element('span', array('class' => 'nickname fn'),
357 $this->profile->nickname);
361 * show the content of the notice
363 * Shows the content of the notice. This is pre-rendered for efficiency
364 * at save time. Some very old notices might not be pre-rendered, so
365 * they're rendered on the spot.
370 function showContent()
372 // FIXME: URL, image, video, audio
373 $this->out->elementStart('p', array('class' => 'entry-content'));
374 if ($this->notice->rendered) {
375 $this->out->raw($this->notice->rendered);
377 // XXX: may be some uncooked notices in the DB,
378 // we cook them right now. This should probably disappear in future
379 // versions (>> 0.4.x)
380 $this->out->raw(common_render_content($this->notice->content, $this->notice));
382 $this->out->elementEnd('p');
386 * show the link to the main page for the notice
388 * Displays a link to the page for a notice, with "relative" time. Tries to
389 * get remote notice URLs correct, but doesn't always succeed.
394 function showNoticeLink()
396 $noticeurl = common_local_url('shownotice',
397 array('notice' => $this->notice->id));
398 // XXX: we need to figure this out better. Is this right?
399 if (strcmp($this->notice->uri, $noticeurl) != 0 &&
400 preg_match('/^http/', $this->notice->uri)) {
401 $noticeurl = $this->notice->uri;
403 $this->out->elementStart('dl', 'timestamp');
404 $this->out->element('dt', null, _('Published'));
405 $this->out->elementStart('dd', null);
406 $this->out->elementStart('a', array('rel' => 'bookmark',
407 'href' => $noticeurl));
408 $dt = common_date_iso8601($this->notice->created);
409 $this->out->element('abbr', array('class' => 'published',
411 common_date_string($this->notice->created));
412 $this->out->elementEnd('a');
413 $this->out->elementEnd('dd');
414 $this->out->elementEnd('dl');
418 * Show the source of the notice
420 * Either the name (and link) of the API client that posted the notice,
421 * or one of other other channels.
426 function showNoticeSource()
428 if ($this->notice->source) {
429 $this->out->elementStart('dl', 'device');
430 $this->out->element('dt', null, _('From'));
431 $source_name = _($this->notice->source);
432 switch ($this->notice->source) {
439 $this->out->element('dd', null, $source_name);
442 $ns = Notice_source::staticGet($this->notice->source);
444 $this->out->elementStart('dd', null);
445 $this->out->element('a', array('href' => $ns->url,
446 'rel' => 'external'),
448 $this->out->elementEnd('dd');
450 $this->out->element('dd', null, $source_name);
454 $this->out->elementEnd('dl');
459 * show link to notice this notice is a reply to
461 * If this notice is a reply, show a link to the notice it is replying to. The
462 * heavy lifting for figuring out replies happens at save time.
467 function showContext()
469 // XXX: also show context if there are replies to this notice
470 if (!empty($this->notice->conversation)
471 && $this->notice->conversation != $this->notice->id) {
472 $convurl = common_local_url('conversation',
473 array('id' => $this->notice->conversation));
474 $this->out->elementStart('dl', 'response');
475 $this->out->element('dt', null, _('To'));
476 $this->out->elementStart('dd');
477 $this->out->element('a', array('href' => $convurl),
479 $this->out->elementEnd('dd');
480 $this->out->elementEnd('dl');
485 * show a link to reply to the current notice
487 * Should either do the reply in the current notice form (if available), or
488 * link out to the notice-posting form. A little flakey, doesn't always work.
493 function showReplyLink()
495 if (common_logged_in()) {
496 $reply_url = common_local_url('newnotice',
497 array('replyto' => $this->profile->nickname));
499 $this->out->elementStart('dl', 'notice_reply');
500 $this->out->element('dt', null, _('Reply to this notice'));
501 $this->out->elementStart('dd');
502 $this->out->elementStart('a', array('href' => $reply_url,
503 'title' => _('Reply to this notice')));
504 $this->out->text(_('Reply'));
505 $this->out->element('span', 'notice_id', $this->notice->id);
506 $this->out->elementEnd('a');
507 $this->out->elementEnd('dd');
508 $this->out->elementEnd('dl');
513 * if the user is the author, let them delete the notice
518 function showDeleteLink()
520 $user = common_current_user();
521 if ($user && $this->notice->profile_id == $user->id) {
522 $deleteurl = common_local_url('deletenotice',
523 array('notice' => $this->notice->id));
524 $this->out->elementStart('dl', 'notice_delete');
525 $this->out->element('dt', null, _('Delete this notice'));
526 $this->out->elementStart('dd');
527 $this->out->element('a', array('href' => $deleteurl,
528 'title' => _('Delete this notice')), _('Delete'));
529 $this->out->elementEnd('dd');
530 $this->out->elementEnd('dl');
537 * Close the last elements in the notice list item
544 $this->out->elementEnd('li');