noticelist.php 14.5 KB
Newer Older
1
<?php
2 3
/**
 * Laconica, the distributed open-source microblogging tool
4
 *
5
 * widget for displaying a list of notices
6 7 8 9
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
10 11 12 13 14 15
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 18 19
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
20 21 22 23 24
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  UI
 * @package   Laconica
 * @author    Evan Prodromou <evan@controlyourself.ca>
25
 * @author    Sarven Capadisli <csarven@controlyourself.ca>
26 27 28
 * @copyright 2008 Control Yourself, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://laconi.ca/
29 30
 */

31 32 33 34
if (!defined('LACONICA')) {
    exit(1);
}

35 36
require_once INSTALLDIR.'/lib/favorform.php';
require_once INSTALLDIR.'/lib/disfavorform.php';
37
require_once INSTALLDIR.'/lib/attachmentlist.php';
38

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
/**
 * widget for displaying a list of notices
 *
 * There are a number of actions that display a list of notices, in
 * reverse chronological order. This widget abstracts out most of the
 * code for UI for notice lists. It's overridden to hide some
 * data for e.g. the profile page.
 *
 * @category UI
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://laconi.ca/
 * @see      Notice
 * @see      NoticeListItem
 * @see      ProfileNoticeList
 */
56

57
class NoticeList extends Widget
58 59
{
    /** the current stream of notices being displayed. */
60

61
    var $notice = null;
62

63 64 65 66 67 68
    /**
     * constructor
     *
     * @param Notice $notice stream of notices from DB_DataObject
     */

69
    function __construct($notice, $out=null)
70
    {
Evan Prodromou's avatar
Evan Prodromou committed
71
        parent::__construct($out);
72 73 74
        $this->notice = $notice;
    }

75 76 77 78 79 80 81 82
    /**
     * show the list of notices
     *
     * "Uses up" the stream by looping through it. So, probably can't
     * be called twice on the same list.
     *
     * @return int count of notices listed.
     */
83

84 85
    function show()
    {
sarven's avatar
sarven committed
86
        $this->out->elementStart('div', array('id' =>'notices_primary'));
sarven's avatar
sarven committed
87
        $this->out->element('h2', null, _('Notices'));
88
        $this->out->elementStart('ol', array('class' => 'notices xoxo'));
89

90
        $cnt = 0;
91

92 93
        while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
            $cnt++;
94

95 96 97
            if ($cnt > NOTICES_PER_PAGE) {
                break;
            }
98

99
            $item = $this->newListItem($this->notice);
100
            $item->show();
101
        }
102

103
        $this->out->elementEnd('ol');
sarven's avatar
sarven committed
104
        $this->out->elementEnd('div');
105 106

        return $cnt;
107
    }
108

109 110 111 112 113 114 115 116 117 118 119 120 121
    /**
     * returns a new list item for the current notice
     *
     * Recipe (factory?) method; overridden by sub-classes to give
     * a different list item class.
     *
     * @param Notice $notice the current notice
     *
     * @return NoticeListItem a list item for displaying the notice
     */

    function newListItem($notice)
    {
122
        return new NoticeListItem($notice, $this->out);
123 124 125
    }
}

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
/**
 * widget for displaying a single notice
 *
 * This widget has the core smarts for showing a single notice: what to display,
 * where, and under which circumstances. Its key method is show(); this is a recipe
 * that calls all the other show*() methods to build up a single notice. The
 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 * author info (since that's implicit by the data in the page).
 *
 * @category UI
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://laconi.ca/
 * @see      NoticeList
 * @see      ProfileNoticeListItem
 */

144
class NoticeListItem extends Widget
145 146
{
    /** The notice this item will show. */
147

148
    var $notice = null;
149

150 151 152 153 154 155 156 157 158 159 160 161
    /** The profile of the author of the notice, extracted once for convenience. */

    var $profile = null;

    /**
     * constructor
     *
     * Also initializes the profile attribute.
     *
     * @param Notice $notice The notice we'll display
     */

162
    function __construct($notice, $out=null)
163
    {
Evan Prodromou's avatar
Evan Prodromou committed
164
        parent::__construct($out);
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
        $this->notice  = $notice;
        $this->profile = $notice->getProfile();
    }

    /**
     * recipe function for displaying a single notice.
     *
     * This uses all the other methods to correctly display a notice. Override
     * it or one of the others to fine-tune the output.
     *
     * @return void
     */

    function show()
    {
        $this->showStart();
181
        $this->showNotice();
182
        $this->showNoticeInfo();
183
        $this->showNoticeOptions();
184 185 186 187 188
        $this->showEnd();
    }

    function showNotice()
    {
189
        $this->out->elementStart('div', 'entry-title');
190
        $this->showAuthor();
sarven's avatar
sarven committed
191
        $this->showContent();
192
        $this->out->elementEnd('div');
193 194 195 196
    }

    function showNoticeInfo()
    {
197
        $this->out->elementStart('div', 'entry-content');
198 199
        $this->showNoticeLink();
        $this->showNoticeSource();
200
        $this->showContext();
201
        $this->out->elementEnd('div');
202 203 204 205
    }

    function showNoticeOptions()
    {
206 207 208 209 210 211 212 213
        $user = common_current_user();
        if ($user) {
            $this->out->elementStart('div', 'notice-options');
            $this->showFaveForm();
            $this->showReplyLink();
            $this->showDeleteLink();
            $this->out->elementEnd('div');
        }
214 215 216 217 218 219 220 221 222 223 224
    }

    /**
     * start a single notice.
     *
     * @return void
     */

    function showStart()
    {
        // XXX: RDFa
225
        // TODO: add notice_type class e.g., notice_video, notice_image
226
        $this->out->elementStart('li', array('class' => 'hentry notice',
Evan Prodromou's avatar
Evan Prodromou committed
227
                                             'id' => 'notice-' . $this->notice->id));
228 229 230 231 232 233 234 235 236 237
    }

    /**
     * show the "favorite" form
     *
     * @return void
     */

    function showFaveForm()
    {
238
        $user = common_current_user();
239 240
        if ($user) {
            if ($user->hasFave($this->notice)) {
Evan Prodromou's avatar
Evan Prodromou committed
241 242
                $disfavor = new DisfavorForm($this->out, $this->notice);
                $disfavor->show();
243
            } else {
Evan Prodromou's avatar
Evan Prodromou committed
244 245
                $favor = new FavorForm($this->out, $this->notice);
                $favor->show();
246 247 248 249 250 251 252 253 254 255 256 257 258 259
            }
        }
    }

    /**
     * show the author of a notice
     *
     * By default, this shows the avatar and (linked) nickname of the author.
     *
     * @return void
     */

    function showAuthor()
    {
260
        $this->out->elementStart('span', 'vcard author');
261 262 263 264 265 266
        $attrs = array('href' => $this->profile->profileurl,
                       'class' => 'url');
        if (!empty($this->profile->fullname)) {
            $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ') ';
        }
        $this->out->elementStart('a', $attrs);
267 268
        $this->showAvatar();
        $this->showNickname();
269 270
        $this->out->elementEnd('a');
        $this->out->elementEnd('span');
271 272 273 274 275 276 277 278 279 280 281 282 283
    }

    /**
     * show the avatar of the notice's author
     *
     * This will use the default avatar if no avatar is assigned for the author.
     * It makes a link to the author's profile.
     *
     * @return void
     */

    function showAvatar()
    {
284 285 286 287 288 289
        if ('shownotice' === $this->out->trimmed('action')) {
            $avatar_size = AVATAR_PROFILE_SIZE;
        } else {
            $avatar_size = AVATAR_STREAM_SIZE;
        }
        $avatar = $this->profile->getAvatar($avatar_size);
290

291
        $this->out->element('img', array('src' => ($avatar) ?
292 293
                                         $avatar->displayUrl() :
                                         Avatar::defaultImage($avatar_size),
Evan Prodromou's avatar
Evan Prodromou committed
294
                                         'class' => 'avatar photo',
295 296
                                         'width' => $avatar_size,
                                         'height' => $avatar_size,
Evan Prodromou's avatar
Evan Prodromou committed
297 298 299 300
                                         'alt' =>
                                         ($this->profile->fullname) ?
                                         $this->profile->fullname :
                                         $this->profile->nickname));
301 302 303 304 305 306 307 308 309 310 311 312
    }

    /**
     * show the nickname of the author
     *
     * Links to the author's profile page
     *
     * @return void
     */

    function showNickname()
    {
313
        $this->out->element('span', array('class' => 'nickname fn'),
Evan Prodromou's avatar
Evan Prodromou committed
314
                            $this->profile->nickname);
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
    }

    /**
     * show the content of the notice
     *
     * Shows the content of the notice. This is pre-rendered for efficiency
     * at save time. Some very old notices might not be pre-rendered, so
     * they're rendered on the spot.
     *
     * @return void
     */

    function showContent()
    {
        // FIXME: URL, image, video, audio
330
        $this->out->elementStart('p', array('class' => 'entry-content'));
331
        if ($this->notice->rendered) {
332
            $this->out->raw($this->notice->rendered);
333 334 335 336
        } else {
            // XXX: may be some uncooked notices in the DB,
            // we cook them right now. This should probably disappear in future
            // versions (>> 0.4.x)
337
            $this->out->raw(common_render_content($this->notice->content, $this->notice));
338
        }
339
        $this->out->elementEnd('p');
340 341 342 343 344 345 346 347 348 349 350 351 352
    }

    /**
     * show the link to the main page for the notice
     *
     * Displays a link to the page for a notice, with "relative" time. Tries to
     * get remote notice URLs correct, but doesn't always succeed.
     *
     * @return void
     */

    function showNoticeLink()
    {
353 354
        if($this->notice->is_local){
            $noticeurl = common_local_url('shownotice',
355
                                      array('notice' => $this->notice->id));
356
        }else{
357 358
            $noticeurl = $this->notice->uri;
        }
359
        $this->out->elementStart('a', array('rel' => 'bookmark',
360
                                            'class' => 'timestamp',
Evan Prodromou's avatar
Evan Prodromou committed
361
                                            'href' => $noticeurl));
362
        $dt = common_date_iso8601($this->notice->created);
363
        $this->out->element('abbr', array('class' => 'published',
Evan Prodromou's avatar
Evan Prodromou committed
364 365
                                          'title' => $dt),
                            common_date_string($this->notice->created));
366
        $this->out->elementEnd('a');
367 368 369 370 371 372 373 374 375 376 377 378 379 380
    }

    /**
     * Show the source of the notice
     *
     * Either the name (and link) of the API client that posted the notice,
     * or one of other other channels.
     *
     * @return void
     */

    function showNoticeSource()
    {
        if ($this->notice->source) {
381 382
            $this->out->elementStart('span', 'source');
            $this->out->text(_('from'));
Evan Prodromou's avatar
Evan Prodromou committed
383
            $source_name = _($this->notice->source);
384
            switch ($this->notice->source) {
Evan Prodromou's avatar
Evan Prodromou committed
385 386 387 388
             case 'web':
             case 'xmpp':
             case 'mail':
             case 'omb':
389
             case 'system':
Evan Prodromou's avatar
Evan Prodromou committed
390
             case 'api':
391
                $this->out->element('span', 'device', $source_name);
392
                break;
Evan Prodromou's avatar
Evan Prodromou committed
393
             default:
394
                $ns = Notice_source::staticGet($this->notice->source);
395
                if ($ns) {
396
                    $this->out->elementStart('span', 'device');
397
                    $this->out->element('a', array('href' => $ns->url,
Evan Prodromou's avatar
Evan Prodromou committed
398 399
                                                   'rel' => 'external'),
                                        $ns->name);
400
                    $this->out->elementEnd('span');
401
                } else {
402
                    $this->out->element('span', 'device', $source_name);
403 404 405
                }
                break;
            }
406
            $this->out->elementEnd('span');
407
        }
408 409
    }

410 411 412 413 414 415 416 417 418
    /**
     * show link to notice this notice is a reply to
     *
     * If this notice is a reply, show a link to the notice it is replying to. The
     * heavy lifting for figuring out replies happens at save time.
     *
     * @return void
     */

419
    function showContext()
420
    {
421 422 423 424 425
        // XXX: also show context if there are replies to this notice
        if (!empty($this->notice->conversation)
            && $this->notice->conversation != $this->notice->id) {
            $convurl = common_local_url('conversation',
                                         array('id' => $this->notice->conversation));
426 427
            $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
                                           'class' => 'response'),
428
                                _('in context'));
429
        }
430 431
    }

432 433 434 435 436 437 438 439 440 441 442
    /**
     * show a link to reply to the current notice
     *
     * Should either do the reply in the current notice form (if available), or
     * link out to the notice-posting form. A little flakey, doesn't always work.
     *
     * @return void
     */

    function showReplyLink()
    {
443 444 445 446
        if (common_logged_in()) {
            $reply_url = common_local_url('newnotice',
                                          array('replyto' => $this->profile->nickname));
            $this->out->elementStart('a', array('href' => $reply_url,
447
                                                'class' => 'notice_reply',
448 449 450 451 452
                                                'title' => _('Reply to this notice')));
            $this->out->text(_('Reply'));
            $this->out->element('span', 'notice_id', $this->notice->id);
            $this->out->elementEnd('a');
        }
453 454
    }

455 456 457 458 459 460 461 462
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
463
        $user = common_current_user();
464 465 466
        if ($user && $this->notice->profile_id == $user->id) {
            $deleteurl = common_local_url('deletenotice',
                                          array('notice' => $this->notice->id));
sarven's avatar
sarven committed
467
            $this->out->element('a', array('href' => $deleteurl,
468
                                           'class' => 'notice_delete',
469
                                           'title' => _('Delete this notice')), _('Delete'));
470
        }
471 472
    }

473 474 475 476 477 478 479 480 481 482
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
483
        $this->out->elementEnd('li');
484 485
    }
}