From: Daniel Friesen <dantman@users.mediawiki.org>
Date: Mon, 12 Dec 2011 19:19:23 +0000 (+0000)
Subject: Replace get{Local,Full,Link,Canonical}URL's $variant argument with a secondary $query... 
X-Git-Tag: 1.31.0-rc.0~26035
X-Git-Url: http://git.cyclocoop.org/%24image?a=commitdiff_plain;h=42e8b0a8e7b1288b232ea6d212b5e4da803847b0;p=lhc%2Fweb%2Fwiklou.git

Replace get{Local,Full,Link,Canonical}URL's $variant argument with a secondary $query argument and treat variant paths like we do action paths.
---

diff --git a/docs/hooks.txt b/docs/hooks.txt
index 198953f140..e16b4c2125 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -914,7 +914,6 @@ $out: OutputPage object
 $title: Title object of page
 $url: string value as output (out parameter, can modify)
 $query: query options passed to Title::getCanonicalURL()
-$variant: variant passed to Title::getCanonicalURL()
 
 'GetDefaultSortkey': Override the default sortkey for a page.
 $title: Title object that we need to get a sortkey for
@@ -924,13 +923,11 @@ $title: Title object that we need to get a sortkey for
 $title: Title object of page
 $url: string value as output (out parameter, can modify)
 $query: query options passed to Title::getFullURL()
-$variant: variant passed to Title::getFullURL()
 
 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
 $title: Title object of page
 $url: string value as output (out parameter, can modify)
 $query: query options passed to Title::getInternalURL()
-$variant: variant passed to Title::getFullURL()
 
 'GetIP': modify the ip of the current user (called only once)
 &$ip: string holding the ip as determined so far
@@ -949,13 +946,11 @@ $linkcolour_ids: array of prefixed DB keys of the pages linked to,
 $title: Title object of page
 &$url: string value as output (out parameter, can modify)
 $query: query options passed to Title::getLocalURL()
-$variant: variant passed to Title::getLocalURL()
 
 'GetLocalURL::Internal': modify local URLs to internal pages.
 $title: Title object of page
 &$url: string value as output (out parameter, can modify)
 $query: query options passed to Title::getLocalURL()
-$variant: variant passed to Title::getLocalURL()
 
 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
 	without any fancy queries or variants.
diff --git a/includes/OutputPage.php b/includes/OutputPage.php
index 565b9bac86..5d17ec1417 100644
--- a/includes/OutputPage.php
+++ b/includes/OutputPage.php
@@ -3009,7 +3009,7 @@ $templates
 						$tags[] = Html::element( 'link', array(
 							'rel' => 'alternate',
 							'hreflang' => $_v,
-							'href' => $this->getTitle()->getLocalURL( '', $_v ) )
+							'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
 						);
 					}
 				} else {
diff --git a/includes/SkinTemplate.php b/includes/SkinTemplate.php
index cd2b387193..b7f3e2577d 100644
--- a/includes/SkinTemplate.php
+++ b/includes/SkinTemplate.php
@@ -1009,7 +1009,7 @@ class SkinTemplate extends Skin {
 						$content_navigation['variants'][] = array(
 							'class' => ( $code == $preferred ) ? 'selected' : false,
 							'text' => $varname,
-							'href' => $title->getLocalURL( '', $code )
+							'href' => $title->getLocalURL( array( 'variant' => $code ) )
 						);
 					}
 				}
diff --git a/includes/Title.php b/includes/Title.php
index 4899456ad5..edbd4c2f62 100644
--- a/includes/Title.php
+++ b/includes/Title.php
@@ -1229,6 +1229,31 @@ class Title {
 		return $s;
 	}
 
+	/**
+	 * Helper to fix up the get{Local,Full,Link,Canonical}URL args
+	 */
+	private static function fixUrlQueryArgs( $query, $query2 ) {
+		if ( is_array( $query ) ) {
+			$query = wfArrayToCGI( $query );
+		}
+		if ( $query2 ) {
+			if ( is_string( $query2 ) ) {
+				// $query2 is a string, we will consider this to be
+				// a deprecated $variant argument and add it to the query
+				$query2 = wfArrayToCGI( array( 'variant' => $query2 ) );
+			} else {
+				$query2 = wfArrayToCGI( $query2 );
+			}
+			// If we have $query content add a & to it first
+			if ( $query ) {
+				$query .= '&';
+			}
+			// Now append the queries together
+			$query .= $query2;
+		}
+		return $query;
+	}
+
 	/**
 	 * Get a real URL referring to this title, with interwiki link and
 	 * fragment
@@ -1239,9 +1264,11 @@ class Title {
 	 * @param $variant String language variant of url (for sr, zh..)
 	 * @return String the URL
 	 */
-	public function getFullURL( $query = '', $variant = false ) {
+	public function getFullURL( $query = '', $query2 = false ) {
+		$query = self::fixUrlQueryArgs( $query, $query2 );
+
 		# Hand off all the decisions on urls to getLocalURL
-		$url = $this->getLocalURL( $query, $variant );
+		$url = $this->getLocalURL( $query );
 
 		# Expand the url to make it a full url. Note that getLocalURL has the
 		# potential to output full urls for a variety of reasons, so we use
@@ -1251,7 +1278,7 @@ class Title {
 		# Finally, add the fragment.
 		$url .= $this->getFragmentForURL();
 
-		wfRunHooks( 'GetFullURL', array( &$this, &$url, $query, $variant ) );
+		wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
 		return $url;
 	}
 
@@ -1266,13 +1293,10 @@ class Title {
 	 * @param $variant String language variant of url (for sr, zh..)
 	 * @return String the URL
 	 */
-	public function getLocalURL( $query = '', $variant = false ) {
+	public function getLocalURL( $query = '', $query2 = false ) {
 		global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
-		global $wgVariantArticlePath;
 
-		if ( is_array( $query ) ) {
-			$query = wfArrayToCGI( $query );
-		}
+		$query = self::fixUrlQueryArgs( $query, $query2 );
 
 		$interwiki = Interwiki::fetch( $this->mInterwiki );
 		if ( $interwiki ) {
@@ -1287,22 +1311,13 @@ class Title {
 		} else {
 			$dbkey = wfUrlencode( $this->getPrefixedDBkey() );
 			if ( $query == '' ) {
-				if ( $variant != false && $this->getPageLanguage()->hasVariants() ) {
-					if ( !$wgVariantArticlePath ) {
-						$variantArticlePath =  "$wgScript?title=$1&variant=$2"; // default
-					} else {
-						$variantArticlePath = $wgVariantArticlePath;
-					}
-					$url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
-					$url = str_replace( '$1', $dbkey, $url  );
-				} else {
-					$url = str_replace( '$1', $dbkey, $wgArticlePath );
-					wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
-				}
+				$url = str_replace( '$1', $dbkey, $wgArticlePath );
+				wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
 			} else {
-				global $wgActionPaths;
+				global $wgVariantArticlePath, $wgActionPaths;
 				$url = false;
 				$matches = array();
+
 				if ( !empty( $wgActionPaths ) &&
 					preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
 				{
@@ -1319,6 +1334,20 @@ class Title {
 					}
 				}
 
+				if ( $url === false &&
+					$wgVariantArticlePath &&
+					$this->getPageLanguage()->hasVariants() &&
+					preg_match( '/^variant=([^&]*)$/', $query, $matches ) )
+				{
+					$variant = urldecode( $matches[1] );
+					if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
+						// Only do the variant replacement if the given variant is a valid
+						// variant for the page's language.
+						$url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
+						$url = str_replace( '$1', $dbkey, $url );
+					}
+				}
+
 				if ( $url === false ) {
 					if ( $query == '-' ) {
 						$query = '';
@@ -1327,7 +1356,7 @@ class Title {
 				}
 			}
 
-			wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query, $variant ) );
+			wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
 
 			// @todo FIXME: This causes breakage in various places when we
 			// actually expected a local URL and end up with dupe prefixes.
@@ -1335,7 +1364,7 @@ class Title {
 				$url = $wgServer . $url;
 			}
 		}
-		wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query, $variant ) );
+		wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
 		return $url;
 	}
 
@@ -1356,14 +1385,14 @@ class Title {
 	 *   for anonymous users).
 	 * @return String the URL
 	 */
-	public function getLinkURL( $query = array(), $variant = false ) {
+	public function getLinkURL( $query = '', $query2 = false ) {
 		wfProfileIn( __METHOD__ );
 		if ( $this->isExternal() ) {
-			$ret = $this->getFullURL( $query );
+			$ret = $this->getFullURL( $query, $query2 );
 		} elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
 			$ret = $this->getFragmentForURL();
 		} else {
-			$ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
+			$ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
 		}
 		wfProfileOut( __METHOD__ );
 		return $ret;
@@ -1376,8 +1405,8 @@ class Title {
 	 * @param $query String an optional query string
 	 * @return String the URL
 	 */
-	public function escapeLocalURL( $query = '' ) {
-		return htmlspecialchars( $this->getLocalURL( $query ) );
+	public function escapeLocalURL( $query = '', $query2 = false ) {
+		return htmlspecialchars( $this->getLocalURL( $query, $query2 ) );
 	}
 
 	/**
@@ -1387,8 +1416,8 @@ class Title {
 	 * @param $query String an optional query string
 	 * @return String the URL
 	 */
-	public function escapeFullURL( $query = '' ) {
-		return htmlspecialchars( $this->getFullURL( $query ) );
+	public function escapeFullURL( $query = '', $query2 = false ) {
+		return htmlspecialchars( $this->getFullURL( $query, $query2 ) );
 	}
 
 	/**
@@ -1404,11 +1433,12 @@ class Title {
 	 * @param $variant String language variant of url (for sr, zh..)
 	 * @return String the URL
 	 */
-	public function getInternalURL( $query = '', $variant = false ) {
+	public function getInternalURL( $query = '', $query2 = false ) {
 		global $wgInternalServer, $wgServer;
+		$query = self::fixUrlQueryArgs( $query, $query2 );
 		$server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
-		$url = wfExpandUrl( $server . $this->getLocalURL( $query, $variant ), PROTO_HTTP );
-		wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query, $variant ) );
+		$url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
+		wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
 		return $url;
 	}
 
@@ -1424,9 +1454,10 @@ class Title {
 	 * @return string The URL
 	 * @since 1.18
 	 */
-	public function getCanonicalURL( $query = '', $variant = false ) {
+	public function getCanonicalURL( $query = '', $query2 = false ) {
+		$query = self::fixUrlQueryArgs( $query, $query2 );
 		$url = wfExpandUrl( $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL(), PROTO_CANONICAL );
-		wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query, $variant ) );
+		wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
 		return $url;
 	}
 
@@ -1434,8 +1465,9 @@ class Title {
 	 * HTML-escaped version of getCanonicalURL()
 	 * @since 1.18
 	 */
-	public function escapeCanonicalURL( $query = '', $variant = false ) {
-		return htmlspecialchars( $this->getCanonicalURL( $query, $variant ) );
+	public function escapeCanonicalURL( $query = '', $query2 = false ) {
+		wfDeprecated( __METHOD__, '1.19' );
+		return htmlspecialchars( $this->getCanonicalURL( $query, $query2 ) );
 	}
 
 	/**
diff --git a/languages/Language.php b/languages/Language.php
index c094927cf6..21f6ca7baa 100644
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -3259,6 +3259,14 @@ class Language {
 		return $text;
 	}
 
+	/**
+	 * Return the LanguageConverter used in the Language
+	 * @return LanguageConverter
+	 */
+	function getConverter() {
+		return $this->mConverter;
+	}
+
 	/**
 	 * convert text to all supported variants
 	 *
@@ -3299,6 +3307,14 @@ class Language {
 		return sizeof( $this->getVariants() ) > 1;
 	}
 
+	/**
+	 * Check if the language has the specific variant
+	 * @return bool
+	 */
+	function hasVariant( $variant ) {
+		return (bool)$this->mConverter->validateVariant( $variant );
+	}
+
 	/**
 	 * Put custom tags (e.g. -{ }-) around math to prevent conversion
 	 *
diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php
index 38d1ab6dbf..5e4bce8d15 100644
--- a/languages/LanguageConverter.php
+++ b/languages/LanguageConverter.php
@@ -189,7 +189,7 @@ class LanguageConverter {
 	 * @param $variant String: the variant to validate
 	 * @return Mixed: returns the variant if it is valid, null otherwise
 	 */
-	protected function validateVariant( $variant = null ) {
+	public function validateVariant( $variant = null ) {
 		if ( $variant !== null && in_array( $variant, $this->mVariants ) ) {
 			return $variant;
 		}