MediaWiki  1.23.2
PathRouterTest.php
Go to the documentation of this file.
1 <?php
2 
9 
13  protected $basicRouter;
14 
15  protected function setUp() {
16  parent::setUp();
17  $router = new PathRouter;
18  $router->add( "/wiki/$1" );
19  $this->basicRouter = $router;
20  }
21 
25  public function testBasic() {
26  $matches = $this->basicRouter->parse( "/wiki/Foo" );
27  $this->assertEquals( $matches, array( 'title' => "Foo" ) );
28  }
29 
33  public function testLoose() {
34  $router = new PathRouter;
35  $router->add( "/" ); # Should be the same as "/$1"
36  $matches = $router->parse( "/Foo" );
37  $this->assertEquals( $matches, array( 'title' => "Foo" ) );
38 
39  $router = new PathRouter;
40  $router->add( "/wiki" ); # Should be the same as /wiki/$1
41  $matches = $router->parse( "/wiki/Foo" );
42  $this->assertEquals( $matches, array( 'title' => "Foo" ) );
43 
44  $router = new PathRouter;
45  $router->add( "/wiki/" ); # Should be the same as /wiki/$1
46  $matches = $router->parse( "/wiki/Foo" );
47  $this->assertEquals( $matches, array( 'title' => "Foo" ) );
48  }
49 
53  public function testOrder() {
54  $router = new PathRouter;
55  $router->add( "/$1" );
56  $router->add( "/a/$1" );
57  $router->add( "/b/$1" );
58  $matches = $router->parse( "/a/Foo" );
59  $this->assertEquals( $matches, array( 'title' => "Foo" ) );
60 
61  $router = new PathRouter;
62  $router->add( "/b/$1" );
63  $router->add( "/a/$1" );
64  $router->add( "/$1" );
65  $matches = $router->parse( "/a/Foo" );
66  $this->assertEquals( $matches, array( 'title' => "Foo" ) );
67  }
68 
72  public function testKeyParameter() {
73  $router = new PathRouter;
74  $router->add( array( 'edit' => "/edit/$1" ), array( 'action' => '$key' ) );
75  $matches = $router->parse( "/edit/Foo" );
76  $this->assertEquals( $matches, array( 'title' => "Foo", 'action' => 'edit' ) );
77  }
78 
82  public function testAdditionalParameter() {
83  // Basic $2
84  $router = new PathRouter;
85  $router->add( '/$2/$1', array( 'test' => '$2' ) );
86  $matches = $router->parse( "/asdf/Foo" );
87  $this->assertEquals( $matches, array( 'title' => "Foo", 'test' => 'asdf' ) );
88  }
89 
93  public function testRestrictedValue() {
94  $router = new PathRouter;
95  $router->add( '/$2/$1',
96  array( 'test' => '$2' ),
97  array( '$2' => array( 'a', 'b' ) )
98  );
99  $router->add( '/$2/$1',
100  array( 'test2' => '$2' ),
101  array( '$2' => 'c' )
102  );
103  $router->add( '/$1' );
104 
105  $matches = $router->parse( "/asdf/Foo" );
106  $this->assertEquals( $matches, array( 'title' => "asdf/Foo" ) );
107 
108  $matches = $router->parse( "/a/Foo" );
109  $this->assertEquals( $matches, array( 'title' => "Foo", 'test' => 'a' ) );
110 
111  $matches = $router->parse( "/c/Foo" );
112  $this->assertEquals( $matches, array( 'title' => "Foo", 'test2' => 'c' ) );
113  }
114 
115  public function callbackForTest( &$matches, $data ) {
116  $matches['x'] = $data['$1'];
117  $matches['foo'] = $data['foo'];
118  }
119 
120  public function testCallback() {
121  $router = new PathRouter;
122  $router->add( "/$1",
123  array( 'a' => 'b', 'data:foo' => 'bar' ),
124  array( 'callback' => array( $this, 'callbackForTest' ) )
125  );
126  $matches = $router->parse( '/Foo' );
127  $this->assertEquals( $matches, array(
128  'title' => "Foo",
129  'x' => 'Foo',
130  'a' => 'b',
131  'foo' => 'bar'
132  ) );
133  }
134 
138  public function testFail() {
139  $router = new PathRouter;
140  $router->add( "/wiki/$1", array( 'title' => "$1$2" ) );
141  $matches = $router->parse( "/wiki/A" );
142  $this->assertEquals( array(), $matches );
143  }
144 
148  public function testWeight() {
149  $router = new PathRouter;
150  $router->addStrict( "/Bar", array( 'ping' => 'pong' ) );
151  $router->add( "/asdf-$1", array( 'title' => 'qwerty-$1' ) );
152  $router->add( "/$1" );
153  $router->add( "/qwerty-$1", array( 'title' => 'asdf-$1' ) );
154  $router->addStrict( "/Baz", array( 'marco' => 'polo' ) );
155  $router->add( "/a/$1" );
156  $router->add( "/asdf/$1" );
157  $router->add( "/$2/$1", array( 'unrestricted' => '$2' ) );
158  $router->add( array( 'qwerty' => "/qwerty/$1" ), array( 'qwerty' => '$key' ) );
159  $router->add( "/$2/$1", array( 'restricted-to-y' => '$2' ), array( '$2' => 'y' ) );
160 
161  foreach (
162  array(
163  '/Foo' => array( 'title' => 'Foo' ),
164  '/Bar' => array( 'ping' => 'pong' ),
165  '/Baz' => array( 'marco' => 'polo' ),
166  '/asdf-foo' => array( 'title' => 'qwerty-foo' ),
167  '/qwerty-bar' => array( 'title' => 'asdf-bar' ),
168  '/a/Foo' => array( 'title' => 'Foo' ),
169  '/asdf/Foo' => array( 'title' => 'Foo' ),
170  '/qwerty/Foo' => array( 'title' => 'Foo', 'qwerty' => 'qwerty' ),
171  '/baz/Foo' => array( 'title' => 'Foo', 'unrestricted' => 'baz' ),
172  '/y/Foo' => array( 'title' => 'Foo', 'restricted-to-y' => 'y' ),
173  ) as $path => $result
174  ) {
175  $this->assertEquals( $router->parse( $path ), $result );
176  }
177  }
178 
182  public function testSpecial() {
183  $matches = $this->basicRouter->parse( "/wiki/Special:Recentchanges" );
184  $this->assertEquals( $matches, array( 'title' => "Special:Recentchanges" ) );
185  }
186 
190  public function testUrlencoding() {
191  $matches = $this->basicRouter->parse( "/wiki/Title_With%20Space" );
192  $this->assertEquals( $matches, array( 'title' => "Title_With Space" ) );
193  }
194 
195  public static function provideRegexpChars() {
196  return array(
197  array( "$" ),
198  array( "$1" ),
199  array( "\\" ),
200  array( "\\$1" ),
201  );
202  }
203 
208  public function testRegexpChars( $char ) {
209  $matches = $this->basicRouter->parse( "/wiki/$char" );
210  $this->assertEquals( $matches, array( 'title' => "$char" ) );
211  }
212 
216  public function testCharacters() {
217  $matches = $this->basicRouter->parse( "/wiki/Plus+And&Dollar\\Stuff();[]{}*" );
218  $this->assertEquals( $matches, array( 'title' => "Plus+And&Dollar\\Stuff();[]{}*" ) );
219  }
220 
227  public function testUnicode() {
228  $matches = $this->basicRouter->parse( "/wiki/Spécial:Modifications_récentes" );
229  $this->assertEquals( $matches, array( 'title' => "Spécial:Modifications_récentes" ) );
230 
231  $matches = $this->basicRouter->parse( "/wiki/Sp%C3%A9cial:Modifications_r%C3%A9centes" );
232  $this->assertEquals( $matches, array( 'title' => "Spécial:Modifications_récentes" ) );
233  }
234 
238  public function testLength() {
239  $matches = $this->basicRouter->parse( "/wiki/Lorem_ipsum_dolor_sit_amet,_consectetur_adipisicing_elit,_sed_do_eiusmod_tempor_incididunt_ut_labore_et_dolore_magna_aliqua._Ut_enim_ad_minim_veniam,_quis_nostrud_exercitation_ullamco_laboris_nisi_ut_aliquip_ex_ea_commodo_consequat._Duis_aute_irure_dolor_in_reprehenderit_in_voluptate_velit_esse_cillum_dolore_eu_fugiat_nulla_pariatur._Excepteur_sint_occaecat_cupidatat_non_proident,_sunt_in_culpa_qui_officia_deserunt_mollit_anim_id_est_laborum." );
240  $this->assertEquals( $matches, array( 'title' => "Lorem_ipsum_dolor_sit_amet,_consectetur_adipisicing_elit,_sed_do_eiusmod_tempor_incididunt_ut_labore_et_dolore_magna_aliqua._Ut_enim_ad_minim_veniam,_quis_nostrud_exercitation_ullamco_laboris_nisi_ut_aliquip_ex_ea_commodo_consequat._Duis_aute_irure_dolor_in_reprehenderit_in_voluptate_velit_esse_cillum_dolore_eu_fugiat_nulla_pariatur._Excepteur_sint_occaecat_cupidatat_non_proident,_sunt_in_culpa_qui_officia_deserunt_mollit_anim_id_est_laborum." ) );
241  }
242 
246  public function testPatternUrlencoding() {
247  $router = new PathRouter;
248  $router->add( "/wiki/$1", array( 'title' => '%20:$1' ) );
249  $matches = $router->parse( "/wiki/Foo" );
250  $this->assertEquals( $matches, array( 'title' => '%20:Foo' ) );
251  }
252 
256  public function testRawParamValue() {
257  $router = new PathRouter;
258  $router->add( "/wiki/$1", array( 'title' => array( 'value' => 'bar%20$1' ) ) );
259  $matches = $router->parse( "/wiki/Foo" );
260  $this->assertEquals( $matches, array( 'title' => 'bar%20$1' ) );
261  }
262 }
PathRouterTest\testKeyParameter
testKeyParameter()
Test the handling of key based arrays with a url parameter.
Definition: PathRouterTest.php:71
PathRouterTest\testFail
testFail()
Test to ensure that matches are not made if a parameter expects nonexistent input.
Definition: PathRouterTest.php:137
PathRouter\add
add( $path, $params=array(), $options=array())
Add a new path pattern to the path router.
Definition: PathRouter.php:159
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
PathRouter\addStrict
addStrict( $path, $params=array(), $options=array())
Add a new path pattern to the path router with the strict option on.
Definition: PathRouter.php:176
PathRouterTest\testSpecial
testSpecial()
Make sure the router handles titles like Special:Recentchanges correctly.
Definition: PathRouterTest.php:181
PathRouterTest\testWeight
testWeight()
Test to ensure weight of paths is handled correctly.
Definition: PathRouterTest.php:147
PathRouterTest\testOrder
testOrder()
Test to ensure that path is based on specifity, not order.
Definition: PathRouterTest.php:52
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:1
PathRouterTest\testRestrictedValue
testRestrictedValue()
Test additional restricted value parameter.
Definition: PathRouterTest.php:92
PathRouterTest\provideRegexpChars
static provideRegexpChars()
Definition: PathRouterTest.php:194
PathRouterTest\testCharacters
testCharacters()
Make sure the router handles characters like +&() properly.
Definition: PathRouterTest.php:215
PathRouterTest\testLoose
testLoose()
Test loose path auto-$1.
Definition: PathRouterTest.php:32
PathRouterTest
Tests for the PathRouter parsing.
Definition: PathRouterTest.php:8
PathRouterTest\callbackForTest
callbackForTest(&$matches, $data)
Definition: PathRouterTest.php:114
MediaWikiTestCase
Definition: MediaWikiTestCase.php:6
PathRouterTest\testRegexpChars
testRegexpChars( $char)
Make sure the router doesn't break on special characters like $ used in regexp replacements @dataProv...
Definition: PathRouterTest.php:207
PathRouterTest\testUnicode
testUnicode()
Make sure the router handles unicode characters correctly @depends testSpecial @depends testUrlencodi...
Definition: PathRouterTest.php:226
PathRouterTest\testCallback
testCallback()
Definition: PathRouterTest.php:119
PathRouterTest\setUp
setUp()
Definition: PathRouterTest.php:14
PathRouterTest\$basicRouter
PathRouter $basicRouter
Definition: PathRouterTest.php:12
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
$matches
if(!defined( 'MEDIAWIKI')) if(!isset( $wgVersion)) $matches
Definition: NoLocalSettings.php:33
PathRouterTest\testLength
testLength()
Ensure the router doesn't choke on long paths.
Definition: PathRouterTest.php:237
PathRouterTest\testAdditionalParameter
testAdditionalParameter()
Test the handling of $2 inside paths.
Definition: PathRouterTest.php:81
PathRouterTest\testUrlencoding
testUrlencoding()
Make sure the router decodes urlencoding properly.
Definition: PathRouterTest.php:189
PathRouterTest\testRawParamValue
testRawParamValue()
Ensure that raw parameter values do not have any variable replacements or urldecoding.
Definition: PathRouterTest.php:255
PathRouterTest\testPatternUrlencoding
testPatternUrlencoding()
Ensure that the php passed site of parameter values are not urldecoded.
Definition: PathRouterTest.php:245
$path
$path
Definition: NoLocalSettings.php:35
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
PathRouterTest\testBasic
testBasic()
Test basic path parsing.
Definition: PathRouterTest.php:24
PathRouter
PathRouter class.
Definition: PathRouter.php:73