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     protected $needPost = true;
  52
  53     var $other  = null;
  54
  55     /**
  56      * Take arguments for running
  57      *
  58      * @param array $args $_REQUEST args
  59      *
  60      * @return boolean success flag
  61      *
  62      */
  63     protected function prepare(array $args=array())
  64     {
  65         parent::prepare($args);
  66
  67         $this->other  = $this->getTargetProfile($this->arg('id'));
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Check the format and show the user info
  76      *
  77      * @return void
  78      */
  79     protected function handle()
  80     {
  81         parent::handle();
  82
  83         if (!in_array($this->format, array('xml', 'json'))) {
  84             // TRANS: Client error displayed when coming across a non-supported API method.
  85             $this->clientError(_('API method not found.'), 404);
  86         }
  87
  88         if (empty($this->other)) {
  89             // TRANS: Client error displayed when trying follow who's profile could not be found.
  90             $this->clientError(_('Could not follow user: profile not found.'), 403);
  91         }
  92
  93         if ($this->user->isSubscribed($this->other)) {
  94             $errmsg = sprintf(
  95                 // TRANS: Client error displayed when trying to follow a user that's already being followed.
  96                 // TRANS: %s is the nickname of the user that is already being followed.
  97                 _('Could not follow user: %s is already on your list.'),
  98                 $this->other->nickname
  99             );
 100             $this->clientError($errmsg, 403);
 101         }
 102
 103         try {
 104             Subscription::start($this->user->getProfile(), $this->other);
 105         } catch (Exception $e) {
 106             $this->clientError($e->getMessage(), 403);
 107         }
 108
 109         $this->initDocument($this->format);
 110         $this->showProfile($this->other, $this->format);
 111         $this->endDocument($this->format);
 112     }
 113 }