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->showNoticeAttachmentsIcon();
 184         $this->showNoticeInfo();
 185         $this->showNoticeOptions();
 186         $this->showNoticeAttachments();
 187         $this->showEnd();
 188     }
 189
 190     function showNotice()
 191     {
 192         $this->out->elementStart('div', 'entry-title');
 193         $this->showAuthor();
 194         $this->showContent();
 195         $this->out->elementEnd('div');
 196     }
 197
 198     function showNoticeAttachments() {
 199         if ($this->isUsedInList()) {
 200             return;
 201         }
 202         $al = new AttachmentList($this->notice, $this->out);
 203         $al->show();
 204     }
 205
 206     function isUsedInList() {
 207         return 'shownotice' !== $this->out->args['action'];
 208     }
 209
 210     function attachmentCount($discriminant = true) {
 211         $file_oembed = new File_oembed;
 212         $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;
 213         $file_oembed->query($query);
 214         $file_oembed->fetch();
 215         return intval($file_oembed->c);
 216     }
 217
 218     function showNoticeAttachmentsIcon()
 219     {
 220         if (!($this->isUsedInList() && ($count = $this->attachmentCount()))) {
 221             return;
 222         }
 223
 224         $href = common_local_url('shownotice', array('notice' => $this->notice->id)) . '#attachments';
 225         $this->out->elementStart('p', 'entry-attachments');
 226         $this->out->element('a', array('href' => $href, 'title' => "# of attachments: $count"), $count === 1 ? '' : $count);
 227         $this->out->elementEnd('p');
 228     }
 229
 230     function showNoticeInfo()
 231     {
 232         $this->out->elementStart('div', 'entry-content');
 233         $this->showNoticeLink();
 234         $this->showNoticeSource();
 235         $this->showContext();
 236         $this->out->elementEnd('div');
 237     }
 238
 239     function showNoticeOptions()
 240     {
 241         $user = common_current_user();
 242         if ($user) {
 243             $this->out->elementStart('div', 'notice-options');
 244             $this->showFaveForm();
 245             $this->showReplyLink();
 246             $this->showDeleteLink();
 247             $this->out->elementEnd('div');
 248         }
 249     }
 250
 251     /**
 252      * start a single notice.
 253      *
 254      * @return void
 255      */
 256
 257     function showStart()
 258     {
 259         // XXX: RDFa
 260         // TODO: add notice_type class e.g., notice_video, notice_image
 261         $this->out->elementStart('li', array('class' => 'hentry notice',
 262                                              'id' => 'notice-' . $this->notice->id));
 263     }
 264
 265     /**
 266      * show the "favorite" form
 267      *
 268      * @return void
 269      */
 270
 271     function showFaveForm()
 272     {
 273         $user = common_current_user();
 274         if ($user) {
 275             if ($user->hasFave($this->notice)) {
 276                 $disfavor = new DisfavorForm($this->out, $this->notice);
 277                 $disfavor->show();
 278             } else {
 279                 $favor = new FavorForm($this->out, $this->notice);
 280                 $favor->show();
 281             }
 282         }
 283     }
 284
 285     /**
 286      * show the author of a notice
 287      *
 288      * By default, this shows the avatar and (linked) nickname of the author.
 289      *
 290      * @return void
 291      */
 292
 293     function showAuthor()
 294     {
 295         $this->out->elementStart('span', 'vcard author');
 296         $attrs = array('href' => $this->profile->profileurl,
 297                        'class' => 'url');
 298         if (!empty($this->profile->fullname)) {
 299             $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ') ';
 300         }
 301         $this->out->elementStart('a', $attrs);
 302         $this->showAvatar();
 303         $this->showNickname();
 304         $this->out->elementEnd('a');
 305         $this->out->elementEnd('span');
 306     }
 307
 308     /**
 309      * show the avatar of the notice's author
 310      *
 311      * This will use the default avatar if no avatar is assigned for the author.
 312      * It makes a link to the author's profile.
 313      *
 314      * @return void
 315      */
 316
 317     function showAvatar()
 318     {
 319         if ('shownotice' === $this->out->trimmed('action')) {
 320             $avatar_size = AVATAR_PROFILE_SIZE;
 321         } else {
 322             $avatar_size = AVATAR_STREAM_SIZE;
 323         }
 324         $avatar = $this->profile->getAvatar($avatar_size);
 325
 326         $this->out->element('img', array('src' => ($avatar) ?
 327                                          $avatar->displayUrl() :
 328                                          Avatar::defaultImage($avatar_size),
 329                                          'class' => 'avatar photo',
 330                                          'width' => $avatar_size,
 331                                          'height' => $avatar_size,
 332                                          'alt' =>
 333                                          ($this->profile->fullname) ?
 334                                          $this->profile->fullname :
 335                                          $this->profile->nickname));
 336     }
 337
 338     /**
 339      * show the nickname of the author
 340      *
 341      * Links to the author's profile page
 342      *
 343      * @return void
 344      */
 345
 346     function showNickname()
 347     {
 348         $this->out->element('span', array('class' => 'nickname fn'),
 349                             $this->profile->nickname);
 350     }
 351
 352     /**
 353      * show the content of the notice
 354      *
 355      * Shows the content of the notice. This is pre-rendered for efficiency
 356      * at save time. Some very old notices might not be pre-rendered, so
 357      * they're rendered on the spot.
 358      *
 359      * @return void
 360      */
 361
 362     function showContent()
 363     {
 364         // FIXME: URL, image, video, audio
 365         $this->out->elementStart('p', array('class' => 'entry-content'));
 366         if ($this->notice->rendered) {
 367             $this->out->raw($this->notice->rendered);
 368         } else {
 369             // XXX: may be some uncooked notices in the DB,
 370             // we cook them right now. This should probably disappear in future
 371             // versions (>> 0.4.x)
 372             $this->out->raw(common_render_content($this->notice->content, $this->notice));
 373         }
 374         $this->out->elementEnd('p');
 375     }
 376
 377     /**
 378      * show the link to the main page for the notice
 379      *
 380      * Displays a link to the page for a notice, with "relative" time. Tries to
 381      * get remote notice URLs correct, but doesn't always succeed.
 382      *
 383      * @return void
 384      */
 385
 386     function showNoticeLink()
 387     {
 388         $noticeurl = common_local_url('shownotice',
 389                                       array('notice' => $this->notice->id));
 390         // XXX: we need to figure this out better. Is this right?
 391         if (strcmp($this->notice->uri, $noticeurl) != 0 &&
 392             preg_match('/^http/', $this->notice->uri)) {
 393             $noticeurl = $this->notice->uri;
 394         }
 395         $this->out->elementStart('dl', 'timestamp');
 396         $this->out->element('dt', null, _('Published'));
 397         $this->out->elementStart('dd', null);
 398         $this->out->elementStart('a', array('rel' => 'bookmark',
 399                                             'href' => $noticeurl));
 400         $dt = common_date_iso8601($this->notice->created);
 401         $this->out->element('abbr', array('class' => 'published',
 402                                           'title' => $dt),
 403                             common_date_string($this->notice->created));
 404         $this->out->elementEnd('a');
 405         $this->out->elementEnd('dd');
 406         $this->out->elementEnd('dl');
 407     }
 408
 409     /**
 410      * Show the source of the notice
 411      *
 412      * Either the name (and link) of the API client that posted the notice,
 413      * or one of other other channels.
 414      *
 415      * @return void
 416      */
 417
 418     function showNoticeSource()
 419     {
 420         if ($this->notice->source) {
 421             $this->out->elementStart('dl', 'device');
 422             $this->out->element('dt', null, _('From'));
 423             $source_name = _($this->notice->source);
 424             switch ($this->notice->source) {
 425              case 'web':
 426              case 'xmpp':
 427              case 'mail':
 428              case 'omb':
 429              case 'system':
 430              case 'api':
 431                 $this->out->element('dd', null, $source_name);
 432                 break;
 433              default:
 434                 $ns = Notice_source::staticGet($this->notice->source);
 435                 if ($ns) {
 436                     $this->out->elementStart('dd', null);
 437                     $this->out->element('a', array('href' => $ns->url,
 438                                                    'rel' => 'external'),
 439                                         $ns->name);
 440                     $this->out->elementEnd('dd');
 441                 } else {
 442                     $this->out->element('dd', null, $source_name);
 443                 }
 444                 break;
 445             }
 446             $this->out->elementEnd('dl');
 447         }
 448     }
 449
 450     /**
 451      * show link to notice this notice is a reply to
 452      *
 453      * If this notice is a reply, show a link to the notice it is replying to. The
 454      * heavy lifting for figuring out replies happens at save time.
 455      *
 456      * @return void
 457      */
 458
 459     function showContext()
 460     {
 461         // XXX: also show context if there are replies to this notice
 462         if (!empty($this->notice->conversation)
 463             && $this->notice->conversation != $this->notice->id) {
 464             $convurl = common_local_url('conversation',
 465                                          array('id' => $this->notice->conversation));
 466             $this->out->elementStart('dl', 'response');
 467             $this->out->element('dt', null, _('To'));
 468             $this->out->elementStart('dd');
 469             $this->out->element('a', array('href' => $convurl),
 470                                 _('in context'));
 471             $this->out->elementEnd('dd');
 472             $this->out->elementEnd('dl');
 473         }
 474     }
 475
 476     /**
 477      * show a link to reply to the current notice
 478      *
 479      * Should either do the reply in the current notice form (if available), or
 480      * link out to the notice-posting form. A little flakey, doesn't always work.
 481      *
 482      * @return void
 483      */
 484
 485     function showReplyLink()
 486     {
 487         if (common_logged_in()) {
 488             $reply_url = common_local_url('newnotice',
 489                                           array('replyto' => $this->profile->nickname));
 490
 491             $this->out->elementStart('dl', 'notice_reply');
 492             $this->out->element('dt', null, _('Reply to this notice'));
 493             $this->out->elementStart('dd');
 494             $this->out->elementStart('a', array('href' => $reply_url,
 495                                                 'title' => _('Reply to this notice')));
 496             $this->out->text(_('Reply'));
 497             $this->out->element('span', 'notice_id', $this->notice->id);
 498             $this->out->elementEnd('a');
 499             $this->out->elementEnd('dd');
 500             $this->out->elementEnd('dl');
 501         }
 502     }
 503
 504     /**
 505      * if the user is the author, let them delete the notice
 506      *
 507      * @return void
 508      */
 509
 510     function showDeleteLink()
 511     {
 512         $user = common_current_user();
 513         if ($user && $this->notice->profile_id == $user->id) {
 514             $deleteurl = common_local_url('deletenotice',
 515                                           array('notice' => $this->notice->id));
 516             $this->out->elementStart('dl', 'notice_delete');
 517             $this->out->element('dt', null, _('Delete this notice'));
 518             $this->out->elementStart('dd');
 519             $this->out->element('a', array('href' => $deleteurl,
 520                                            'title' => _('Delete this notice')), _('Delete'));
 521             $this->out->elementEnd('dd');
 522             $this->out->elementEnd('dl');
 523         }
 524     }
 525
 526     /**
 527      * finish the notice
 528      *
 529      * Close the last elements in the notice list item
 530      *
 531      * @return void
 532      */
 533
 534     function showEnd()
 535     {
 536         $this->out->elementEnd('li');
 537     }
 538 }