1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
<?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'
];
}
}
|
