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-2011 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 class ShownoticeAction extends Action
  48 {
  49     /**
  50      * Notice object to show
  51      */
  52     var $notice = null;
  53
  54     /**
  55      * Profile of the notice object
  56      */
  57     var $profile = null;
  58
  59     /**
  60      * Avatar of the profile of the notice object
  61      */
  62     var $avatar = null;
  63
  64     /**
  65      * Load attributes based on database arguments
  66      *
  67      * Loads all the DB stuff
  68      *
  69      * @param array $args $_REQUEST array
  70      *
  71      * @return success flag
  72      */
  73     protected function prepare(array $args=array())
  74     {
  75         parent::prepare($args);
  76         if ($this->boolean('ajax')) {
  77             StatusNet::setApi(true);
  78         }
  79
  80         $this->notice = $this->getNotice();
  81
  82         $cur = common_current_user();
  83
  84         if (!empty($cur)) {
  85             $curProfile = $cur->getProfile();
  86         } else {
  87             $curProfile = null;
  88         }
  89
  90         if (!$this->notice->inScope($curProfile)) {
  91             // TRANS: Client exception thrown when trying a view a notice the user has no access to.
  92             throw new ClientException(_('Not available.'), 403);
  93         }
  94
  95         $this->profile = $this->notice->getProfile();
  96
  97         if (empty($this->profile)) {
  98             // TRANS: Server error displayed trying to show a notice without a connected profile.
  99             $this->serverError(_('Notice has no profile.'), 500);
 100             return false;
 101         }
 102
 103         $this->user = User::getKV('id', $this->profile->id);
 104
 105         try {
 106             $this->avatar = $this->profile->getAvatar(AVATAR_PROFILE_SIZE);
 107         } catch (Exception $e) {
 108             $this->avatar = null;
 109         }
 110
 111         return true;
 112     }
 113
 114     /**
 115      * Fetch the notice to show. This may be overridden by child classes to
 116      * customize what we fetch without duplicating all of the prepare() method.
 117      *
 118      * @return Notice
 119      */
 120     protected function getNotice()
 121     {
 122         $id = $this->arg('notice');
 123
 124         $notice = Notice::getKV('id', $id);
 125
 126         if (!$notice instanceof Notice) {
 127             // Did we used to have it, and it got deleted?
 128             $deleted = Deleted_notice::getKV($id);
 129             if ($deleted instanceof Deleted_notice) {
 130                 // TRANS: Client error displayed trying to show a deleted notice.
 131                 $this->clientError(_('Notice deleted.'), 410);
 132             } else {
 133                 // TRANS: Client error displayed trying to show a non-existing notice.
 134                 $this->clientError(_('No such notice.'), 404);
 135             }
 136             return false;
 137         }
 138         return $notice;
 139     }
 140
 141     /**
 142      * Is this action read-only?
 143      *
 144      * @return boolean true
 145      */
 146     function isReadOnly($args)
 147     {
 148         return true;
 149     }
 150
 151     /**
 152      * Last-modified date for page
 153      *
 154      * When was the content of this page last modified? Based on notice,
 155      * profile, avatar.
 156      *
 157      * @return int last-modified date as unix timestamp
 158      */
 159     function lastModified()
 160     {
 161         return max(strtotime($this->notice->modified),
 162                    strtotime($this->profile->modified),
 163                    ($this->avatar) ? strtotime($this->avatar->modified) : 0);
 164     }
 165
 166     /**
 167      * An entity tag for this page
 168      *
 169      * Shows the ETag for the page, based on the notice ID and timestamps
 170      * for the notice, profile, and avatar. It's weak, since we change
 171      * the date text "one hour ago", etc.
 172      *
 173      * @return string etag
 174      */
 175     function etag()
 176     {
 177         $avtime = ($this->avatar) ?
 178           strtotime($this->avatar->modified) : 0;
 179
 180         return 'W/"' . implode(':', array($this->arg('action'),
 181                                           common_user_cache_hash(),
 182                                           common_language(),
 183                                           $this->notice->id,
 184                                           strtotime($this->notice->created),
 185                                           strtotime($this->profile->modified),
 186                                           $avtime)) . '"';
 187     }
 188
 189     /**
 190      * Title of the page
 191      *
 192      * @return string title of the page
 193      */
 194     function title()
 195     {
 196         $base = $this->profile->getFancyName();
 197
 198         // TRANS: Title of the page that shows a notice.
 199         // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
 200         return sprintf(_('%1$s\'s status on %2$s'),
 201                        $base,
 202                        common_exact_date($this->notice->created));
 203     }
 204
 205     /**
 206      * Handle input
 207      *
 208      * Only handles get, so just show the page.
 209      *
 210      * @param array $args $_REQUEST data (unused)
 211      *
 212      * @return void
 213      */
 214     protected function handle()
 215     {
 216         parent::handle();
 217
 218         if ($this->boolean('ajax')) {
 219             $this->showAjax();
 220         } else {
 221             if ($this->notice->is_local == Notice::REMOTE) {
 222                 if (!empty($this->notice->url)) {
 223                     $target = $this->notice->url;
 224                 } else if (!empty($this->notice->uri) && preg_match('/^https?:/', $this->notice->uri)) {
 225                     // Old OMB posts saved the remote URL only into the URI field.
 226                     $target = $this->notice->uri;
 227                 } else {
 228                     // Shouldn't happen.
 229                     $target = false;
 230                 }
 231                 if ($target && $target != $this->selfUrl()) {
 232                     common_redirect($target, 301);
 233                     return false;
 234                 }
 235             }
 236             $this->showPage();
 237         }
 238     }
 239
 240     /**
 241      * Fill the content area of the page
 242      *
 243      * Shows a single notice list item.
 244      *
 245      * @return void
 246      */
 247     function showContent()
 248     {
 249         $this->elementStart('ol', array('class' => 'notices xoxo'));
 250         $nli = new SingleNoticeItem($this->notice, $this);
 251         $nli->show();
 252         $this->elementEnd('ol');
 253     }
 254
 255     function showAjax()
 256     {
 257         $this->startHTML('text/xml;charset=utf-8');
 258         $this->elementStart('head');
 259         // TRANS: Title for page that shows a notice.
 260         $this->element('title', null, _m('TITLE','Notice'));
 261         $this->elementEnd('head');
 262         $this->elementStart('body');
 263         $nli = new NoticeListItem($this->notice, $this);
 264         $nli->show();
 265         $this->elementEnd('body');
 266         $this->endHTML();
 267     }
 268
 269     /**
 270      * Don't show page notice
 271      *
 272      * @return void
 273      */
 274     function showPageNoticeBlock()
 275     {
 276     }
 277
 278     /**
 279      * Don't show aside
 280      *
 281      * @return void
 282      */
 283     function showAside() {
 284     }
 285
 286     /**
 287      * Extra <head> content
 288      *
 289      * We show the microid(s) for the author, if any.
 290      *
 291      * @return void
 292      */
 293     function extraHead()
 294     {
 295         $user = User::getKV($this->profile->id);
 296
 297         if (!$user) {
 298             return;
 299         }
 300
 301         if ($user->emailmicroid && $user->email && $this->notice->uri) {
 302             $id = new Microid('mailto:'. $user->email,
 303                               $this->notice->uri);
 304             $this->element('meta', array('name' => 'microid',
 305                                          'content' => $id->toString()));
 306         }
 307
 308         $this->element('link',array('rel'=>'alternate',
 309             'type'=>'application/json+oembed',
 310             'href'=>common_local_url(
 311                 'oembed',
 312                 array(),
 313                 array('format'=>'json','url'=>$this->notice->uri)),
 314             'title'=>'oEmbed'),null);
 315         $this->element('link',array('rel'=>'alternate',
 316             'type'=>'text/xml+oembed',
 317             'href'=>common_local_url(
 318                 'oembed',
 319                 array(),
 320                 array('format'=>'xml','url'=>$this->notice->uri)),
 321             'title'=>'oEmbed'),null);
 322
 323         // Extras to aid in sharing notices to Facebook
 324         $avatarUrl = $this->profile->avatarUrl(AVATAR_PROFILE_SIZE);
 325         $this->element('meta', array('property' => 'og:image',
 326                                      'content' => $avatarUrl));
 327         $this->element('meta', array('property' => 'og:description',
 328                                      'content' => $this->notice->content));
 329     }
 330 }
 331
 332 // @todo FIXME: Class documentation missing.
 333 class SingleNoticeItem extends DoFollowListItem
 334 {
 335     function avatarSize()
 336     {
 337         return AVATAR_STREAM_SIZE;
 338     }
 339 }