lib/noticelist.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * widget for displaying a list of notices
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  UI
  23  * @package   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
  26  * @copyright 2008 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/favorform.php';
  36 require_once INSTALLDIR.'/lib/disfavorform.php';
  37 require_once INSTALLDIR.'/lib/attachmentlist.php';
  38
  39 /**
  40  * widget for displaying a list of notices
  41  *
  42  * There are a number of actions that display a list of notices, in
  43  * reverse chronological order. This widget abstracts out most of the
  44  * code for UI for notice lists. It's overridden to hide some
  45  * data for e.g. the profile page.
  46  *
  47  * @category UI
  48  * @package  Laconica
  49  * @author   Evan Prodromou <evan@controlyourself.ca>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  51  * @link     http://laconi.ca/
  52  * @see      Notice
  53  * @see      StreamAction
  54  * @see      NoticeListItem
  55  * @see      ProfileNoticeList
  56  */
  57
  58 class NoticeList extends Widget
  59 {
  60     /** the current stream of notices being displayed. */
  61
  62     var $notice = null;
  63
  64     /**
  65      * constructor
  66      *
  67      * @param Notice $notice stream of notices from DB_DataObject
  68      */
  69
  70     function __construct($notice, $out=null)
  71     {
  72         parent::__construct($out);
  73         $this->notice = $notice;
  74     }
  75
  76     /**
  77      * show the list of notices
  78      *
  79      * "Uses up" the stream by looping through it. So, probably can't
  80      * be called twice on the same list.
  81      *
  82      * @return int count of notices listed.
  83      */
  84
  85     function show()
  86     {
  87         $this->out->elementStart('div', array('id' =>'notices_primary'));
  88         $this->out->element('h2', null, _('Notices'));
  89         $this->out->elementStart('ul', array('class' => 'notices'));
  90
  91         $cnt = 0;
  92
  93         while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
  94             $cnt++;
  95
  96             if ($cnt > NOTICES_PER_PAGE) {
  97                 break;
  98             }
  99
 100             $item = $this->newListItem($this->notice);
 101             $item->show();
 102         }
 103
 104         $this->out->elementEnd('ul');
 105         $this->out->elementEnd('div');
 106
 107         return $cnt;
 108     }
 109
 110     /**
 111      * returns a new list item for the current notice
 112      *
 113      * Recipe (factory?) method; overridden by sub-classes to give
 114      * a different list item class.
 115      *
 116      * @param Notice $notice the current notice
 117      *
 118      * @return NoticeListItem a list item for displaying the notice
 119      */
 120
 121     function newListItem($notice)
 122     {
 123         return new NoticeListItem($notice, $this->out);
 124     }
 125 }
 126
 127 /**
 128  * widget for displaying a single notice
 129  *
 130  * This widget has the core smarts for showing a single notice: what to display,
 131  * where, and under which circumstances. Its key method is show(); this is a recipe
 132  * that calls all the other show*() methods to build up a single notice. The
 133  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 134  * author info (since that's implicit by the data in the page).
 135  *
 136  * @category UI
 137  * @package  Laconica
 138  * @author   Evan Prodromou <evan@controlyourself.ca>
 139  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 140  * @link     http://laconi.ca/
 141  * @see      NoticeList
 142  * @see      ProfileNoticeListItem
 143  */
 144
 145 class NoticeListItem extends Widget
 146 {
 147     /** The notice this item will show. */
 148
 149     var $notice = null;
 150
 151     /** The profile of the author of the notice, extracted once for convenience. */
 152
 153     var $profile = null;
 154
 155     /**
 156      * constructor
 157      *
 158      * Also initializes the profile attribute.
 159      *
 160      * @param Notice $notice The notice we'll display
 161      */
 162
 163     function __construct($notice, $out=null)
 164     {
 165         parent::__construct($out);
 166         $this->notice  = $notice;
 167         $this->profile = $notice->getProfile();
 168     }
 169
 170     /**
 171      * recipe function for displaying a single notice.
 172      *
 173      * This uses all the other methods to correctly display a notice. Override
 174      * it or one of the others to fine-tune the output.
 175      *
 176      * @return void
 177      */
 178
 179     function show()
 180     {
 181         $this->showStart();
 182         $this->showNotice();
 183         $this->showNoticeAttachments();
 184         $this->showNoticeInfo();
 185         $this->showNoticeOptions();
 186         $this->showEnd();
 187     }
 188
 189     function showNotice()
 190     {
 191         $this->out->elementStart('div', 'entry-title');
 192         $this->showAuthor();
 193         $this->showContent();
 194         $this->out->elementEnd('div');
 195     }
 196
 197     function showNoticeAttachments() {
 198         if ($this->isUsedInList()) {
 199             return;
 200         }
 201         $al = new AttachmentList($this->notice, $this->out);
 202         $al->show();
 203     }
 204
 205     function isUsedInList() {
 206         return 'shownotice' !== $this->out->args['action'];
 207     }
 208
 209     function attachmentCount($discriminant = true) {
 210         $file_oembed = new File_oembed;
 211         $query = "select count(*) as c from file_oembed join file_to_post on file_oembed.file_id = file_to_post.file_id where post_id=" . $this->notice->id;
 212         $file_oembed->query($query);
 213         $file_oembed->fetch();
 214         return intval($file_oembed->c);
 215     }
 216
 217     function showNoticeInfo()
 218     {
 219         $this->out->elementStart('div', 'entry-content');
 220         $this->showNoticeLink();
 221         $this->showNoticeSource();
 222         $this->showContext();
 223         $this->out->elementEnd('div');
 224     }
 225
 226     function showNoticeOptions()
 227     {
 228         $user = common_current_user();
 229         if ($user) {
 230             $this->out->elementStart('div', 'notice-options');
 231             $this->showFaveForm();
 232             $this->showReplyLink();
 233             $this->showDeleteLink();
 234             $this->out->elementEnd('div');
 235         }
 236     }
 237
 238     /**
 239      * start a single notice.
 240      *
 241      * @return void
 242      */
 243
 244     function showStart()
 245     {
 246         // XXX: RDFa
 247         // TODO: add notice_type class e.g., notice_video, notice_image
 248         $this->out->elementStart('li', array('class' => 'hentry notice',
 249                                              'id' => 'notice-' . $this->notice->id));
 250     }
 251
 252     /**
 253      * show the "favorite" form
 254      *
 255      * @return void
 256      */
 257
 258     function showFaveForm()
 259     {
 260         $user = common_current_user();
 261         if ($user) {
 262             if ($user->hasFave($this->notice)) {
 263                 $disfavor = new DisfavorForm($this->out, $this->notice);
 264                 $disfavor->show();
 265             } else {
 266                 $favor = new FavorForm($this->out, $this->notice);
 267                 $favor->show();
 268             }
 269         }
 270     }
 271
 272     /**
 273      * show the author of a notice
 274      *
 275      * By default, this shows the avatar and (linked) nickname of the author.
 276      *
 277      * @return void
 278      */
 279
 280     function showAuthor()
 281     {
 282         $this->out->elementStart('span', 'vcard author');
 283         $attrs = array('href' => $this->profile->profileurl,
 284                        'class' => 'url');
 285         if (!empty($this->profile->fullname)) {
 286             $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ') ';
 287         }
 288         $this->out->elementStart('a', $attrs);
 289         $this->showAvatar();
 290         $this->showNickname();
 291         $this->out->elementEnd('a');
 292         $this->out->elementEnd('span');
 293     }
 294
 295     /**
 296      * show the avatar of the notice's author
 297      *
 298      * This will use the default avatar if no avatar is assigned for the author.
 299      * It makes a link to the author's profile.
 300      *
 301      * @return void
 302      */
 303
 304     function showAvatar()
 305     {
 306         if ('shownotice' === $this->out->trimmed('action')) {
 307             $avatar_size = AVATAR_PROFILE_SIZE;
 308         } else {
 309             $avatar_size = AVATAR_STREAM_SIZE;
 310         }
 311         $avatar = $this->profile->getAvatar($avatar_size);
 312
 313         $this->out->element('img', array('src' => ($avatar) ?
 314                                          $avatar->displayUrl() :
 315                                          Avatar::defaultImage($avatar_size),
 316                                          'class' => 'avatar photo',
 317                                          'width' => $avatar_size,
 318                                          'height' => $avatar_size,
 319                                          'alt' =>
 320                                          ($this->profile->fullname) ?
 321                                          $this->profile->fullname :
 322                                          $this->profile->nickname));
 323     }
 324
 325     /**
 326      * show the nickname of the author
 327      *
 328      * Links to the author's profile page
 329      *
 330      * @return void
 331      */
 332
 333     function showNickname()
 334     {
 335         $this->out->element('span', array('class' => 'nickname fn'),
 336                             $this->profile->nickname);
 337     }
 338
 339     /**
 340      * show the content of the notice
 341      *
 342      * Shows the content of the notice. This is pre-rendered for efficiency
 343      * at save time. Some very old notices might not be pre-rendered, so
 344      * they're rendered on the spot.
 345      *
 346      * @return void
 347      */
 348
 349     function showContent()
 350     {
 351         // FIXME: URL, image, video, audio
 352         $this->out->elementStart('p', array('class' => 'entry-content'));
 353         if ($this->notice->rendered) {
 354             $this->out->raw($this->notice->rendered);
 355         } else {
 356             // XXX: may be some uncooked notices in the DB,
 357             // we cook them right now. This should probably disappear in future
 358             // versions (>> 0.4.x)
 359             $this->out->raw(common_render_content($this->notice->content, $this->notice));
 360         }
 361         $this->out->elementEnd('p');
 362     }
 363
 364     /**
 365      * show the link to the main page for the notice
 366      *
 367      * Displays a link to the page for a notice, with "relative" time. Tries to
 368      * get remote notice URLs correct, but doesn't always succeed.
 369      *
 370      * @return void
 371      */
 372
 373     function showNoticeLink()
 374     {
 375         $noticeurl = common_local_url('shownotice',
 376                                       array('notice' => $this->notice->id));
 377         // XXX: we need to figure this out better. Is this right?
 378         if (strcmp($this->notice->uri, $noticeurl) != 0 &&
 379             preg_match('/^http/', $this->notice->uri)) {
 380             $noticeurl = $this->notice->uri;
 381         }
 382         $this->out->elementStart('dl', 'timestamp');
 383         $this->out->element('dt', null, _('Published'));
 384         $this->out->elementStart('dd', null);
 385         $this->out->elementStart('a', array('rel' => 'bookmark',
 386                                             'href' => $noticeurl));
 387         $dt = common_date_iso8601($this->notice->created);
 388         $this->out->element('abbr', array('class' => 'published',
 389                                           'title' => $dt),
 390                             common_date_string($this->notice->created));
 391         $this->out->elementEnd('a');
 392         $this->out->elementEnd('dd');
 393         $this->out->elementEnd('dl');
 394     }
 395
 396     /**
 397      * Show the source of the notice
 398      *
 399      * Either the name (and link) of the API client that posted the notice,
 400      * or one of other other channels.
 401      *
 402      * @return void
 403      */
 404
 405     function showNoticeSource()
 406     {
 407         if ($this->notice->source) {
 408             $this->out->elementStart('dl', 'device');
 409             $this->out->element('dt', null, _('From'));
 410             $source_name = _($this->notice->source);
 411             switch ($this->notice->source) {
 412              case 'web':
 413              case 'xmpp':
 414              case 'mail':
 415              case 'omb':
 416              case 'system':
 417              case 'api':
 418                 $this->out->element('dd', null, $source_name);
 419                 break;
 420              default:
 421                 $ns = Notice_source::staticGet($this->notice->source);
 422                 if ($ns) {
 423                     $this->out->elementStart('dd', null);
 424                     $this->out->element('a', array('href' => $ns->url,
 425                                                    'rel' => 'external'),
 426                                         $ns->name);
 427                     $this->out->elementEnd('dd');
 428                 } else {
 429                     $this->out->element('dd', null, $source_name);
 430                 }
 431                 break;
 432             }
 433             $this->out->elementEnd('dl');
 434         }
 435     }
 436
 437     /**
 438      * show link to notice this notice is a reply to
 439      *
 440      * If this notice is a reply, show a link to the notice it is replying to. The
 441      * heavy lifting for figuring out replies happens at save time.
 442      *
 443      * @return void
 444      */
 445
 446     function showContext()
 447     {
 448         // XXX: also show context if there are replies to this notice
 449         if (!empty($this->notice->conversation)
 450             && $this->notice->conversation != $this->notice->id) {
 451             $convurl = common_local_url('conversation',
 452                                          array('id' => $this->notice->conversation));
 453             $this->out->elementStart('dl', 'response');
 454             $this->out->element('dt', null, _('To'));
 455             $this->out->elementStart('dd');
 456             $this->out->element('a', array('href' => $convurl),
 457                                 _('in context'));
 458             $this->out->elementEnd('dd');
 459             $this->out->elementEnd('dl');
 460         }
 461     }
 462
 463     /**
 464      * show a link to reply to the current notice
 465      *
 466      * Should either do the reply in the current notice form (if available), or
 467      * link out to the notice-posting form. A little flakey, doesn't always work.
 468      *
 469      * @return void
 470      */
 471
 472     function showReplyLink()
 473     {
 474         if (common_logged_in()) {
 475             $reply_url = common_local_url('newnotice',
 476                                           array('replyto' => $this->profile->nickname));
 477
 478             $this->out->elementStart('dl', 'notice_reply');
 479             $this->out->element('dt', null, _('Reply to this notice'));
 480             $this->out->elementStart('dd');
 481             $this->out->elementStart('a', array('href' => $reply_url,
 482                                                 'title' => _('Reply to this notice')));
 483             $this->out->text(_('Reply'));
 484             $this->out->element('span', 'notice_id', $this->notice->id);
 485             $this->out->elementEnd('a');
 486             $this->out->elementEnd('dd');
 487             $this->out->elementEnd('dl');
 488         }
 489     }
 490
 491     /**
 492      * if the user is the author, let them delete the notice
 493      *
 494      * @return void
 495      */
 496
 497     function showDeleteLink()
 498     {
 499         $user = common_current_user();
 500         if ($user && $this->notice->profile_id == $user->id) {
 501             $deleteurl = common_local_url('deletenotice',
 502                                           array('notice' => $this->notice->id));
 503             $this->out->elementStart('dl', 'notice_delete');
 504             $this->out->element('dt', null, _('Delete this notice'));
 505             $this->out->elementStart('dd');
 506             $this->out->element('a', array('href' => $deleteurl,
 507                                            'title' => _('Delete this notice')), _('Delete'));
 508             $this->out->elementEnd('dd');
 509             $this->out->elementEnd('dl');
 510         }
 511     }
 512
 513     /**
 514      * finish the notice
 515      *
 516      * Close the last elements in the notice list item
 517      *
 518      * @return void
 519      */
 520
 521     function showEnd()
 522     {
 523         $this->out->elementEnd('li');
 524     }
 525 }