3 * StatusNet, the distributed open-source microblogging tool
5 * Add a notice to 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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29 * @link http://status.net/
32 if (!defined('STATUSNET')) {
36 require_once INSTALLDIR . '/lib/apiauth.php';
39 * Favorites the status specified in the ID parameter as the authenticating user.
40 * Returns the favorite status when successful.
44 * @author Craig Andrews <candrews@integralblue.com>
45 * @author Evan Prodromou <evan@status.net>
46 * @author Zach Copley <zach@status.net>
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
51 class ApiFavoriteCreateAction extends ApiAuthAction
56 * Take arguments for running
58 * @param array $args $_REQUEST args
60 * @return boolean success flag
64 function prepare($args)
66 parent::prepare($args);
68 $this->user = $this->auth_user;
69 $this->notice = Notice::staticGet($this->arg('id'));
77 * Check the format and show the user info
79 * @param array $args $_REQUEST data (unused)
84 function handle($args)
86 parent::handle($args);
88 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
90 _('This method requires a POST.'),
97 if (!in_array($this->format, array('xml', 'json'))) {
99 _('API method not found.'),
106 if (empty($this->notice)) {
108 _('No status found with that ID.'),
115 // Note: Twitter lets you fave things repeatedly via API.
117 if ($this->user->hasFave($this->notice)) {
119 _('This status is already a favorite.'),
126 $fave = Fave::addNew($this->user->getProfile(), $this->notice);
130 _('Could not create favorite.'),
137 $this->notify($fave, $this->notice, $this->user);
138 $this->user->blowFavesCache();
140 if ($this->format == 'xml') {
141 $this->showSingleXmlStatus($this->notice);
142 } elseif ($this->format == 'json') {
143 $this->show_single_json_status($this->notice);
148 * Notify the author of the favorite that the user likes their notice
150 * @param Favorite $fave the favorite in question
151 * @param Notice $notice the notice that's been faved
152 * @param User $user the user doing the favoriting
156 function notify($fave, $notice, $user)
158 $other = User::staticGet('id', $notice->profile_id);
159 if ($other && $other->id != $user->id) {
160 if ($other->email && $other->emailnotifyfav) {
161 mail_notify_fave($other, $user, $notice);
164 // XXX: notify by SMS