noticelist.php 20.5 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
     *
78
     * "Uses up" the stream by looping through it. So, probably can't
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
    /** The notice that was repeated. */

    var $repeat = null;

154 155 156 157 158 159 160 161 162 163 164 165
    /** 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
     */

166
    function __construct($notice, $out=null)
167
    {
Evan Prodromou's avatar
Evan Prodromou committed
168
        parent::__construct($out);
169
        if (!empty($notice->repeat_of)) {
170 171 172 173 174 175 176
            $original = Notice::staticGet('id', $notice->repeat_of);
            if (empty($original)) { // could have been deleted
                $this->notice = $notice;
            } else {
                $this->notice = $original;
                $this->repeat = $notice;
            }
177 178 179 180
        } else {
            $this->notice  = $notice;
        }
        $this->profile = $this->notice->getProfile();
181 182 183 184 185 186 187 188 189 190 191 192 193
    }

    /**
     * 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()
    {
194 195 196 197 198 199 200 201
        if (empty($this->notice)) {
            common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
            return;
        } else if (empty($this->profile)) {
            common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
            return;
        }

202
        $this->showStart();
203 204 205 206 207 208
        if (Event::handle('StartShowNoticeItem', array($this))) {
            $this->showNotice();
            $this->showNoticeInfo();
            $this->showNoticeOptions();
            Event::handle('EndShowNoticeItem', array($this));
        }
209 210 211 212 213
        $this->showEnd();
    }

    function showNotice()
    {
214
        $this->out->elementStart('div', 'entry-title');
215
        $this->showAuthor();
sarven's avatar
sarven committed
216
        $this->showContent();
217
        $this->out->elementEnd('div');
218 219 220 221
    }

    function showNoticeInfo()
    {
222
        $this->out->elementStart('div', 'entry-content');
223 224
        $this->showNoticeLink();
        $this->showNoticeSource();
225
        $this->showNoticeLocation();
226
        $this->showContext();
227
        $this->showRepeat();
228
        $this->out->elementEnd('div');
229 230 231 232
    }

    function showNoticeOptions()
    {
233 234 235 236 237
        $user = common_current_user();
        if ($user) {
            $this->out->elementStart('div', 'notice-options');
            $this->showFaveForm();
            $this->showReplyLink();
238
            $this->showRepeatForm();
239 240 241
            $this->showDeleteLink();
            $this->out->elementEnd('div');
        }
242 243 244 245 246 247 248 249 250 251 252
    }

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

    function showStart()
    {
        // XXX: RDFa
253
        // TODO: add notice_type class e.g., notice_video, notice_image
254
        $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
255
        $this->out->elementStart('li', array('class' => 'hentry notice',
256
                                             'id' => 'notice-' . $id));
257 258 259 260 261 262 263 264 265 266
    }

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

    function showFaveForm()
    {
267
        $user = common_current_user();
268 269
        if ($user) {
            if ($user->hasFave($this->notice)) {
Evan Prodromou's avatar
Evan Prodromou committed
270 271
                $disfavor = new DisfavorForm($this->out, $this->notice);
                $disfavor->show();
272
            } else {
Evan Prodromou's avatar
Evan Prodromou committed
273 274
                $favor = new FavorForm($this->out, $this->notice);
                $favor->show();
275 276 277 278 279 280 281 282 283 284 285 286 287 288
            }
        }
    }

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

    function showAuthor()
    {
289
        $this->out->elementStart('span', 'vcard author');
290 291 292
        $attrs = array('href' => $this->profile->profileurl,
                       'class' => 'url');
        if (!empty($this->profile->fullname)) {
293
            $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
294 295
        }
        $this->out->elementStart('a', $attrs);
296
        $this->showAvatar();
297
        $this->out->text(' ');
298
        $this->showNickname();
299 300
        $this->out->elementEnd('a');
        $this->out->elementEnd('span');
301 302 303 304 305 306 307 308 309 310 311 312 313
    }

    /**
     * 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()
    {
314 315 316 317 318 319
        if ('shownotice' === $this->out->trimmed('action')) {
            $avatar_size = AVATAR_PROFILE_SIZE;
        } else {
            $avatar_size = AVATAR_STREAM_SIZE;
        }
        $avatar = $this->profile->getAvatar($avatar_size);
320

321
        $this->out->element('img', array('src' => ($avatar) ?
322 323
                                         $avatar->displayUrl() :
                                         Avatar::defaultImage($avatar_size),
Evan Prodromou's avatar
Evan Prodromou committed
324
                                         'class' => 'avatar photo',
325 326
                                         'width' => $avatar_size,
                                         'height' => $avatar_size,
Evan Prodromou's avatar
Evan Prodromou committed
327 328 329 330
                                         'alt' =>
                                         ($this->profile->fullname) ?
                                         $this->profile->fullname :
                                         $this->profile->nickname));
331 332 333 334 335 336 337 338 339 340 341 342
    }

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

    function showNickname()
    {
343 344 345
        $this->out->raw('<span class="nickname fn">' .
                        htmlspecialchars($this->profile->nickname) .
                        '</span>');
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
    }

    /**
     * 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
361
        $this->out->elementStart('p', array('class' => 'entry-content'));
362
        if ($this->notice->rendered) {
363
            $this->out->raw($this->notice->rendered);
364 365 366 367
        } 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)
368
            $this->out->raw(common_render_content($this->notice->content, $this->notice));
369
        }
370
        $this->out->elementEnd('p');
371 372 373 374 375 376
    }

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

    function showNoticeLink()
    {
384 385 386 387 388 389
        $noticeurl = $this->notice->bestUrl();

        // above should always return an URL

        assert(!empty($noticeurl));

390
        $this->out->elementStart('a', array('rel' => 'bookmark',
391
                                            'class' => 'timestamp',
Evan Prodromou's avatar
Evan Prodromou committed
392
                                            'href' => $noticeurl));
393
        $dt = common_date_iso8601($this->notice->created);
394
        $this->out->element('abbr', array('class' => 'published',
Evan Prodromou's avatar
Evan Prodromou committed
395 396
                                          'title' => $dt),
                            common_date_string($this->notice->created));
397
        $this->out->elementEnd('a');
398 399
    }

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
    /**
     * 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();

422 423 424 425
        $lat = $this->notice->lat;
        $lon = $this->notice->lon;
        $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';

426
        if (empty($name)) {
427 428
            $latdms = $this->decimalDegreesToDMS(abs($lat));
            $londms = $this->decimalDegreesToDMS(abs($lon));
429
            // TRANS: Used in coordinates as abbreviation of north
430
            $north = _('N');
431
            // TRANS: Used in coordinates as abbreviation of south
432
            $south = _('S');
433
            // TRANS: Used in coordinates as abbreviation of east
434
            $east = _('E');
435
            // TRANS: Used in coordinates as abbreviation of west
436
            $west = _('W');
437 438
            $name = sprintf(
                _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
439
                $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
440
                $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
441 442
        }

443 444
        $url  = $location->getUrl();

445
        $this->out->text(' ');
446 447
        $this->out->elementStart('span', array('class' => 'location'));
        $this->out->text(_('at'));
448
        $this->out->text(' ');
449
        if (empty($url)) {
450
            $this->out->element('abbr', array('class' => 'geo',
451 452 453
                                              'title' => $latlon),
                                $name);
        } else {
454
            $xstr = new XMLStringer(false);
455 456
            $xstr->elementStart('a', array('href' => $url,
                                           'rel' => 'external'));
457 458 459 460 461
            $xstr->element('abbr', array('class' => 'geo',
                                         'title' => $latlon),
                           $name);
            $xstr->elementEnd('a');
            $this->out->raw($xstr->getString());
462
        }
463
        $this->out->elementEnd('span');
464 465
    }

466 467 468 469
    /**
     * @param number $dec decimal degrees
     * @return array split into 'deg', 'min', and 'sec'
     */
Craig Andrews's avatar
Craig Andrews committed
470 471
    function decimalDegreesToDMS($dec)
    {
472 473
        $deg = intval($dec);
        $tempma = abs($dec) - abs($deg);
Craig Andrews's avatar
Craig Andrews committed
474 475 476 477 478 479 480 481

        $tempma = $tempma * 3600;
        $min = floor($tempma / 60);
        $sec = $tempma - ($min*60);

        return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
    }

482 483 484 485 486 487 488 489 490 491 492
    /**
     * 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()
    {
493 494 495 496
        $ns = $this->notice->getSource();

        if ($ns) {
            $source_name = _($ns->code);
497
            $this->out->text(' ');
498 499
            $this->out->elementStart('span', 'source');
            $this->out->text(_('from'));
500
            $this->out->text(' ');
501

502 503 504
            $name  = $source_name;
            $url   = $ns->url;
            $title = null;
505

506 507 508 509 510
            if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
                $name = $source_name;
                $url  = $ns->url;
            }
            Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
511

512 513 514
            // if $ns->name and $ns->url are populated we have
            // configured a source attr somewhere
            if (!empty($name) && !empty($url)) {
515

516
                $this->out->elementStart('span', 'device');
517

518 519 520 521
                $attrs = array(
                    'href' => $url,
                    'rel' => 'external'
                );
522

523 524
                if (!empty($title)) {
                    $attrs['title'] = $title;
525
                }
526 527 528 529 530

                $this->out->element('a', $attrs, $name);
                $this->out->elementEnd('span');
            } else {
                $this->out->element('span', 'device', $name);
531
            }
532

533
            $this->out->elementEnd('span');
534
        }
535 536
    }

537 538 539 540 541 542 543 544 545
    /**
     * 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
     */

546
    function showContext()
547
    {
548
        if ($this->notice->hasConversation()) {
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
            $conv = Conversation::staticGet(
                'id',
                $this->notice->conversation
            );
            $convurl = $conv->uri;
            if (!empty($convurl)) {
                $this->out->text(' ');
                $this->out->element(
                    'a',
                    array(
                    'href' => $convurl.'#notice-'.$this->notice->id,
                    'class' => 'response'),
                    _('in context')
                );
            } else {
                $msg = sprintf(
                    "Couldn't find Conversation ID %d to make 'in context'"
                    . "link for Notice ID %d",
                    $this->notice->conversation,
                    $this->notice->id
                );
                common_log(LOG_WARNING, $msg);
            }
572
        }
573 574
    }

575 576 577 578 579 580 581 582 583 584 585 586
    /**
     * show a link to the author of repeat
     *
     * @return void
     */

    function showRepeat()
    {
        if (!empty($this->repeat)) {

            $repeater = Profile::staticGet('id', $this->repeat->profile_id);

587
            $attrs = array('href' => $repeater->profileurl,
588 589 590 591 592 593
                           'class' => 'url');

            if (!empty($repeater->fullname)) {
                $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
            }

Sarven Capadisli's avatar
Sarven Capadisli committed
594
            $this->out->elementStart('span', 'repeat vcard');
595

Sarven Capadisli's avatar
Sarven Capadisli committed
596 597
            $this->out->raw(_('Repeated by'));

598
            $this->out->elementStart('a', $attrs);
599
            $this->out->element('span', 'fn nickname', $repeater->nickname);
600 601 602 603 604 605
            $this->out->elementEnd('a');

            $this->out->elementEnd('span');
        }
    }

606 607 608 609
    /**
     * show a link to reply to the current notice
     *
     * Should either do the reply in the current notice form (if available), or
610
     * link out to the notice-posting form. A little flakey, doesn't always work.
611 612 613 614 615 616
     *
     * @return void
     */

    function showReplyLink()
    {
617
        if (common_logged_in()) {
618
            $this->out->text(' ');
619
            $reply_url = common_local_url('newnotice',
620
                                          array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
621
            $this->out->elementStart('a', array('href' => $reply_url,
622
                                                'class' => 'notice_reply',
623 624
                                                'title' => _('Reply to this notice')));
            $this->out->text(_('Reply'));
625
            $this->out->text(' ');
626 627 628
            $this->out->element('span', 'notice_id', $this->notice->id);
            $this->out->elementEnd('a');
        }
629 630
    }

631 632 633 634 635 636 637 638
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
639
        $user = common_current_user();
640

641 642
        $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;

643
        if (!empty($user) &&
644
            ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
645
            $this->out->text(' ');
646
            $deleteurl = common_local_url('deletenotice',
647
                                          array('notice' => $todel->id));
sarven's avatar
sarven committed
648
            $this->out->element('a', array('href' => $deleteurl,
649
                                           'class' => 'notice_delete',
650
                                           'title' => _('Delete this notice')), _('Delete'));
651
        }
652 653
    }

654 655 656 657 658 659 660 661 662 663
    /**
     * show the form to repeat a notice
     *
     * @return void
     */

    function showRepeatForm()
    {
        $user = common_current_user();
        if ($user && $user->id != $this->notice->profile_id) {
664
            $this->out->text(' ');
665 666
            $profile = $user->getProfile();
            if ($profile->hasRepeated($this->notice->id)) {
667 668 669
                $this->out->element('span', array('class' => 'repeated',
                                                  'title' => _('Notice repeated')),
                                            _('Repeated'));
670 671 672 673 674 675 676
            } else {
                $rf = new RepeatForm($this->out, $this->notice);
                $rf->show();
            }
        }
    }

677 678 679 680 681 682 683 684 685 686
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
687
        $this->out->elementEnd('li');
688 689
    }
}