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
|
<?php
declare( strict_types = 1 );
namespace MediaWiki\Extension\Translate\Synchronization;
use ApiBase;
use ApiMain;
use Exception;
use FormatJson;
use MediaWiki\Logger\LoggerFactory;
use MessageGroups;
use Psr\Log\LoggerInterface;
/**
* Api module for managing group synchronization cache
* @ingroup API TranslateAPI
* @since 2021.03
* @author Abijeet Patro
* @license GPL-2.0-or-later
*/
class ManageGroupSynchronizationCacheActionApi extends ApiBase {
private const RIGHT = 'translate-manage';
private const VALID_OPS = [ 'resolveMessage', 'resolveGroup' ];
/** @var GroupSynchronizationCache */
private $groupSyncCache;
/** @var LoggerInterface */
private $groupSyncLog;
public function __construct( ApiMain $mainModule, $moduleName, GroupSynchronizationCache $groupSyncCache ) {
parent::__construct( $mainModule, $moduleName );
$this->groupSyncCache = $groupSyncCache;
$this->groupSyncLog = LoggerFactory::getInstance( 'Translate.GroupSynchronization' );
}
public function execute() {
$this->checkUserRightsAny( self::RIGHT );
$params = $this->extractRequestParams();
$operation = $params['operation'];
$groupId = $params['group'];
$titleStr = $params['title'] ?? null;
$group = MessageGroups::getGroup( $groupId );
if ( $group === null ) {
$this->dieWithError( 'apierror-translate-invalidgroup', 'invalidgroup' );
}
try {
if ( $operation === 'resolveMessage' ) {
if ( $titleStr === null ) {
$this->dieWithError( [ 'apierror-missingparam', 'title' ] );
}
$this->markAsResolved( $groupId, $titleStr );
} elseif ( $operation === 'resolveGroup' ) {
$this->markAsResolved( $groupId );
}
} catch ( Exception $e ) {
$data = [
'requestParams' => $params,
'exceptionMessage' => $e->getMessage()
];
$this->groupSyncLog->error(
"Error while running: ManageGroupSynchronizationCacheActionApi::execute. Details: \n" .
FormatJson::encode( $data, true )
);
$this->dieWithError(
[
'apierror-translate-operation-error',
wfEscapeWikiText( $e->getMessage() )
]
);
}
}
private function markAsResolved( string $groupId, ?string $messageTitle = null ): void {
if ( $messageTitle === null ) {
$currentGroupStatus = $this->groupSyncCache->markGroupAsResolved( $groupId );
$this->groupSyncLog->info(
'{user} resolved group {groupId}.',
[
'user' => $this->getUser()->getName(),
'groupId' => $groupId
]
);
} else {
$this->groupSyncCache->markMessageAsResolved( $groupId, $messageTitle );
$currentGroupStatus = $this->groupSyncCache->syncGroupErrors( $groupId );
$this->groupSyncLog->info(
'{user} resolved message {messageTitle} in group {groupId}.',
[
'user' => $this->getUser()->getName(),
'groupId' => $groupId,
'messageTitle' => $messageTitle
]
);
}
$this->getResult()->addValue( null, $this->getModuleName(), [
'success' => 1,
'data' => [
'groupRemainingMessageCount' => count( $currentGroupStatus->getRemainingMessages() )
]
] );
}
protected function getAllowedParams() {
return [
'operation' => [
ApiBase::PARAM_TYPE => self::VALID_OPS,
ApiBase::PARAM_ISMULTI => false,
ApiBase::PARAM_REQUIRED => true,
],
'title' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => false
],
'group' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true
]
];
}
public function isInternal() {
return true;
}
public function needsToken() {
return 'csrf';
}
}
|
GitWeb