noticelist.php 14.2 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 25 26 27
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  UI
 * @package   Laconica
 * @author    Evan Prodromou <evan@controlyourself.ca>
 * @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/
28 29
 */

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
if (!defined('LACONICA')) {
    exit(1);
}

/**
 * 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      StreamAction
 * @see      NoticeListItem
 * @see      ProfileNoticeList
 */
52

53
class NoticeList extends Widget
54 55
{
    /** the current stream of notices being displayed. */
56

57
    var $notice = null;
58

59 60 61 62 63 64
    /**
     * constructor
     *
     * @param Notice $notice stream of notices from DB_DataObject
     */

65
    function __construct($notice, $out=null)
66
    {
67
	parent::__construct($out);
68 69 70
        $this->notice = $notice;
    }

71 72 73 74 75 76 77 78
    /**
     * 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.
     */
79

80 81
    function show()
    {
sarven's avatar
sarven committed
82
        $this->out->elementStart('div', array('id' =>'notices_primary'));
sarven's avatar
sarven committed
83 84
        $this->out->element('h2', null, _('Notices'));
        $this->out->elementStart('ul', array('class' => 'notices'));
85

86
        $cnt = 0;
87

88 89
        while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
            $cnt++;
90

91 92 93
            if ($cnt > NOTICES_PER_PAGE) {
                break;
            }
94

95
            $item = $this->newListItem($this->notice);
96
            $item->show();
97
        }
98

99
        $this->out->elementEnd('ul');
sarven's avatar
sarven committed
100
        $this->out->elementEnd('div');
101 102

        return $cnt;
103
    }
104

105 106 107 108 109 110 111 112 113 114 115 116 117
    /**
     * 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)
    {
118
        return new NoticeListItem($notice, $this->out);
119 120 121
    }
}

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
/**
 * 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
 */

140
class NoticeListItem extends Widget
141 142
{
    /** The notice this item will show. */
143

144
    var $notice = null;
145

146 147 148 149 150 151 152 153 154 155 156 157
    /** 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
     */

158
    function __construct($notice, $out=null)
159
    {
160
	parent::__construct($out);
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
        $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();
177 178 179 180 181 182 183 184
        $this->showNotice();
        $this->showNoticeInfo();
        $this->showNoticeOptions();
        $this->showEnd();
    }

    function showNotice()
    {
185
        $this->out->elementStart('div', 'entry-title');
186
        $this->showAuthor();
sarven's avatar
sarven committed
187
        $this->showContent();
188
        $this->out->elementEnd('div');
189 190 191 192
    }

    function showNoticeInfo()
    {
193
        $this->out->elementStart('div', 'entry-content');
194 195 196
        $this->showNoticeLink();
        $this->showNoticeSource();
        $this->showReplyTo();
197
        $this->out->elementEnd('div');
198 199 200 201
    }

    function showNoticeOptions()
    {
202
        $this->out->elementStart('div', 'notice-options');
203
        $this->showFaveForm();
204 205
        $this->showReplyLink();
        $this->showDeleteLink();
206
        $this->out->elementEnd('div');
207 208
    }

sarven's avatar
sarven committed
209

210 211 212 213 214 215 216 217 218
    /**
     * start a single notice.
     *
     * @return void
     */

    function showStart()
    {
        // XXX: RDFa
219
        // TODO: add notice_type class e.g., notice_video, notice_image
220
        $this->out->elementStart('li', array('class' => 'hentry notice',
221 222 223 224 225 226 227 228 229 230 231
                                         'id' => 'notice-' . $this->notice->id));
    }

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

    function showFaveForm()
    {
232
        $user = common_current_user();
233 234
        if ($user) {
            if ($user->hasFave($this->notice)) {
235 236
		$disfavor = new DisfavorForm($this->out, $this->notice);
		$disfavor->show();
237
            } else {
238 239
		$favor = new FavorForm($this->out, $this->notice);
		$favor->show();
240 241 242 243 244 245 246 247 248 249 250 251 252 253
            }
        }
    }

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

    function showAuthor()
    {
254 255
        $this->out->elementStart('span', 'vcard author');
        $this->out->elementStart('a', array('href' => $this->profile->profileurl,
sarven's avatar
sarven committed
256
                                        'class' => 'url'));
257 258
        $this->showAvatar();
        $this->showNickname();
259 260
        $this->out->elementEnd('a');
        $this->out->elementEnd('span');
261 262 263 264 265 266 267 268 269 270 271 272 273 274
    }

    /**
     * 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()
    {
        $avatar = $this->profile->getAvatar(AVATAR_STREAM_SIZE);
275

276
        $this->out->element('img', array('src' => ($avatar) ?
277 278
                                    common_avatar_display_url($avatar) :
                                    common_default_avatar(AVATAR_STREAM_SIZE),
279
                                    'class' => 'avatar photo',
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
                                    'width' => AVATAR_STREAM_SIZE,
                                    'height' => AVATAR_STREAM_SIZE,
                                    'alt' =>
                                    ($this->profile->fullname) ?
                                    $this->profile->fullname :
                                    $this->profile->nickname));
    }

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

    function showNickname()
    {
298
        $this->out->element('span', array('class' => 'nickname fn'),
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
                       $this->profile->nickname);
    }

    /**
     * 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
315
        $this->out->elementStart('p', array('class' => 'entry-content'));
316
        if ($this->notice->rendered) {
317
            $this->out->raw($this->notice->rendered);
318 319 320 321
        } 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)
322
            $this->out->raw(common_render_content($this->notice->content, $this->notice));
323
        }
324
        $this->out->elementEnd('p');
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
    }

    /**
     * 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()
    {
        $noticeurl = common_local_url('shownotice',
                                      array('notice' => $this->notice->id));
        // XXX: we need to figure this out better. Is this right?
        if (strcmp($this->notice->uri, $noticeurl) != 0 &&
            preg_match('/^http/', $this->notice->uri)) {
            $noticeurl = $this->notice->uri;
        }
345 346 347
        $this->out->elementStart('dl', 'timestamp');
        $this->out->element('dt', _('Published')); 
        $this->out->elementStart('dd', null);
348
        $this->out->elementStart('a', array('rel' => 'bookmark',
349 350
                                        'href' => $noticeurl));
        $dt = common_date_iso8601($this->notice->created);
351
        $this->out->element('abbr', array('class' => 'published',
352 353
                                     'title' => $dt),
                       common_date_string($this->notice->created));
354 355 356
        $this->out->elementEnd('a');
        $this->out->elementEnd('dd');
        $this->out->elementEnd('dl');
357 358 359 360 361 362 363 364 365 366 367 368 369 370
    }

    /**
     * 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) {
371 372
            $this->out->elementStart('dl', 'device');
            $this->out->element('dt', null, _('From'));
Evan Prodromou's avatar
Evan Prodromou committed
373
            $source_name = _($this->notice->source);
374
            switch ($this->notice->source) {
375 376 377 378 379
            case 'web':
            case 'xmpp':
            case 'mail':
            case 'omb':
            case 'api':
380
                $this->out->element('dd', 'noticesource', $source_name);
381
                break;
382
            default:
383
                $ns = Notice_source::staticGet($this->notice->source);
384
                if ($ns) {
385 386
                    $this->out->elementStart('dd', null);
                    $this->out->element('a', array('href' => $ns->url,
sarven's avatar
sarven committed
387
                                              'rel' => 'external'),
388
                                   $ns->name);
389
                    $this->out->elementEnd('dd');
390
                } else {
391
                    $this->out->element('dd', 'noticesource', $source_name);
392 393 394
                }
                break;
            }
395
            $this->out->elementEnd('dl');
396
        }
397 398
    }

399 400 401 402 403 404 405 406 407 408 409 410 411 412
    /**
     * 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
     */

    function showReplyTo()
    {
        if ($this->notice->reply_to) {
            $replyurl = common_local_url('shownotice',
                                         array('notice' => $this->notice->reply_to));
413 414 415 416
            $this->out->elementStart('dl', 'response');
            $this->out->element('dt', null, _('To'));
            $this->out->elementStart('dd');
            $this->out->element('a', array('href' => $replyurl,
sarven's avatar
sarven committed
417
                                      'rel' => 'in-reply-to'),
sarven's avatar
sarven committed
418
                           _('in reply to'));
419 420
            $this->out->elementEnd('dd');
            $this->out->elementEnd('dl');
421
        }
422 423
    }

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
    /**
     * 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()
    {
        $reply_url = common_local_url('newnotice',
                                      array('replyto' => $this->profile->nickname));

        $reply_js =
          'return doreply("'.$this->profile->nickname.'",'.$this->notice->id.');';

441
        $this->out->elementStart('a',
442 443 444 445
                             array('href' => $reply_url,
                                   'onclick' => $reply_js,
                                   'title' => _('reply'),
                                   'class' => 'replybutton'));
446 447
        $this->out->raw(' &#8594;');
        $this->out->elementEnd('a');
448 449
    }

450 451 452 453 454 455 456 457
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
458
        $user = common_current_user();
459 460 461
        if ($user && $this->notice->profile_id == $user->id) {
            $deleteurl = common_local_url('deletenotice',
                                          array('notice' => $this->notice->id));
462
            $this->out->elementStart('a', array('class' => 'deletenotice',
463 464
                                            'href' => $deleteurl,
                                            'title' => _('delete')));
465 466
            $this->out->raw(' &#215;');
            $this->out->elementEnd('a');
467
        }
468 469
    }

470 471 472 473 474 475 476 477 478 479
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
480
        $this->out->elementEnd('li');
481 482
    }
}