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 require_once INSTALLDIR . '/lib/apiauth.php';
  37
  38 /**
  39  * Allows the authenticating users to follow (subscribe) the user specified in
  40  * the ID parameter.  Returns the befriended user in the requested format when
  41  * successful.  Returns a string describing the failure condition when unsuccessful.
  42  *
  43  * @category API
  44  * @package  StatusNet
  45  * @author   Dan Moore <dan@moore.cx>
  46  * @author   Evan Prodromou <evan@status.net>
  47  * @author   Zach Copley <zach@status.net>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  */
  51
  52 class ApiFriendshipsCreateAction extends ApiAuthAction
  53 {
  54     var $other  = null;
  55
  56     /**
  57      * Take arguments for running
  58      *
  59      * @param array $args $_REQUEST args
  60      *
  61      * @return boolean success flag
  62      *
  63      */
  64
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68
  69         $this->user   = $this->auth_user;
  70         $this->other  = $this->getTargetProfile($this->arg('id'));
  71
  72         return true;
  73     }
  74
  75     /**
  76      * Handle the request
  77      *
  78      * Check the format and show the user info
  79      *
  80      * @param array $args $_REQUEST data (unused)
  81      *
  82      * @return void
  83      */
  84
  85     function handle($args)
  86     {
  87         parent::handle($args);
  88
  89         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  90             $this->clientError(
  91                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  92                 _('This method requires a POST.'),
  93                 400,
  94                 $this->format
  95             );
  96             return;
  97         }
  98
  99         if (!in_array($this->format, array('xml', 'json'))) {
 100             $this->clientError(
 101                 _('API method not found.'),
 102                 404,
 103                 $this->format
 104             );
 105             return;
 106         }
 107
 108         if (empty($this->other)) {
 109             $this->clientError(
 110                 _('Could not follow user: profile not found.'),
 111                 403,
 112                 $this->format
 113             );
 114             return;
 115         }
 116
 117         if ($this->user->isSubscribed($this->other)) {
 118             $errmsg = sprintf(
 119                 _('Could not follow user: %s is already on your list.'),
 120                 $this->other->nickname
 121             );
 122             $this->clientError($errmsg, 403, $this->format);
 123             return;
 124         }
 125
 126         $result = subs_subscribe_to($this->user, $this->other);
 127
 128         if (is_string($result)) {
 129             $this->clientError($result, 403, $this->format);
 130             return;
 131         }
 132
 133         $this->initDocument($this->format);
 134         $this->showProfile($this->other, $this->format);
 135         $this->endDocument($this->format);
 136     }
 137
 138 }