-
Notifications
You must be signed in to change notification settings - Fork 4
/
ApiEditSlot.php
160 lines (146 loc) · 3.35 KB
/
ApiEditSlot.php
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
<?php
namespace WSSlots\API;
use ApiBase;
use ApiUsageException;
use MediaWiki\Revision\SlotRecord;
use MWContentSerializationException;
use MWException;
use Wikimedia\ParamValidator\ParamValidator;
use WSSlots\Logger;
use WSSlots\WSSlots;
/**
* A slot-aware module that allows for editing and creating pages.
*/
class ApiEditSlot extends ApiBase {
/**
* @inheritDoc
*
* @throws ApiUsageException
* @throws MWContentSerializationException
* @throws MWException
*/
public function execute() {
$this->useTransactionalTimeLimit();
$user = $this->getUser();
$params = $this->extractRequestParams();
$wikiPage = $this->getTitleOrPageId( $params );
$title = $wikiPage->getTitle();
// Check if we are allowed to edit or create this page
$this->checkTitleUserPermissions(
$title,
$title->exists() ? 'edit' : [ 'edit', 'create' ],
[ 'autoblock' => true ]
);
$result = WSSlots::editSlot(
$user,
$wikiPage,
$params["text"] ?? "",
$params["slot"],
$params["summary"],
$params["append"],
$params["watchlist"],
$params["prepend"],
$params["bot"],
$params["minor"],
$params["createonly"],
$params["nocreate"],
$params["suppress"]
);
if ( $result !== true ) {
[ $message, $code ] = $result;
Logger::getLogger()->alert( 'Editing slot failed while performing edit through the "editslot" API: {message}', [
'message' => $message
] );
$this->dieWithError( $message, $code );
}
}
/**
* @inheritDoc
*/
public function mustBePosted(): bool {
return true;
}
/**
* @inheritDoc
*/
public function isWriteMode(): bool {
return true;
}
/**
* @inheritDoc
*/
public function getAllowedParams(): array {
return [
'title' => [
ParamValidator::PARAM_TYPE => 'string'
],
'pageid' => [
ParamValidator::PARAM_TYPE => 'integer'
],
'text' => [
ParamValidator::PARAM_TYPE => 'text'
],
'slot' => [
ParamValidator::PARAM_TYPE => 'text',
ParamValidator::PARAM_DEFAULT => SlotRecord::MAIN
],
'append' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
],
'prepend' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
],
'summary' => [
ParamValidator::PARAM_TYPE => 'text',
ParamValidator::PARAM_DEFAULT => ""
],
'watchlist' => [
ParamValidator::PARAM_TYPE => [
'watch',
'unwatch',
'preferences',
'nochange',
],
ParamValidator::PARAM_DEFAULT => "nochange",
],
'bot' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
],
'minor' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
],
'createonly' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
],
'nocreate' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
],
'suppress' => [
ParamValidator::PARAM_TYPE => 'boolean',
ParamValidator::PARAM_DEFAULT => false
]
];
}
/**
* @inheritDoc
*/
public function needsToken(): string {
return 'csrf';
}
/**
* @inheritDoc
*/
protected function getExamplesMessages(): array {
return [
'action=editslot&title=Test&summary=test%20summary&' .
'text=article%20content&token=123ABC'
=> 'apihelp-edit-example-edit'
];
}
}