3 * StatusNet, 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@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @copyright 2008 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !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@status.net>
50 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
51 * @link http://status.net/
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@status.net>
138 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
139 * @link http://status.net/
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.
181 if (Event::handle('StartShowNoticeItem', array($this))) {
183 $this->showNoticeInfo();
184 $this->showNoticeOptions();
185 Event::handle('EndShowNoticeItem', array($this));
190 function showNotice()
192 $this->out->elementStart('div', 'entry-title');
194 $this->showContent();
195 $this->out->elementEnd('div');
198 function showNoticeInfo()
200 $this->out->elementStart('div', 'entry-content');
201 $this->showNoticeLink();
202 $this->showNoticeLocation();
203 $this->showNoticeSource();
204 $this->showContext();
205 $this->out->elementEnd('div');
208 function showNoticeOptions()
210 $user = common_current_user();
212 $this->out->elementStart('div', 'notice-options');
213 $this->showFaveForm();
214 $this->showReplyLink();
215 $this->showDeleteLink();
216 $this->out->elementEnd('div');
221 * start a single notice.
229 // TODO: add notice_type class e.g., notice_video, notice_image
230 $this->out->elementStart('li', array('class' => 'hentry notice',
231 'id' => 'notice-' . $this->notice->id));
235 * show the "favorite" form
240 function showFaveForm()
242 $user = common_current_user();
244 if ($user->hasFave($this->notice)) {
245 $disfavor = new DisfavorForm($this->out, $this->notice);
248 $favor = new FavorForm($this->out, $this->notice);
255 * show the author of a notice
257 * By default, this shows the avatar and (linked) nickname of the author.
262 function showAuthor()
264 $this->out->elementStart('span', 'vcard author');
265 $attrs = array('href' => $this->profile->profileurl,
267 if (!empty($this->profile->fullname)) {
268 $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
270 $this->out->elementStart('a', $attrs);
272 $this->showNickname();
273 $this->out->elementEnd('a');
274 $this->out->elementEnd('span');
278 * show the avatar of the notice's author
280 * This will use the default avatar if no avatar is assigned for the author.
281 * It makes a link to the author's profile.
286 function showAvatar()
288 if ('shownotice' === $this->out->trimmed('action')) {
289 $avatar_size = AVATAR_PROFILE_SIZE;
291 $avatar_size = AVATAR_STREAM_SIZE;
293 $avatar = $this->profile->getAvatar($avatar_size);
295 $this->out->element('img', array('src' => ($avatar) ?
296 $avatar->displayUrl() :
297 Avatar::defaultImage($avatar_size),
298 'class' => 'avatar photo',
299 'width' => $avatar_size,
300 'height' => $avatar_size,
302 ($this->profile->fullname) ?
303 $this->profile->fullname :
304 $this->profile->nickname));
308 * show the nickname of the author
310 * Links to the author's profile page
315 function showNickname()
317 $this->out->element('span', array('class' => 'nickname fn'),
318 $this->profile->nickname);
322 * show the content of the notice
324 * Shows the content of the notice. This is pre-rendered for efficiency
325 * at save time. Some very old notices might not be pre-rendered, so
326 * they're rendered on the spot.
331 function showContent()
333 // FIXME: URL, image, video, audio
334 $this->out->elementStart('p', array('class' => 'entry-content'));
335 if ($this->notice->rendered) {
336 $this->out->raw($this->notice->rendered);
338 // XXX: may be some uncooked notices in the DB,
339 // we cook them right now. This should probably disappear in future
340 // versions (>> 0.4.x)
341 $this->out->raw(common_render_content($this->notice->content, $this->notice));
343 $this->out->elementEnd('p');
347 * show the link to the main page for the notice
349 * Displays a link to the page for a notice, with "relative" time. Tries to
350 * get remote notice URLs correct, but doesn't always succeed.
355 function showNoticeLink()
357 if($this->notice->is_local){
358 $noticeurl = common_local_url('shownotice',
359 array('notice' => $this->notice->id));
361 $noticeurl = $this->notice->uri;
363 $this->out->elementStart('a', array('rel' => 'bookmark',
364 'class' => 'timestamp',
365 'href' => $noticeurl));
366 $dt = common_date_iso8601($this->notice->created);
367 $this->out->element('abbr', array('class' => 'published',
369 common_date_string($this->notice->created));
370 $this->out->elementEnd('a');
374 * show the notice location
376 * shows the notice location in the correct language.
378 * If an URL is available, makes a link. Otherwise, just a span.
383 function showNoticeLocation()
385 $id = $this->notice->id;
387 $location = $this->notice->getLocation();
389 if (empty($location)) {
393 $name = $location->getName();
396 // XXX: Could be a translation issue. Fall back to... something?
400 $url = $location->getUrl();
403 $this->out->element('span', array('class' => 'location'), $name);
405 $this->out->element('a', array('class' => 'location',
412 * Show the source of the notice
414 * Either the name (and link) of the API client that posted the notice,
415 * or one of other other channels.
420 function showNoticeSource()
422 if ($this->notice->source) {
423 $this->out->elementStart('span', 'source');
424 $this->out->text(_('from'));
425 $source_name = _($this->notice->source);
426 switch ($this->notice->source) {
433 $this->out->element('span', 'device', $source_name);
436 $ns = Notice_source::staticGet($this->notice->source);
438 $this->out->elementStart('span', 'device');
439 $this->out->element('a', array('href' => $ns->url,
440 'rel' => 'external'),
442 $this->out->elementEnd('span');
444 $this->out->element('span', 'device', $source_name);
448 $this->out->elementEnd('span');
453 * show link to notice this notice is a reply to
455 * If this notice is a reply, show a link to the notice it is replying to. The
456 * heavy lifting for figuring out replies happens at save time.
461 function showContext()
463 $hasConversation = false;
464 if( !empty($this->notice->conversation)
465 && $this->notice->conversation != $this->notice->id){
466 $hasConversation = true;
468 $conversation = Notice::conversationStream($this->notice->id, 1, 1);
469 if($conversation->N > 0){
470 $hasConversation = true;
473 if ($hasConversation){
474 $convurl = common_local_url('conversation',
475 array('id' => $this->notice->conversation));
476 $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
477 'class' => 'response'),
483 * show a link to reply to the current notice
485 * Should either do the reply in the current notice form (if available), or
486 * link out to the notice-posting form. A little flakey, doesn't always work.
491 function showReplyLink()
493 if (common_logged_in()) {
494 $reply_url = common_local_url('newnotice',
495 array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
496 $this->out->elementStart('a', array('href' => $reply_url,
497 'class' => 'notice_reply',
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');
506 * if the user is the author, let them delete the notice
511 function showDeleteLink()
513 $user = common_current_user();
516 ($this->notice->profile_id == $user->id || $user->hasRight(Right::deleteOthersNotice))) {
518 $deleteurl = common_local_url('deletenotice',
519 array('notice' => $this->notice->id));
520 $this->out->element('a', array('href' => $deleteurl,
521 'class' => 'notice_delete',
522 'title' => _('Delete this notice')), _('Delete'));
529 * Close the last elements in the notice list item
536 $this->out->elementEnd('li');