actions/apiblockdestroy.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Un-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  * Un-blocks the user specified in the ID parameter for the authenticating user.
  39  * Returns the un-blocked user in the requested format when successful.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @author   Zach Copley <zach@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  */
  48 class ApiBlockDestroyAction 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     function prepare($args)
  60     {
  61         parent::prepare($args);
  62
  63         $this->user   = $this->auth_user;
  64         $this->other  = $this->getTargetProfile($this->arg('id'));
  65
  66         return true;
  67     }
  68
  69     /**
  70      * Handle the request
  71      *
  72      * Save the new message
  73      *
  74      * @param array $args $_REQUEST data (unused)
  75      *
  76      * @return void
  77      */
  78     function handle($args)
  79     {
  80         parent::handle($args);
  81
  82         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  83             $this->clientError(
  84                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  85                 _('This method requires a POST.'),
  86                 400,
  87                 $this->format
  88             );
  89             return;
  90         }
  91
  92         if (empty($this->user) || empty($this->other)) {
  93             // TRANS: Client error when user not found for an API action to remove a block for a user.
  94             $this->clientError(_('No such user.'), 404, $this->format);
  95             return;
  96         }
  97
  98         if ($this->user->hasBlocked($this->other)) {
  99             if (Event::handle('StartUnblockProfile', array($this->user, $this->other))) {
 100                 $result = $this->user->unblock($this->other);
 101                 if ($result) {
 102                     Event::handle('EndUnblockProfile', array($this->user, $this->other));
 103                 }
 104             }
 105         }
 106
 107         if (!$this->user->hasBlocked($this->other)) {
 108             $this->initDocument($this->format);
 109             $this->showProfile($this->other, $this->format);
 110             $this->endDocument($this->format);
 111         } else {
 112             // TRANS: Server error displayed when unblocking a user has failed.
 113             $this->serverError(_('Unblock user failed.'));
 114         }
 115     }
 116 }