3 * StatusNet, the distributed open-source microblogging tool
5 * Remote a notice from a user's list of favorite notices via the API
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.
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.
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/>.
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Zach Copley <zach@status.net>
27 * @copyright 2009 StatusNet, Inc.
28 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
29 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET')) {
38 * Un-favorites the status specified in the ID parameter as the authenticating user.
39 * Returns the un-favorited status in the requested format when successful.
43 * @author Craig Andrews <candrews@integralblue.com>
44 * @author Evan Prodromou <evan@status.net>
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
49 class ApiFavoriteDestroyAction extends ApiAuthAction
54 * Take arguments for running
56 * @param array $args $_REQUEST args
58 * @return boolean success flag
60 function prepare($args)
62 parent::prepare($args);
64 $this->user = $this->auth_user;
65 $this->notice = Notice::getKV($this->arg('id'));
66 if ($this->notice->repeat_of != '' ) {
67 common_log(LOG_DEBUG, 'Trying to unFave '.$this->notice->id);
68 common_log(LOG_DEBUG, 'Will unFave '.$this->notice->repeat_of.' instead');
69 $real_notice_id = $this->notice->repeat_of;
70 $this->notice = Notice::getKV($real_notice_id);
79 * Check the format and show the user info
81 * @param array $args $_REQUEST data (unused)
85 function handle($args)
87 parent::handle($args);
89 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
91 // TRANS: Client error. POST is a HTTP command. It should not be translated.
92 _('This method requires a POST.'),
99 if (!in_array($this->format, array('xml', 'json'))) {
101 // TRANS: Client error displayed when coming across a non-supported API method.
102 _('API method not found.'),
109 if (empty($this->notice)) {
111 // TRANS: Client error displayed when trying to remove a favourite with an invalid ID.
112 _('No status found with that ID.'),
120 $fave->user_id = $this->user->id;
121 $fave->notice_id = $this->notice->id;
123 if (!$fave->find(true)) {
125 // TRANS: Client error displayed when trying to remove a favourite that was not a favourite.
126 _('That status is not a favorite.'),
133 $result = $fave->delete();
136 common_log_db_error($fave, 'DELETE', __FILE__);
138 // TRANS: Client error displayed when removing a favourite has failed.
139 _('Could not delete favorite.'),
146 Fave::blowCacheForProfileId($this->user->id);
148 if ($this->format == 'xml') {
149 $this->showSingleXmlStatus($this->notice);
150 } elseif ($this->format == 'json') {
151 $this->show_single_json_status($this->notice);