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
  51     var $format = null;
  52     var $user   = null;
  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
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         if ($this->requiresAuth()) {
  69             if ($this->checkBasicAuthUser() == false) {
  70                 return;
  71             }
  72         }
  73
  74         $this->format = $this->arg('format');
  75         $this->user   = $this->auth_user;
  76         $this->other  = $this->getTargetUser($id);
  77
  78         return true;
  79     }
  80
  81     /**
  82      * Handle the request
  83      *
  84      * Check the format and show the user info
  85      *
  86      * @param array $args $_REQUEST data (unused)
  87      *
  88      * @return void
  89      */
  90
  91     function handle($args)
  92     {
  93         parent::handle($args);
  94
  95         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  96             $this->clientError(
  97                 _('This method requires a POST.'),
  98                 400,
  99                 $this->format
 100             );
 101             return;
 102         }
 103
 104         if (empty($this->other)) {
 105             $this->clientError(
 106                 _('Could not follow user: User not found.'),
 107                 403,
 108                 $this->format
 109             );
 110             return;
 111         }
 112
 113         if ($this->user->isSubscribed($this->other)) {
 114             $errmsg = sprintf(
 115                 _('Could not follow user: %s is already on your list.'),
 116                 $this->other->nickname
 117             );
 118             $this->clientError($errmsg, 403, $this->format);
 119             return;
 120         }
 121
 122         $result = subs_subscribe_to($this->user, $this->other);
 123
 124         if (is_string($result)) {
 125             $this->clientError($result, 403, $this->format);
 126             return;
 127         }
 128
 129         $this->init_document($this->format);
 130         $this->show_profile($this->other, $this->format);
 131         $this->end_document($this->format);
 132     }
 133
 134 }