3 * Provide things related to namespaces.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * This is a utility class with only static functions
25 * for dealing with namespaces that encodes all the
26 * "magic" behaviors of them based on index. The textual
27 * names of the namespaces are handled by Language.php.
29 * These are synonyms for the names given in the language file
30 * Users and translators should not change them
35 * These namespaces should always be first-letter capitalized, now and
36 * forevermore. Historically, they could've probably been lowercased too,
37 * but some things are just too ingrained now. :)
39 private static $alwaysCapitalizedNamespaces = [ NS_SPECIAL
, NS_USER
, NS_MEDIAWIKI
];
42 * Throw an exception when trying to get the subject or talk page
43 * for a given namespace where it does not make sense.
44 * Special namespaces are defined in includes/Defines.php and have
45 * a value below 0 (ex: NS_SPECIAL = -1 , NS_MEDIA = -2)
48 * @param string $method
53 private static function isMethodValidFor( $index, $method ) {
54 if ( $index < NS_MAIN
) {
55 throw new MWException( "$method does not make any sense for given namespace $index" );
61 * Can pages in the given namespace be moved?
63 * @param int $index Namespace index
66 public static function isMovable( $index ) {
67 global $wgAllowImageMoving;
69 $result = !( $index < NS_MAIN ||
( $index == NS_FILE
&& !$wgAllowImageMoving ) );
74 Hooks
::run( 'NamespaceIsMovable', [ $index, &$result ] );
80 * Is the given namespace is a subject (non-talk) namespace?
82 * @param int $index Namespace index
86 public static function isSubject( $index ) {
87 return !self
::isTalk( $index );
91 * Is the given namespace a talk namespace?
93 * @param int $index Namespace index
96 public static function isTalk( $index ) {
97 return $index > NS_MAIN
102 * Get the talk namespace index for a given namespace
104 * @param int $index Namespace index
107 public static function getTalk( $index ) {
108 self
::isMethodValidFor( $index, __METHOD__
);
109 return self
::isTalk( $index )
115 * Get the subject namespace index for a given namespace
116 * Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
118 * @param int $index Namespace index
121 public static function getSubject( $index ) {
122 # Handle special namespaces
123 if ( $index < NS_MAIN
) {
127 return self
::isTalk( $index )
133 * Get the associated namespace.
134 * For talk namespaces, returns the subject (non-talk) namespace
135 * For subject (non-talk) namespaces, returns the talk namespace
137 * @param int $index Namespace index
138 * @return int|null If no associated namespace could be found
140 public static function getAssociated( $index ) {
141 self
::isMethodValidFor( $index, __METHOD__
);
143 if ( self
::isSubject( $index ) ) {
144 return self
::getTalk( $index );
145 } elseif ( self
::isTalk( $index ) ) {
146 return self
::getSubject( $index );
153 * Returns whether the specified namespace exists
160 public static function exists( $index ) {
161 $nslist = self
::getCanonicalNamespaces();
162 return isset( $nslist[$index] );
166 * Returns whether the specified namespaces are the same namespace
168 * @note It's possible that in the future we may start using something
169 * other than just namespace indexes. Under that circumstance making use
170 * of this function rather than directly doing comparison will make
171 * sure that code will not potentially break.
173 * @param int $ns1 The first namespace index
174 * @param int $ns2 The second namespace index
179 public static function equals( $ns1, $ns2 ) {
184 * Returns whether the specified namespaces share the same subject.
185 * eg: NS_USER and NS_USER wil return true, as well
186 * NS_USER and NS_USER_TALK will return true.
188 * @param int $ns1 The first namespace index
189 * @param int $ns2 The second namespace index
194 public static function subjectEquals( $ns1, $ns2 ) {
195 return self
::getSubject( $ns1 ) == self
::getSubject( $ns2 );
199 * Returns array of all defined namespaces with their canonical
202 * @param bool $rebuild Rebuild namespace list (default = false). Used for testing.
207 public static function getCanonicalNamespaces( $rebuild = false ) {
208 static $namespaces = null;
209 if ( $namespaces === null ||
$rebuild ) {
210 global $wgExtraNamespaces, $wgCanonicalNamespaceNames;
211 $namespaces = [ NS_MAIN
=> '' ] +
$wgCanonicalNamespaceNames;
212 // Add extension namespaces
213 $namespaces +
= ExtensionRegistry
::getInstance()->getAttribute( 'ExtensionNamespaces' );
214 if ( is_array( $wgExtraNamespaces ) ) {
215 $namespaces +
= $wgExtraNamespaces;
217 Hooks
::run( 'CanonicalNamespaces', [ &$namespaces ] );
223 * Returns the canonical (English) name for a given index
225 * @param int $index Namespace index
226 * @return string|bool If no canonical definition.
228 public static function getCanonicalName( $index ) {
229 $nslist = self
::getCanonicalNamespaces();
230 if ( isset( $nslist[$index] ) ) {
231 return $nslist[$index];
238 * Returns the index for a given canonical name, or NULL
239 * The input *must* be converted to lower case first
241 * @param string $name Namespace name
244 public static function getCanonicalIndex( $name ) {
245 static $xNamespaces = false;
246 if ( $xNamespaces === false ) {
248 foreach ( self
::getCanonicalNamespaces() as $i => $text ) {
249 $xNamespaces[strtolower( $text )] = $i;
252 if ( array_key_exists( $name, $xNamespaces ) ) {
253 return $xNamespaces[$name];
260 * Returns an array of the namespaces (by integer id) that exist on the
261 * wiki. Used primarily by the api in help documentation.
264 public static function getValidNamespaces() {
265 static $mValidNamespaces = null;
267 if ( is_null( $mValidNamespaces ) ) {
268 foreach ( array_keys( self
::getCanonicalNamespaces() ) as $ns ) {
270 $mValidNamespaces[] = $ns;
273 // T109137: sort numerically
274 sort( $mValidNamespaces, SORT_NUMERIC
);
277 return $mValidNamespaces;
281 * Does this namespace ever have a talk namespace?
283 * @deprecated since 1.30, use hasTalkNamespace() instead.
285 * @param int $index Namespace index
286 * @return bool True if this namespace either is or has a corresponding talk namespace.
288 public static function canTalk( $index ) {
289 return self
::hasTalkNamespace( $index );
293 * Does this namespace ever have a talk namespace?
297 * @param int $index Namespace ID
298 * @return bool True if this namespace either is or has a corresponding talk namespace.
300 public static function hasTalkNamespace( $index ) {
301 return $index >= NS_MAIN
;
305 * Does this namespace contain content, for the purposes of calculating
308 * @param int $index Index to check
311 public static function isContent( $index ) {
312 global $wgContentNamespaces;
313 return $index == NS_MAIN ||
in_array( $index, $wgContentNamespaces );
317 * Might pages in this namespace require the use of the Signature button on
320 * @param int $index Index to check
323 public static function wantSignatures( $index ) {
324 global $wgExtraSignatureNamespaces;
325 return self
::isTalk( $index ) ||
in_array( $index, $wgExtraSignatureNamespaces );
329 * Can pages in a namespace be watched?
334 public static function isWatchable( $index ) {
335 return $index >= NS_MAIN
;
339 * Does the namespace allow subpages?
341 * @param int $index Index to check
344 public static function hasSubpages( $index ) {
345 global $wgNamespacesWithSubpages;
346 return !empty( $wgNamespacesWithSubpages[$index] );
350 * Get a list of all namespace indices which are considered to contain content
351 * @return array Array of namespace indices
353 public static function getContentNamespaces() {
354 global $wgContentNamespaces;
355 if ( !is_array( $wgContentNamespaces ) ||
$wgContentNamespaces === [] ) {
357 } elseif ( !in_array( NS_MAIN
, $wgContentNamespaces ) ) {
358 // always force NS_MAIN to be part of array (to match the algorithm used by isContent)
359 return array_merge( [ NS_MAIN
], $wgContentNamespaces );
361 return $wgContentNamespaces;
366 * List all namespace indices which are considered subject, aka not a talk
367 * or special namespace. See also MWNamespace::isSubject
369 * @return array Array of namespace indices
371 public static function getSubjectNamespaces() {
373 self
::getValidNamespaces(),
374 'MWNamespace::isSubject'
379 * List all namespace indices which are considered talks, aka not a subject
380 * or special namespace. See also MWNamespace::isTalk
382 * @return array Array of namespace indices
384 public static function getTalkNamespaces() {
386 self
::getValidNamespaces(),
387 'MWNamespace::isTalk'
392 * Is the namespace first-letter capitalized?
394 * @param int $index Index to check
397 public static function isCapitalized( $index ) {
398 global $wgCapitalLinks, $wgCapitalLinkOverrides;
399 // Turn NS_MEDIA into NS_FILE
400 $index = $index === NS_MEDIA ? NS_FILE
: $index;
402 // Make sure to get the subject of our namespace
403 $index = self
::getSubject( $index );
405 // Some namespaces are special and should always be upper case
406 if ( in_array( $index, self
::$alwaysCapitalizedNamespaces ) ) {
409 if ( isset( $wgCapitalLinkOverrides[$index] ) ) {
410 // $wgCapitalLinkOverrides is explicitly set
411 return $wgCapitalLinkOverrides[$index];
413 // Default to the global setting
414 return $wgCapitalLinks;
418 * Does the namespace (potentially) have different aliases for different
419 * genders. Not all languages make a distinction here.
422 * @param int $index Index to check
425 public static function hasGenderDistinction( $index ) {
426 return $index == NS_USER ||
$index == NS_USER_TALK
;
430 * It is not possible to use pages from this namespace as template?
433 * @param int $index Index to check
436 public static function isNonincludable( $index ) {
437 global $wgNonincludableNamespaces;
438 return $wgNonincludableNamespaces && in_array( $index, $wgNonincludableNamespaces );
442 * Get the default content model for a namespace
443 * This does not mean that all pages in that namespace have the model
446 * @param int $index Index to check
447 * @return null|string Default model name for the given namespace, if set
449 public static function getNamespaceContentModel( $index ) {
450 global $wgNamespaceContentModels;
451 return isset( $wgNamespaceContentModels[$index] )
452 ?
$wgNamespaceContentModels[$index]
457 * Determine which restriction levels it makes sense to use in a namespace,
458 * optionally filtered by a user's rights.
461 * @param int $index Index to check
462 * @param User $user User to check
465 public static function getRestrictionLevels( $index, User
$user = null ) {
466 global $wgNamespaceProtection, $wgRestrictionLevels;
468 if ( !isset( $wgNamespaceProtection[$index] ) ) {
469 // All levels are valid if there's no namespace restriction.
470 // But still filter by user, if necessary
471 $levels = $wgRestrictionLevels;
473 $levels = array_values( array_filter( $levels, function ( $level ) use ( $user ) {
475 if ( $right == 'sysop' ) {
476 $right = 'editprotected'; // BC
478 if ( $right == 'autoconfirmed' ) {
479 $right = 'editsemiprotected'; // BC
481 return ( $right == '' ||
$user->isAllowed( $right ) );
487 // First, get the list of groups that can edit this namespace.
488 $namespaceGroups = [];
489 $combine = 'array_merge';
490 foreach ( (array)$wgNamespaceProtection[$index] as $right ) {
491 if ( $right == 'sysop' ) {
492 $right = 'editprotected'; // BC
494 if ( $right == 'autoconfirmed' ) {
495 $right = 'editsemiprotected'; // BC
497 if ( $right != '' ) {
498 $namespaceGroups = call_user_func( $combine, $namespaceGroups,
499 User
::getGroupsWithPermission( $right ) );
500 $combine = 'array_intersect';
504 // Now, keep only those restriction levels where there is at least one
505 // group that can edit the namespace but would be blocked by the
507 $usableLevels = [ '' ];
508 foreach ( $wgRestrictionLevels as $level ) {
510 if ( $right == 'sysop' ) {
511 $right = 'editprotected'; // BC
513 if ( $right == 'autoconfirmed' ) {
514 $right = 'editsemiprotected'; // BC
516 if ( $right != '' && ( !$user ||
$user->isAllowed( $right ) ) &&
517 array_diff( $namespaceGroups, User
::getGroupsWithPermission( $right ) )
519 $usableLevels[] = $level;
523 return $usableLevels;