noticelist.php 15.9 KB
Newer Older
1
<?php
2
/**
3
 * StatusNet, 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  UI
23
 * @package   StatusNet
24 25
 * @author    Evan Prodromou <evan@status.net>
 * @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/
29 30
 */

31
if (!defined('STATUSNET') && !defined('LACONICA')) {
32 33 34
    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
/**
 * 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
48
 * @package  StatusNet
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/
52 53 54 55
 * @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
    /**
     * show the list of notices
     *
Siebrand Mazeland's avatar
Siebrand Mazeland committed
78
     * "Uses up" the stream by looping through it. So, probably cannot
79 80 81 82
     * 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
/**
 * 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
136
 * @package  StatusNet
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/
140 141 142 143
 * @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 182 183 184 185 186
        if (Event::handle('StartShowNoticeItem', array($this))) {
            $this->showNotice();
            $this->showNoticeInfo();
            $this->showNoticeOptions();
            Event::handle('EndShowNoticeItem', array($this));
        }
187 188 189 190 191
        $this->showEnd();
    }

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

    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');
206 207 208 209
    }

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

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

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

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

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

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

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

    /**
     * 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()
    {
288 289 290 291 292 293
        if ('shownotice' === $this->out->trimmed('action')) {
            $avatar_size = AVATAR_PROFILE_SIZE;
        } else {
            $avatar_size = AVATAR_STREAM_SIZE;
        }
        $avatar = $this->profile->getAvatar($avatar_size);
294

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

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

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

    /**
     * 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
334
        $this->out->elementStart('p', array('class' => 'entry-content'));
335
        if ($this->notice->rendered) {
336
            $this->out->raw($this->notice->rendered);
337 338 339 340
        } 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)
341
            $this->out->raw(common_render_content($this->notice->content, $this->notice));
342
        }
343
        $this->out->elementEnd('p');
344 345 346 347 348 349 350 351 352 353 354 355 356
    }

    /**
     * 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()
    {
357 358
        if($this->notice->is_local){
            $noticeurl = common_local_url('shownotice',
359
                                      array('notice' => $this->notice->id));
360
        }else{
361 362
            $noticeurl = $this->notice->uri;
        }
363
        $this->out->elementStart('a', array('rel' => 'bookmark',
364
                                            'class' => 'timestamp',
Evan Prodromou's avatar
Evan Prodromou committed
365
                                            'href' => $noticeurl));
366
        $dt = common_date_iso8601($this->notice->created);
367
        $this->out->element('abbr', array('class' => 'published',
Evan Prodromou's avatar
Evan Prodromou committed
368 369
                                          'title' => $dt),
                            common_date_string($this->notice->created));
370
        $this->out->elementEnd('a');
371 372
    }

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
    /**
     * show the notice location
     *
     * shows the notice location in the correct language.
     *
     * If an URL is available, makes a link. Otherwise, just a span.
     *
     * @return void
     */

    function showNoticeLocation()
    {
        $id = $this->notice->id;

        $location = $this->notice->getLocation();

        if (empty($location)) {
            return;
        }

        $name = $location->getName();

        if (empty($name)) {
            // XXX: Could be a translation issue. Fall back to... something?
            return;
        }

        $url  = $location->getUrl();

        if (empty($url)) {
            $this->out->element('span', array('class' => 'location'), $name);
        } else {
            $this->out->element('a', array('class' => 'location',
                                           'href' => $url),
                                $name);
        }
    }

411 412 413 414 415 416 417 418 419 420 421 422
    /**
     * 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) {
423 424
            $this->out->elementStart('span', 'source');
            $this->out->text(_('from'));
Evan Prodromou's avatar
Evan Prodromou committed
425
            $source_name = _($this->notice->source);
426
            switch ($this->notice->source) {
Evan Prodromou's avatar
Evan Prodromou committed
427 428 429 430
             case 'web':
             case 'xmpp':
             case 'mail':
             case 'omb':
431
             case 'system':
Evan Prodromou's avatar
Evan Prodromou committed
432
             case 'api':
433
                $this->out->element('span', 'device', $source_name);
434
                break;
Evan Prodromou's avatar
Evan Prodromou committed
435
             default:
436
                $ns = Notice_source::staticGet($this->notice->source);
437
                if ($ns) {
438
                    $this->out->elementStart('span', 'device');
439
                    $this->out->element('a', array('href' => $ns->url,
Evan Prodromou's avatar
Evan Prodromou committed
440 441
                                                   'rel' => 'external'),
                                        $ns->name);
442
                    $this->out->elementEnd('span');
443
                } else {
444
                    $this->out->element('span', 'device', $source_name);
445 446 447
                }
                break;
            }
448
            $this->out->elementEnd('span');
449
        }
450 451
    }

452 453 454 455 456 457 458 459 460
    /**
     * 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
     */

461
    function showContext()
462
    {
463 464 465 466 467 468 469 470 471 472 473
        $hasConversation = false;
        if( !empty($this->notice->conversation)
            && $this->notice->conversation != $this->notice->id){
            $hasConversation = true;
        }else{
            $conversation = Notice::conversationStream($this->notice->id, 1, 1);
            if($conversation->N > 0){
                $hasConversation = true;
            }
        }
        if ($hasConversation){
474 475
            $convurl = common_local_url('conversation',
                                         array('id' => $this->notice->conversation));
476 477
            $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
                                           'class' => 'response'),
478
                                _('in context'));
479
        }
480 481
    }

482 483 484 485 486 487 488 489 490 491 492
    /**
     * 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()
    {
493 494
        if (common_logged_in()) {
            $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 499 500 501 502
                                                'title' => _('Reply to this notice')));
            $this->out->text(_('Reply'));
            $this->out->element('span', 'notice_id', $this->notice->id);
            $this->out->elementEnd('a');
        }
503 504
    }

505 506 507 508 509 510 511 512
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
513
        $user = common_current_user();
514 515

        if (!empty($user) &&
516
            ($this->notice->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
517

518 519
            $deleteurl = common_local_url('deletenotice',
                                          array('notice' => $this->notice->id));
sarven's avatar
sarven committed
520
            $this->out->element('a', array('href' => $deleteurl,
521
                                           'class' => 'notice_delete',
522
                                           'title' => _('Delete this notice')), _('Delete'));
523
        }
524 525
    }

526 527 528 529 530 531 532 533 534 535
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
536
        $this->out->elementEnd('li');
537 538
    }
}