3 * Laconica, the distributed open-source microblogging tool
5 * utilities for sending email
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 * @copyright 2008 Control Yourself, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://laconi.ca/
30 if (!defined('LACONICA')) {
35 * widget for displaying a list of notices
37 * There are a number of actions that display a list of notices, in
38 * reverse chronological order. This widget abstracts out most of the
39 * code for UI for notice lists. It's overridden to hide some
40 * data for e.g. the profile page.
44 * @author Evan Prodromou <evan@controlyourself.ca>
45 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
46 * @link http://laconi.ca/
50 * @see ProfileNoticeList
55 /** the current stream of notices being displayed. */
62 * @param Notice $notice stream of notices from DB_DataObject
65 function __construct($notice)
67 $this->notice = $notice;
71 * show the list of notices
73 * "Uses up" the stream by looping through it. So, probably can't
74 * be called twice on the same list.
76 * @return int count of notices listed.
81 common_element_start('ul', array('id' => 'notices'));
85 while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
88 if ($cnt > NOTICES_PER_PAGE) {
92 $item = $this->newListItem($this->notice);
96 common_element_end('ul');
102 * returns a new list item for the current notice
104 * Recipe (factory?) method; overridden by sub-classes to give
105 * a different list item class.
107 * @param Notice $notice the current notice
109 * @return NoticeListItem a list item for displaying the notice
112 function newListItem($notice)
114 return new NoticeListItem($notice);
119 * widget for displaying a single notice
121 * This widget has the core smarts for showing a single notice: what to display,
122 * where, and under which circumstances. Its key method is show(); this is a recipe
123 * that calls all the other show*() methods to build up a single notice. The
124 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
125 * author info (since that's implicit by the data in the page).
129 * @author Evan Prodromou <evan@controlyourself.ca>
130 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
131 * @link http://laconi.ca/
133 * @see ProfileNoticeListItem
138 /** The notice this item will show. */
142 /** The profile of the author of the notice, extracted once for convenience. */
149 * Also initializes the profile attribute.
151 * @param Notice $notice The notice we'll display
154 function __construct($notice)
156 $this->notice = $notice;
157 $this->profile = $notice->getProfile();
161 * recipe function for displaying a single notice.
163 * This uses all the other methods to correctly display a notice. Override
164 * it or one of the others to fine-tune the output.
172 $this->showFaveForm();
174 $this->showContent();
175 $this->startTimeSection();
176 $this->showNoticeLink();
177 $this->showNoticeSource();
178 $this->showReplyTo();
179 $this->showReplyLink();
180 $this->showDeleteLink();
181 $this->endTimeSection();
186 * start a single notice.
194 common_element_start('li', array('class' => 'notice_single hentry',
195 'id' => 'notice-' . $this->notice->id));
199 * show the "favorite" form
204 function showFaveForm()
206 $user = common_current_user();
208 if ($user->hasFave($this->notice)) {
209 common_disfavor_form($this->notice);
211 common_favor_form($this->notice);
217 * show the author of a notice
219 * By default, this shows the avatar and (linked) nickname of the author.
224 function showAuthor()
226 common_element_start('span', 'vcard author');
228 $this->showNickname();
229 common_element_end('span');
233 * show the avatar of the notice's author
235 * This will use the default avatar if no avatar is assigned for the author.
236 * It makes a link to the author's profile.
241 function showAvatar()
243 $avatar = $this->profile->getAvatar(AVATAR_STREAM_SIZE);
244 common_element_start('a', array('href' => $this->profile->profileurl));
245 common_element('img', array('src' => ($avatar) ?
246 common_avatar_display_url($avatar) :
247 common_default_avatar(AVATAR_STREAM_SIZE),
248 'class' => 'avatar stream photo',
249 'width' => AVATAR_STREAM_SIZE,
250 'height' => AVATAR_STREAM_SIZE,
252 ($this->profile->fullname) ?
253 $this->profile->fullname :
254 $this->profile->nickname));
255 common_element_end('a');
259 * show the nickname of the author
261 * Links to the author's profile page
266 function showNickname()
268 common_element('a', array('href' => $this->profile->profileurl,
269 'class' => 'nickname fn url'),
270 $this->profile->nickname);
274 * show the content of the notice
276 * Shows the content of the notice. This is pre-rendered for efficiency
277 * at save time. Some very old notices might not be pre-rendered, so
278 * they're rendered on the spot.
283 function showContent()
285 // FIXME: URL, image, video, audio
286 common_element_start('p', array('class' => 'content entry-title'));
287 if ($this->notice->rendered) {
288 common_raw($this->notice->rendered);
290 // XXX: may be some uncooked notices in the DB,
291 // we cook them right now. This should probably disappear in future
292 // versions (>> 0.4.x)
293 common_raw(common_render_content($this->notice->content, $this->notice));
295 common_element_end('p');
299 * show the "time" section of a notice
301 * This is the greyed-out section that appears beneath the content, including
302 * links to delete or reply to the notice. Probably should be called something
308 function startTimeSection()
310 common_element_start('p', 'time');
314 * show the link to the main page for the notice
316 * Displays a link to the page for a notice, with "relative" time. Tries to
317 * get remote notice URLs correct, but doesn't always succeed.
322 function showNoticeLink()
324 $noticeurl = common_local_url('shownotice',
325 array('notice' => $this->notice->id));
326 // XXX: we need to figure this out better. Is this right?
327 if (strcmp($this->notice->uri, $noticeurl) != 0 &&
328 preg_match('/^http/', $this->notice->uri)) {
329 $noticeurl = $this->notice->uri;
331 common_element_start('a', array('class' => 'permalink',
333 'href' => $noticeurl));
334 $dt = common_date_iso8601($this->notice->created);
335 common_element('abbr', array('class' => 'published',
337 common_date_string($this->notice->created));
338 common_element_end('a');
342 * Show the source of the notice
344 * Either the name (and link) of the API client that posted the notice,
345 * or one of other other channels.
350 function showNoticeSource()
352 if ($this->notice->source) {
353 common_element('span', null, _(' from '));
354 $source_name = _($this->notice->source);
355 switch ($this->notice->source) {
361 common_element('span', 'noticesource', $source_name);
364 $ns = Notice_source::staticGet($this->notice->source);
366 common_element('a', array('href' => $ns->url),
369 common_element('span', 'noticesource', $source_name);
377 * show link to notice this notice is a reply to
379 * If this notice is a reply, show a link to the notice it is replying to. The
380 * heavy lifting for figuring out replies happens at save time.
385 function showReplyTo()
387 if ($this->notice->reply_to) {
388 $replyurl = common_local_url('shownotice',
389 array('notice' => $this->notice->reply_to));
391 common_element('a', array('class' => 'inreplyto',
392 'href' => $replyurl),
393 _('in reply to...'));
399 * show a link to reply to the current notice
401 * Should either do the reply in the current notice form (if available), or
402 * link out to the notice-posting form. A little flakey, doesn't always work.
407 function showReplyLink()
409 $reply_url = common_local_url('newnotice',
410 array('replyto' => $this->profile->nickname));
413 'return doreply("'.$this->profile->nickname.'",'.$this->notice->id.');';
415 common_element_start('a',
416 array('href' => $reply_url,
417 'onclick' => $reply_js,
418 'title' => _('reply'),
419 'class' => 'replybutton'));
420 common_raw(' →');
421 common_element_end('a');
425 * if the user is the author, let them delete the notice
430 function showDeleteLink()
432 $user = common_current_user();
433 if ($user && $this->notice->profile_id == $user->id) {
434 $deleteurl = common_local_url('deletenotice',
435 array('notice' => $this->notice->id));
436 common_element_start('a', array('class' => 'deletenotice',
437 'href' => $deleteurl,
438 'title' => _('delete')));
439 common_raw(' ×');
440 common_element_end('a');
445 * end the time section
450 function endTimeSection()
452 common_element_end('p');
458 * Close the last elements in the notice list item
465 common_element_end('li');