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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<?php
/**
* This file is part of MediaWiki.
*
* 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
*
* @file
*/
namespace MediaWiki\Revision;
use InvalidArgumentException;
use LogicException;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Storage\NameTableStore;
use Wikimedia\Assert\Assert;
/**
* A registry service for SlotRoleHandlers, used to define which slot roles are available on
* which page.
*
* Extensions may use the SlotRoleRegistry to register the slots they define.
*
* In the context of the SlotRoleRegistry, it is useful to distinguish between "defined" and "known"
* slot roles: A slot role is "defined" if defineRole() or defineRoleWithModel() was called for
* that role. A slot role is "known" if the NameTableStore provided to the constructor as the
* $roleNamesStore parameter has an ID associated with that role, which essentially means that
* the role at some point has been used on the wiki. Roles that are not "defined" but are
* "known" typically belong to extensions that used to be installed on the wiki, but no longer are.
* Such slots should be considered ok for display and administrative operations, but only "defined"
* slots should be supported for editing.
*
* @since 1.33
*/
class SlotRoleRegistry {
private NameTableStore $roleNamesStore;
/** @var array<string,callable> */
private array $instantiators = [];
/** @var array<string,SlotRoleHandler> */
private array $handlers = [];
public function __construct( NameTableStore $roleNamesStore ) {
$this->roleNamesStore = $roleNamesStore;
}
/**
* Defines a slot role.
*
* For use by extensions that wish to define roles beyond the main slot role.
*
* @see defineRoleWithModel()
*
* @param string $role The role name of the slot to define. This should follow the
* same convention as message keys:
* @param callable $instantiator called with $role as a parameter;
* Signature: function ( string $role ): SlotRoleHandler
*/
public function defineRole( string $role, callable $instantiator ): void {
$role = strtolower( $role );
if ( isset( $this->instantiators[$role] ) ) {
throw new LogicException( "Role $role is already defined" );
}
$this->instantiators[$role] = $instantiator;
}
/**
* Defines a slot role that allows only the given content model, and has no special
* behavior.
*
* For use by extensions that wish to define roles beyond the main slot role, but have
* no need to implement any special behavior for that slot.
*
* @see defineRole()
*
* @param string $role The role name of the slot to define, see defineRole()
* for more information.
* @param string $model A content model name, see ContentHandler
* @param array $layout See SlotRoleHandler getOutputLayoutHints
* @param bool $derived see SlotRoleHandler constructor
* @since 1.36 optional $derived parameter added
*/
public function defineRoleWithModel(
string $role,
string $model,
array $layout = [],
bool $derived = false
): void {
$this->defineRole(
$role,
static function ( $role ) use ( $model, $layout, $derived ) {
return new SlotRoleHandler( $role, $model, $layout, $derived );
}
);
}
/**
* Gets the SlotRoleHandler that should be used when processing content of the given role.
*
* @param string $role
*
* @throws InvalidArgumentException If $role is not a known slot role.
* @return SlotRoleHandler The handler to be used for $role. This may be a
* FallbackSlotRoleHandler if the slot is "known" but not "defined".
*/
public function getRoleHandler( string $role ): SlotRoleHandler {
$role = strtolower( $role );
if ( !isset( $this->handlers[$role] ) ) {
if ( !isset( $this->instantiators[$role] ) ) {
if ( $this->isKnownRole( $role ) ) {
// The role has no handler defined, but is represented in the database.
// This may happen e.g. when the extension that defined the role was uninstalled.
wfWarn( __METHOD__ . ": known but undefined slot role $role" );
$this->handlers[$role] = new FallbackSlotRoleHandler( $role );
} else {
// The role doesn't have a handler defined, and is not represented in
// the database. Something must be quite wrong.
throw new InvalidArgumentException( "Unknown role $role" );
}
} else {
$handler = $this->instantiators[$role]( $role );
Assert::postcondition(
$handler instanceof SlotRoleHandler,
"Instantiator for $role role must return a SlotRoleHandler"
);
$this->handlers[$role] = $handler;
}
}
return $this->handlers[$role];
}
/**
* Returns the list of roles allowed when creating a new revision on the given page.
* The choice should not depend on external state, such as the page content.
* Note that existing revisions of that page are not guaranteed to comply with this list.
*
* All implementations of this method are required to return at least all "required" roles.
*
* @param PageIdentity $page
*
* @return string[]
*/
public function getAllowedRoles( PageIdentity $page ): array {
// TODO: allow this to be overwritten per namespace (or page type)
// TODO: decide how to control which slots are offered for editing by default (T209927)
return $this->getDefinedRoles();
}
/**
* Returns the list of roles required when creating a new revision on the given page.
* The should not depend on external state, such as the page content.
* Note that existing revisions of that page are not guaranteed to comply with this list.
*
* All required roles are implicitly considered "allowed", so any roles
* returned by this method will also be returned by getAllowedRoles().
*
* @param PageIdentity $page
*
* @return string[]
*/
public function getRequiredRoles( PageIdentity $page ): array {
// TODO: allow this to be overwritten per namespace (or page type)
return [ SlotRecord::MAIN ];
}
/**
* Returns the list of roles defined by calling defineRole().
*
* This list should be used when enumerating slot roles that can be used for editing.
*
* @return string[]
*/
public function getDefinedRoles(): array {
return array_keys( $this->instantiators );
}
/**
* Returns the list of known roles, including the ones returned by getDefinedRoles(),
* and roles that exist according to the NameTableStore provided to the constructor.
*
* This list should be used when enumerating slot roles that can be used in queries or
* for display.
*
* @return string[]
*/
public function getKnownRoles(): array {
return array_unique( array_merge(
$this->getDefinedRoles(),
$this->roleNamesStore->getMap()
) );
}
/**
* Whether the given role is defined, that is, it was defined by calling defineRole().
*/
public function isDefinedRole( string $role ): bool {
$role = strtolower( $role );
return isset( $this->instantiators[$role] );
}
/**
* Whether the given role is known, that is, it's either defined or exist according to
* the NameTableStore provided to the constructor.
*/
public function isKnownRole( string $role ): bool {
$role = strtolower( $role );
return in_array( $role, $this->getKnownRoles(), true );
}
}
|
