actions/twitapifavorites.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('LACONICA')) { exit(1); }
  21
  22 require_once(INSTALLDIR.'/lib/twitterapi.php');
  23
  24 class TwitapifavoritesAction extends TwitterapiAction {
  25
  26     function favorites($args, $apidata)
  27     {
  28         parent::handle($args);
  29
  30         $this->auth_user = $apidata['user'];
  31         $user = $this->get_user($apidata['api_arg'], $apidata);
  32
  33         if (!$user) {
  34             $this->client_error('Not Found', 404, $apidata['content-type']);
  35             return;
  36         }
  37
  38         $profile = $user->getProfile();
  39
  40         if (!$profile) {
  41             common_server_error(_('User has no profile.'));
  42             return;
  43         }
  44
  45         $page = $this->arg('page');
  46
  47         if (!$page) {
  48             $page = 1;
  49         }
  50
  51         if (!$count) {
  52             $count = 20;
  53         }
  54
  55         $notice = $user->favoriteNotices((($page-1)*20), $count);
  56
  57         if (!$notice) {
  58             common_server_error(_('Could not retrieve favorite notices.'));
  59             return;
  60         }
  61
  62         $sitename = common_config('site', 'name');
  63         $siteserver = common_config('site', 'server');
  64
  65         $title = sprintf(_('%s / Favorites from %s'), $sitename, $user->nickname);
  66         $id = "tag:$siteserver:favorites:".$user->id;
  67         $link = common_local_url('favorites', array('nickname' => $user->nickname));
  68         $subtitle = sprintf(_('%s updates favorited by %s / %s.'), $sitename, $profile->getBestName(), $user->nickname);
  69
  70         switch($apidata['content-type']) {
  71          case 'xml':
  72             $this->show_xml_timeline($notice);
  73             break;
  74          case 'rss':
  75             $this->show_rss_timeline($notice, $title, $link, $subtitle);
  76             break;
  77          case 'atom':
  78             $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
  79             break;
  80          case 'json':
  81             $this->show_json_timeline($notice);
  82             break;
  83          default:
  84             common_user_error(_('API method not found!'), $code = 404);
  85         }
  86
  87     }
  88
  89     function create($args, $apidata)
  90     {
  91         parent::handle($args);
  92
  93         // Check for RESTfulness
  94         if (!in_array($_SERVER['REQUEST_METHOD'], array('POST', 'DELETE'))) {
  95             // XXX: Twitter just prints the err msg, no XML / JSON.
  96             $this->client_error(_('This method requires a POST or DELETE.'), 400, $apidata['content-type']);
  97             return;
  98         }
  99
 100         if (!in_array($apidata['content-type'], array('xml', 'json'))) {
 101             common_user_error(_('API method not found!'), $code = 404);
 102             return;
 103         }
 104
 105         $this->auth_user = $apidata['user'];
 106         $user = $this->auth_user;
 107         $notice_id = $apidata['api_arg'];
 108         $notice = Notice::staticGet($notice_id);
 109
 110         if (!$notice) {
 111             $this->client_error(_('No status found with that ID.'), 404, $apidata['content-type']);
 112             return;
 113         }
 114
 115         // XXX: Twitter lets you fave things repeatedly via api.
 116         if ($user->hasFave($notice)) {
 117             $this->client_error(_('This notice is already a favorite!'), 403, $apidata['content-type']);
 118             return;
 119         }
 120
 121         $fave = Fave::addNew($user, $notice);
 122
 123         if (!$fave) {
 124             common_server_error(_('Could not create favorite.'));
 125             return;
 126         }
 127
 128         $this->notify($fave, $notice, $user);
 129         $user->blowFavesCache();
 130
 131         if ($apidata['content-type'] == 'xml') {
 132             $this->show_single_xml_status($notice);
 133         } elseif ($apidata['content-type'] == 'json') {
 134             $this->show_single_json_status($notice);
 135         }
 136
 137     }
 138
 139     function destroy($args, $apidata)
 140     {
 141         parent::handle($args);
 142         common_server_error(_('API method under construction.'), $code=501);
 143     }
 144
 145     // XXX: these two funcs swiped from faves.  Maybe put in util.php, or some common base class?
 146
 147     function notify($fave, $notice, $user)
 148     {
 149         $other = User::staticGet('id', $notice->profile_id);
 150         if ($other && $other->id != $user->id) {
 151             if ($other->email && $other->emailnotifyfav) {
 152                 $this->notify_mail($other, $user, $notice);
 153             }
 154             # XXX: notify by IM
 155             # XXX: notify by SMS
 156         }
 157     }
 158
 159     function notify_mail($other, $user, $notice)
 160     {
 161         $profile = $user->getProfile();
 162         $bestname = $profile->getBestName();
 163         $subject = sprintf(_('%s added your notice as a favorite'), $bestname);
 164         $body = sprintf(_("%1\$s just added your notice from %2\$s as one of their favorites.\n\n" .
 165                           "In case you forgot, you can see the text of your notice here:\n\n" .
 166                           "%3\$s\n\n" .
 167                           "You can see the list of %1\$s's favorites here:\n\n" .
 168                           "%4\$s\n\n" .
 169                           "Faithfully yours,\n" .
 170                           "%5\$s\n"),
 171                         $bestname,
 172                         common_exact_date($notice->created),
 173                         common_local_url('shownotice', array('notice' => $notice->id)),
 174                         common_local_url('showfavorites', array('nickname' => $user->nickname)),
 175                         common_config('site', 'name'));
 176
 177         mail_to_user($other, $subject, $body);
 178     }
 179
 180 }