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/
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@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() {
197 if ($this->isUsedInList()) {
200 $al = new AttachmentList($this->notice, $this->out);
204 function isUsedInList() {
205 return 'shownotice' !== $this->out->args['action'];
209 function attachmentCount($discriminant = true) {
210 $file_oembed = new File_oembed;
211 $query = "select count(*) as c from file_oembed join file_to_post on file_oembed.file_id = file_to_post.file_id where post_id=" . $this->notice->id;
212 $file_oembed->query($query);
213 $file_oembed->fetch();
214 return intval($file_oembed->c);
218 function showWithAttachment() {
221 function showNoticeInfo()
223 $this->out->elementStart('div', 'entry-content');
224 $this->showNoticeLink();
225 // $this->showWithAttachment();
226 $this->showNoticeSource();
227 $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->showDeleteLink();
239 $this->out->elementEnd('div');
244 * start a single notice.
252 // TODO: add notice_type class e.g., notice_video, notice_image
253 $this->out->elementStart('li', array('class' => 'hentry notice',
254 'id' => 'notice-' . $this->notice->id));
258 * show the "favorite" form
263 function showFaveForm()
265 $user = common_current_user();
267 if ($user->hasFave($this->notice)) {
268 $disfavor = new DisfavorForm($this->out, $this->notice);
271 $favor = new FavorForm($this->out, $this->notice);
278 * show the author of a notice
280 * By default, this shows the avatar and (linked) nickname of the author.
285 function showAuthor()
287 $this->out->elementStart('span', 'vcard author');
288 $attrs = array('href' => $this->profile->profileurl,
290 if (!empty($this->profile->fullname)) {
291 $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ') ';
293 $this->out->elementStart('a', $attrs);
295 $this->showNickname();
296 $this->out->elementEnd('a');
297 $this->out->elementEnd('span');
301 * show the avatar of the notice's author
303 * This will use the default avatar if no avatar is assigned for the author.
304 * It makes a link to the author's profile.
309 function showAvatar()
311 if ('shownotice' === $this->out->trimmed('action')) {
312 $avatar_size = AVATAR_PROFILE_SIZE;
314 $avatar_size = AVATAR_STREAM_SIZE;
316 $avatar = $this->profile->getAvatar($avatar_size);
318 $this->out->element('img', array('src' => ($avatar) ?
319 $avatar->displayUrl() :
320 Avatar::defaultImage($avatar_size),
321 'class' => 'avatar photo',
322 'width' => $avatar_size,
323 'height' => $avatar_size,
325 ($this->profile->fullname) ?
326 $this->profile->fullname :
327 $this->profile->nickname));
331 * show the nickname of the author
333 * Links to the author's profile page
338 function showNickname()
340 $this->out->element('span', array('class' => 'nickname fn'),
341 $this->profile->nickname);
345 * show the content of the notice
347 * Shows the content of the notice. This is pre-rendered for efficiency
348 * at save time. Some very old notices might not be pre-rendered, so
349 * they're rendered on the spot.
354 function showContent()
356 // FIXME: URL, image, video, audio
357 $this->out->elementStart('p', array('class' => 'entry-content'));
358 if ($this->notice->rendered) {
359 $this->out->raw($this->notice->rendered);
361 // XXX: may be some uncooked notices in the DB,
362 // we cook them right now. This should probably disappear in future
363 // versions (>> 0.4.x)
364 $this->out->raw(common_render_content($this->notice->content, $this->notice));
366 $uploaded = $this->notice->getUploadedAttachment();
368 $this->out->element('a', array('href' => $uploaded[0], 'class' => 'attachment', 'id' => 'attachment-' . $uploaded[1]), $uploaded[0]);
370 $this->out->elementEnd('p');
374 * show the link to the main page for the notice
376 * Displays a link to the page for a notice, with "relative" time. Tries to
377 * get remote notice URLs correct, but doesn't always succeed.
382 function showNoticeLink()
384 $noticeurl = common_local_url('shownotice',
385 array('notice' => $this->notice->id));
386 // XXX: we need to figure this out better. Is this right?
387 if (strcmp($this->notice->uri, $noticeurl) != 0 &&
388 preg_match('/^http/', $this->notice->uri)) {
389 $noticeurl = $this->notice->uri;
391 $this->out->elementStart('dl', 'timestamp');
392 $this->out->element('dt', null, _('Published'));
393 $this->out->elementStart('dd', null);
394 $this->out->elementStart('a', array('rel' => 'bookmark',
395 'href' => $noticeurl));
396 $dt = common_date_iso8601($this->notice->created);
397 $this->out->element('abbr', array('class' => 'published',
399 common_date_string($this->notice->created));
401 $this->out->elementEnd('a');
402 $this->out->elementEnd('dd');
403 $this->out->elementEnd('dl');
407 * Show the source of the notice
409 * Either the name (and link) of the API client that posted the notice,
410 * or one of other other channels.
415 function showNoticeSource()
417 if ($this->notice->source) {
418 $this->out->elementStart('dl', 'device');
419 $this->out->element('dt', null, _('From'));
420 $source_name = _($this->notice->source);
421 switch ($this->notice->source) {
428 $this->out->element('dd', null, $source_name);
431 $ns = Notice_source::staticGet($this->notice->source);
433 $this->out->elementStart('dd', null);
434 $this->out->element('a', array('href' => $ns->url,
435 'rel' => 'external'),
437 $this->out->elementEnd('dd');
439 $this->out->element('dd', null, $source_name);
443 $this->out->elementEnd('dl');
448 * show link to notice this notice is a reply to
450 * If this notice is a reply, show a link to the notice it is replying to. The
451 * heavy lifting for figuring out replies happens at save time.
456 function showContext()
458 // XXX: also show context if there are replies to this notice
459 if (!empty($this->notice->conversation)
460 && $this->notice->conversation != $this->notice->id) {
461 $convurl = common_local_url('conversation',
462 array('id' => $this->notice->conversation));
463 $this->out->elementStart('dl', 'response');
464 $this->out->element('dt', null, _('To'));
465 $this->out->elementStart('dd');
466 $this->out->element('a', array('href' => $convurl),
468 $this->out->elementEnd('dd');
469 $this->out->elementEnd('dl');
474 * show a link to reply to the current notice
476 * Should either do the reply in the current notice form (if available), or
477 * link out to the notice-posting form. A little flakey, doesn't always work.
482 function showReplyLink()
484 if (common_logged_in()) {
485 $reply_url = common_local_url('newnotice',
486 array('replyto' => $this->profile->nickname));
488 $this->out->elementStart('dl', 'notice_reply');
489 $this->out->element('dt', null, _('Reply to this notice'));
490 $this->out->elementStart('dd');
491 $this->out->elementStart('a', array('href' => $reply_url,
492 'title' => _('Reply to this notice')));
493 $this->out->text(_('Reply'));
494 $this->out->element('span', 'notice_id', $this->notice->id);
495 $this->out->elementEnd('a');
496 $this->out->elementEnd('dd');
497 $this->out->elementEnd('dl');
502 * if the user is the author, let them delete the notice
507 function showDeleteLink()
509 $user = common_current_user();
510 if ($user && $this->notice->profile_id == $user->id) {
511 $deleteurl = common_local_url('deletenotice',
512 array('notice' => $this->notice->id));
513 $this->out->elementStart('dl', 'notice_delete');
514 $this->out->element('dt', null, _('Delete this notice'));
515 $this->out->elementStart('dd');
516 $this->out->element('a', array('href' => $deleteurl,
517 'title' => _('Delete this notice')), _('Delete'));
518 $this->out->elementEnd('dd');
519 $this->out->elementEnd('dl');
526 * Close the last elements in the notice list item
533 $this->out->elementEnd('li');