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    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  * Un-blocks the user specified in the ID parameter for the authenticating user.
  38  * Returns the un-blocked user in the requested format when successful.
  39  *
  40  * @category API
  41  * @package  StatusNet
  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
  47 class ApiBlockDestroyAction extends ApiAuthAction
  48 {
  49     var $format  = null;
  50     var $user    = null;
  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         if ($this->requiresAuth()) {
  67             if ($this->checkBasicAuthUser() == false) {
  68                 return;
  69             }
  70         }
  71
  72         $this->user   = $this->auth_user;
  73         $this->other  = $this->getTargetUser($this->arg('id'));
  74         $this->format = $this->arg('format');
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Handle the request
  81      *
  82      * Save the new message
  83      *
  84      * @param array $args $_REQUEST data (unused)
  85      *
  86      * @return void
  87      */
  88
  89     function handle($args)
  90     {
  91         parent::handle($args);
  92
  93         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  94             $this->clientError(
  95                 _('This method requires a POST.'),
  96                 400,
  97                 $this->format
  98             );
  99             return;
 100         }
 101
 102         if (empty($this->user) || empty($this->other)) {
 103             $this->clientError(_('No such user!'), 404, $this->format);
 104             return;
 105         }
 106
 107         if (!$this->user->hasBlocked($this->other)
 108             || $this->user->unblock($this->other)
 109         ) {
 110             $this->init_document($this->format);
 111             $this->show_profile($this->other, $this->format);
 112             $this->end_document($this->format);
 113         } else {
 114             $this->serverError(_('Unblock user failed.'));
 115         }
 116
 117     }
 118
 119 }
 120