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