plugins/Favorite/actions/atompubshowfavorite.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Show a single favorite in Atom Activity Streams format
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  AtomPub
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Show a single favorite in Atom Activity Streams format.
  39  *
  40  * Can also be used to delete a favorite.
  41  *
  42  * @category  Action
  43  * @package   StatusNet
  44  * @author    Evan Prodromou <evan@status.net>
  45  * @copyright 2010 StatusNet, Inc.
  46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  47  * @link      http://status.net/
  48  */
  49 class AtompubshowfavoriteAction extends ApiAuthAction
  50 {
  51     private $_profile = null;
  52     private $_notice  = null;
  53     private $_fave    = null;
  54
  55     /**
  56      * For initializing members of the class.
  57      *
  58      * @param array $argarray misc. arguments
  59      *
  60      * @return boolean true
  61      */
  62     function prepare($argarray)
  63     {
  64         parent::prepare($argarray);
  65
  66         $profileId = $this->trimmed('profile');
  67         $noticeId  = $this->trimmed('notice');
  68
  69         $this->_profile = Profile::getKV('id', $profileId);
  70
  71         if (empty($this->_profile)) {
  72             // TRANS: Client exception.
  73             throw new ClientException(_('No such profile.'), 404);
  74         }
  75
  76         $this->_notice = Notice::getKV('id', $noticeId);
  77
  78         if (empty($this->_notice)) {
  79             // TRANS: Client exception thrown when referencing a non-existing notice.
  80             throw new ClientException(_('No such notice.'), 404);
  81         }
  82
  83         $this->_fave = Fave::pkeyGet(array('user_id' => $profileId,
  84                                            'notice_id' => $noticeId));
  85
  86         if (empty($this->_fave)) {
  87             // TRANS: Client exception thrown when referencing a non-existing favorite.
  88             throw new ClientException(_('No such favorite.'), 404);
  89         }
  90
  91         return true;
  92     }
  93
  94     /**
  95      * Handler method
  96      *
  97      * @param array $argarray is ignored since it's now passed in in prepare()
  98      *
  99      * @return void
 100      */
 101     function handle($argarray=null)
 102     {
 103         parent::handle($argarray);
 104
 105         switch ($_SERVER['REQUEST_METHOD']) {
 106         case 'GET':
 107         case 'HEAD':
 108             $this->showFave();
 109             break;
 110         case 'DELETE':
 111             $this->deleteFave();
 112             break;
 113         default:
 114             // TRANS: Client exception thrown using an unsupported HTTP method.
 115             throw new ClientException(_('HTTP method not supported.'), 405);
 116         }
 117         return true;
 118     }
 119
 120     /**
 121      * Show a single favorite, in ActivityStreams format
 122      *
 123      * @return void
 124      */
 125     function showFave()
 126     {
 127         $activity = $this->_fave->asActivity();
 128
 129         header('Content-Type: application/atom+xml; charset=utf-8');
 130
 131         $this->startXML();
 132         $this->raw($activity->asString(true, true, true));
 133         $this->endXML();
 134
 135         return;
 136     }
 137
 138     /**
 139      * Delete the favorite
 140      *
 141      * @return void
 142      */
 143     function deleteFave()
 144     {
 145         if (empty($this->auth_user) ||
 146             $this->auth_user->id != $this->_profile->id) {
 147             // TRANS: Client exception thrown when trying to remove a favorite notice of another user.
 148             throw new ClientException(_("Cannot delete someone else's".
 149                                         " favorite."), 403);
 150         }
 151
 152         $this->_fave->delete();
 153
 154         return;
 155     }
 156
 157     /**
 158      * Return true if read only.
 159      *
 160      * MAY override
 161      *
 162      * @param array $args other arguments
 163      *
 164      * @return boolean is read only action?
 165      */
 166     function isReadOnly(array $args=array())
 167     {
 168         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 169             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 170             return true;
 171         } else {
 172             return false;
 173         }
 174     }
 175
 176     /**
 177      * Return last modified, if applicable.
 178      *
 179      * MAY override
 180      *
 181      * @return string last modified http header
 182      */
 183     function lastModified()
 184     {
 185         return max(strtotime($this->_profile->modified),
 186                    strtotime($this->_notice->modified),
 187                    strtotime($this->_fave->modified));
 188     }
 189
 190     /**
 191      * Return etag, if applicable.
 192      *
 193      * MAY override
 194      *
 195      * @return string etag http header
 196      */
 197     function etag()
 198     {
 199         $mtime = strtotime($this->_fave->modified);
 200
 201         return 'W/"' . implode(':', array('AtomPubShowFavorite',
 202                                           $this->_profile->id,
 203                                           $this->_notice->id,
 204                                           $mtime)) . '"';
 205     }
 206
 207     /**
 208      * Does this require authentication?
 209      *
 210      * @return boolean true if delete, else false
 211      */
 212     function requiresAuth()
 213     {
 214         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 215             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 216             return false;
 217         } else {
 218             return true;
 219         }
 220     }
 221 }