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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?php
/**
* API module for marking translations as reviewed
* @file
* @author Niklas Laxström
* @license GPL-2.0+
*/
/**
* API module for marking translations as reviewed
*
* @ingroup API TranslateAPI
*/
class ApiTranslationReview extends ApiBase {
protected static $right = 'translate-messagereview';
public function execute() {
if ( !$this->getUser()->isAllowed( self::$right ) ) {
$this->dieUsage( 'Permission denied', 'permissiondenied' );
}
$params = $this->extractRequestParams();
$revision = Revision::newFromId( $params['revision'] );
if ( !$revision ) {
$this->dieUsage( 'Invalid revision', 'invalidrevision' );
}
$error = self::getReviewBlockers( $this->getUser(), $revision );
switch ( $error ) {
case '':
// Everything is okay
break;
case 'permissiondenied':
$this->dieUsage( 'Permission denied', $error );
break; // Unreachable, but throws off code analyzer.
case 'blocked':
$this->dieUsage( 'You have been blocked', $error );
break; // Unreachable, but throws off code analyzer.
case 'unknownmessage':
$this->dieUsage( 'Unknown message', $error );
break; // Unreachable, but throws off code analyzer.
case 'owntranslation':
$this->dieUsage( 'Cannot review own translations', $error );
break; // Unreachable, but throws off code analyzer.
case 'fuzzymessage':
$this->dieUsage( 'Cannot review fuzzy translations', $error );
break; // Unreachable, but throws off code analyzer.
default:
$this->dieUsage( 'Unknown error', $error );
}
$ok = self::doReview( $this->getUser(), $revision );
if ( !$ok ) {
$this->setWarning( 'Already marked as reviewed by you' );
}
$output = array( 'review' => array(
'title' => $revision->getTitle()->getPrefixedText(),
'pageid' => $revision->getPage(),
'revision' => $revision->getId()
) );
$this->getResult()->addValue( null, $this->getModuleName(), $output );
}
/**
* Executes the real stuff. No checks done!
* @param User $user
* @param Revision $revision
* @param null|string $comment
* @return Bool, whether the action was recorded.
*/
public static function doReview( User $user, Revision $revision, $comment = null ) {
$dbw = wfGetDB( DB_MASTER );
$table = 'translate_reviews';
$row = array(
'trr_user' => $user->getId(),
'trr_page' => $revision->getPage(),
'trr_revision' => $revision->getId(),
);
$options = array( 'IGNORE' );
$dbw->insert( $table, $row, __METHOD__, $options );
if ( !$dbw->affectedRows() ) {
return false;
}
$title = $revision->getTitle();
$entry = new ManualLogEntry( 'translationreview', 'message' );
$entry->setPerformer( $user );
$entry->setTarget( $title );
$entry->setComment( $comment );
$entry->setParameters( array(
'4::revision' => $revision->getId(),
) );
$logid = $entry->insert();
$entry->publish( $logid );
$handle = new MessageHandle( $title );
Hooks::run( 'TranslateEventTranslationReview', array( $handle ) );
return true;
}
/**
* Validates review action by checking permissions and other things.
* @param User $user
* @param Revision $revision
* @return string Error key or empty string if review is allowed.
* @since 2012-09-24
*/
public static function getReviewBlockers( User $user, Revision $revision ) {
if ( !$user->isAllowed( self::$right ) ) {
return 'permissiondenied';
}
if ( $user->isBlocked() ) {
return 'blocked';
}
$title = $revision->getTitle();
$handle = new MessageHandle( $title );
if ( !$handle->isValid() ) {
return 'unknownmessage';
}
if ( $revision->getUser() === $user->getId() ) {
return 'owntranslation';
}
if ( $handle->isFuzzy() ) {
return 'fuzzymessage';
}
return '';
}
public function isWriteMode() {
return true;
}
public function needsToken() {
return 'csrf';
}
public function getAllowedParams() {
return array(
'revision' => array(
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_REQUIRED => true,
),
'token' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
),
);
}
protected function getExamplesMessages() {
return array(
'action=translationreview&revision=1&token=foo'
=> 'apihelp-translationreview-example-1',
);
}
}
|
