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