actions/apifriendshipscreate.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Subscribe to a user via the API
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Dan Moore <dan@moore.cx>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Zach Copley <zach@status.net>
  27  * @copyright 2009-2010 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/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 /**
  37  * Allows the authenticating users to follow (subscribe) the user specified in
  38  * the ID parameter.  Returns the befriended user in the requested format when
  39  * successful.  Returns a string describing the failure condition when unsuccessful.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Dan Moore <dan@moore.cx>
  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/
  48  */
  49 class ApiFriendshipsCreateAction extends ApiAuthAction
  50 {
  51     var $other  = null;
  52
  53     /**
  54      * Take arguments for running
  55      *
  56      * @param array $args $_REQUEST args
  57      *
  58      * @return boolean success flag
  59      *
  60      */
  61     function prepare($args)
  62     {
  63         parent::prepare($args);
  64
  65         $this->user   = $this->auth_user;
  66         $this->other  = $this->getTargetProfile($this->arg('id'));
  67
  68         return true;
  69     }
  70
  71     /**
  72      * Handle the request
  73      *
  74      * Check the format and show the user info
  75      *
  76      * @param array $args $_REQUEST data (unused)
  77      *
  78      * @return void
  79      */
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  85             $this->clientError(
  86                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  87                 _('This method requires a POST.'),
  88                 400,
  89                 $this->format
  90             );
  91             return;
  92         }
  93
  94         if (!in_array($this->format, array('xml', 'json'))) {
  95             $this->clientError(
  96                 // TRANS: Client error displayed when coming across a non-supported API method.
  97                 _('API method not found.'),
  98                 404,
  99                 $this->format
 100             );
 101             return;
 102         }
 103
 104         if (empty($this->other)) {
 105             $this->clientError(
 106                 // TRANS: Client error displayed when trying follow who's profile could not be found.
 107                 _('Could not follow user: profile not found.'),
 108                 403,
 109                 $this->format
 110             );
 111             return;
 112         }
 113
 114         if ($this->user->isSubscribed($this->other)) {
 115             $errmsg = sprintf(
 116                 // TRANS: Client error displayed when trying to follow a user that's already being followed.
 117                 // TRANS: %s is the nickname of the user that is already being followed.
 118                 _('Could not follow user: %s is already on your list.'),
 119                 $this->other->nickname
 120             );
 121             $this->clientError($errmsg, 403, $this->format);
 122             return;
 123         }
 124
 125         try {
 126             Subscription::start($this->user->getProfile(), $this->other);
 127         } catch (Exception $e) {
 128             $this->clientError($e->getMessage(), 403, $this->format);
 129         }
 130
 131         $this->initDocument($this->format);
 132         $this->showProfile($this->other, $this->format);
 133         $this->endDocument($this->format);
 134     }
 135 }