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