3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Show a single favorite in Atom Activity Streams format
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.
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.
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/>.
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Show a single favorite in Atom Activity Streams format.
40 * Can also be used to delete a favorite.
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/
49 class AtompubshowfavoriteAction extends ApiAuthAction
51 private $_profile = null;
52 private $_notice = null;
53 private $_fave = null;
56 * For initializing members of the class.
58 * @param array $argarray misc. arguments
60 * @return boolean true
62 function prepare($argarray)
64 parent::prepare($argarray);
66 $profileId = $this->trimmed('profile');
67 $noticeId = $this->trimmed('notice');
69 $this->_profile = Profile::getKV('id', $profileId);
71 if (empty($this->_profile)) {
72 // TRANS: Client exception.
73 throw new ClientException(_('No such profile.'), 404);
76 $this->_notice = Notice::getKV('id', $noticeId);
78 if (empty($this->_notice)) {
79 // TRANS: Client exception thrown when referencing a non-existing notice.
80 throw new ClientException(_('No such notice.'), 404);
83 $this->_fave = Fave::pkeyGet(array('user_id' => $profileId,
84 'notice_id' => $noticeId));
86 if (empty($this->_fave)) {
87 // TRANS: Client exception thrown when referencing a non-existing favorite.
88 throw new ClientException(_('No such favorite.'), 404);
97 * @param array $argarray is ignored since it's now passed in in prepare()
101 function handle($argarray=null)
103 parent::handle($argarray);
105 switch ($_SERVER['REQUEST_METHOD']) {
114 // TRANS: Client exception thrown using an unsupported HTTP method.
115 throw new ClientException(_('HTTP method not supported.'), 405);
121 * Show a single favorite, in ActivityStreams format
127 $activity = $this->_fave->asActivity();
129 header('Content-Type: application/atom+xml; charset=utf-8');
132 $this->raw($activity->asString(true, true, true));
139 * Delete the favorite
143 function deleteFave()
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".
152 $this->_fave->delete();
158 * Return true if read only.
162 * @param array $args other arguments
164 * @return boolean is read only action?
166 function isReadOnly(array $args=array())
168 if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
169 $_SERVER['REQUEST_METHOD'] == 'HEAD') {
177 * Return last modified, if applicable.
181 * @return string last modified http header
183 function lastModified()
185 return max(strtotime($this->_profile->modified),
186 strtotime($this->_notice->modified),
187 strtotime($this->_fave->modified));
191 * Return etag, if applicable.
195 * @return string etag http header
199 $mtime = strtotime($this->_fave->modified);
201 return 'W/"' . implode(':', array('AtomPubShowFavorite',
208 * Does this require authentication?
210 * @return boolean true if delete, else false
212 function requiresAuth()
214 if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
215 $_SERVER['REQUEST_METHOD'] == 'HEAD') {