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