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
  27     function favorites($args, $apidata)
  28     {
  29         parent::handle($args);
  30
  31         $this->auth_user = $apidata['user'];
  32         $user = $this->get_user($apidata['api_arg'], $apidata);
  33
  34         if (!$user) {
  35             $this->client_error('Not Found', 404, $apidata['content-type']);
  36             return;
  37         }
  38
  39         $profile = $user->getProfile();
  40
  41         if (!$profile) {
  42             common_server_error(_('User has no profile.'));
  43             return;
  44         }
  45
  46         $page = $this->arg('page');
  47
  48         if (!$page) {
  49             $page = 1;
  50         }
  51
  52         if (!$count) {
  53             $count = 20;
  54         }
  55
  56         $notice = $user->favoriteNotices((($page-1)*20), $count);
  57
  58         if (!$notice) {
  59             common_server_error(_('Could not retrieve favorite notices.'));
  60             return;
  61         }
  62
  63         $sitename = common_config('site', 'name');
  64         $siteserver = common_config('site', 'server');
  65
  66         $title = sprintf(_('%s / Favorites from %s'), $sitename, $user->nickname);
  67         $id = "tag:$siteserver:favorites:".$user->id;
  68         $link = common_local_url('favorites', array('nickname' => $user->nickname));
  69         $subtitle = sprintf(_('%s updates favorited by %s / %s.'), $sitename, $profile->getBestName(), $user->nickname);
  70
  71         switch($apidata['content-type']) {
  72          case 'xml':
  73             $this->show_xml_timeline($notice);
  74             break;
  75          case 'rss':
  76             $this->show_rss_timeline($notice, $title, $link, $subtitle);
  77             break;
  78          case 'atom':
  79             $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
  80             break;
  81          case 'json':
  82             $this->show_json_timeline($notice);
  83             break;
  84          default:
  85             common_user_error(_('API method not found!'), $code = 404);
  86         }
  87
  88     }
  89
  90     function create($args, $apidata)
  91     {
  92         parent::handle($args);
  93
  94         // Check for RESTfulness
  95         if (!in_array($_SERVER['REQUEST_METHOD'], array('POST', 'DELETE'))) {
  96             // XXX: Twitter just prints the err msg, no XML / JSON.
  97             $this->client_error(_('This method requires a POST or DELETE.'), 400, $apidata['content-type']);
  98             return;
  99         }
 100
 101         if (!in_array($apidata['content-type'], array('xml', 'json'))) {
 102             common_user_error(_('API method not found!'), $code = 404);
 103             return;
 104         }
 105
 106         $this->auth_user = $apidata['user'];
 107         $user = $this->auth_user;
 108         $notice_id = $apidata['api_arg'];
 109         $notice = Notice::staticGet($notice_id);
 110
 111         if (!$notice) {
 112             $this->client_error(_('No status found with that ID.'), 404, $apidata['content-type']);
 113             return;
 114         }
 115
 116         // XXX: Twitter lets you fave things repeatedly via api.
 117         if ($user->hasFave($notice)) {
 118             $this->client_error(_('This notice is already a favorite!'), 403, $apidata['content-type']);
 119             return;
 120         }
 121
 122         $fave = Fave::addNew($user, $notice);
 123
 124         if (!$fave) {
 125             common_server_error(_('Could not create favorite.'));
 126             return;
 127         }
 128
 129         $this->notify($fave, $notice, $user);
 130         $user->blowFavesCache();
 131
 132         if ($apidata['content-type'] == 'xml') {
 133             $this->show_single_xml_status($notice);
 134         } elseif ($apidata['content-type'] == 'json') {
 135             $this->show_single_json_status($notice);
 136         }
 137
 138     }
 139
 140     function destroy($args, $apidata)
 141     {
 142         parent::handle($args);
 143         common_server_error(_('API method under construction.'), $code=501);
 144     }
 145
 146     // XXX: these two funcs swiped from faves.  Maybe put in util.php, or some common base class?
 147
 148     function notify($fave, $notice, $user)
 149     {
 150         $other = User::staticGet('id', $notice->profile_id);
 151         if ($other && $other->id != $user->id) {
 152             if ($other->email && $other->emailnotifyfav) {
 153                 $this->notify_mail($other, $user, $notice);
 154             }
 155             # XXX: notify by IM
 156             # XXX: notify by SMS
 157         }
 158     }
 159
 160     function notify_mail($other, $user, $notice)
 161     {
 162         $profile = $user->getProfile();
 163         $bestname = $profile->getBestName();
 164         $subject = sprintf(_('%s added your notice as a favorite'), $bestname);
 165         $body = sprintf(_("%1\$s just added your notice from %2\$s as one of their favorites.\n\n" .
 166                           "In case you forgot, you can see the text of your notice here:\n\n" .
 167                           "%3\$s\n\n" .
 168                           "You can see the list of %1\$s's favorites here:\n\n" .
 169                           "%4\$s\n\n" .
 170                           "Faithfully yours,\n" .
 171                           "%5\$s\n"),
 172                         $bestname,
 173                         common_exact_date($notice->created),
 174                         common_local_url('shownotice', array('notice' => $notice->id)),
 175                         common_local_url('showfavorites', array('nickname' => $user->nickname)),
 176                         common_config('site', 'name'));
 177
 178         mail_to_user($other, $subject, $body);
 179     }
 180
 181 }