actions/apiblockcreate.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Block 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  * Blocks the user specified in the ID parameter as the authenticating user.
  38  * Destroys a friendship to the blocked user if it exists. Returns the
  39  * blocked user in the requested format when successful.
  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 ApiBlockCreateAction extends ApiAuthAction
  49 {
  50     var $format  = null;
  51     var $user    = null;
  52     var $other   = null;
  53
  54     /**
  55      * Take arguments for running
  56      *
  57      * @param array $args $_REQUEST args
  58      *
  59      * @return boolean success flag
  60      *
  61      */
  62
  63     function prepare($args)
  64     {
  65         parent::prepare($args);
  66
  67         if ($this->requiresAuth()) {
  68             if ($this->checkBasicAuthUser() == false) {
  69                 return;
  70             }
  71         }
  72
  73         $this->user   = $this->auth_user;
  74         $this->other  = $this->getTargetUser($this->arg('id'));
  75         $this->format = $this->arg('format');
  76
  77         return true;
  78     }
  79
  80     /**
  81      * Handle the request
  82      *
  83      * Save the new message
  84      *
  85      * @param array $args $_REQUEST data (unused)
  86      *
  87      * @return void
  88      */
  89
  90     function handle($args)
  91     {
  92         parent::handle($args);
  93
  94         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  95             $this->clientError(
  96                 _('This method requires a POST.'),
  97                 400,
  98                 $this->format
  99             );
 100             return;
 101         }
 102
 103         if (empty($this->user) || empty($this->other)) {
 104             $this->clientError(_('No such user!'), 404, $this->format);
 105             return;
 106         }
 107
 108         if ($this->user->hasBlocked($this->other)
 109             || $this->user->block($this->other)
 110         ) {
 111             $this->init_document($this->format);
 112             $this->show_profile($this->other, $this->format);
 113             $this->end_document($this->format);
 114         } else {
 115             $this->serverError(_('Block user failed.'), 500, $this->format);
 116         }
 117
 118     }
 119
 120 }
 121