X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FNamespace.php;h=0883011fc0dad46f0c404dcf9a5d9097ebc9ec01;hb=bbb0d379b9abfcd9a2f4573f1afbe2f85eb35155;hp=bba5deb3df31266c649fd86f15fa2e35560307a8;hpb=62e98ad47cc61745473907f407146cb56c0947c8;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/Namespace.php b/includes/Namespace.php
index bba5deb3df..0883011fc0 100644
--- a/includes/Namespace.php
+++ b/includes/Namespace.php
@@ -1,111 +1,312 @@
 <?php
-if( defined( "MEDIAWIKI" ) ) {
-
-# This is a utility class with only static functions
-# for dealing with namespaces that encodes all the
-# "magic" behaviors of them based on index.  The textual
-# names of the namespaces are handled by Language.php.
-
-# Definitions of the NS_ constants are in Defines.php
-
-# These are synonyms for the names given in the language file
-# Users and translators should not change them
-/* private */ $wgCanonicalNamespaceNames = array(
-	NS_MEDIA            => "Media",
-	NS_SPECIAL          => "Special",
-	NS_TALK	            => "Talk",
-	NS_USER             => "User",
-	NS_USER_TALK        => "User_talk",
-	NS_WIKIPEDIA        => "Project",
-	NS_WIKIPEDIA_TALK   => "Project_talk",
-	NS_IMAGE            => "Image",
-	NS_IMAGE_TALK       => "Image_talk",
-	NS_MEDIAWIKI        => "MediaWiki",
-	NS_MEDIAWIKI_TALK   => "MediaWiki_talk",
-	NS_TEMPLATE         => "Template",
-	NS_TEMPLATE_TALK    => "Template_talk",
-	NS_HELP             => "Help",
-	NS_HELP_TALK        => "Help_talk",
-	NS_CATEGORY	    => "Category",
-	NS_CATEGORY_TALK    => "Category_talk"
-);
-
-class Namespace {
-
-	/* These functions are deprecated */
-	function getSpecial() { return NS_SPECIAL; }
-	function getUser() { return NS_USER; }
-	function getWikipedia() { return NS_WP; }
-	function getImage() { return NS_IMAGE; }
-	function getMedia() { return NS_MEDIA; }
-	function getCategory() { return NS_CATEGORY; }
-
-	function isMovable( $index )
-	{
-		if ( $index < NS_MAIN || $index == NS_IMAGE  || $index == NS_CATEGORY ) { 
-			return false; 
+/**
+ * Provide things related to namespaces
+ * @file
+ */
+
+/**
+ * This is a utility class with only static functions
+ * for dealing with namespaces that encodes all the
+ * "magic" behaviors of them based on index.  The textual
+ * names of the namespaces are handled by Language.php.
+ *
+ * These are synonyms for the names given in the language file
+ * Users and translators should not change them
+ *
+ */
+
+class MWNamespace {
+
+	/**
+	 * These namespaces should always be first-letter capitalized, now and
+	 * forevermore. Historically, they could've probably been lowercased too,
+	 * but some things are just too ingrained now. :)
+	 */
+	private static $alwaysCapitalizedNamespaces = array( NS_SPECIAL, NS_USER, NS_MEDIAWIKI );
+
+	/**
+	 * Throw an exception when trying to get the subject or talk page
+	 * for a given namespace where it does not make sense.
+	 * Special namespaces are defined in includes/Defines.php and have
+	 * a value below 0 (ex: NS_SPECIAL = -1 , NS_MEDIA = -2)
+	 *
+	 * @param $index
+	 * @param $method
+	 *
+	 * @return true
+	 */
+	private static function isMethodValidFor( $index, $method ) {
+		if( $index < NS_MAIN ) {
+			throw new MWException( "$method does not make any sense for given namespace $index" );
 		}
 		return true;
 	}
 
-	function isTalk( $index )
-	{
-		if ( NS_TALK == $index || NS_USER_TALK == $index || NS_WP_TALK
-	== $index || NS_IMAGE_TALK == $index || NS_MEDIAWIKI_TALK == $index ||
-	NS_TEMPLATE_TALK == $index || NS_HELP_TALK == $index ||
-	NS_CATEGORY_TALK == $index ) {
-			return true;
-		}
-		return false;
+	/**
+	 * Can pages in the given namespace be moved?
+	 *
+	 * @param $index Int: namespace index
+	 * @return bool
+	 */
+	public static function isMovable( $index ) {
+		global $wgAllowImageMoving;
+		return !( $index < NS_MAIN || ($index == NS_FILE && !$wgAllowImageMoving)  || $index == NS_CATEGORY );
 	}
 
-	# Get the talk namespace corresponding to the given index
-	#
-	function getTalk( $index )
-	{
-		if ( Namespace::isTalk( $index ) ) {
+	/**
+	 * Is the given namespace is a subject (non-talk) namespace?
+	 *
+	 * @param $index Int: namespace index
+	 * @return bool
+	 */
+	public static function isMain( $index ) {
+		return !self::isTalk( $index );
+	}
+
+	/**
+	 * Is the given namespace a talk namespace?
+	 *
+	 * @param $index Int: namespace index
+	 * @return bool
+	 */
+	public static function isTalk( $index ) {
+		return $index > NS_MAIN
+			&& $index % 2;
+	}
+
+	/**
+	 * Get the talk namespace index for a given namespace
+	 *
+	 * @param $index Int: namespace index
+	 * @return int
+	 */
+	public static function getTalk( $index ) {
+		self::isMethodValidFor( $index, __METHOD__ );
+		return self::isTalk( $index )
+			? $index
+			: $index + 1;
+	}
+
+	/**
+	 * Get the subject namespace index for a given namespace
+	 * Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
+	 *
+	 * @param $index Int: Namespace index
+	 * @return int
+	 */
+	public static function getSubject( $index ) {
+		# Handle special namespaces
+		if( $index < NS_MAIN ) {
 			return $index;
-		} else {
-			# FIXME
-			return $index + 1;
 		}
+
+		return self::isTalk( $index )
+			? $index - 1
+			: $index;
 	}
 
-	function getSubject( $index )
-	{
-		if ( Namespace::isTalk( $index ) ) {
-			return $index - 1;
+	/**
+	 * Get the associated namespace.
+	 * For talk namespaces, returns the subject (non-talk) namespace
+	 * For subject (non-talk) namespaces, returns the talk namespace
+	 *
+	 * @param $index Int: namespace index
+	 * @return int or null if no associated namespace could be found
+	 */
+	public static function getAssociated( $index ) {
+		self::isMethodValidFor( $index, __METHOD__ );
+
+		if( self::isMain( $index ) ) {
+			return self::getTalk( $index );
+		} elseif( self::isTalk( $index ) ) {
+			return self::getSubject( $index );
 		} else {
-			return $index;
+			return null;
+		}
+	}
+
+	/**
+	 * Returns whether the specified namespace exists
+	 *
+	 * @param $index
+	 * 
+	 * @return bool
+	 */
+	public static function exists( $index ) {
+		$nslist = self::getCanonicalNamespaces();
+		return isset( $nslist[$index] );
+	}
+
+	/**
+	 * Returns array of all defined namespaces with their canonical
+	 * (English) names.
+	 *
+	 * @return \array
+	 * @since 1.17
+	 */
+	public static function getCanonicalNamespaces() {
+		static $namespaces = null;
+		if ( $namespaces === null ) {
+			global $wgExtraNamespaces, $wgCanonicalNamespaceNames;
+			$namespaces = array( NS_MAIN => '' ) + $wgCanonicalNamespaceNames;
+			if ( is_array( $wgExtraNamespaces ) ) {
+				$namespaces += $wgExtraNamespaces;
+			}
+			wfRunHooks( 'CanonicalNamespaces', array( &$namespaces ) );
 		}
+		return $namespaces;
 	}
 
-	# Returns the canonical (English Wikipedia) name for a given index
-	function &getCanonicalName( $index )
-	{
-		global $wgCanonicalNamespaceNames;
-		return $wgCanonicalNamespaceNames[$index];
+	/**
+	 * Returns the canonical (English) name for a given index
+	 *
+	 * @param $index Int: namespace index
+	 * @return string or false if no canonical definition.
+	 */
+	public static function getCanonicalName( $index ) {
+		$nslist = self::getCanonicalNamespaces();
+		if( isset( $nslist[$index] ) ) {
+			return $nslist[$index];
+		} else {
+			return false;
+		}
 	}
 
-	# Returns the index for a given canonical name, or NULL
-	# The input *must* be converted to lower case first
-	function &getCanonicalIndex( $name )
-	{
-		global $wgCanonicalNamespaceNames;
+	/**
+	 * Returns the index for a given canonical name, or NULL
+	 * The input *must* be converted to lower case first
+	 *
+	 * @param $name String: namespace name
+	 * @return int
+	 */
+	public static function getCanonicalIndex( $name ) {
 		static $xNamespaces = false;
 		if ( $xNamespaces === false ) {
 			$xNamespaces = array();
-			foreach ( $wgCanonicalNamespaceNames as $i => $text ) {
+			foreach ( self::getCanonicalNamespaces() as $i => $text ) {
 				$xNamespaces[strtolower($text)] = $i;
 			}
 		}
 		if ( array_key_exists( $name, $xNamespaces ) ) {
 			return $xNamespaces[$name];
 		} else {
-			return NULL;
+			return null;
 		}
 	}
-}
+
+	/**
+	 * Returns an array of the namespaces (by integer id) that exist on the
+	 * wiki. Used primarily by the api in help documentation.
+	 * @return array
+	 */
+	public static function getValidNamespaces() {
+		static $mValidNamespaces = null;
+
+		if ( is_null( $mValidNamespaces ) ) {
+			foreach ( array_keys( self::getCanonicalNamespaces() ) as $ns ) {
+				if ( $ns >= 0 ) {
+					$mValidNamespaces[] = $ns;
+				}
+			}
+		}
+
+		return $mValidNamespaces;
+	}
+
+	/**
+	 * Can this namespace ever have a talk namespace?
+	 *
+	 * @param $index Int: namespace index
+	 * @return bool
+	 */
+	 public static function canTalk( $index ) {
+		return $index >= NS_MAIN;
+	 }
+
+	/**
+	 * Does this namespace contain content, for the purposes of calculating
+	 * statistics, etc?
+	 *
+	 * @param $index Int: index to check
+	 * @return bool
+	 */
+	public static function isContent( $index ) {
+		global $wgContentNamespaces;
+		return $index == NS_MAIN || in_array( $index, $wgContentNamespaces );
+	}
+
+	/**
+	 * Can pages in a namespace be watched?
+	 *
+	 * @param $index Int
+	 * @return bool
+	 */
+	public static function isWatchable( $index ) {
+		return $index >= NS_MAIN;
+	}
+
+	/**
+	 * Does the namespace allow subpages?
+	 *
+	 * @param $index int Index to check
+	 * @return bool
+	 */
+	public static function hasSubpages( $index ) {
+		global $wgNamespacesWithSubpages;
+		return !empty( $wgNamespacesWithSubpages[$index] );
+	}
+
+	/**
+	 * Get a list of all namespace indices which are considered to contain content
+	 * @return array of namespace indices
+	 */
+	public static function getContentNamespaces() {
+		global $wgContentNamespaces;
+		if( !is_array( $wgContentNamespaces ) || $wgContentNamespaces === array() ) {
+			return NS_MAIN;
+		} elseif ( !in_array( NS_MAIN, $wgContentNamespaces ) ) {
+			// always force NS_MAIN to be part of array (to match the algorithm used by isContent)
+			return array_merge( array( NS_MAIN ), $wgContentNamespaces );
+		} else {
+			return $wgContentNamespaces;
+		}
+	}
+	/**
+	 * Is the namespace first-letter capitalized?
+	 *
+	 * @param $index int Index to check
+	 * @return bool
+	 */
+	public static function isCapitalized( $index ) {
+		global $wgCapitalLinks, $wgCapitalLinkOverrides;
+		// Turn NS_MEDIA into NS_FILE
+		$index = $index === NS_MEDIA ? NS_FILE : $index;
+
+		// Make sure to get the subject of our namespace
+		$index = self::getSubject( $index );
+
+		// Some namespaces are special and should always be upper case
+		if ( in_array( $index, self::$alwaysCapitalizedNamespaces ) ) {
+			return true;
+		}
+		if ( isset( $wgCapitalLinkOverrides[ $index ] ) ) {
+			// $wgCapitalLinkOverrides is explicitly set
+			return $wgCapitalLinkOverrides[ $index ];
+		}
+		// Default to the global setting
+		return $wgCapitalLinks;
+	}
+
+	/**
+	 * Does the namespace (potentially) have different aliases for different
+	 * genders. Not all languages make a distinction here.
+	 *
+	 * @since 1.18
+	 * @param $index int Index to check
+	 * @return bool
+	 */
+	public static function hasGenderDistinction( $index ) {
+		return $index == NS_USER || $index == NS_USER_TALK;
+	}
 
 }
-?>