noticelist.php 16.9 KB
Newer Older
1
<?php
2 3
/**
 * Laconica, the distributed open-source microblogging tool
4
 *
5
 * widget for displaying a list of notices
6 7 8 9
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
10 11 12 13 14 15
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 18 19
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
20 21 22 23 24
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  UI
 * @package   Laconica
 * @author    Evan Prodromou <evan@controlyourself.ca>
25
 * @author    Sarven Capadisli <csarven@controlyourself.ca>
26 27 28
 * @copyright 2008 Control Yourself, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://laconi.ca/
29 30
 */

31 32 33 34
if (!defined('LACONICA')) {
    exit(1);
}

35 36 37
require_once INSTALLDIR.'/lib/favorform.php';
require_once INSTALLDIR.'/lib/disfavorform.php';

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
/**
 * widget for displaying a list of notices
 *
 * There are a number of actions that display a list of notices, in
 * reverse chronological order. This widget abstracts out most of the
 * code for UI for notice lists. It's overridden to hide some
 * data for e.g. the profile page.
 *
 * @category UI
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://laconi.ca/
 * @see      Notice
 * @see      StreamAction
 * @see      NoticeListItem
 * @see      ProfileNoticeList
 */
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 78 79 80 81 82
    /**
     * show the list of notices
     *
     * "Uses up" the stream by looping through it. So, probably can't
     * be called twice on the same list.
     *
     * @return int count of notices listed.
     */
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 88
        $this->out->element('h2', null, _('Notices'));
        $this->out->elementStart('ul', array('class' => 'notices'));
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('ul');
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 136 137 138 139 140 141 142 143
/**
 * widget for displaying a single notice
 *
 * This widget has the core smarts for showing a single notice: what to display,
 * where, and under which circumstances. Its key method is show(); this is a recipe
 * that calls all the other show*() methods to build up a single notice. The
 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 * author info (since that's implicit by the data in the page).
 *
 * @category UI
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://laconi.ca/
 * @see      NoticeList
 * @see      ProfileNoticeListItem
 */

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
        $this->showNotice();
182 183
        $this->showNoticeAttachments();
        $this->showNoticeInfo();
184
        $this->showNoticeOptions();
185 186 187 188 189
        $this->showEnd();
    }

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

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
    function showNoticeAttachments()
    {
        $f2p = new File_to_post;
        $f2p->post_id = $this->notice->id;
        $file = new File;
        $file->joinAdd($f2p);
        $file->selectAdd();
        $file->selectAdd('file.id as id');
        $count = $file->find(true);
        if (!$count) return;
        if (1 === $count) {
            $href = common_local_url('attachment', array('attachment' => $file->id));
            $att_class = 'attachment';
        } else {
            $href = common_local_url('attachments', array('notice' => $this->notice->id));
            $att_class = 'attachments';
        }

        $clip = theme_path('images/icons/clip', 'base');
        if ('shownotice' === $this->out->args['action']) {
            $height = '96px';
            $width = '83%';
            $width_att = '15%';
            $clip .= '-big.png';
            $top = '70px';
        } else {
            $height = '48px';
            $width = '90%';
            $width_att = '8%';
            $clip .= '.png';
            $top = '20px';
        }
Robin Millette's avatar
Robin Millette committed
228
if(0)
229 230 231 232 233 234 235 236 237
        $this->out->elementStart('div', 'entry-attachments');
else
        $this->out->elementStart('p', array('class' => 'entry-attachments', 'style' => "float: right; width: $width_att; background: url($clip) no-repeat; text-align: right; height: $height;"));
        $this->out->element('a', array('class' => $att_class, 'style' => "text-decoration: none; padding-top: $top; display: block; height: $height;", 'href' => $href, 'title' => "# of attachments: $count"), $count === 1 ? '' : $count);


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

238 239
    function showNoticeInfo()
    {
240
        $this->out->elementStart('div', 'entry-content');
241 242
        $this->showNoticeLink();
        $this->showNoticeSource();
243
        $this->showContext();
244
        $this->out->elementEnd('div');
245 246 247 248
    }

    function showNoticeOptions()
    {
249 250 251 252 253 254 255 256
        $user = common_current_user();
        if ($user) {
            $this->out->elementStart('div', 'notice-options');
            $this->showFaveForm();
            $this->showReplyLink();
            $this->showDeleteLink();
            $this->out->elementEnd('div');
        }
257 258 259 260 261 262 263 264 265 266 267
    }

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

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

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

    function showFaveForm()
    {
281
        $user = common_current_user();
282 283
        if ($user) {
            if ($user->hasFave($this->notice)) {
Evan Prodromou's avatar
Evan Prodromou committed
284 285
                $disfavor = new DisfavorForm($this->out, $this->notice);
                $disfavor->show();
286
            } else {
Evan Prodromou's avatar
Evan Prodromou committed
287 288
                $favor = new FavorForm($this->out, $this->notice);
                $favor->show();
289 290 291 292 293 294 295 296 297 298 299 300 301 302
            }
        }
    }

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

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

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

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

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

    function showNickname()
    {
356
        $this->out->element('span', array('class' => 'nickname fn'),
Evan Prodromou's avatar
Evan Prodromou committed
357
                            $this->profile->nickname);
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
    }

    /**
     * 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
373
        $this->out->elementStart('p', array('class' => 'entry-content'));
374
        if ($this->notice->rendered) {
375
            $this->out->raw($this->notice->rendered);
376 377 378 379
        } 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)
380
            $this->out->raw(common_render_content($this->notice->content, $this->notice));
381
        }
382
        $this->out->elementEnd('p');
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
    }

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

    function showNoticeLink()
    {
        $noticeurl = common_local_url('shownotice',
                                      array('notice' => $this->notice->id));
        // XXX: we need to figure this out better. Is this right?
        if (strcmp($this->notice->uri, $noticeurl) != 0 &&
            preg_match('/^http/', $this->notice->uri)) {
            $noticeurl = $this->notice->uri;
        }
403
        $this->out->elementStart('dl', 'timestamp');
Evan Prodromou's avatar
Evan Prodromou committed
404
        $this->out->element('dt', null, _('Published'));
405
        $this->out->elementStart('dd', null);
406
        $this->out->elementStart('a', array('rel' => 'bookmark',
Evan Prodromou's avatar
Evan Prodromou committed
407
                                            'href' => $noticeurl));
408
        $dt = common_date_iso8601($this->notice->created);
409
        $this->out->element('abbr', array('class' => 'published',
Evan Prodromou's avatar
Evan Prodromou committed
410 411
                                          'title' => $dt),
                            common_date_string($this->notice->created));
412 413 414
        $this->out->elementEnd('a');
        $this->out->elementEnd('dd');
        $this->out->elementEnd('dl');
415 416 417 418 419 420 421 422 423 424 425 426 427 428
    }

    /**
     * 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) {
429 430
            $this->out->elementStart('dl', 'device');
            $this->out->element('dt', null, _('From'));
Evan Prodromou's avatar
Evan Prodromou committed
431
            $source_name = _($this->notice->source);
432
            switch ($this->notice->source) {
Evan Prodromou's avatar
Evan Prodromou committed
433 434 435 436
             case 'web':
             case 'xmpp':
             case 'mail':
             case 'omb':
437
             case 'system':
Evan Prodromou's avatar
Evan Prodromou committed
438
             case 'api':
439
                $this->out->element('dd', null, $source_name);
440
                break;
Evan Prodromou's avatar
Evan Prodromou committed
441
             default:
442
                $ns = Notice_source::staticGet($this->notice->source);
443
                if ($ns) {
444 445
                    $this->out->elementStart('dd', null);
                    $this->out->element('a', array('href' => $ns->url,
Evan Prodromou's avatar
Evan Prodromou committed
446 447
                                                   'rel' => 'external'),
                                        $ns->name);
448
                    $this->out->elementEnd('dd');
449
                } else {
450
                    $this->out->element('dd', null, $source_name);
451 452 453
                }
                break;
            }
454
            $this->out->elementEnd('dl');
455
        }
456 457
    }

458 459 460 461 462 463 464 465 466
    /**
     * 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
     */

467
    function showContext()
468
    {
469 470 471 472 473
        // XXX: also show context if there are replies to this notice
        if (!empty($this->notice->conversation)
            && $this->notice->conversation != $this->notice->id) {
            $convurl = common_local_url('conversation',
                                         array('id' => $this->notice->conversation));
474 475 476
            $this->out->elementStart('dl', 'response');
            $this->out->element('dt', null, _('To'));
            $this->out->elementStart('dd');
477 478
            $this->out->element('a', array('href' => $convurl),
                                _('in context'));
479 480
            $this->out->elementEnd('dd');
            $this->out->elementEnd('dl');
481
        }
482 483
    }

484 485 486 487 488 489 490 491 492 493 494
    /**
     * 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()
    {
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
        if (common_logged_in()) {
            $reply_url = common_local_url('newnotice',
                                          array('replyto' => $this->profile->nickname));

            $this->out->elementStart('dl', 'notice_reply');
            $this->out->element('dt', null, _('Reply to this notice'));
            $this->out->elementStart('dd');
            $this->out->elementStart('a', array('href' => $reply_url,
                                                'title' => _('Reply to this notice')));
            $this->out->text(_('Reply'));
            $this->out->element('span', 'notice_id', $this->notice->id);
            $this->out->elementEnd('a');
            $this->out->elementEnd('dd');
            $this->out->elementEnd('dl');
        }
510 511
    }

512 513 514 515 516 517 518 519
    /**
     * if the user is the author, let them delete the notice
     *
     * @return void
     */

    function showDeleteLink()
    {
520
        $user = common_current_user();
521 522 523
        if ($user && $this->notice->profile_id == $user->id) {
            $deleteurl = common_local_url('deletenotice',
                                          array('notice' => $this->notice->id));
sarven's avatar
sarven committed
524 525 526 527
            $this->out->elementStart('dl', 'notice_delete');
            $this->out->element('dt', null, _('Delete this notice'));
            $this->out->elementStart('dd');
            $this->out->element('a', array('href' => $deleteurl,
528
                                           'title' => _('Delete this notice')), _('Delete'));
sarven's avatar
sarven committed
529 530
            $this->out->elementEnd('dd');
            $this->out->elementEnd('dl');
531
        }
532 533
    }

534 535 536 537 538 539 540 541 542 543
    /**
     * finish the notice
     *
     * Close the last elements in the notice list item
     *
     * @return void
     */

    function showEnd()
    {
544
        $this->out->elementEnd('li');
545 546
    }
}