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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/apiauth.php';
  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   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
  48 class ApiFriendshipsCreateAction extends ApiAuthAction
  49 {
  50     var $other  = null;
  51
  52     /**
  53      * Take arguments for running
  54      *
  55      * @param array $args $_REQUEST args
  56      *
  57      * @return boolean success flag
  58      *
  59      */
  60
  61     function prepare($args)
  62     {
  63         parent::prepare($args);
  64
  65         $this->user   = $this->auth_user;
  66         $this->other  = $this->getTargetUser($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
  81     function handle($args)
  82     {
  83         parent::handle($args);
  84
  85         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  86             $this->clientError(
  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                 _('API method not found!'),
  97                 404,
  98                 $this->format
  99             );
 100             return;
 101         }
 102
 103         if (empty($this->other)) {
 104             $this->clientError(
 105                 _('Could not follow user: User not found.'),
 106                 403,
 107                 $this->format
 108             );
 109             return;
 110         }
 111
 112         if ($this->user->isSubscribed($this->other)) {
 113             $errmsg = sprintf(
 114                 _('Could not follow user: %s is already on your list.'),
 115                 $this->other->nickname
 116             );
 117             $this->clientError($errmsg, 403, $this->format);
 118             return;
 119         }
 120
 121         $result = subs_subscribe_to($this->user, $this->other);
 122
 123         if (is_string($result)) {
 124             $this->clientError($result, 403, $this->format);
 125             return;
 126         }
 127
 128         $this->initDocument($this->format);
 129         $this->showProfile($this->other, $this->format);
 130         $this->endDocument($this->format);
 131     }
 132
 133 }