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    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2009-2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR . '/lib/apiauth.php';
  36
  37 /**
  38  * Blocks the user specified in the ID parameter as the authenticating user.
  39  * Destroys a friendship to the blocked user if it exists. Returns the
  40  * blocked user in the requested format when successful.
  41  *
  42  * @category API
  43  * @package  StatusNet
  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
  50 class ApiBlockCreateAction extends ApiAuthAction
  51 {
  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         $this->user   = $this->auth_user;
  68         $this->other  = $this->getTargetProfile($this->arg('id'));
  69
  70         return true;
  71     }
  72
  73     /**
  74      * Handle the request
  75      *
  76      * Save the new message
  77      *
  78      * @param array $args $_REQUEST data (unused)
  79      *
  80      * @return void
  81      */
  82
  83     function handle($args)
  84     {
  85         parent::handle($args);
  86
  87         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  88             $this->clientError(
  89                 _('This method requires a POST.'),
  90                 400,
  91                 $this->format
  92             );
  93             return;
  94         }
  95
  96         if (empty($this->user) || empty($this->other)) {
  97             $this->clientError(_('No such user.'), 404, $this->format);
  98             return;
  99         }
 100
 101         // Don't allow blocking yourself!
 102
 103         if ($this->user->id == $this->other->id) {
 104             $this->clientError(
 105                 _("You cannot block yourself!"),
 106                 403,
 107                 $this->format
 108             );
 109             return;
 110         }
 111
 112         if (!$this->user->hasBlocked($this->other)) {
 113             if (Event::handle('StartBlockProfile', array($this->user, $this->other))) {
 114                 $result = $this->user->block($this->other);
 115                 if ($result) {
 116                     Event::handle('EndBlockProfile', array($this->user, $this->other));
 117                 }
 118             }
 119         }
 120
 121         if ($this->user->hasBlocked($this->other)) {
 122             $this->initDocument($this->format);
 123             $this->showProfile($this->other, $this->format);
 124             $this->endDocument($this->format);
 125         } else {
 126             $this->serverError(_('Block user failed.'), 500, $this->format);
 127         }
 128
 129     }
 130
 131 }
 132