We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

noticelist.php 21.4 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 100 101 102 103 104 105 106
            try {
                $item = $this->newListItem($this->notice);
                $item->show();
            } catch (Exception $e) {
                // we log exceptions and continue
                common_log(LOG_ERR, $e->getMessage());
                continue;
            }
107
        }
108

109
        $this->out->elementEnd('ol');
sarven's avatar
sarven committed
110
        $this->out->elementEnd('div');
111 112

        return $cnt;
113
    }
114

115 116 117 118 119 120 121 122 123 124 125 126 127
    /**
     * 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)
    {
128
        return new NoticeListItem($notice, $this->out);
129 130 131
    }
}

132 133 134 135 136 137 138 139 140 141
/**
 * 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
142
 * @package  StatusNet
143
 * @author   Evan Prodromou <evan@status.net>
144
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
145
 * @link     http://status.net/
146 147 148 149
 * @see      NoticeList
 * @see      ProfileNoticeListItem
 */

150
class NoticeListItem extends Widget
151 152
{
    /** The notice this item will show. */
153

154
    var $notice = null;
155

156 157 158 159
    /** The notice that was repeated. */

    var $repeat = null;

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
     */

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

    /**
     * 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()
    {
200 201 202 203 204 205 206 207
        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;
        }

208
        $this->showStart();
209 210 211 212 213 214
        if (Event::handle('StartShowNoticeItem', array($this))) {
            $this->showNotice();
            $this->showNoticeInfo();
            $this->showNoticeOptions();
            Event::handle('EndShowNoticeItem', array($this));
        }
215 216 217 218 219
        $this->showEnd();
    }

    function showNotice()
    {
220
        $this->out->elementStart('div', 'entry-title');
221
        $this->showAuthor();
sarven's avatar
sarven committed
222
        $this->showContent();
223
        $this->out->elementEnd('div');
224 225 226 227
    }

    function showNoticeInfo()
    {
228
        $this->out->elementStart('div', 'entry-content');
229 230 231 232 233 234 235 236 237
        if (Event::handle('StartShowNoticeInfo', array($this))) {
            $this->showNoticeLink();
            $this->showNoticeSource();
            $this->showNoticeLocation();
            $this->showContext();
            $this->showRepeat();
            Event::handle('EndShowNoticeInfo', array($this));
        }

238
        $this->out->elementEnd('div');
239 240 241 242
    }

    function showNoticeOptions()
    {
243 244 245 246 247 248 249 250 251 252 253
        if (Event::handle('StartShowNoticeOptions', array($this))) {
            $user = common_current_user();
            if ($user) {
                $this->out->elementStart('div', 'notice-options');
                $this->showFaveForm();
                $this->showReplyLink();
                $this->showRepeatForm();
                $this->showDeleteLink();
                $this->out->elementEnd('div');
            }
            Event::handle('EndShowNoticeOptions', array($this));
254
        }
255 256 257 258 259 260 261 262 263 264 265
    }

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

    function showStart()
    {
        // XXX: RDFa
266
        // TODO: add notice_type class e.g., notice_video, notice_image
267
        $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
268
        $this->out->elementStart('li', array('class' => 'hentry notice',
269
                                             'id' => 'notice-' . $id));
270 271 272 273 274 275 276 277 278 279
    }

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

    function showFaveForm()
    {
280 281 282 283 284 285 286 287 288 289
        if (Event::handle('StartShowFaveForm', array($this))) {
            $user = common_current_user();
            if ($user) {
                if ($user->hasFave($this->notice)) {
                    $disfavor = new DisfavorForm($this->out, $this->notice);
                    $disfavor->show();
                } else {
                    $favor = new FavorForm($this->out, $this->notice);
                    $favor->show();
                }
290
            }
291
            Event::handle('EndShowFaveForm', array($this));
292 293 294 295 296 297 298 299 300 301 302 303 304
        }
    }

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

    function showAuthor()
    {
305
        $this->out->elementStart('span', 'vcard author');
306 307 308
        $attrs = array('href' => $this->profile->profileurl,
                       'class' => 'url');
        if (!empty($this->profile->fullname)) {
309
            $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
310 311
        }
        $this->out->elementStart('a', $attrs);
312
        $this->showAvatar();
313
        $this->out->text(' ');
314
        $this->showNickname();
315 316
        $this->out->elementEnd('a');
        $this->out->elementEnd('span');
317 318 319 320 321 322 323 324 325 326 327 328 329
    }

    /**
     * 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()
    {
330 331 332 333 334 335
        if ('shownotice' === $this->out->trimmed('action')) {
            $avatar_size = AVATAR_PROFILE_SIZE;
        } else {
            $avatar_size = AVATAR_STREAM_SIZE;
        }
        $avatar = $this->profile->getAvatar($avatar_size);
336

337
        $this->out->element('img', array('src' => ($avatar) ?
338 339
                                         $avatar->displayUrl() :
                                         Avatar::defaultImage($avatar_size),
Evan Prodromou's avatar
Evan Prodromou committed
340
                                         'class' => 'avatar photo',
341 342
                                         'width' => $avatar_size,
                                         'height' => $avatar_size,
Evan Prodromou's avatar
Evan Prodromou committed
343 344 345 346
                                         'alt' =>
                                         ($this->profile->fullname) ?
                                         $this->profile->fullname :
                                         $this->profile->nickname));
347 348 349 350 351 352 353 354 355 356 357 358
    }

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

    function showNickname()
    {
359 360 361
        $this->out->raw('<span class="nickname fn">' .
                        htmlspecialchars($this->profile->nickname) .
                        '</span>');
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
    }

    /**
     * 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
377
        $this->out->elementStart('p', array('class' => 'entry-content'));
378
        if ($this->notice->rendered) {
379
            $this->out->raw($this->notice->rendered);
380 381 382 383
        } 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)
384
            $this->out->raw(common_render_content($this->notice->content, $this->notice));
385
        }
386
        $this->out->elementEnd('p');
387 388 389 390 391 392
    }

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

    function showNoticeLink()
    {
400 401 402 403 404 405
        $noticeurl = $this->notice->bestUrl();

        // above should always return an URL

        assert(!empty($noticeurl));

406
        $this->out->elementStart('a', array('rel' => 'bookmark',
407
                                            'class' => 'timestamp',
Evan Prodromou's avatar
Evan Prodromou committed
408
                                            'href' => $noticeurl));
409
        $dt = common_date_iso8601($this->notice->created);
410
        $this->out->element('abbr', array('class' => 'published',
Evan Prodromou's avatar
Evan Prodromou committed
411 412
                                          'title' => $dt),
                            common_date_string($this->notice->created));
413
        $this->out->elementEnd('a');
414 415
    }

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
    /**
     * 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();

438 439 440 441
        $lat = $this->notice->lat;
        $lon = $this->notice->lon;
        $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';

442
        if (empty($name)) {
443 444
            $latdms = $this->decimalDegreesToDMS(abs($lat));
            $londms = $this->decimalDegreesToDMS(abs($lon));
445
            // TRANS: Used in coordinates as abbreviation of north
446
            $north = _('N');
447
            // TRANS: Used in coordinates as abbreviation of south
448
            $south = _('S');
449
            // TRANS: Used in coordinates as abbreviation of east
450
            $east = _('E');
451
            // TRANS: Used in coordinates as abbreviation of west
452
            $west = _('W');
453 454
            $name = sprintf(
                _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
455
                $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
456
                $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
457 458
        }

459 460
        $url  = $location->getUrl();

461
        $this->out->text(' ');
462 463
        $this->out->elementStart('span', array('class' => 'location'));
        $this->out->text(_('at'));
464
        $this->out->text(' ');
465
        if (empty($url)) {
466
            $this->out->element('abbr', array('class' => 'geo',
467 468 469
                                              'title' => $latlon),
                                $name);
        } else {
470
            $xstr = new XMLStringer(false);
471 472
            $xstr->elementStart('a', array('href' => $url,
                                           'rel' => 'external'));
473 474 475 476 477
            $xstr->element('abbr', array('class' => 'geo',
                                         'title' => $latlon),
                           $name);
            $xstr->elementEnd('a');
            $this->out->raw($xstr->getString());
478
        }
479
        $this->out->elementEnd('span');
480 481
    }

482 483 484 485
    /**
     * @param number $dec decimal degrees
     * @return array split into 'deg', 'min', and 'sec'
     */
Craig Andrews's avatar
Craig Andrews committed
486 487
    function decimalDegreesToDMS($dec)
    {
488 489
        $deg = intval($dec);
        $tempma = abs($dec) - abs($deg);
Craig Andrews's avatar
Craig Andrews committed
490 491 492 493 494 495 496 497

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

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

498 499 500 501 502 503 504 505 506 507 508
    /**
     * 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()
    {
509 510 511
        $ns = $this->notice->getSource();

        if ($ns) {
512
            $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _('web')) : _($ns->name);
513
            $this->out->text(' ');
514
            $this->out->elementStart('span', 'source');
515
            // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
516
            $this->out->text(_('from'));
517
            $this->out->text(' ');
518

519 520 521
            $name  = $source_name;
            $url   = $ns->url;
            $title = null;
522

523 524 525 526 527
            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));
528

529 530 531
            // if $ns->name and $ns->url are populated we have
            // configured a source attr somewhere
            if (!empty($name) && !empty($url)) {
532

533
                $this->out->elementStart('span', 'device');
534

535 536 537 538
                $attrs = array(
                    'href' => $url,
                    'rel' => 'external'
                );
539

540 541
                if (!empty($title)) {
                    $attrs['title'] = $title;
542
                }
543 544 545 546 547

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

550
            $this->out->elementEnd('span');
551
        }
552 553
    }

554 555 556 557 558 559 560 561 562
    /**
     * 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
     */

563
    function showContext()
564
    {
565
        if ($this->notice->hasConversation()) {
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
            $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);
            }
589
        }
590 591
    }

592 593 594 595 596 597 598 599 600 601 602 603
    /**
     * show a link to the author of repeat
     *
     * @return void
     */

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

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

604
            $attrs = array('href' => $repeater->profileurl,
605 606 607 608 609 610
                           'class' => 'url');

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

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

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

615
            $this->out->elementStart('a', $attrs);
616
            $this->out->element('span', 'fn nickname', $repeater->nickname);
617 618 619 620 621 622
            $this->out->elementEnd('a');

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

623 624 625 626
    /**
     * show a link to reply to the current notice
     *
     * Should either do the reply in the current notice form (if available), or
627
     * link out to the notice-posting form. A little flakey, doesn't always work.
628 629 630 631 632 633
     *
     * @return void
     */

    function showReplyLink()
    {
634
        if (common_logged_in()) {
635
            $this->out->text(' ');
636
            $reply_url = common_local_url('newnotice',
637
                                          array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
638
            $this->out->elementStart('a', array('href' => $reply_url,
639
                                                'class' => 'notice_reply',
640 641
                                                'title' => _('Reply to this notice')));
            $this->out->text(_('Reply'));
642
            $this->out->text(' ');
643 644 645
            $this->out->element('span', 'notice_id', $this->notice->id);
            $this->out->elementEnd('a');
        }
646 647
    }

648 649 650 651 652 653 654 655
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
656
        $user = common_current_user();
657

658 659
        $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;

660
        if (!empty($user) &&
661
            ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
662
            $this->out->text(' ');
663
            $deleteurl = common_local_url('deletenotice',
664
                                          array('notice' => $todel->id));
sarven's avatar
sarven committed
665
            $this->out->element('a', array('href' => $deleteurl,
666
                                           'class' => 'notice_delete',
667
                                           'title' => _('Delete this notice')), _('Delete'));
668
        }
669 670
    }

671 672 673 674 675 676 677 678 679 680
    /**
     * show the form to repeat a notice
     *
     * @return void
     */

    function showRepeatForm()
    {
        $user = common_current_user();
        if ($user && $user->id != $this->notice->profile_id) {
681
            $this->out->text(' ');
682 683
            $profile = $user->getProfile();
            if ($profile->hasRepeated($this->notice->id)) {
684 685 686
                $this->out->element('span', array('class' => 'repeated',
                                                  'title' => _('Notice repeated')),
                                            _('Repeated'));
687 688 689 690 691 692 693
            } else {
                $rf = new RepeatForm($this->out, $this->notice);
                $rf->show();
            }
        }
    }

694 695 696 697 698 699 700 701 702 703
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
704
        $this->out->elementEnd('li');
705 706
    }
}