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('GNUSOCIAL')) { exit(1); }
  33
  34 /**
  35  * Allows the authenticating users to follow (subscribe) the user specified in
  36  * the ID parameter.  Returns the befriended user in the requested format when
  37  * successful.  Returns a string describing the failure condition when unsuccessful.
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Dan Moore <dan@moore.cx>
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47 class ApiFriendshipsCreateAction extends ApiAuthAction
  48 {
  49     protected $needPost = true;
  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     protected function prepare(array $args=array())
  62     {
  63         parent::prepare($args);
  64
  65         $this->other  = $this->getTargetProfile($this->arg('id'));
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * Check the format and show the user info
  74      *
  75      * @return void
  76      */
  77     protected function handle()
  78     {
  79         parent::handle();
  80
  81         if (!in_array($this->format, array('xml', 'json'))) {
  82             // TRANS: Client error displayed when coming across a non-supported API method.
  83             $this->clientError(_('API method not found.'), 404);
  84         }
  85
  86         if (empty($this->other)) {
  87             // TRANS: Client error displayed when trying follow who's profile could not be found.
  88             $this->clientError(_('Could not follow user: profile not found.'), 403);
  89         }
  90
  91         if ($this->scoped->isSubscribed($this->other)) {
  92             $errmsg = sprintf(
  93                 // TRANS: Client error displayed when trying to follow a user that's already being followed.
  94                 // TRANS: %s is the nickname of the user that is already being followed.
  95                 _('Could not follow user: %s is already on your list.'),
  96                 $this->other->nickname
  97             );
  98             $this->clientError($errmsg, 403);
  99         }
 100
 101         try {
 102             Subscription::start($this->scoped, $this->other);
 103         } catch (AlreadyFulfilledException $e) {
 104             $this->clientError($e->getMessage(), 409);
 105         }
 106
 107         $this->initDocument($this->format);
 108         $this->showProfile($this->other, $this->format);
 109         $this->endDocument($this->format);
 110     }
 111 }