lib/noticelist.php

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