gnu-social/actions/block.php

240 lines
7.0 KiB
PHP
Raw Permalink Normal View History

<?php
2020-07-31 14:35:27 +01:00
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
2009-01-22 06:02:23 +00:00
/**
* Block a user action class.
*
2020-07-31 14:35:27 +01:00
* @category Action
* @package GNUsocial
* @author Evan Prodromou <evan@status.net>
* @author Robin Millette <millette@status.net>
* @copyright 2008, 2009 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
2020-07-31 14:35:27 +01:00
defined('GNUSOCIAL') || die();
2009-01-22 06:02:23 +00:00
/**
* Block a user action class.
*
2020-07-31 14:35:27 +01:00
* @category Action
* @package GNUsocial
* @author Evan Prodromou <evan@status.net>
* @author Robin Millette <millette@status.net>
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2009-01-22 06:02:23 +00:00
*/
class BlockAction extends ProfileFormAction
{
2020-07-31 14:35:27 +01:00
public $profile = null;
2009-01-22 06:02:23 +00:00
/**
* Take arguments for running
*
* @param array $args $_REQUEST args
*
* @return boolean success flag
*/
2020-07-31 14:35:27 +01:00
public function prepare(array $args = []): bool
{
if (!parent::prepare($args)) {
return false;
}
$cur = common_current_user();
assert(!empty($cur)); // checked by parent
if ($cur->hasBlocked($this->profile)) {
// TRANS: Client error displayed when blocking a user that has already been blocked.
$this->clientError(_('You already blocked that user.'));
}
return true;
}
2009-01-22 06:02:23 +00:00
/**
* Handle request
*
* @param array $args $_REQUEST args; handled in prepare()
*
* @return void
*/
2020-07-31 14:35:27 +01:00
public function handle(): void
{
if ($_SERVER['REQUEST_METHOD'] == 'POST') {
2009-01-23 04:29:21 +00:00
if ($this->arg('no')) {
$this->returnToPrevious();
2009-01-23 04:29:21 +00:00
} elseif ($this->arg('yes')) {
$this->handlePost();
$this->returnToPrevious();
} else {
2009-01-23 04:29:21 +00:00
$this->showPage();
}
} else {
$this->showPage();
}
}
2020-07-31 14:35:27 +01:00
public function showContent(): void
{
2009-01-23 04:29:21 +00:00
$this->areYouSureForm();
}
2020-07-31 14:35:27 +01:00
public function title(): string
{
// TRANS: Title for block user page.
2009-01-23 04:29:21 +00:00
return _('Block user');
}
2020-07-31 14:35:27 +01:00
public function showNoticeForm(): void
{
2009-01-23 04:29:21 +00:00
// nop
}
2009-01-22 06:02:23 +00:00
/**
* Confirm with user.
*
* Shows a confirmation form.
*
* @return void
*/
2020-07-31 14:35:27 +01:00
public function areYouSureForm()
{
// @fixme if we ajaxify the confirmation form, skip the preview on ajax hits
$profile = new ArrayWrapper(array($this->profile));
$preview = new ProfileList($profile, $this);
$preview->show();
$id = $this->profile->id;
$this->elementStart('form', array('id' => 'block-' . $id,
'method' => 'post',
'class' => 'form_settings form_entity_block',
'action' => common_local_url('block')));
$this->elementStart('fieldset');
$this->hidden('token', common_session_token());
// TRANS: Legend for block user form.
$this->element('legend', _('Block user'));
2020-07-31 14:35:27 +01:00
$this->element(
'p',
null,
// TRANS: Explanation of consequences when blocking a user on the block user page.
_('Are you sure you want to block this user? '
. 'Afterwards, they will be unsubscribed from you, '
. 'unable to subscribe to you in the future, and '
. 'you will not be notified of any @-replies from them.')
);
$this->element('input', [
'id' => 'blockto-' . $id,
'name' => 'profileid',
'type' => 'hidden',
'value' => $id
]);
foreach ($this->args as $k => $v) {
if (substr($k, 0, 9) == 'returnto-') {
$this->hidden($k, $v);
}
}
2020-07-31 14:35:27 +01:00
$this->submit(
'form_action-no',
// TRANS: Button label on the user block form.
_m('BUTTON', 'No'),
'submit form_action-primary',
'no',
// TRANS: Submit button title for 'No' when blocking a user.
_('Do not block this user.')
);
$this->submit(
'form_action-yes',
// TRANS: Button label on the user block form.
_m('BUTTON', 'Yes'),
'submit form_action-secondary',
'yes',
// TRANS: Submit button title for 'Yes' when blocking a user.
_('Block this user.')
);
$this->elementEnd('fieldset');
$this->elementEnd('form');
}
2009-01-22 06:02:23 +00:00
/**
* Actually block a user.
*
* @return void
*/
2020-07-31 14:35:27 +01:00
public function handlePost(): void
{
$cur = common_current_user();
2009-12-28 18:42:55 +00:00
if (Event::handle('StartBlockProfile', array($cur, $this->profile))) {
$result = $cur->block($this->profile);
if ($result) {
Event::handle('EndBlockProfile', array($cur, $this->profile));
}
}
if (!$result) {
// TRANS: Server error displayed when blocking a user fails.
$this->serverError(_('Failed to save block information.'));
}
}
2020-07-31 14:35:27 +01:00
public function showScripts(): void
{
parent::showScripts();
$this->autofocus('form_action-yes');
}
/**
* Override for form session token checks; on our first hit we're just
* requesting confirmation, which doesn't need a token. We need to be
* able to take regular GET requests from email!
*
* @throws ClientException if token is bad on POST request or if we have
* confirmation parameters which could trigger something.
*/
2020-07-31 14:35:27 +01:00
public function checkSessionToken(): void
{
2020-07-31 14:35:27 +01:00
if (
$_SERVER['REQUEST_METHOD'] === 'POST'
|| $this->arg('yes')
|| $this->arg('no')
) {
parent::checkSessionToken();
}
}
/**
* If we reached this form without returnto arguments, return to the
* current user's subscription list.
*
* @return string URL
*/
2020-07-31 14:35:27 +01:00
public function defaultReturnTo()
{
$user = common_current_user();
if ($user) {
2020-07-31 14:35:27 +01:00
return common_local_url(
'subscribers',
['nickname' => $user->nickname]
);
} else {
return common_local_url('public');
}
}
}