* @author Daniel Friesen
*/
class PathRouter {
+
+ /**
+ * Protected helper to do the actual bulk work of adding a single pattern.
+ * This is in a separate method so that add() can handle the difference between
+ * a single string $path and an array() $path that contains multiple path
+ * patterns each with an associated $key to pass on.
+ */
protected function doAdd( $path, $params, $options, $key = null ) {
+ // Make sure all paths start with a /
if ( $path[0] !== '/' ) {
$path = '/' . $path;
}
}
}
+ // If 'title' is not specified and our path pattern contains a $1
+ // Add a default 'title' => '$1' rule to the parameters.
if ( !isset( $params['title'] ) && strpos( $path, '$1' ) !== false ) {
$params['title'] = '$1';
}
+ // If the user explicitly marked 'title' as false then omit it from the matches
if ( isset( $params['title'] ) && $params['title'] === false ) {
unset( $params['title'] );
}
+ // Loop over our parameters and convert basic key => string
+ // patterns into fully descriptive array form
foreach ( $params as $paramName => $paramData ) {
if ( is_string( $paramData ) ) {
if ( preg_match( '/\$(\d+|key)/u', $paramData ) ) {
}
}
+ // Loop over our options and convert any single value $# restrictions
+ // into an array so we only have to do in_array tests.
foreach ( $options as $optionName => $optionData ) {
if ( preg_match( '/^\$\d+$/u', $optionName ) ) {
if ( !is_array( $optionData ) ) {
$this->add( $path, $params, $options );
}
+ /**
+ * Protected helper to re-sort our patterns so that the most specific
+ * (most heavily weighted) patterns are at the start of the array.
+ */
protected function sortByWeight() {
$weights = array();
foreach( $this->patterns as $key => $pattern ) {
array_multisort( $weights, SORT_DESC, SORT_NUMERIC, $this->patterns );
}
- public static function makeWeight( $pattern ) {
+ protected static function makeWeight( $pattern ) {
# Start with a weight of 0
$weight = 0;
* @return Array The array of matches for the path
*/
public function parse( $path ) {
+ // Make sure our patterns are sorted by weight so the most specific
+ // matches are tested first
$this->sortByWeight();
$matches = null;
}
}
+ // We know the difference between null (no matches) and
+ // array() (a match with no data) but our WebRequest caller
+ // expects array() even when we have no matches so return
+ // a array() when we have null
return is_null( $matches ) ? array() : $matches;
}
protected static function extractTitle( $path, $pattern ) {
+ // Convert the path pattern into a regexp we can match with
$regexp = preg_quote( $pattern->path, '#' );
+ // .* for the $1
$regexp = preg_replace( '#\\\\\$1#u', '(?P<par1>.*)', $regexp );
+ // .+ for the rest of the parameter numbers
$regexp = preg_replace( '#\\\\\$(\d+)#u', '(?P<par$1>.+?)', $regexp );
$regexp = "#^{$regexp}$#";
$matches = array();
$data = array();
+ // Try to match the path we were asked to parse with our regexp
if ( preg_match( $regexp, $path, $m ) ) {
+ // Ensure that any $# restriction we have set in our {$option}s
+ // matches properly here.
foreach ( $pattern->options as $key => $option ) {
if ( preg_match( '/^\$\d+$/u', $key ) ) {
$n = intval( substr( $key, 1 ) );
$value = rawurldecode( $m["par{$n}"] );
if ( !in_array( $value, $option ) ) {
+ // If any restriction does not match return null
+ // to signify that this rule did not match.
return null;
}
}
}
+ // Give our $data array a copy of every $# that was matched
foreach ( $m as $matchKey => $matchValue ) {
if ( preg_match( '/^par\d+$/u', $matchKey ) ) {
$n = intval( substr( $matchKey, 3 ) );
$data['$'.$n] = rawurldecode( $matchValue );
}
}
+ // If present give our $data array a $key as well
if ( isset( $pattern->key ) ) {
$data['$key'] = $pattern->key;
}
+ // Go through our parameters for this match and add data to our matches and data arrays
foreach ( $pattern->params as $paramName => $paramData ) {
$value = null;
+ // Differentiate data: from normal parameters and keep the correct
+ // array key around (ie: foo for data:foo)
if ( preg_match( '/^data:/u', $paramName ) ) {
$isData = true;
$key = substr( $paramName, 5 );
}
if ( isset( $paramData['value'] ) ) {
+ // For basic values just set the raw data as the value
$value = $paramData['value'];
} elseif ( isset( $paramData['pattern'] ) ) {
+ // For patterns we have to make value replacements on the string
$value = $paramData['pattern'];
+ // For each $# match replace any $# within the value
foreach ( $m as $matchKey => $matchValue ) {
if ( preg_match( '/^par\d+$/u', $matchKey ) ) {
$n = intval( substr( $matchKey, 3 ) );
$value = str_replace( '$' . $n, rawurldecode( $matchValue ), $value );
}
}
+ // If a key was set replace any $key within the value
if ( isset( $pattern->key ) ) {
$value = str_replace( '$key', $pattern->key, $value );
}
}
}
+ // Send things that start with data: to $data, the rest to $matches
if ( $isData ) {
$data[$key] = $value;
} else {
}
}
+ // If this match includes a callback, execute it
if ( isset( $pattern->options['callback'] ) ) {
call_user_func_array( $pattern->options['callback'], array( &$matches, $data ) );
}
} else {
+ // Our regexp didn't match, return null to signify no match.
return null;
}
+ // Fall through, everything went ok, return our matches array
return $matches;
}
}
/**
- * Extract the PATH_INFO variable even when it isn't a reasonable
- * value. On some large webhosts, PATH_INFO includes the script
- * path as well as everything after it.
+ * Extract relevant query arguments from the http request uri's path
+ * to be merged with the normal php provided query arguments.
+ * Tries to use the REQUEST_URI data if available and parses it
+ * according to the wiki's configuration looking for any known pattern.
+ *
+ * If the REQUEST_URI is not provided we'll fall back on the PATH_INFO
+ * provided by the server if any and use that to set a 'title' parameter.
*
* @param $want string: If this is not 'all', then the function
* will return an empty array if it determines that the URL is
* inside a rewrite path.
*
- * @return Array: 'title' key is the title of the article.
+ * @return Array: Any query arguments found in path matches.
*/
static public function getPathInfo( $want = 'all' ) {
// PATH_INFO is mangled due to http://bugs.php.net/bug.php?id=31892
global $wgVariantArticlePath, $wgContLang;
if( $wgVariantArticlePath ) {
- /*$variantPaths = array();
- foreach( $wgContLang->getVariants() as $variant ) {
- $variantPaths[$variant] =
- str_replace( '$2', $variant, $wgVariantArticlePath );
- }
- $router->add( $variantPaths, array( 'parameter' => 'variant' ) );*/
- // Maybe actually this?
$router->add( $wgVariantArticlePath,
array( 'variant' => '$2'),
array( '$2' => $wgContLang->getVariants() )