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->showNoticeInfo();
183 $this->showNoticeOptions();
187 function showNotice()
189 $this->out->elementStart('div', 'entry-title');
191 $this->showContent();
192 $this->out->elementEnd('div');
195 function showNoticeInfo()
197 $this->out->elementStart('div', 'entry-content');
198 $this->showNoticeLink();
199 $this->showNoticeSource();
200 $this->showReplyTo();
201 $this->out->elementEnd('div');
204 function showNoticeOptions()
206 $this->out->elementStart('div', 'notice-options');
207 $this->showFaveForm();
208 $this->showReplyLink();
209 $this->showDeleteLink();
210 $this->out->elementEnd('div');
214 * start a single notice.
222 // TODO: add notice_type class e.g., notice_video, notice_image
223 $this->out->elementStart('li', array('class' => 'hentry notice',
224 'id' => 'notice-' . $this->notice->id));
228 * show the "favorite" form
233 function showFaveForm()
235 $user = common_current_user();
237 if ($user->hasFave($this->notice)) {
238 $disfavor = new DisfavorForm($this->out, $this->notice);
241 $favor = new FavorForm($this->out, $this->notice);
248 * show the author of a notice
250 * By default, this shows the avatar and (linked) nickname of the author.
255 function showAuthor()
257 $this->out->elementStart('span', 'vcard author');
258 $this->out->elementStart('a', array('href' => $this->profile->profileurl,
261 $this->showNickname();
262 $this->out->elementEnd('a');
263 $this->out->elementEnd('span');
267 * show the avatar of the notice's author
269 * This will use the default avatar if no avatar is assigned for the author.
270 * It makes a link to the author's profile.
275 function showAvatar()
277 $avatar = $this->profile->getAvatar(AVATAR_STREAM_SIZE);
279 $this->out->element('img', array('src' => ($avatar) ?
280 common_avatar_display_url($avatar) :
281 common_default_avatar(AVATAR_STREAM_SIZE),
282 'class' => 'avatar photo',
283 'width' => AVATAR_STREAM_SIZE,
284 'height' => AVATAR_STREAM_SIZE,
286 ($this->profile->fullname) ?
287 $this->profile->fullname :
288 $this->profile->nickname));
292 * show the nickname of the author
294 * Links to the author's profile page
299 function showNickname()
301 $this->out->element('span', array('class' => 'nickname fn'),
302 $this->profile->nickname);
306 * show the content of the notice
308 * Shows the content of the notice. This is pre-rendered for efficiency
309 * at save time. Some very old notices might not be pre-rendered, so
310 * they're rendered on the spot.
315 function showContent()
317 // FIXME: URL, image, video, audio
318 $this->out->elementStart('p', array('class' => 'entry-content'));
319 if ($this->notice->rendered) {
320 $this->out->raw($this->notice->rendered);
322 // XXX: may be some uncooked notices in the DB,
323 // we cook them right now. This should probably disappear in future
324 // versions (>> 0.4.x)
325 $this->out->raw(common_render_content($this->notice->content, $this->notice));
327 $this->out->elementEnd('p');
331 * show the link to the main page for the notice
333 * Displays a link to the page for a notice, with "relative" time. Tries to
334 * get remote notice URLs correct, but doesn't always succeed.
339 function showNoticeLink()
341 $noticeurl = common_local_url('shownotice',
342 array('notice' => $this->notice->id));
343 // XXX: we need to figure this out better. Is this right?
344 if (strcmp($this->notice->uri, $noticeurl) != 0 &&
345 preg_match('/^http/', $this->notice->uri)) {
346 $noticeurl = $this->notice->uri;
348 $this->out->elementStart('dl', 'timestamp');
349 $this->out->element('dt', null, _('Published'));
350 $this->out->elementStart('dd', null);
351 $this->out->elementStart('a', array('rel' => 'bookmark',
352 'href' => $noticeurl));
353 $dt = common_date_iso8601($this->notice->created);
354 $this->out->element('abbr', array('class' => 'published',
356 common_date_string($this->notice->created));
357 $this->out->elementEnd('a');
358 $this->out->elementEnd('dd');
359 $this->out->elementEnd('dl');
363 * Show the source of the notice
365 * Either the name (and link) of the API client that posted the notice,
366 * or one of other other channels.
371 function showNoticeSource()
373 if ($this->notice->source) {
374 $this->out->elementStart('dl', 'device');
375 $this->out->element('dt', null, _('From'));
376 $source_name = _($this->notice->source);
377 switch ($this->notice->source) {
383 $this->out->element('dd', null, $source_name);
386 $ns = Notice_source::staticGet($this->notice->source);
388 $this->out->elementStart('dd', null);
389 $this->out->element('a', array('href' => $ns->url,
390 'rel' => 'external'),
392 $this->out->elementEnd('dd');
394 $this->out->element('dd', null, $source_name);
398 $this->out->elementEnd('dl');
403 * show link to notice this notice is a reply to
405 * If this notice is a reply, show a link to the notice it is replying to. The
406 * heavy lifting for figuring out replies happens at save time.
411 function showReplyTo()
413 if ($this->notice->reply_to) {
414 $replyurl = common_local_url('shownotice',
415 array('notice' => $this->notice->reply_to));
416 $this->out->elementStart('dl', 'response');
417 $this->out->element('dt', null, _('To'));
418 $this->out->elementStart('dd');
419 $this->out->element('a', array('href' => $replyurl,
420 'rel' => 'in-reply-to'),
422 $this->out->elementEnd('dd');
423 $this->out->elementEnd('dl');
428 * show a link to reply to the current notice
430 * Should either do the reply in the current notice form (if available), or
431 * link out to the notice-posting form. A little flakey, doesn't always work.
436 function showReplyLink()
438 $reply_url = common_local_url('newnotice',
439 array('replyto' => $this->profile->nickname));
441 $this->out->elementStart('dl', 'notice_reply');
442 $this->out->element('dt', null, _('Reply to this notice'));
443 $this->out->elementStart('dd');
444 $this->out->elementStart('a', array('href' => $reply_url,
445 'title' => _('Reply to this notice')));
446 $this->out->text(_('Reply'));
447 $this->out->element('span', 'notice_id', $this->notice->id);
448 $this->out->elementEnd('a');
449 $this->out->elementEnd('dd');
450 $this->out->elementEnd('dl');
454 * if the user is the author, let them delete the notice
459 function showDeleteLink()
461 $user = common_current_user();
462 if ($user && $this->notice->profile_id == $user->id) {
463 $deleteurl = common_local_url('deletenotice',
464 array('notice' => $this->notice->id));
465 $this->out->elementStart('dl', 'notice_delete');
466 $this->out->element('dt', null, _('Delete this notice'));
467 $this->out->elementStart('dd');
468 $this->out->element('a', array('href' => $deleteurl,
469 'title' => _('Delete this notice')), _('Delete'));
470 $this->out->elementEnd('dd');
471 $this->out->elementEnd('dl');
478 * Close the last elements in the notice list item
485 $this->out->elementEnd('li');