actions/shownotice.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a single notice
   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  Personal
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008-2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/personalgroupnav.php';
  35 require_once INSTALLDIR.'/lib/noticelist.php';
  36 require_once INSTALLDIR.'/lib/feedlist.php';
  37
  38 /**
  39  * Show a single notice
  40  *
  41  * @category Personal
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class ShownoticeAction extends OwnerDesignAction
  49 {
  50     /**
  51      * Notice object to show
  52      */
  53
  54     var $notice = null;
  55
  56     /**
  57      * Profile of the notice object
  58      */
  59
  60     var $profile = null;
  61
  62     /**
  63      * Avatar of the profile of the notice object
  64      */
  65
  66     var $avatar = null;
  67
  68     /**
  69      * Load attributes based on database arguments
  70      *
  71      * Loads all the DB stuff
  72      *
  73      * @param array $args $_REQUEST array
  74      *
  75      * @return success flag
  76      */
  77
  78     function prepare($args)
  79     {
  80         parent::prepare($args);
  81
  82         $id = $this->arg('notice');
  83
  84         $this->notice = Notice::staticGet($id);
  85
  86         if (empty($this->notice)) {
  87             // Did we used to have it, and it got deleted?
  88             $deleted = Deleted_notice::staticGet($id);
  89             if (!empty($deleted)) {
  90                 $this->clientError(_('Notice deleted.'), 410);
  91             } else {
  92                 $this->clientError(_('No such notice.'), 404);
  93             }
  94             return false;
  95         }
  96
  97         $this->profile = $this->notice->getProfile();
  98
  99         if (empty($this->profile)) {
 100             $this->serverError(_('Notice has no profile.'), 500);
 101             return false;
 102         }
 103
 104         $this->user = User::staticGet('id', $this->profile->id);
 105
 106         $this->avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
 107
 108         return true;
 109     }
 110
 111     /**
 112      * Is this action read-only?
 113      *
 114      * @return boolean true
 115      */
 116
 117     function isReadOnly($args)
 118     {
 119         return true;
 120     }
 121
 122     /**
 123      * Last-modified date for page
 124      *
 125      * When was the content of this page last modified? Based on notice,
 126      * profile, avatar.
 127      *
 128      * @return int last-modified date as unix timestamp
 129      */
 130
 131     function lastModified()
 132     {
 133         return max(strtotime($this->notice->modified),
 134                    strtotime($this->profile->modified),
 135                    ($this->avatar) ? strtotime($this->avatar->modified) : 0);
 136     }
 137
 138     /**
 139      * An entity tag for this page
 140      *
 141      * Shows the ETag for the page, based on the notice ID and timestamps
 142      * for the notice, profile, and avatar. It's weak, since we change
 143      * the date text "one hour ago", etc.
 144      *
 145      * @return string etag
 146      */
 147
 148     function etag()
 149     {
 150         $avtime = ($this->avatar) ?
 151           strtotime($this->avatar->modified) : 0;
 152
 153         return 'W/"' . implode(':', array($this->arg('action'),
 154                                           common_user_cache_hash(),
 155                                           common_language(),
 156                                           $this->notice->id,
 157                                           strtotime($this->notice->created),
 158                                           strtotime($this->profile->modified),
 159                                           $avtime)) . '"';
 160     }
 161
 162     /**
 163      * Title of the page
 164      *
 165      * @return string title of the page
 166      */
 167
 168     function title()
 169     {
 170         $base = $this->profile->getFancyName();
 171
 172         return sprintf(_('%1$s\'s status on %2$s'),
 173                        $base,
 174                        common_exact_date($this->notice->created));
 175     }
 176
 177     /**
 178      * Handle input
 179      *
 180      * Only handles get, so just show the page.
 181      *
 182      * @param array $args $_REQUEST data (unused)
 183      *
 184      * @return void
 185      */
 186
 187     function handle($args)
 188     {
 189         parent::handle($args);
 190
 191         if ($this->boolean('ajax')) {
 192             StatusNet::setApi(true);
 193             $this->showAjax();
 194         } else {
 195             if ($this->notice->is_local == Notice::REMOTE_OMB) {
 196                 if (!empty($this->notice->url)) {
 197                     $target = $this->notice->url;
 198                 } else if (!empty($this->notice->uri) && preg_match('/^https?:/', $this->notice->uri)) {
 199                     // Old OMB posts saved the remote URL only into the URI field.
 200                     $target = $this->notice->uri;
 201                 } else {
 202                     // Shouldn't happen.
 203                     $target = false;
 204                 }
 205                 if ($target && $target != $this->selfUrl()) {
 206                     common_redirect($target, 301);
 207                     return false;
 208                 }
 209             }
 210             $this->showPage();
 211         }
 212     }
 213
 214     /**
 215      * Don't show local navigation
 216      *
 217      * @return void
 218      */
 219
 220     function showLocalNavBlock()
 221     {
 222     }
 223
 224     /**
 225      * Fill the content area of the page
 226      *
 227      * Shows a single notice list item.
 228      *
 229      * @return void
 230      */
 231
 232     function showContent()
 233     {
 234         $this->elementStart('ol', array('class' => 'notices xoxo'));
 235         $nli = new SingleNoticeItem($this->notice, $this);
 236         $nli->show();
 237         $this->elementEnd('ol');
 238     }
 239
 240     function showAjax()
 241     {
 242         header('Content-Type: text/xml;charset=utf-8');
 243         $this->xw->startDocument('1.0', 'UTF-8');
 244         $this->elementStart('html');
 245         $this->elementStart('head');
 246         $this->element('title', null, _('Notice'));
 247         $this->elementEnd('head');
 248         $this->elementStart('body');
 249         $nli = new NoticeListItem($this->notice, $this);
 250         $nli->show();
 251         $this->elementEnd('body');
 252         $this->elementEnd('html');
 253     }
 254
 255     /**
 256      * Don't show page notice
 257      *
 258      * @return void
 259      */
 260
 261     function showPageNoticeBlock()
 262     {
 263     }
 264
 265     /**
 266      * Don't show aside
 267      *
 268      * @return void
 269      */
 270
 271     function showAside() {
 272     }
 273
 274     /**
 275      * Extra <head> content
 276      *
 277      * We show the microid(s) for the author, if any.
 278      *
 279      * @return void
 280      */
 281
 282     function extraHead()
 283     {
 284         $user = User::staticGet($this->profile->id);
 285
 286         if (!$user) {
 287             return;
 288         }
 289
 290         if ($user->emailmicroid && $user->email && $this->notice->uri) {
 291             $id = new Microid('mailto:'. $user->email,
 292                               $this->notice->uri);
 293             $this->element('meta', array('name' => 'microid',
 294                                          'content' => $id->toString()));
 295         }
 296
 297         $this->element('link',array('rel'=>'alternate',
 298             'type'=>'application/json+oembed',
 299             'href'=>common_local_url(
 300                 'oembed',
 301                 array(),
 302                 array('format'=>'json','url'=>$this->notice->uri)),
 303             'title'=>'oEmbed'),null);
 304         $this->element('link',array('rel'=>'alternate',
 305             'type'=>'text/xml+oembed',
 306             'href'=>common_local_url(
 307                 'oembed',
 308                 array(),
 309                 array('format'=>'xml','url'=>$this->notice->uri)),
 310             'title'=>'oEmbed'),null);
 311
 312         // Extras to aid in sharing notices to Facebook
 313         $avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
 314         $avatarUrl = ($avatar) ?
 315                      $avatar->displayUrl() :
 316                      Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 317         $this->element('meta', array('property' => 'og:image',
 318                                      'content' => $avatarUrl));
 319         $this->element('meta', array('property' => 'og:description',
 320                                      'content' => $this->notice->content));
 321     }
 322 }
 323
 324 class SingleNoticeItem extends DoFollowListItem
 325 {
 326     /**
 327      * recipe function for displaying a single notice.
 328      *
 329      * We overload to show attachments.
 330      *
 331      * @return void
 332      */
 333
 334     function show()
 335     {
 336         $this->showStart();
 337         if (Event::handle('StartShowNoticeItem', array($this))) {
 338             $this->showNotice();
 339             $this->showNoticeAttachments();
 340             $this->showNoticeInfo();
 341             $this->showNoticeOptions();
 342             Event::handle('EndShowNoticeItem', array($this));
 343         }
 344
 345         $this->showEnd();
 346     }
 347
 348     /**
 349      * For our zoomed-in special case we'll use a fuller list
 350      * for the attachment info.
 351      */
 352     function showNoticeAttachments() {
 353         $al = new AttachmentList($this->notice, $this->out);
 354         $al->show();
 355     }
 356
 357     /**
 358      * show the avatar of the notice's author
 359      *
 360      * We use the larger size for single notice page.
 361      *
 362      * @return void
 363      */
 364
 365     function showAvatar()
 366     {
 367         $avatar_size = AVATAR_PROFILE_SIZE;
 368
 369         $avatar = $this->profile->getAvatar($avatar_size);
 370
 371         $this->out->element('img', array('src' => ($avatar) ?
 372                                          $avatar->displayUrl() :
 373                                          Avatar::defaultImage($avatar_size),
 374                                          'class' => 'avatar photo',
 375                                          'width' => $avatar_size,
 376                                          'height' => $avatar_size,
 377                                          'alt' =>
 378                                          ($this->profile->fullname) ?
 379                                          $this->profile->fullname :
 380                                          $this->profile->nickname));
 381     }
 382 }