noticelist.php 13.6 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 54 55
class NoticeList
{
    /** the current stream of notices being displayed. */
56

57
    var $notice = null;
58

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

    function __construct($notice)
    {
67 68 69
        $this->notice = $notice;
    }

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

79 80 81
    function show()
    {
        common_element_start('ul', array('id' => 'notices'));
82

83
        $cnt = 0;
84

85 86
        while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
            $cnt++;
87

88 89 90
            if ($cnt > NOTICES_PER_PAGE) {
                break;
            }
91

92
            $item = $this->newListItem($this->notice);
93
            $item->show();
94
        }
95

96
        common_element_end('ul');
97 98

        return $cnt;
99
    }
100

101 102 103 104 105 106 107 108 109 110 111 112 113
    /**
     * 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)
    {
114 115 116 117
        return new NoticeListItem($notice);
    }
}

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

class NoticeListItem
{
    /** The notice this item will show. */
139

140
    var $notice = null;
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
    /** 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
     */

    function __construct($notice)
    {
        $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();
172 173 174 175 176 177 178 179 180
        $this->showNotice();
        $this->showNoticeInfo();
        $this->showNoticeOptions();
        $this->showEnd();
    }

    function showNotice()
    {
        $this->elementStart('div', 'entry-title');
181
        $this->showAuthor();
sarven's avatar
sarven committed
182
        $this->showContent();
183 184 185 186 187 188
        $this->elementEnd('div');
    }

    function showNoticeInfo()
    {
        $this->elementStart('div', 'entry-content');
189 190 191
        $this->showNoticeLink();
        $this->showNoticeSource();
        $this->showReplyTo();
192 193 194 195 196 197 198
        $this->elementEnd('div');
    }

    function showNoticeOptions()
    {
        $this->elementStart('div', 'notice-options');
        $this->showFaveForm();
199 200
        $this->showReplyLink();
        $this->showDeleteLink();
201
        $this->elementEnd('div');
202 203
    }

sarven's avatar
sarven committed
204

205 206 207 208 209 210 211 212 213
    /**
     * start a single notice.
     *
     * @return void
     */

    function showStart()
    {
        // XXX: RDFa
214 215
        // TODO: add notice_type class e.g., notice_video, notice_image
        common_element_start('li', array('class' => 'hentry notice',
216 217 218 219 220 221 222 223 224 225 226
                                         'id' => 'notice-' . $this->notice->id));
    }

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

    function showFaveForm()
    {
227
        $user = common_current_user();
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        if ($user) {
            if ($user->hasFave($this->notice)) {
                common_disfavor_form($this->notice);
            } else {
                common_favor_form($this->notice);
            }
        }
    }

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

    function showAuthor()
    {
sarven's avatar
sarven committed
247 248
        $this->elementStart('span', 'vcard author');
        $this->elementStart('a', array('href' => $this->profile->profileurl,
sarven's avatar
sarven committed
249
                                        'class' => 'url'));
250 251
        $this->showAvatar();
        $this->showNickname();
sarven's avatar
sarven committed
252 253
        $this->elementEnd('a');
        $this->elementEnd('span');
254 255 256 257 258 259 260 261 262 263 264 265 266 267
    }

    /**
     * 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);
268

sarven's avatar
sarven committed
269
        $this->element('img', array('src' => ($avatar) ?
270 271
                                    common_avatar_display_url($avatar) :
                                    common_default_avatar(AVATAR_STREAM_SIZE),
272
                                    'class' => 'avatar photo',
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
                                    '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()
    {
sarven's avatar
sarven committed
291
        $this->element('span', array('class' => 'nickname fn'),
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
                       $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
sarven's avatar
sarven committed
308
        common_element_start('p', array('class' => 'entry-content'));
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
        if ($this->notice->rendered) {
            common_raw($this->notice->rendered);
        } 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)
            common_raw(common_render_content($this->notice->content, $this->notice));
        }
        common_element_end('p');
    }

    /**
     * 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;
        }
sarven's avatar
sarven committed
338 339 340 341
        $this->elementStart('dl', 'timestamp');
        $this->element('dt', _('Published')); 
        $this->elementStart('dd', null);
        $this->element('a', array('rel' => 'bookmark',
342 343
                                        'href' => $noticeurl));
        $dt = common_date_iso8601($this->notice->created);
sarven's avatar
sarven committed
344
        $this->element('abbr', array('class' => 'published',
345 346
                                     'title' => $dt),
                       common_date_string($this->notice->created));
sarven's avatar
sarven committed
347 348 349
        $this->elementEnd('a');
        $this->elementEnd('dd');
        $this->elementEnd('dl');
350 351 352 353 354 355 356 357 358 359 360 361 362 363
    }

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

392 393 394 395 396 397 398 399 400 401 402 403 404 405
    /**
     * 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));
sarven's avatar
sarven committed
406 407 408
            $this->elementStart('dl', 'response');
            $this->element('dt', null, _('To'));
            $this->elementStart('dd');
sarven's avatar
sarven committed
409
            $this->element('a', array('href' => $replyurl,
sarven's avatar
sarven committed
410
                                      'rel' => 'in-reply-to'),
sarven's avatar
sarven committed
411 412 413
                           _('in reply to'));
            $this->elementEnd('dd');
            $this->elementEnd('dl');
414
        }
415 416
    }

417 418 419 420 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.');';

        common_element_start('a',
                             array('href' => $reply_url,
                                   'onclick' => $reply_js,
                                   'title' => _('reply'),
                                   'class' => 'replybutton'));
        common_raw(' &#8594;');
        common_element_end('a');
441 442
    }

443 444 445 446 447 448 449 450
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
451
        $user = common_current_user();
452 453 454 455 456 457 458 459 460
        if ($user && $this->notice->profile_id == $user->id) {
            $deleteurl = common_local_url('deletenotice',
                                          array('notice' => $this->notice->id));
            common_element_start('a', array('class' => 'deletenotice',
                                            'href' => $deleteurl,
                                            'title' => _('delete')));
            common_raw(' &#215;');
            common_element_end('a');
        }
461 462
    }

463 464 465 466 467 468 469 470 471 472 473
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
        common_element_end('li');
474 475
    }
}