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 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
  49 class ApiBlockDestroyAction extends ApiAuthAction
  50 {
  51     var $other   = null;
  52
  53     /**
  54      * Take arguments for running
  55      *
  56      * @param array $args $_REQUEST args
  57      *
  58      * @return boolean success flag
  59      *
  60      */
  61
  62     function prepare($args)
  63     {
  64         parent::prepare($args);
  65
  66         $this->user   = $this->auth_user;
  67         $this->other  = $this->getTargetUser($this->arg('id'));
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Save the new message
  76      *
  77      * @param array $args $_REQUEST data (unused)
  78      *
  79      * @return void
  80      */
  81
  82     function handle($args)
  83     {
  84         parent::handle($args);
  85
  86         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  87             $this->clientError(
  88                 _('This method requires a POST.'),
  89                 400,
  90                 $this->format
  91             );
  92             return;
  93         }
  94
  95         if (empty($this->user) || empty($this->other)) {
  96             $this->clientError(_('No such user!'), 404, $this->format);
  97             return;
  98         }
  99
 100         if (!$this->user->hasBlocked($this->other)
 101             || $this->user->unblock($this->other)
 102         ) {
 103             $this->initDocument($this->format);
 104             $this->showProfile($this->other, $this->format);
 105             $this->endDocument($this->format);
 106         } else {
 107             $this->serverError(_('Unblock user failed.'));
 108         }
 109
 110     }
 111
 112 }
 113