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