actions/unsilence.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Action class to unsilence a user
   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  Action
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@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 /**
  35  * Silence a user.
  36  *
  37  * @category Action
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  */
  43 class UnsilenceAction extends ProfileFormAction
  44 {
  45     /**
  46      * Check parameters
  47      *
  48      * @param array $args action arguments (URL, GET, POST)
  49      *
  50      * @return boolean success flag
  51      */
  52     function prepare(array $args=array())
  53     {
  54         if (!parent::prepare($args)) {
  55             return false;
  56         }
  57
  58         $cur = common_current_user();
  59
  60         assert(!empty($cur)); // checked by parent
  61
  62         if (!$cur->hasRight(Right::SILENCEUSER)) {
  63             // TRANS: Client error on page to unsilence a user when the feature is not enabled.
  64             $this->clientError(_('You cannot silence users on this site.'));
  65         }
  66
  67         assert(!empty($this->profile)); // checked by parent
  68
  69         if (!$this->profile->isSilenced()) {
  70             // TRANS: Client error on page to unsilence a user when the to be unsilenced user has not been silenced.
  71             $this->clientError(_('User is not silenced.'));
  72         }
  73
  74         return true;
  75     }
  76
  77     /**
  78      * Silence a user.
  79      *
  80      * @return void
  81      */
  82     function handlePost()
  83     {
  84         $this->profile->unsilence();
  85     }
  86 }