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

noticelistitem.php 21.4 KB
Newer Older
1 2 3 4 5 6
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * An item in a notice list
7
 *
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * PHP version 5
 *
 * This program is free software: you can redistribute it and/or modify
 * 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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Widget
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

31
if (!defined('GNUSOCIAL')) { exit(1); }
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

/**
 * 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  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 * @see      NoticeList
 * @see      ProfileNoticeListItem
 */
class NoticeListItem extends Widget
{
    /** The notice this item will show. */
    var $notice = null;

    /** The notice that was repeated. */
    var $repeat = null;

    /** The profile of the author of the notice, extracted once for convenience. */
    var $profile = null;

61 62
    protected $addressees = true;
    protected $attachments = true;
63
    protected $id_prefix = null;
64 65
    protected $options = true;
    protected $maxchars = 0;   // if <= 0 it means use full posts
66
    protected $item_tag = 'li';
67
    protected $pa = null;
68

69 70 71 72 73 74 75
    /**
     * constructor
     *
     * Also initializes the profile attribute.
     *
     * @param Notice $notice The notice we'll display
     */
76
    function __construct(Notice $notice, Action $out=null, array $prefs=array())
77 78 79
    {
        parent::__construct($out);
        if (!empty($notice->repeat_of)) {
80
            $original = Notice::getKV('id', $notice->repeat_of);
81
            if (!$original instanceof Notice) { // could have been deleted
82 83 84 85 86 87 88 89
                $this->notice = $notice;
            } else {
                $this->notice = $original;
                $this->repeat = $notice;
            }
        } else {
            $this->notice  = $notice;
        }
90

91
        $this->profile = $this->notice->getProfile();
92 93 94 95 96 97 98 99 100 101 102 103 104
        
        // integer preferences
        foreach(array('maxchars') as $key) {
            if (array_key_exists($key, $prefs)) {
                $this->$key = (int)$prefs[$key];
            }
        }
        // boolean preferences
        foreach(array('addressees', 'attachments', 'options') as $key) {
            if (array_key_exists($key, $prefs)) {
                $this->$key = (bool)$prefs[$key];
            }
        }
105
        // string preferences
106
        foreach(array('id_prefix', 'item_tag') as $key) {
107 108 109 110
            if (array_key_exists($key, $prefs)) {
                $this->$key = $prefs[$key];
            }
        }
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
    }

    /**
     * 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()
    {
        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;
        }

        $this->showStart();
        if (Event::handle('StartShowNoticeItem', array($this))) {
            $this->showNotice();
            Event::handle('EndShowNoticeItem', array($this));
        }
        $this->showEnd();
    }

    function showNotice()
    {
141
        if (Event::handle('StartShowNoticeItemNotice', array($this))) {
142
            $this->showNoticeHeaders();
143
            $this->showContent();
144
            $this->showNoticeFooter();
145
            Event::handle('EndShowNoticeItemNotice', array($this));
146
        }
mattl's avatar
mattl committed
147 148
    }

149 150 151 152 153
    function showNoticeHeaders()
    {
        $this->elementStart('section', array('class'=>'notice-headers'));
        $this->showNoticeTitle();
        $this->showAuthor();
154

155
        if (!empty($this->notice->reply_to) || count($this->getProfileAddressees()) > 0) {
156
            $this->elementStart('div', array('class' => 'parents'));
mattl's avatar
mattl committed
157 158 159 160 161
            try {
                $this->showParent();
            } catch (NoParentNoticeException $e) {
                // no parent notice
            }
162 163 164
            if ($this->addressees) { $this->showAddressees(); }
            $this->elementEnd('div');
        }
165 166 167 168 169 170 171
        $this->elementEnd('section');
    }

    function showNoticeFooter()
    {
        $this->elementStart('footer');
        $this->showNoticeInfo();
172
        if ($this->options) { $this->showNoticeOptions(); }
mattl's avatar
mattl committed
173
        if ($this->attachments) { $this->showNoticeAttachments(); }
174 175 176
        $this->elementEnd('footer');
    }

mattl's avatar
mattl committed
177 178 179
    function showNoticeTitle()
    {
        if (Event::handle('StartShowNoticeTitle', array($this))) {
180
            $this->element('a', array('href' => $this->notice->getUrl(true),
181
                                      'class' => 'notice-title'),
mattl's avatar
mattl committed
182 183 184
                           $this->notice->getTitle());
            Event::handle('EndShowNoticeTitle', array($this));
        }
185 186 187 188 189 190 191 192
    }

    function showNoticeInfo()
    {
        if (Event::handle('StartShowNoticeInfo', array($this))) {
            $this->showNoticeLink();
            $this->showNoticeSource();
            $this->showNoticeLocation();
193
            $this->showPermalink();
194 195 196 197 198 199 200 201 202 203
            Event::handle('EndShowNoticeInfo', array($this));
        }
    }

    function showNoticeOptions()
    {
        if (Event::handle('StartShowNoticeOptions', array($this))) {
            $user = common_current_user();
            if ($user) {
                $this->out->elementStart('div', 'notice-options');
204 205 206 207 208
                if (Event::handle('StartShowNoticeOptionItems', array($this))) {
                    $this->showReplyLink();
                    $this->showDeleteLink();
                    Event::handle('EndShowNoticeOptionItems', array($this));
                }
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
                $this->out->elementEnd('div');
            }
            Event::handle('EndShowNoticeOptions', array($this));
        }
    }

    /**
     * start a single notice.
     *
     * @return void
     */
    function showStart()
    {
        if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
            $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
mattl's avatar
mattl committed
224
            $class = 'h-entry notice';
225 226 227
            if ($this->notice->scope != 0 && $this->notice->scope != 1) {
                $class .= ' limited-scope';
            }
228 229 230
            if (!empty($this->notice->source)) {
                $class .= ' notice-source-'.$this->notice->source;
            }
231
            $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
232
            $this->out->elementStart($this->item_tag, array('class' => $class,
233
                                                 'id' => "${id_prefix}notice-${id}"));
234 235 236 237 238 239 240 241 242 243 244
            Event::handle('EndOpenNoticeListItemElement', array($this));
        }
    }

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

246 247 248
    function showAuthor()
    {
        $attrs = array('href' => $this->profile->profileurl,
249
                       'class' => 'h-card',
mattl's avatar
mattl committed
250
                       'title' => $this->profile->getNickname());
251
        if(empty($this->repeat)) { $attrs['class'] .= ' p-author'; }
252

253 254 255 256 257 258 259
        if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
            $this->out->elementStart('a', $attrs);
            $this->showAvatar($this->profile);
            $this->out->text($this->profile->getStreamName());
            $this->out->elementEnd('a');
            Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
        }
260 261
    }

262 263 264 265 266 267 268 269 270 271 272 273 274
    function showParent()
    {
        $this->out->element(
            'a',
            array(
                'href' => $this->notice->getParent()->getUrl(),
                'class' => 'u-in-reply-to',
                'rel' => 'in-reply-to'
            ),
            'in reply to'
        );
    }

275 276
    function showAddressees()
    {
277 278
        $pa = $this->getProfileAddressees();

279
        if (!empty($pa)) {
mattl's avatar
mattl committed
280
            $this->out->elementStart('ul', 'addressees');
281
            $first = true;
282
            foreach ($pa as $addr) {
mattl's avatar
mattl committed
283
                $this->out->elementStart('li', 'h-card');
284 285 286
                $text = $addr['text'];
                unset($addr['text']);
                $this->out->element('a', $addr, $text);
mattl's avatar
mattl committed
287
                $this->out->elementEnd('li');
288
            }
mattl's avatar
mattl committed
289
            $this->out->elementEnd('ul', 'addressees');
290
        }
291 292
    }

293
    function getProfileAddressees()
294
    {
295 296
        if($this->pa) { return $this->pa; }
        $this->pa = array();
297

298
        $attentions = $this->getReplyProfiles();
299

300 301
        foreach ($attentions as $attn) {
            $class = $attn->isGroup() ? 'group' : 'account';
302 303 304 305
            $this->pa[] = array('href' => $attn->profileurl,
                                'title' => $attn->getNickname(),
                                'class' => "addressee {$class}",
                                'text' => $attn->getStreamName());
306 307
        }

308
        return $this->pa;
309 310 311 312 313 314 315
    }

    function getReplyProfiles()
    {
        return $this->notice->getReplyProfiles();
    }

316 317 318 319 320 321 322 323 324
    /**
     * show the nickname of the author
     *
     * Links to the author's profile page
     *
     * @return void
     */
    function showNickname()
    {
mattl's avatar
mattl committed
325 326
        $this->out->raw('<span class="p-name">' .
                        htmlspecialchars($this->profile->getNickname()) .
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
                        '</span>');
    }

    /**
     * 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
342
        $this->out->elementStart('article', array('class' => 'e-content'));
343
        if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
344 345
            if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
                $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
346
            } else {
347
                $this->out->raw($this->notice->getRendered());
348 349
            }
            Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
350
        }
351
        $this->out->elementEnd('article');
352 353 354 355 356 357 358 359 360 361 362 363
    }

    function showNoticeAttachments() {
        if (common_config('attachments', 'show_thumbs')) {
            $al = new InlineAttachmentList($this->notice, $this->out);
            $al->show();
        }
    }

    /**
     * show the link to the main page for the notice
     *
364
     * Displays a local link to the rendered notice, with "relative" time.
365 366 367 368 369 370
     *
     * @return void
     */
    function showNoticeLink()
    {
        $this->out->elementStart('a', array('rel' => 'bookmark',
mattl's avatar
mattl committed
371
                                            'class' => 'timestamp',
372
                                            'href' => Conversation::getUrlFromNotice($this->notice)));
373 374 375
        $this->out->element('time', array('class' => 'dt-published',
                                          'datetime' => common_date_iso8601($this->notice->created),
                                          'title' => common_exact_date($this->notice->created)),
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
                            common_date_string($this->notice->created));
        $this->out->elementEnd('a');
    }

    /**
     * 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()
    {
391 392 393 394 395 396
        return;
        try {
            $location = Notice_location::locFromStored($this->notice);
        } catch (NoResultException $e) {
            return;
        } catch (ServerException $e) {
397 398 399 400 401
            return;
        }

        $name = $location->getName();

402 403
        $lat = $location->lat;
        $lon = $location->lon;
404 405 406 407 408
        $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';

        if (empty($name)) {
            $latdms = $this->decimalDegreesToDMS(abs($lat));
            $londms = $this->decimalDegreesToDMS(abs($lon));
409
            // TRANS: Used in coordinates as abbreviation of north.
410
            $north = _('N');
411
            // TRANS: Used in coordinates as abbreviation of south.
412
            $south = _('S');
413
            // TRANS: Used in coordinates as abbreviation of east.
414
            $east = _('E');
415
            // TRANS: Used in coordinates as abbreviation of west.
416 417
            $west = _('W');
            $name = sprintf(
418 419 420 421 422
                // TRANS: Coordinates message.
                // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
                // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
                // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
                // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
423 424 425 426 427 428 429 430 431
                _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
                $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
                $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
        }

        $url  = $location->getUrl();

        $this->out->text(' ');
        $this->out->elementStart('span', array('class' => 'location'));
432
        // TRANS: Followed by geo location.
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
        $this->out->text(_('at'));
        $this->out->text(' ');
        if (empty($url)) {
            $this->out->element('abbr', array('class' => 'geo',
                                              'title' => $latlon),
                                $name);
        } else {
            $xstr = new XMLStringer(false);
            $xstr->elementStart('a', array('href' => $url,
                                           'rel' => 'external'));
            $xstr->element('abbr', array('class' => 'geo',
                                         'title' => $latlon),
                           $name);
            $xstr->elementEnd('a');
            $this->out->raw($xstr->getString());
        }
        $this->out->elementEnd('span');
    }

    /**
     * @param number $dec decimal degrees
     * @return array split into 'deg', 'min', and 'sec'
     */
    function decimalDegreesToDMS($dec)
    {
        $deg = intval($dec);
        $tempma = abs($dec) - abs($deg);

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

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

    /**
     * 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()
    {
        $ns = $this->notice->getSource();

480 481 482
        if (!$ns instanceof Notice_source) {
            return false;
        }
483

484 485 486 487 488 489 490 491
        // TRANS: A possible notice source (web interface).
        $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
        $this->out->text(' ');
        $this->out->elementStart('span', 'source');
        // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
        // TRANS: Followed by notice source.
        $this->out->text(_('from'));
        $this->out->text(' ');
492

493 494 495
        $name  = $source_name;
        $url   = $ns->url;
        $title = null;
496

497 498 499 500 501
        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));
502

503 504 505 506 507 508 509 510 511 512 513 514
        // if $ns->name and $ns->url are populated we have
        // configured a source attr somewhere
        if (!empty($name) && !empty($url)) {
            $this->out->elementStart('span', 'device');

            $attrs = array(
                'href' => $url,
                'rel' => 'external'
            );

            if (!empty($title)) {
                $attrs['title'] = $title;
515 516
            }

517
            $this->out->element('a', $attrs, $name);
518
            $this->out->elementEnd('span');
519 520
        } else {
            $this->out->element('span', 'device', $name);
521
        }
522 523

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

    /**
527
     * show link to single-notice view for this notice item
528
     *
529
     * A permalink that goes to this specific object and nothing else
530 531 532
     *
     * @return void
     */
533
    function showPermalink()
534
    {
mattl's avatar
mattl committed
535 536 537 538
        $class = 'permalink u-url';
        if (!$this->notice->isLocal()) {
            $class .= ' external';
        }
539 540 541 542 543 544 545 546 547 548 549 550 551

        try {
            if($this->repeat) {
                $this->out->element('a',
                            array('href' => $this->repeat->getUrl(),
                                  'class' => 'u-url'),
                            '');
                $class = str_replace('u-url', 'u-repost-of', $class);
            }
        } catch (InvalidUrlException $e) {
            // no permalink available
        }

mattl's avatar
mattl committed
552 553
        try {
            $this->out->element('a',
554
                        array('href' => $this->notice->getUrl(true),
mattl's avatar
mattl committed
555 556 557 558 559 560
                              'class' => $class),
                        // TRANS: Addition in notice list item for single-notice view.
                        _('permalink'));
        } catch (InvalidUrlException $e) {
            // no permalink available
        }
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    }

    /**
     * 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()
    {
        if (common_logged_in()) {
            $this->out->text(' ');
            $reply_url = common_local_url('newnotice',
mattl's avatar
mattl committed
576
                                          array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
577 578
            $this->out->elementStart('a', array('href' => $reply_url,
                                                'class' => 'notice_reply',
579
                                                // TRANS: Link title in notice list item to reply to a notice.
580
                                                'title' => _('Reply to this notice.')));
581
            // TRANS: Link text in notice list item to reply to a notice.
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
            $this->out->text(_('Reply'));
            $this->out->text(' ');
            $this->out->element('span', 'notice_id', $this->notice->id);
            $this->out->elementEnd('a');
        }
    }

    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */
    function showDeleteLink()
    {
        $user = common_current_user();

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

        if (!empty($user) &&
            ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
            $this->out->text(' ');
            $deleteurl = common_local_url('deletenotice',
                                          array('notice' => $todel->id));
            $this->out->element('a', array('href' => $deleteurl,
606
                                           'class' => 'notice_delete popup',
607
                                           // TRANS: Link title in notice list item to delete a notice.
608
                                           'title' => _('Delete this notice from the timeline.')),
609 610
                                           // TRANS: Link text in notice list item to delete a notice.
                                           _('Delete'));
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
        }
    }

    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */
    function showEnd()
    {
        if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
            $this->out->elementEnd('li');
            Event::handle('EndCloseNoticeListItemElement', array($this));
        }
    }
628 629 630 631 632 633 634 635 636 637 638 639 640

    /**
     * Get the notice in question
     *
     * For hooks, etc., this may be useful
     *
     * @return Notice The notice we're showing
     */

    function getNotice()
    {
        return $this->notice;
    }
641
}