Page MenuHomeWickedGov Phorge
Files F5967553

AbuseLogPrivateDetails.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

AbuseLogPrivateDetails.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
namespace MediaWiki\Extension\AbuseFilter\Api;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiMain;
use MediaWiki\Extension\AbuseFilter\AbuseFilterPermissionManager;
use MediaWiki\Extension\AbuseFilter\Special\SpecialAbuseLog;
use Wikimedia\ParamValidator\ParamValidator;
/**
* API module to allow accessing private details (the user's IP) from AbuseLog entries
*
* @ingroup API
* @ingroup Extensions
*/
class AbuseLogPrivateDetails extends ApiBase {
/** @var AbuseFilterPermissionManager */
private $afPermManager;
/**
* @param ApiMain $main
* @param string $action
* @param AbuseFilterPermissionManager $afPermManager
*/
public function __construct(
ApiMain $main,
$action,
AbuseFilterPermissionManager $afPermManager
) {
parent::__construct( $main, $action );
$this->afPermManager = $afPermManager;
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
public function mustBePosted() {
return true;
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
public function isWriteMode() {
return true;
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
public function needsToken() {
return 'csrf';
}
/**
* @inheritDoc
*/
public function execute() {
$user = $this->getUser();
if ( !$this->afPermManager->canSeePrivateDetails( $user ) ) {
$this->dieWithError( 'abusefilter-log-cannot-see-privatedetails' );
}
$params = $this->extractRequestParams();
if ( !SpecialAbuseLog::checkPrivateDetailsAccessReason( $params['reason'] ) ) {
// Double check, in case we add some extra validation
$this->dieWithError( 'abusefilter-noreason' );
}
$status = SpecialAbuseLog::getPrivateDetailsRow( $user, $params['logid'] );
if ( !$status->isGood() ) {
$this->dieStatus( $status );
}
$row = $status->getValue();
// Log accessing private details
if ( $this->getConfig()->get( 'AbuseFilterLogPrivateDetailsAccess' ) ) {
SpecialAbuseLog::addPrivateDetailsAccessLogEntry(
$params['logid'],
$params['reason'],
$user
);
}
$result = [
'log-id' => $params['logid'],
'user' => $row->afl_user_text,
'filter-id' => (int)$row->af_id,
'filter-description' => $row->af_public_comments,
'ip-address' => $row->afl_ip !== '' ? $row->afl_ip : null
];
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
public function getAllowedParams() {
return [
'logid' => [
ParamValidator::PARAM_TYPE => 'integer'
],
'reason' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => $this->getConfig()->get( 'AbuseFilterPrivateDetailsForceReason' ),
ParamValidator::PARAM_DEFAULT => '',
]
];
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
protected function getExamplesMessages() {
return [
'action=abuselogprivatedetails&logid=1&reason=example&token=ABC123'
=> 'apihelp-abuselogprivatedetails-example-1'
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 12:28 (2 d, 23 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
55/8e/05e908458efad8e6582697275c88
Default Alt Text
AbuseLogPrivateDetails.php (3 KB)

Event Timeline