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 /**
  36  * Un-blocks the user specified in the ID parameter for the authenticating user.
  37  * Returns the un-blocked user in the requested format when successful.
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46 class ApiBlockDestroyAction extends ApiAuthAction
  47 {
  48     protected $needPost = true;
  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     protected function prepare(array $args=array())
  60     {
  61         parent::prepare($args);
  62
  63         $this->other  = $this->getTargetProfile($this->arg('id'));
  64
  65         return true;
  66     }
  67
  68     /**
  69      * Handle the request
  70      *
  71      * Save the new message
  72      *
  73      * @return void
  74      */
  75     protected function handle()
  76     {
  77         parent::handle();
  78
  79         if (empty($this->user) || empty($this->other)) {
  80             // TRANS: Client error when user not found for an API action to remove a block for a user.
  81             $this->clientError(_('No such user.'), 404);
  82         }
  83
  84         if ($this->user->hasBlocked($this->other)) {
  85             if (Event::handle('StartUnblockProfile', array($this->user, $this->other))) {
  86                 $result = $this->user->unblock($this->other);
  87                 if ($result) {
  88                     Event::handle('EndUnblockProfile', array($this->user, $this->other));
  89                 }
  90             }
  91         }
  92
  93         if (!$this->user->hasBlocked($this->other)) {
  94             $this->initDocument($this->format);
  95             $this->showProfile($this->other, $this->format);
  96             $this->endDocument($this->format);
  97         } else {
  98             // TRANS: Server error displayed when unblocking a user has failed.
  99             $this->serverError(_('Unblock user failed.'));
 100         }
 101     }
 102 }