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