RouterTest.php 100 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  5. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  6. *
  7. * Licensed under The MIT License
  8. * For full copyright and license information, please see the LICENSE.txt
  9. * Redistributions of files must retain the above copyright notice.
  10. *
  11. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  12. * @link https://cakephp.org CakePHP(tm) Project
  13. * @since 1.2.0
  14. * @license https://opensource.org/licenses/mit-license.php MIT License
  15. */
  16. namespace Cake\Test\TestCase\Routing;
  17. use Cake\Core\Configure;
  18. use Cake\Http\ServerRequest;
  19. use Cake\Http\ServerRequestFactory;
  20. use Cake\Routing\Route\Route;
  21. use Cake\Routing\RouteBuilder;
  22. use Cake\Routing\RouteCollection;
  23. use Cake\Routing\Router;
  24. use Cake\TestSuite\TestCase;
  25. /**
  26. * RouterTest class
  27. */
  28. class RouterTest extends TestCase
  29. {
  30. /**
  31. * setUp method
  32. *
  33. * @return void
  34. */
  35. public function setUp()
  36. {
  37. parent::setUp();
  38. Configure::write('Routing', ['admin' => null, 'prefixes' => []]);
  39. Router::fullBaseUrl('');
  40. Configure::write('App.fullBaseUrl', 'http://localhost');
  41. }
  42. /**
  43. * tearDown method
  44. *
  45. * @return void
  46. */
  47. public function tearDown()
  48. {
  49. parent::tearDown();
  50. $this->clearPlugins();
  51. Router::reload();
  52. Router::defaultRouteClass('Cake\Routing\Route\Route');
  53. }
  54. /**
  55. * testFullBaseUrl method
  56. *
  57. * @return void
  58. */
  59. public function testBaseUrl()
  60. {
  61. Router::scope('/', function (RouteBuilder $routes) {
  62. $routes->fallbacks();
  63. });
  64. $this->assertRegExp('/^http(s)?:\/\//', Router::url('/', true));
  65. $this->assertRegExp('/^http(s)?:\/\//', Router::url(null, true));
  66. $this->assertRegExp('/^http(s)?:\/\//', Router::url(['_full' => true]));
  67. }
  68. /**
  69. * Tests that the base URL can be changed at runtime.
  70. *
  71. * @return void
  72. */
  73. public function testFullBaseURL()
  74. {
  75. Router::scope('/', function (RouteBuilder $routes) {
  76. $routes->fallbacks();
  77. });
  78. Router::fullBaseUrl('http://example.com');
  79. $this->assertEquals('http://example.com/', Router::url('/', true));
  80. $this->assertEquals('http://example.com', Configure::read('App.fullBaseUrl'));
  81. Router::fullBaseUrl('https://example.com');
  82. $this->assertEquals('https://example.com/', Router::url('/', true));
  83. $this->assertEquals('https://example.com', Configure::read('App.fullBaseUrl'));
  84. }
  85. /**
  86. * Test that Router uses App.base to build URL's when there are no stored
  87. * request objects.
  88. *
  89. * @return void
  90. */
  91. public function testBaseUrlWithBasePath()
  92. {
  93. Configure::write('App.base', '/cakephp');
  94. Router::fullBaseUrl('http://example.com');
  95. $this->assertEquals('http://example.com/cakephp/tasks', Router::url('/tasks', true));
  96. }
  97. /**
  98. * Test that Router uses App.base to build URL's when there are no stored
  99. * request objects.
  100. *
  101. * @return void
  102. */
  103. public function testBaseUrlWithBasePathArrayUrl()
  104. {
  105. Configure::write('App.base', '/cakephp');
  106. Router::fullBaseUrl('http://example.com');
  107. Router::scope('/', function (RouteBuilder $routes) {
  108. $routes->get('/:controller', ['action' => 'index']);
  109. });
  110. $out = Router::url([
  111. 'controller' => 'tasks',
  112. 'action' => 'index',
  113. '_method' => 'GET',
  114. ], true);
  115. $this->assertEquals('http://example.com/cakephp/tasks', $out);
  116. $out = Router::url([
  117. 'controller' => 'tasks',
  118. 'action' => 'index',
  119. '_base' => false,
  120. '_method' => 'GET',
  121. ], true);
  122. $this->assertEquals('http://example.com/tasks', $out);
  123. }
  124. /**
  125. * Test that Router uses the correct url including base path for requesting the current actions.
  126. *
  127. * @return void
  128. */
  129. public function testCurrentUrlWithBasePath()
  130. {
  131. Router::fullBaseUrl('http://example.com');
  132. $request = new ServerRequest([
  133. 'params' => [
  134. 'action' => 'view',
  135. 'plugin' => null,
  136. 'controller' => 'pages',
  137. 'pass' => ['1'],
  138. ],
  139. 'here' => '/cakephp',
  140. 'url' => '/cakephp/pages/view/1',
  141. ]);
  142. Router::setRequestInfo($request);
  143. $this->assertEquals('http://example.com/cakephp/pages/view/1', Router::url(null, true));
  144. $this->assertEquals('/cakephp/pages/view/1', Router::url());
  145. }
  146. /**
  147. * testRouteDefaultParams method
  148. *
  149. * @return void
  150. */
  151. public function testRouteDefaultParams()
  152. {
  153. Router::connect('/:controller', ['controller' => 'posts']);
  154. $this->assertEquals(Router::url(['action' => 'index']), '/');
  155. }
  156. /**
  157. * testRouteExists method
  158. *
  159. * @return void
  160. */
  161. public function testRouteExists()
  162. {
  163. Router::connect('/:controller/:action', ['controller' => 'posts']);
  164. $this->assertTrue(Router::routeExists(['action' => 'view']));
  165. $this->assertFalse(Router::routeExists(['action' => 'view', 'controller' => 'users', 'plugin' => 'test']));
  166. }
  167. /**
  168. * testMultipleResourceRoute method
  169. *
  170. * @return void
  171. */
  172. public function testMultipleResourceRoute()
  173. {
  174. Router::connect('/:controller', ['action' => 'index', '_method' => ['GET', 'POST']]);
  175. $result = Router::parseRequest($this->makeRequest('/posts', 'GET'));
  176. $expected = [
  177. 'pass' => [],
  178. 'plugin' => null,
  179. 'controller' => 'posts',
  180. 'action' => 'index',
  181. '_method' => ['GET', 'POST'],
  182. '_matchedRoute' => '/:controller',
  183. ];
  184. $this->assertEquals($expected, $result);
  185. $result = Router::parseRequest($this->makeRequest('/posts', 'POST'));
  186. $expected = [
  187. 'pass' => [],
  188. 'plugin' => null,
  189. 'controller' => 'posts',
  190. 'action' => 'index',
  191. '_method' => ['GET', 'POST'],
  192. '_matchedRoute' => '/:controller',
  193. ];
  194. $this->assertEquals($expected, $result);
  195. }
  196. /**
  197. * testGenerateUrlResourceRoute method
  198. *
  199. * @return void
  200. */
  201. public function testGenerateUrlResourceRoute()
  202. {
  203. Router::scope('/', function (RouteBuilder $routes) {
  204. $routes->resources('Posts');
  205. });
  206. $result = Router::url([
  207. 'controller' => 'Posts',
  208. 'action' => 'index',
  209. '_method' => 'GET',
  210. ]);
  211. $expected = '/posts';
  212. $this->assertEquals($expected, $result);
  213. $result = Router::url([
  214. 'controller' => 'Posts',
  215. 'action' => 'view',
  216. '_method' => 'GET',
  217. 'id' => '10',
  218. ]);
  219. $expected = '/posts/10';
  220. $this->assertEquals($expected, $result);
  221. $result = Router::url(['controller' => 'Posts', 'action' => 'add', '_method' => 'POST']);
  222. $expected = '/posts';
  223. $this->assertEquals($expected, $result);
  224. $result = Router::url(['controller' => 'Posts', 'action' => 'edit', '_method' => 'PUT', 'id' => '10']);
  225. $expected = '/posts/10';
  226. $this->assertEquals($expected, $result);
  227. $result = Router::url([
  228. 'controller' => 'Posts',
  229. 'action' => 'delete',
  230. '_method' => 'DELETE',
  231. 'id' => '10',
  232. ]);
  233. $expected = '/posts/10';
  234. $this->assertEquals($expected, $result);
  235. $result = Router::url([
  236. 'controller' => 'Posts',
  237. 'action' => 'edit',
  238. '_method' => 'PATCH',
  239. 'id' => '10',
  240. ]);
  241. $expected = '/posts/10';
  242. $this->assertEquals($expected, $result);
  243. }
  244. /**
  245. * testUrlNormalization method
  246. *
  247. * @return void
  248. */
  249. public function testUrlNormalization()
  250. {
  251. Router::connect('/:controller/:action');
  252. $expected = '/users/logout';
  253. $result = Router::normalize('/users/logout/');
  254. $this->assertEquals($expected, $result);
  255. $result = Router::normalize('//users//logout//');
  256. $this->assertEquals($expected, $result);
  257. $result = Router::normalize('users/logout');
  258. $this->assertEquals($expected, $result);
  259. $result = Router::normalize(['controller' => 'users', 'action' => 'logout']);
  260. $this->assertEquals($expected, $result);
  261. $result = Router::normalize('/');
  262. $this->assertEquals('/', $result);
  263. $result = Router::normalize('http://google.com/');
  264. $this->assertEquals('http://google.com/', $result);
  265. $result = Router::normalize('http://google.com//');
  266. $this->assertEquals('http://google.com//', $result);
  267. $result = Router::normalize('/users/login/scope://foo');
  268. $this->assertEquals('/users/login/scope:/foo', $result);
  269. $result = Router::normalize('/recipe/recipes/add');
  270. $this->assertEquals('/recipe/recipes/add', $result);
  271. $request = new ServerRequest(['base' => '/us']);
  272. Router::setRequestInfo($request);
  273. $result = Router::normalize('/us/users/logout/');
  274. $this->assertEquals('/users/logout', $result);
  275. Router::reload();
  276. $request = new ServerRequest(['base' => '/cake_12']);
  277. Router::setRequestInfo($request);
  278. $result = Router::normalize('/cake_12/users/logout/');
  279. $this->assertEquals('/users/logout', $result);
  280. Router::reload();
  281. $_back = Configure::read('App.fullBaseUrl');
  282. Configure::write('App.fullBaseUrl', '/');
  283. $request = new ServerRequest();
  284. Router::setRequestInfo($request);
  285. $result = Router::normalize('users/login');
  286. $this->assertEquals('/users/login', $result);
  287. Configure::write('App.fullBaseUrl', $_back);
  288. Router::reload();
  289. $request = new ServerRequest(['base' => 'beer']);
  290. Router::setRequestInfo($request);
  291. $result = Router::normalize('beer/admin/beers_tags/add');
  292. $this->assertEquals('/admin/beers_tags/add', $result);
  293. $result = Router::normalize('/admin/beers_tags/add');
  294. $this->assertEquals('/admin/beers_tags/add', $result);
  295. }
  296. /**
  297. * Test generating urls with base paths.
  298. *
  299. * @return void
  300. */
  301. public function testUrlGenerationWithBasePath()
  302. {
  303. Router::connect('/:controller/:action/*');
  304. $request = new ServerRequest([
  305. 'params' => [
  306. 'action' => 'index',
  307. 'plugin' => null,
  308. 'controller' => 'subscribe',
  309. ],
  310. 'url' => '/subscribe',
  311. 'base' => '/magazine',
  312. 'webroot' => '/magazine/',
  313. ]);
  314. Router::pushRequest($request);
  315. $result = Router::url();
  316. $this->assertEquals('/magazine/subscribe', $result);
  317. $result = Router::url([]);
  318. $this->assertEquals('/magazine/subscribe', $result);
  319. $result = Router::url('/');
  320. $this->assertEquals('/magazine/', $result);
  321. $result = Router::url('/articles/');
  322. $this->assertEquals('/magazine/articles/', $result);
  323. $result = Router::url('/articles/view');
  324. $this->assertEquals('/magazine/articles/view', $result);
  325. $result = Router::url(['controller' => 'articles', 'action' => 'view', 1]);
  326. $this->assertEquals('/magazine/articles/view/1', $result);
  327. }
  328. /**
  329. * Test url() with _host option routes with request context
  330. *
  331. * @return void
  332. */
  333. public function testUrlGenerationHostOptionRequestContext()
  334. {
  335. $server = [
  336. 'HTTP_HOST' => 'foo.example.com',
  337. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  338. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php',
  339. 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1',
  340. 'REQUEST_URI' => '/subdir/articles/view/1',
  341. 'QUERY_STRING' => '',
  342. 'SERVER_PORT' => 80,
  343. ];
  344. Router::connect('/fallback', ['controller' => 'Articles'], ['_host' => '*.example.com']);
  345. $request = ServerRequestFactory::fromGlobals($server);
  346. Router::setRequestContext($request);
  347. $result = Router::url(['controller' => 'Articles', 'action' => 'index']);
  348. $this->assertEquals('http://foo.example.com/subdir/fallback', $result);
  349. $result = Router::url(['controller' => 'Articles', 'action' => 'index'], true);
  350. $this->assertEquals('http://foo.example.com/subdir/fallback', $result);
  351. }
  352. /**
  353. * Test that catch all routes work with a variety of falsey inputs.
  354. *
  355. * @return void
  356. */
  357. public function testUrlCatchAllRoute()
  358. {
  359. Router::connect('/*', ['controller' => 'categories', 'action' => 'index']);
  360. $result = Router::url(['controller' => 'categories', 'action' => 'index', '0']);
  361. $this->assertEquals('/0', $result);
  362. $expected = [
  363. 'plugin' => null,
  364. 'controller' => 'categories',
  365. 'action' => 'index',
  366. 'pass' => ['0'],
  367. '_matchedRoute' => '/*',
  368. ];
  369. $result = Router::parseRequest($this->makeRequest('/0', 'GET'));
  370. $this->assertEquals($expected, $result);
  371. $result = Router::parseRequest($this->makeRequest('0', 'GET'));
  372. $this->assertEquals($expected, $result);
  373. }
  374. /**
  375. * test generation of basic urls.
  376. *
  377. * @return void
  378. */
  379. public function testUrlGenerationBasic()
  380. {
  381. extract(Router::getNamedExpressions());
  382. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  383. $out = Router::url(['controller' => 'pages', 'action' => 'display', 'home']);
  384. $this->assertEquals('/', $out);
  385. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  386. $result = Router::url(['controller' => 'pages', 'action' => 'display', 'about']);
  387. $expected = '/pages/about';
  388. $this->assertEquals($expected, $result);
  389. Router::reload();
  390. Router::connect('/:plugin/:id/*', ['controller' => 'posts', 'action' => 'view'], ['id' => $ID]);
  391. $result = Router::url([
  392. 'plugin' => 'cake_plugin',
  393. 'controller' => 'posts',
  394. 'action' => 'view',
  395. 'id' => '1',
  396. ]);
  397. $expected = '/cake_plugin/1';
  398. $this->assertEquals($expected, $result);
  399. $result = Router::url([
  400. 'plugin' => 'cake_plugin',
  401. 'controller' => 'posts',
  402. 'action' => 'view',
  403. 'id' => '1',
  404. '0',
  405. ]);
  406. $expected = '/cake_plugin/1/0';
  407. $this->assertEquals($expected, $result);
  408. Router::reload();
  409. Router::connect('/:controller/:action/:id', [], ['id' => $ID]);
  410. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => '1']);
  411. $expected = '/posts/view/1';
  412. $this->assertEquals($expected, $result);
  413. Router::reload();
  414. Router::connect('/:controller/:id', ['action' => 'view']);
  415. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => '1']);
  416. $expected = '/posts/1';
  417. $this->assertEquals($expected, $result);
  418. Router::connect('/view/*', ['controller' => 'posts', 'action' => 'view']);
  419. $result = Router::url(['controller' => 'posts', 'action' => 'view', '1']);
  420. $expected = '/view/1';
  421. $this->assertEquals($expected, $result);
  422. Router::reload();
  423. Router::connect('/:controller/:action');
  424. $request = new ServerRequest([
  425. 'params' => [
  426. 'action' => 'index',
  427. 'plugin' => null,
  428. 'controller' => 'users',
  429. ],
  430. ]);
  431. Router::setRequestInfo($request);
  432. $result = Router::url(['action' => 'login']);
  433. $expected = '/users/login';
  434. $this->assertEquals($expected, $result);
  435. Router::reload();
  436. Router::connect('/contact/:action', ['plugin' => 'contact', 'controller' => 'contact']);
  437. $result = Router::url([
  438. 'plugin' => 'contact',
  439. 'controller' => 'contact',
  440. 'action' => 'me',
  441. ]);
  442. $expected = '/contact/me';
  443. $this->assertEquals($expected, $result);
  444. Router::reload();
  445. Router::connect('/:controller', ['action' => 'index']);
  446. $request = new ServerRequest([
  447. 'params' => [
  448. 'action' => 'index',
  449. 'plugin' => 'myplugin',
  450. 'controller' => 'mycontroller',
  451. ],
  452. ]);
  453. Router::setRequestInfo($request);
  454. $result = Router::url(['plugin' => null, 'controller' => 'myothercontroller']);
  455. $expected = '/myothercontroller';
  456. $this->assertEquals($expected, $result);
  457. }
  458. /**
  459. * Test that generated names for routes are case-insensitive.
  460. *
  461. * @return void
  462. */
  463. public function testRouteNameCasing()
  464. {
  465. Router::connect('/articles/:id', ['controller' => 'Articles', 'action' => 'view']);
  466. Router::connect('/:controller/:action/*', [], ['routeClass' => 'InflectedRoute']);
  467. $result = Router::url(['controller' => 'Articles', 'action' => 'view', 'id' => 10]);
  468. $expected = '/articles/10';
  469. $this->assertEquals($expected, $result);
  470. }
  471. /**
  472. * Test generation of routes with query string parameters.
  473. *
  474. * @return void
  475. */
  476. public function testUrlGenerationWithQueryStrings()
  477. {
  478. Router::connect('/:controller/:action/*');
  479. $result = Router::url([
  480. 'controller' => 'posts',
  481. '0',
  482. '?' => ['var' => 'test', 'var2' => 'test2'],
  483. ]);
  484. $expected = '/posts/index/0?var=test&var2=test2';
  485. $this->assertEquals($expected, $result);
  486. $result = Router::url(['controller' => 'posts', '0', '?' => ['var' => null]]);
  487. $this->assertEquals('/posts/index/0', $result);
  488. $result = Router::url([
  489. 'controller' => 'posts',
  490. '0',
  491. '?' => [
  492. 'var' => 'test',
  493. 'var2' => 'test2',
  494. ],
  495. '#' => 'unencoded string %',
  496. ]);
  497. $expected = '/posts/index/0?var=test&var2=test2#unencoded string %';
  498. $this->assertEquals($expected, $result);
  499. }
  500. /**
  501. * test that regex validation of keyed route params is working.
  502. *
  503. * @return void
  504. */
  505. public function testUrlGenerationWithRegexQualifiedParams()
  506. {
  507. Router::connect(
  508. ':language/galleries',
  509. ['controller' => 'galleries', 'action' => 'index'],
  510. ['language' => '[a-z]{3}']
  511. );
  512. Router::connect(
  513. '/:language/:admin/:controller/:action/*',
  514. ['admin' => 'admin'],
  515. ['language' => '[a-z]{3}', 'admin' => 'admin']
  516. );
  517. Router::connect(
  518. '/:language/:controller/:action/*',
  519. [],
  520. ['language' => '[a-z]{3}']
  521. );
  522. $result = Router::url(['admin' => false, 'language' => 'dan', 'action' => 'index', 'controller' => 'galleries']);
  523. $expected = '/dan/galleries';
  524. $this->assertEquals($expected, $result);
  525. $result = Router::url(['admin' => false, 'language' => 'eng', 'action' => 'index', 'controller' => 'galleries']);
  526. $expected = '/eng/galleries';
  527. $this->assertEquals($expected, $result);
  528. Router::reload();
  529. Router::connect(
  530. '/:language/pages',
  531. ['controller' => 'pages', 'action' => 'index'],
  532. ['language' => '[a-z]{3}']
  533. );
  534. Router::connect('/:language/:controller/:action/*', [], ['language' => '[a-z]{3}']);
  535. $result = Router::url(['language' => 'eng', 'action' => 'index', 'controller' => 'pages']);
  536. $expected = '/eng/pages';
  537. $this->assertEquals($expected, $result);
  538. $result = Router::url(['language' => 'eng', 'controller' => 'pages']);
  539. $this->assertEquals($expected, $result);
  540. $result = Router::url(['language' => 'eng', 'controller' => 'pages', 'action' => 'add']);
  541. $expected = '/eng/pages/add';
  542. $this->assertEquals($expected, $result);
  543. Router::reload();
  544. Router::connect(
  545. '/forestillinger/:month/:year/*',
  546. ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'],
  547. ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}']
  548. );
  549. $result = Router::url([
  550. 'plugin' => 'shows',
  551. 'controller' => 'shows',
  552. 'action' => 'calendar',
  553. 'month' => '10',
  554. 'year' => '2007',
  555. 'min-forestilling',
  556. ]);
  557. $expected = '/forestillinger/10/2007/min-forestilling';
  558. $this->assertEquals($expected, $result);
  559. Router::reload();
  560. Router::connect(
  561. '/kalender/:month/:year/*',
  562. ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'],
  563. ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}']
  564. );
  565. Router::connect('/kalender/*', ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar']);
  566. $result = Router::url(['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar', 'min-forestilling']);
  567. $expected = '/kalender/min-forestilling';
  568. $this->assertEquals($expected, $result);
  569. $result = Router::url([
  570. 'plugin' => 'shows',
  571. 'controller' => 'shows',
  572. 'action' => 'calendar',
  573. 'year' => '2007',
  574. 'month' => '10',
  575. 'min-forestilling',
  576. ]);
  577. $expected = '/kalender/10/2007/min-forestilling';
  578. $this->assertEquals($expected, $result);
  579. }
  580. /**
  581. * Test URL generation with an admin prefix
  582. *
  583. * @return void
  584. */
  585. public function testUrlGenerationWithPrefix()
  586. {
  587. Router::reload();
  588. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  589. Router::connect('/reset/*', ['admin' => true, 'controller' => 'users', 'action' => 'reset']);
  590. Router::connect('/tests', ['controller' => 'tests', 'action' => 'index']);
  591. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  592. Router::extensions('rss', false);
  593. $request = new ServerRequest([
  594. 'params' => [
  595. 'controller' => 'registrations',
  596. 'action' => 'admin_index',
  597. 'plugin' => null,
  598. 'prefix' => 'admin',
  599. '_ext' => 'html',
  600. ],
  601. 'url' => '/admin/registrations/index',
  602. ]);
  603. Router::setRequestInfo($request);
  604. $result = Router::url([]);
  605. $expected = '/admin/registrations/index';
  606. $this->assertEquals($expected, $result);
  607. Router::reload();
  608. Router::connect('/admin/subscriptions/:action/*', ['controller' => 'subscribe', 'prefix' => 'admin']);
  609. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  610. $request = new ServerRequest([
  611. 'params' => [
  612. 'action' => 'index',
  613. 'plugin' => null,
  614. 'controller' => 'subscribe',
  615. 'prefix' => 'admin',
  616. ],
  617. 'webroot' => '/magazine/',
  618. 'base' => '/magazine',
  619. 'url' => '/admin/subscriptions/edit/1',
  620. ]);
  621. Router::setRequestInfo($request);
  622. $result = Router::url(['action' => 'edit', 1]);
  623. $expected = '/magazine/admin/subscriptions/edit/1';
  624. $this->assertEquals($expected, $result);
  625. $result = Router::url(['prefix' => 'admin', 'controller' => 'users', 'action' => 'login']);
  626. $expected = '/magazine/admin/users/login';
  627. $this->assertEquals($expected, $result);
  628. Router::reload();
  629. $request = new ServerRequest([
  630. 'params' => [
  631. 'prefix' => 'admin',
  632. 'action' => 'index',
  633. 'plugin' => null,
  634. 'controller' => 'users',
  635. ],
  636. 'webroot' => '/',
  637. 'url' => '/admin/users/index',
  638. ]);
  639. Router::setRequestInfo($request);
  640. Router::connect('/page/*', ['controller' => 'pages', 'action' => 'view', 'prefix' => 'admin']);
  641. $result = Router::url(['prefix' => 'admin', 'controller' => 'pages', 'action' => 'view', 'my-page']);
  642. $expected = '/page/my-page';
  643. $this->assertEquals($expected, $result);
  644. Router::reload();
  645. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  646. $request = new ServerRequest([
  647. 'params' => [
  648. 'plugin' => null,
  649. 'controller' => 'pages',
  650. 'action' => 'add',
  651. 'prefix' => 'admin',
  652. ],
  653. 'webroot' => '/',
  654. 'url' => '/admin/pages/add',
  655. ]);
  656. Router::setRequestInfo($request);
  657. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]);
  658. $expected = '/admin/pages/add';
  659. $this->assertEquals($expected, $result);
  660. Router::reload();
  661. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  662. $request = new ServerRequest([
  663. 'params' => [
  664. 'plugin' => null,
  665. 'controller' => 'pages',
  666. 'action' => 'add',
  667. 'prefix' => 'admin',
  668. ],
  669. 'webroot' => '/',
  670. 'url' => '/admin/pages/add',
  671. ]);
  672. Router::setRequestInfo($request);
  673. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]);
  674. $expected = '/admin/pages/add';
  675. $this->assertEquals($expected, $result);
  676. Router::reload();
  677. Router::connect('/admin/:controller/:action/:id', ['prefix' => 'admin'], ['id' => '[0-9]+']);
  678. $request = new ServerRequest([
  679. 'params' => [
  680. 'plugin' => null,
  681. 'controller' => 'pages',
  682. 'action' => 'edit',
  683. 'pass' => ['284'],
  684. 'prefix' => 'admin',
  685. ],
  686. 'url' => '/admin/pages/edit/284',
  687. ]);
  688. Router::setRequestInfo($request);
  689. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'id' => '284']);
  690. $expected = '/admin/pages/edit/284';
  691. $this->assertEquals($expected, $result);
  692. Router::reload();
  693. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  694. $request = new ServerRequest([
  695. 'params' => [
  696. 'plugin' => null, 'controller' => 'pages', 'action' => 'add', 'prefix' => 'admin',
  697. ],
  698. 'url' => '/admin/pages/add',
  699. ]);
  700. Router::setRequestInfo($request);
  701. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'add', 'id' => false]);
  702. $expected = '/admin/pages/add';
  703. $this->assertEquals($expected, $result);
  704. Router::reload();
  705. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  706. $request = new ServerRequest([
  707. 'params' => [
  708. 'plugin' => null, 'controller' => 'pages', 'action' => 'edit', 'prefix' => 'admin',
  709. ],
  710. 'url' => '/admin/pages/edit/284',
  711. ]);
  712. Router::setRequestInfo($request);
  713. $result = Router::url(['plugin' => null, 'controller' => 'pages', 'action' => 'edit', 284]);
  714. $expected = '/admin/pages/edit/284';
  715. $this->assertEquals($expected, $result);
  716. Router::reload();
  717. Router::connect('/admin/posts/*', ['controller' => 'posts', 'action' => 'index', 'prefix' => 'admin']);
  718. $request = new ServerRequest([
  719. 'params' => [
  720. 'plugin' => null, 'controller' => 'posts', 'action' => 'index', 'prefix' => 'admin',
  721. 'pass' => ['284'],
  722. ],
  723. 'url' => '/admin/pages/edit/284',
  724. ]);
  725. Router::setRequestInfo($request);
  726. $result = Router::url(['all']);
  727. $expected = '/admin/posts/all';
  728. $this->assertEquals($expected, $result);
  729. }
  730. /**
  731. * Test URL generation inside a prefixed plugin.
  732. *
  733. * @return void
  734. */
  735. public function testUrlGenerationPrefixedPlugin()
  736. {
  737. Router::prefix('admin', function (RouteBuilder $routes) {
  738. $routes->plugin('MyPlugin', function (RouteBuilder $routes) {
  739. $routes->fallbacks('InflectedRoute');
  740. });
  741. });
  742. $result = Router::url(['prefix' => 'admin', 'plugin' => 'MyPlugin', 'controller' => 'Forms', 'action' => 'edit', 2]);
  743. $expected = '/admin/my-plugin/forms/edit/2';
  744. $this->assertEquals($expected, $result);
  745. }
  746. /**
  747. * Test URL generation with multiple prefixes.
  748. *
  749. * @return void
  750. */
  751. public function testUrlGenerationMultiplePrefixes()
  752. {
  753. Router::prefix('admin', function (RouteBuilder $routes) {
  754. $routes->prefix('backoffice', function (RouteBuilder $routes) {
  755. $routes->fallbacks('InflectedRoute');
  756. });
  757. });
  758. $result = Router::url([
  759. 'prefix' => 'admin/backoffice',
  760. 'controller' => 'Dashboards',
  761. 'action' => 'home',
  762. ]);
  763. $expected = '/admin/backoffice/dashboards/home';
  764. $this->assertEquals($expected, $result);
  765. }
  766. /**
  767. * testUrlGenerationWithExtensions method
  768. *
  769. * @return void
  770. */
  771. public function testUrlGenerationWithExtensions()
  772. {
  773. Router::connect('/:controller', ['action' => 'index']);
  774. Router::connect('/:controller/:action');
  775. $result = Router::url([
  776. 'plugin' => null,
  777. 'controller' => 'articles',
  778. 'action' => 'add',
  779. 'id' => null,
  780. '_ext' => 'json',
  781. ]);
  782. $expected = '/articles/add.json';
  783. $this->assertEquals($expected, $result);
  784. $result = Router::url([
  785. 'plugin' => null,
  786. 'controller' => 'articles',
  787. 'action' => 'add',
  788. '_ext' => 'json',
  789. ]);
  790. $expected = '/articles/add.json';
  791. $this->assertEquals($expected, $result);
  792. $result = Router::url([
  793. 'plugin' => null,
  794. 'controller' => 'articles',
  795. 'action' => 'index',
  796. 'id' => null,
  797. '_ext' => 'json',
  798. ]);
  799. $expected = '/articles.json';
  800. $this->assertEquals($expected, $result);
  801. $result = Router::url([
  802. 'plugin' => null,
  803. 'controller' => 'articles',
  804. 'action' => 'index',
  805. '?' => ['id' => 'testing'],
  806. '_ext' => 'json',
  807. ]);
  808. $expected = '/articles.json?id=testing';
  809. $this->assertEquals($expected, $result);
  810. }
  811. /**
  812. * test url() when the current request has an extension.
  813. *
  814. * @return void
  815. */
  816. public function testUrlGenerationWithExtensionInCurrentRequest()
  817. {
  818. Router::extensions('rss');
  819. Router::scope('/', function ($r) {
  820. $r->fallbacks('InflectedRoute');
  821. });
  822. $request = new ServerRequest([
  823. 'params' => ['plugin' => null, 'controller' => 'Tasks', 'action' => 'index', '_ext' => 'rss'],
  824. ]);
  825. Router::pushRequest($request);
  826. $result = Router::url([
  827. 'controller' => 'Tasks',
  828. 'action' => 'view',
  829. 1,
  830. ]);
  831. $expected = '/tasks/view/1';
  832. $this->assertEquals($expected, $result);
  833. $result = Router::url([
  834. 'controller' => 'Tasks',
  835. 'action' => 'view',
  836. 1,
  837. '_ext' => 'json',
  838. ]);
  839. $expected = '/tasks/view/1.json';
  840. $this->assertEquals($expected, $result);
  841. }
  842. /**
  843. * Test url generation with named routes.
  844. */
  845. public function testUrlGenerationNamedRoute()
  846. {
  847. Router::connect(
  848. '/users',
  849. ['controller' => 'users', 'action' => 'index'],
  850. ['_name' => 'users-index']
  851. );
  852. Router::connect(
  853. '/users/:name',
  854. ['controller' => 'users', 'action' => 'view'],
  855. ['_name' => 'test']
  856. );
  857. Router::connect(
  858. '/view/*',
  859. ['action' => 'view'],
  860. ['_name' => 'Articles::view']
  861. );
  862. $url = Router::url(['_name' => 'test', 'name' => 'mark']);
  863. $this->assertEquals('/users/mark', $url);
  864. $url = Router::url([
  865. '_name' => 'test', 'name' => 'mark',
  866. '?' => ['page' => 1, 'sort' => 'title', 'dir' => 'desc', ],
  867. ]);
  868. $this->assertEquals('/users/mark?page=1&sort=title&dir=desc', $url);
  869. $url = Router::url(['_name' => 'Articles::view']);
  870. $this->assertEquals('/view/', $url);
  871. $url = Router::url(['_name' => 'Articles::view', '1']);
  872. $this->assertEquals('/view/1', $url);
  873. $url = Router::url(['_name' => 'Articles::view', '_full' => true, '1']);
  874. $this->assertEquals('http://localhost/view/1', $url);
  875. $url = Router::url(['_name' => 'Articles::view', '1', '#' => 'frag']);
  876. $this->assertEquals('/view/1#frag', $url);
  877. }
  878. /**
  879. * Test that using invalid names causes exceptions.
  880. *
  881. * @return void
  882. */
  883. public function testNamedRouteException()
  884. {
  885. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  886. Router::connect(
  887. '/users/:name',
  888. ['controller' => 'users', 'action' => 'view'],
  889. ['_name' => 'test']
  890. );
  891. $url = Router::url(['_name' => 'junk', 'name' => 'mark']);
  892. }
  893. /**
  894. * Test that using duplicate names causes exceptions.
  895. *
  896. * @return void
  897. */
  898. public function testDuplicateNamedRouteException()
  899. {
  900. $this->expectException(\Cake\Routing\Exception\DuplicateNamedRouteException::class);
  901. Router::connect(
  902. '/users/:name',
  903. ['controller' => 'users', 'action' => 'view'],
  904. ['_name' => 'test']
  905. );
  906. Router::connect(
  907. '/users/:name',
  908. ['controller' => 'users', 'action' => 'view'],
  909. ['_name' => 'otherName']
  910. );
  911. Router::connect(
  912. '/users/:name',
  913. ['controller' => 'users', 'action' => 'view'],
  914. ['_name' => 'test']
  915. );
  916. }
  917. /**
  918. * Test that url filters are applied to url params.
  919. *
  920. * @return void
  921. */
  922. public function testUrlGenerationWithUrlFilter()
  923. {
  924. Router::connect('/:lang/:controller/:action/*');
  925. $request = new ServerRequest([
  926. 'params' => [
  927. 'plugin' => null,
  928. 'lang' => 'en',
  929. 'controller' => 'posts',
  930. 'action' => 'index',
  931. ],
  932. ]);
  933. Router::pushRequest($request);
  934. $calledCount = 0;
  935. Router::addUrlFilter(function ($url, $request) use (&$calledCount) {
  936. $calledCount++;
  937. $url['lang'] = $request->getParam('lang');
  938. return $url;
  939. });
  940. Router::addUrlFilter(function ($url, $request) use (&$calledCount) {
  941. $calledCount++;
  942. $url[] = '1234';
  943. return $url;
  944. });
  945. $result = Router::url(['controller' => 'tasks', 'action' => 'edit']);
  946. $this->assertEquals('/en/tasks/edit/1234', $result);
  947. $this->assertEquals(2, $calledCount);
  948. }
  949. /**
  950. * Test url param persistence.
  951. *
  952. * @return void
  953. */
  954. public function testUrlParamPersistence()
  955. {
  956. Router::connect('/:lang/:controller/:action/*', [], ['persist' => ['lang']]);
  957. $request = new ServerRequest([
  958. 'url' => '/en/posts/index',
  959. 'params' => [
  960. 'plugin' => null,
  961. 'lang' => 'en',
  962. 'controller' => 'posts',
  963. 'action' => 'index',
  964. ],
  965. ]);
  966. Router::pushRequest($request);
  967. $result = Router::url(['controller' => 'tasks', 'action' => 'edit', '1234']);
  968. $this->assertEquals('/en/tasks/edit/1234', $result);
  969. }
  970. /**
  971. * Test that plain strings urls work
  972. *
  973. * @return void
  974. */
  975. public function testUrlGenerationPlainString()
  976. {
  977. $mailto = 'mailto:mark@example.com';
  978. $result = Router::url($mailto);
  979. $this->assertEquals($mailto, $result);
  980. $js = 'javascript:alert("hi")';
  981. $result = Router::url($js);
  982. $this->assertEquals($js, $result);
  983. $hash = '#first';
  984. $result = Router::url($hash);
  985. $this->assertEquals($hash, $result);
  986. }
  987. /**
  988. * test that you can leave active plugin routes with plugin = null
  989. *
  990. * @return void
  991. */
  992. public function testCanLeavePlugin()
  993. {
  994. Router::connect('/admin/:controller', ['action' => 'index', 'prefix' => 'admin']);
  995. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  996. $request = new ServerRequest([
  997. 'url' => '/admin/this/interesting/index',
  998. 'params' => [
  999. 'pass' => [],
  1000. 'prefix' => 'admin',
  1001. 'plugin' => 'this',
  1002. 'action' => 'index',
  1003. 'controller' => 'interesting',
  1004. ],
  1005. ]);
  1006. Router::setRequestInfo($request);
  1007. $result = Router::url(['plugin' => null, 'controller' => 'posts', 'action' => 'index']);
  1008. $this->assertEquals('/admin/posts', $result);
  1009. }
  1010. /**
  1011. * testUrlParsing method
  1012. *
  1013. * @return void
  1014. */
  1015. public function testUrlParsing()
  1016. {
  1017. extract(Router::getNamedExpressions());
  1018. Router::connect(
  1019. '/posts/:value/:somevalue/:othervalue/*',
  1020. ['controller' => 'Posts', 'action' => 'view'],
  1021. ['value', 'somevalue', 'othervalue']
  1022. );
  1023. $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET'));
  1024. $expected = [
  1025. 'value' => '2007',
  1026. 'somevalue' => '08',
  1027. 'othervalue' => '01',
  1028. 'controller' => 'Posts',
  1029. 'action' => 'view',
  1030. 'plugin' => null,
  1031. 'pass' => ['0' => 'title-of-post-here'],
  1032. '_matchedRoute' => '/posts/:value/:somevalue/:othervalue/*',
  1033. ];
  1034. $this->assertEquals($expected, $result);
  1035. Router::reload();
  1036. Router::connect(
  1037. '/posts/:year/:month/:day/*',
  1038. ['controller' => 'posts', 'action' => 'view'],
  1039. ['year' => $Year, 'month' => $Month, 'day' => $Day]
  1040. );
  1041. $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET'));
  1042. $expected = [
  1043. 'year' => '2007',
  1044. 'month' => '08',
  1045. 'day' => '01',
  1046. 'controller' => 'posts',
  1047. 'action' => 'view',
  1048. 'plugin' => null,
  1049. 'pass' => ['0' => 'title-of-post-here'],
  1050. '_matchedRoute' => '/posts/:year/:month/:day/*',
  1051. ];
  1052. $this->assertEquals($expected, $result);
  1053. Router::reload();
  1054. Router::connect(
  1055. '/posts/:day/:year/:month/*',
  1056. ['controller' => 'posts', 'action' => 'view'],
  1057. ['year' => $Year, 'month' => $Month, 'day' => $Day]
  1058. );
  1059. $result = Router::parseRequest($this->makeRequest('/posts/01/2007/08/title-of-post-here', 'GET'));
  1060. $expected = [
  1061. 'day' => '01',
  1062. 'year' => '2007',
  1063. 'month' => '08',
  1064. 'controller' => 'posts',
  1065. 'action' => 'view',
  1066. 'plugin' => null,
  1067. 'pass' => ['0' => 'title-of-post-here'],
  1068. '_matchedRoute' => '/posts/:day/:year/:month/*',
  1069. ];
  1070. $this->assertEquals($expected, $result);
  1071. Router::reload();
  1072. Router::connect(
  1073. '/posts/:month/:day/:year/*',
  1074. ['controller' => 'posts', 'action' => 'view'],
  1075. ['year' => $Year, 'month' => $Month, 'day' => $Day]
  1076. );
  1077. $result = Router::parseRequest($this->makeRequest('/posts/08/01/2007/title-of-post-here', 'GET'));
  1078. $expected = [
  1079. 'month' => '08',
  1080. 'day' => '01',
  1081. 'year' => '2007',
  1082. 'controller' => 'posts',
  1083. 'action' => 'view',
  1084. 'plugin' => null,
  1085. 'pass' => ['0' => 'title-of-post-here'],
  1086. '_matchedRoute' => '/posts/:month/:day/:year/*',
  1087. ];
  1088. $this->assertEquals($expected, $result);
  1089. Router::reload();
  1090. Router::connect(
  1091. '/posts/:year/:month/:day/*',
  1092. ['controller' => 'posts', 'action' => 'view']
  1093. );
  1094. $result = Router::parseRequest($this->makeRequest('/posts/2007/08/01/title-of-post-here', 'GET'));
  1095. $expected = [
  1096. 'year' => '2007',
  1097. 'month' => '08',
  1098. 'day' => '01',
  1099. 'controller' => 'posts',
  1100. 'action' => 'view',
  1101. 'plugin' => null,
  1102. 'pass' => ['0' => 'title-of-post-here'],
  1103. '_matchedRoute' => '/posts/:year/:month/:day/*',
  1104. ];
  1105. $this->assertEquals($expected, $result);
  1106. Router::reload();
  1107. $this->_connectDefaultRoutes();
  1108. $result = Router::parseRequest($this->makeRequest('/pages/display/home', 'GET'));
  1109. $expected = [
  1110. 'plugin' => null,
  1111. 'pass' => ['home'],
  1112. 'controller' => 'Pages',
  1113. 'action' => 'display',
  1114. '_matchedRoute' => '/:controller/:action/*',
  1115. ];
  1116. $this->assertEquals($expected, $result);
  1117. $result = Router::parseRequest($this->makeRequest('pages/display/home/', 'GET'));
  1118. $this->assertEquals($expected, $result);
  1119. $result = Router::parseRequest($this->makeRequest('pages/display/home', 'GET'));
  1120. $this->assertEquals($expected, $result);
  1121. Router::reload();
  1122. Router::connect('/page/*', ['controller' => 'test']);
  1123. $result = Router::parseRequest($this->makeRequest('/page/my-page', 'GET'));
  1124. $expected = [
  1125. 'pass' => ['my-page'],
  1126. 'plugin' => null,
  1127. 'controller' => 'test',
  1128. 'action' => 'index',
  1129. '_matchedRoute' => '/page/*',
  1130. ];
  1131. $this->assertEquals($expected, $result);
  1132. Router::reload();
  1133. Router::connect(
  1134. '/:language/contact',
  1135. ['language' => 'eng', 'plugin' => 'contact', 'controller' => 'contact', 'action' => 'index'],
  1136. ['language' => '[a-z]{3}']
  1137. );
  1138. $result = Router::parseRequest($this->makeRequest('/eng/contact', 'GET'));
  1139. $expected = [
  1140. 'pass' => [],
  1141. 'language' => 'eng',
  1142. 'plugin' => 'contact',
  1143. 'controller' => 'contact',
  1144. 'action' => 'index',
  1145. '_matchedRoute' => '/:language/contact',
  1146. ];
  1147. $this->assertEquals($expected, $result);
  1148. Router::reload();
  1149. Router::connect(
  1150. '/forestillinger/:month/:year/*',
  1151. ['plugin' => 'shows', 'controller' => 'shows', 'action' => 'calendar'],
  1152. ['month' => '0[1-9]|1[012]', 'year' => '[12][0-9]{3}']
  1153. );
  1154. $result = Router::parseRequest($this->makeRequest('/forestillinger/10/2007/min-forestilling', 'GET'));
  1155. $expected = [
  1156. 'pass' => ['min-forestilling'],
  1157. 'plugin' => 'shows',
  1158. 'controller' => 'shows',
  1159. 'action' => 'calendar',
  1160. 'year' => 2007,
  1161. 'month' => 10,
  1162. '_matchedRoute' => '/forestillinger/:month/:year/*',
  1163. ];
  1164. $this->assertEquals($expected, $result);
  1165. Router::reload();
  1166. Router::connect('/:controller/:action/*');
  1167. Router::connect('/', ['plugin' => 'pages', 'controller' => 'pages', 'action' => 'display']);
  1168. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  1169. $expected = [
  1170. 'pass' => [],
  1171. 'controller' => 'pages',
  1172. 'action' => 'display',
  1173. 'plugin' => 'pages',
  1174. '_matchedRoute' => '/',
  1175. ];
  1176. $this->assertEquals($expected, $result);
  1177. $result = Router::parseRequest($this->makeRequest('/posts/edit/0', 'GET'));
  1178. $expected = [
  1179. 'pass' => [0],
  1180. 'controller' => 'posts',
  1181. 'action' => 'edit',
  1182. 'plugin' => null,
  1183. '_matchedRoute' => '/:controller/:action/*',
  1184. ];
  1185. $this->assertEquals($expected, $result);
  1186. Router::reload();
  1187. Router::connect(
  1188. '/posts/:id::url_title',
  1189. ['controller' => 'posts', 'action' => 'view'],
  1190. ['pass' => ['id', 'url_title'], 'id' => '[\d]+']
  1191. );
  1192. $result = Router::parseRequest($this->makeRequest('/posts/5:sample-post-title', 'GET'));
  1193. $expected = [
  1194. 'pass' => ['5', 'sample-post-title'],
  1195. 'id' => 5,
  1196. 'url_title' => 'sample-post-title',
  1197. 'plugin' => null,
  1198. 'controller' => 'posts',
  1199. 'action' => 'view',
  1200. '_matchedRoute' => '/posts/:id::url_title',
  1201. ];
  1202. $this->assertEquals($expected, $result);
  1203. Router::reload();
  1204. Router::connect(
  1205. '/posts/:id::url_title/*',
  1206. ['controller' => 'posts', 'action' => 'view'],
  1207. ['pass' => ['id', 'url_title'], 'id' => '[\d]+']
  1208. );
  1209. $result = Router::parseRequest($this->makeRequest('/posts/5:sample-post-title/other/params/4', 'GET'));
  1210. $expected = [
  1211. 'pass' => ['5', 'sample-post-title', 'other', 'params', '4'],
  1212. 'id' => 5,
  1213. 'url_title' => 'sample-post-title',
  1214. 'plugin' => null,
  1215. 'controller' => 'posts',
  1216. 'action' => 'view',
  1217. '_matchedRoute' => '/posts/:id::url_title/*',
  1218. ];
  1219. $this->assertEquals($expected, $result);
  1220. Router::reload();
  1221. Router::connect('/posts/view/*', ['controller' => 'posts', 'action' => 'view']);
  1222. $result = Router::parseRequest($this->makeRequest('/posts/view/10?id=123&tab=abc', 'GET'));
  1223. $expected = [
  1224. 'pass' => [10],
  1225. 'plugin' => null,
  1226. 'controller' => 'posts',
  1227. 'action' => 'view',
  1228. '?' => ['id' => '123', 'tab' => 'abc'],
  1229. '_matchedRoute' => '/posts/view/*',
  1230. ];
  1231. $this->assertEquals($expected, $result);
  1232. Router::reload();
  1233. Router::connect(
  1234. '/posts/:url_title-(uuid::id)',
  1235. ['controller' => 'posts', 'action' => 'view'],
  1236. ['pass' => ['id', 'url_title'], 'id' => $UUID]
  1237. );
  1238. $result = Router::parseRequest($this->makeRequest('/posts/sample-post-title-(uuid:47fc97a9-019c-41d1-a058-1fa3cbdd56cb)', 'GET'));
  1239. $expected = [
  1240. 'pass' => ['47fc97a9-019c-41d1-a058-1fa3cbdd56cb', 'sample-post-title'],
  1241. 'id' => '47fc97a9-019c-41d1-a058-1fa3cbdd56cb',
  1242. 'url_title' => 'sample-post-title',
  1243. 'plugin' => null,
  1244. 'controller' => 'posts',
  1245. 'action' => 'view',
  1246. '_matchedRoute' => '/posts/:url_title-(uuid::id)',
  1247. ];
  1248. $this->assertEquals($expected, $result);
  1249. Router::reload();
  1250. Router::connect('/posts/view/*', ['controller' => 'posts', 'action' => 'view']);
  1251. $result = Router::parseRequest($this->makeRequest('/posts/view/foo:bar/routing:fun', 'GET'));
  1252. $expected = [
  1253. 'pass' => ['foo:bar', 'routing:fun'],
  1254. 'plugin' => null,
  1255. 'controller' => 'posts',
  1256. 'action' => 'view',
  1257. '_matchedRoute' => '/posts/view/*',
  1258. ];
  1259. $this->assertEquals($expected, $result);
  1260. }
  1261. /**
  1262. * test parseRequest
  1263. *
  1264. * @return void
  1265. */
  1266. public function testParseRequest()
  1267. {
  1268. Router::connect('/articles/:action/*', ['controller' => 'Articles']);
  1269. $request = new ServerRequest(['url' => '/articles/view/1']);
  1270. $result = Router::parseRequest($request);
  1271. $expected = [
  1272. 'pass' => ['1'],
  1273. 'plugin' => null,
  1274. 'controller' => 'Articles',
  1275. 'action' => 'view',
  1276. '_matchedRoute' => '/articles/:action/*',
  1277. ];
  1278. $this->assertEquals($expected, $result);
  1279. }
  1280. /**
  1281. * testUuidRoutes method
  1282. *
  1283. * @return void
  1284. */
  1285. public function testUuidRoutes()
  1286. {
  1287. Router::connect(
  1288. '/subjects/add/:category_id',
  1289. ['controller' => 'subjects', 'action' => 'add'],
  1290. ['category_id' => '\w{8}-\w{4}-\w{4}-\w{4}-\w{12}']
  1291. );
  1292. $result = Router::parseRequest($this->makeRequest('/subjects/add/4795d601-19c8-49a6-930e-06a8b01d17b7', 'GET'));
  1293. $expected = [
  1294. 'pass' => [],
  1295. 'category_id' => '4795d601-19c8-49a6-930e-06a8b01d17b7',
  1296. 'plugin' => null,
  1297. 'controller' => 'subjects',
  1298. 'action' => 'add',
  1299. '_matchedRoute' => '/subjects/add/:category_id',
  1300. ];
  1301. $this->assertEquals($expected, $result);
  1302. }
  1303. /**
  1304. * testRouteSymmetry method
  1305. *
  1306. * @return void
  1307. */
  1308. public function testRouteSymmetry()
  1309. {
  1310. Router::connect(
  1311. '/:extra/page/:slug/*',
  1312. ['controller' => 'pages', 'action' => 'view', 'extra' => null],
  1313. ['extra' => '[a-z1-9_]*', 'slug' => '[a-z1-9_]+', 'action' => 'view']
  1314. );
  1315. $result = Router::parseRequest($this->makeRequest('/some_extra/page/this_is_the_slug', 'GET'));
  1316. $expected = [
  1317. 'pass' => [],
  1318. 'plugin' => null,
  1319. 'controller' => 'pages',
  1320. 'action' => 'view',
  1321. 'slug' => 'this_is_the_slug',
  1322. 'extra' => 'some_extra',
  1323. '_matchedRoute' => '/:extra/page/:slug/*',
  1324. ];
  1325. $this->assertEquals($expected, $result);
  1326. $result = Router::parseRequest($this->makeRequest('/page/this_is_the_slug', 'GET'));
  1327. $expected = [
  1328. 'pass' => [],
  1329. 'plugin' => null,
  1330. 'controller' => 'pages',
  1331. 'action' => 'view',
  1332. 'slug' => 'this_is_the_slug',
  1333. 'extra' => null,
  1334. '_matchedRoute' => '/:extra/page/:slug/*',
  1335. ];
  1336. $this->assertEquals($expected, $result);
  1337. Router::reload();
  1338. Router::connect(
  1339. '/:extra/page/:slug/*',
  1340. ['controller' => 'pages', 'action' => 'view', 'extra' => null],
  1341. ['extra' => '[a-z1-9_]*', 'slug' => '[a-z1-9_]+']
  1342. );
  1343. $result = Router::url([
  1344. 'admin' => null,
  1345. 'plugin' => null,
  1346. 'controller' => 'pages',
  1347. 'action' => 'view',
  1348. 'slug' => 'this_is_the_slug',
  1349. 'extra' => null,
  1350. ]);
  1351. $expected = '/page/this_is_the_slug';
  1352. $this->assertEquals($expected, $result);
  1353. $result = Router::url([
  1354. 'admin' => null,
  1355. 'plugin' => null,
  1356. 'controller' => 'pages',
  1357. 'action' => 'view',
  1358. 'slug' => 'this_is_the_slug',
  1359. 'extra' => 'some_extra',
  1360. ]);
  1361. $expected = '/some_extra/page/this_is_the_slug';
  1362. $this->assertEquals($expected, $result);
  1363. }
  1364. /**
  1365. * Test exceptions when parsing fails.
  1366. *
  1367. */
  1368. public function testParseError()
  1369. {
  1370. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  1371. Router::connect('/', ['controller' => 'Pages', 'action' => 'display', 'home']);
  1372. Router::parseRequest($this->makeRequest('/nope', 'GET'));
  1373. }
  1374. /**
  1375. * Test parse and reverse symmetry
  1376. *
  1377. * @return void
  1378. * @dataProvider parseReverseSymmetryData
  1379. */
  1380. public function testParseReverseSymmetry($url)
  1381. {
  1382. $this->_connectDefaultRoutes();
  1383. $this->assertSame($url, Router::reverse(Router::parseRequest($this->makeRequest($url, 'GET')) + ['url' => []]));
  1384. }
  1385. /**
  1386. * Data for parse and reverse test
  1387. *
  1388. * @return array
  1389. */
  1390. public function parseReverseSymmetryData()
  1391. {
  1392. return [
  1393. ['/controller/action'],
  1394. ['/controller/action/param'],
  1395. ['/controller/action?param1=value1&param2=value2'],
  1396. ['/controller/action/param?param1=value1'],
  1397. ];
  1398. }
  1399. /**
  1400. * testSetExtensions method
  1401. *
  1402. * @return void
  1403. */
  1404. public function testSetExtensions()
  1405. {
  1406. Router::extensions('rss', false);
  1407. $this->assertContains('rss', Router::extensions());
  1408. $this->_connectDefaultRoutes();
  1409. $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET'));
  1410. $this->assertEquals('rss', $result['_ext']);
  1411. $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET'));
  1412. $this->assertArrayNotHasKey('_ext', $result);
  1413. Router::extensions(['xml']);
  1414. }
  1415. /**
  1416. * Test that route builders propagate extensions to the top.
  1417. *
  1418. * @return void
  1419. */
  1420. public function testExtensionsWithScopedRoutes()
  1421. {
  1422. Router::extensions(['json']);
  1423. Router::scope('/', function (RouteBuilder $routes) {
  1424. $routes->setExtensions('rss');
  1425. $routes->connect('/', ['controller' => 'Pages', 'action' => 'index']);
  1426. $routes->scope('/api', function (RouteBuilder $routes) {
  1427. $routes->setExtensions('xml');
  1428. $routes->connect('/docs', ['controller' => 'ApiDocs', 'action' => 'index']);
  1429. });
  1430. });
  1431. $this->assertEquals(['json', 'rss', 'xml'], array_values(Router::extensions()));
  1432. }
  1433. /**
  1434. * Test connecting resources.
  1435. *
  1436. * @return void
  1437. */
  1438. public function testResourcesInScope()
  1439. {
  1440. Router::scope('/api', ['prefix' => 'api'], function (RouteBuilder $routes) {
  1441. $routes->setExtensions(['json']);
  1442. $routes->resources('Articles');
  1443. });
  1444. $url = Router::url([
  1445. 'prefix' => 'api',
  1446. 'controller' => 'Articles',
  1447. 'action' => 'edit',
  1448. '_method' => 'PUT',
  1449. 'id' => '99',
  1450. ]);
  1451. $this->assertEquals('/api/articles/99', $url);
  1452. $url = Router::url([
  1453. 'prefix' => 'api',
  1454. 'controller' => 'Articles',
  1455. 'action' => 'edit',
  1456. '_method' => 'PUT',
  1457. '_ext' => 'json',
  1458. 'id' => '99',
  1459. ]);
  1460. $this->assertEquals('/api/articles/99.json', $url);
  1461. }
  1462. /**
  1463. * testExtensionParsing method
  1464. *
  1465. * @return void
  1466. */
  1467. public function testExtensionParsing()
  1468. {
  1469. Router::extensions('rss', false);
  1470. $this->_connectDefaultRoutes();
  1471. $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET'));
  1472. $expected = [
  1473. 'plugin' => null,
  1474. 'controller' => 'Posts',
  1475. 'action' => 'index',
  1476. '_ext' => 'rss',
  1477. 'pass' => [],
  1478. '_matchedRoute' => '/:controller',
  1479. ];
  1480. $this->assertEquals($expected, $result);
  1481. $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss', 'GET'));
  1482. $expected = [
  1483. 'plugin' => null,
  1484. 'controller' => 'Posts',
  1485. 'action' => 'view',
  1486. 'pass' => ['1'],
  1487. '_ext' => 'rss',
  1488. '_matchedRoute' => '/:controller/:action/*',
  1489. ];
  1490. $this->assertEquals($expected, $result);
  1491. $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss?query=test', 'GET'));
  1492. $expected['?'] = ['query' => 'test'];
  1493. $this->assertEquals($expected, $result);
  1494. Router::reload();
  1495. Router::extensions(['rss', 'xml'], false);
  1496. $this->_connectDefaultRoutes();
  1497. $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET'));
  1498. $expected = [
  1499. 'plugin' => null,
  1500. 'controller' => 'Posts',
  1501. 'action' => 'index',
  1502. '_ext' => 'xml',
  1503. 'pass' => [],
  1504. '_matchedRoute' => '/:controller',
  1505. ];
  1506. $this->assertEquals($expected, $result);
  1507. $result = Router::parseRequest($this->makeRequest('/posts.atom?hello=goodbye', 'GET'));
  1508. $expected = [
  1509. 'plugin' => null,
  1510. 'controller' => 'Posts.atom',
  1511. 'action' => 'index',
  1512. 'pass' => [],
  1513. '?' => ['hello' => 'goodbye'],
  1514. '_matchedRoute' => '/:controller',
  1515. ];
  1516. $this->assertEquals($expected, $result);
  1517. Router::reload();
  1518. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1519. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1520. $expected = [
  1521. 'controller' => 'controller',
  1522. 'action' => 'action',
  1523. 'plugin' => null,
  1524. '_ext' => 'rss',
  1525. 'pass' => [],
  1526. '_matchedRoute' => '/controller/action',
  1527. ];
  1528. $this->assertEquals($expected, $result);
  1529. Router::reload();
  1530. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1531. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1532. $expected = [
  1533. 'controller' => 'controller',
  1534. 'action' => 'action',
  1535. 'plugin' => null,
  1536. '_ext' => 'rss',
  1537. 'pass' => [],
  1538. '_matchedRoute' => '/controller/action',
  1539. ];
  1540. $this->assertEquals($expected, $result);
  1541. Router::reload();
  1542. Router::extensions('rss', false);
  1543. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1544. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1545. $expected = [
  1546. 'controller' => 'controller',
  1547. 'action' => 'action',
  1548. 'plugin' => null,
  1549. '_ext' => 'rss',
  1550. 'pass' => [],
  1551. '_matchedRoute' => '/controller/action',
  1552. ];
  1553. $this->assertEquals($expected, $result);
  1554. }
  1555. /**
  1556. * Test newer style automatically generated prefix routes.
  1557. *
  1558. * @return void
  1559. * @see testUrlGenerationWithAutoPrefixes
  1560. */
  1561. public function testUrlGenerationWithAutoPrefixes()
  1562. {
  1563. Router::reload();
  1564. Router::connect('/protected/:controller/:action/*', ['prefix' => 'protected']);
  1565. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  1566. Router::connect('/:controller/:action/*');
  1567. $request = new ServerRequest([
  1568. 'url' => '/images/index',
  1569. 'params' => [
  1570. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  1571. 'prefix' => null, 'protected' => false, 'url' => ['url' => 'images/index'],
  1572. ],
  1573. ]);
  1574. Router::setRequestInfo($request);
  1575. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  1576. $expected = '/images/add';
  1577. $this->assertEquals($expected, $result);
  1578. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  1579. $expected = '/protected/images/add';
  1580. $this->assertEquals($expected, $result);
  1581. $result = Router::url(['controller' => 'images', 'action' => 'add_protected_test', 'prefix' => 'protected']);
  1582. $expected = '/protected/images/add_protected_test';
  1583. $this->assertEquals($expected, $result);
  1584. $result = Router::url(['action' => 'edit', 1]);
  1585. $expected = '/images/edit/1';
  1586. $this->assertEquals($expected, $result);
  1587. $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']);
  1588. $expected = '/protected/images/edit/1';
  1589. $this->assertEquals($expected, $result);
  1590. $result = Router::url(['action' => 'protectededit', 1, 'prefix' => 'protected']);
  1591. $expected = '/protected/images/protectededit/1';
  1592. $this->assertEquals($expected, $result);
  1593. $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']);
  1594. $expected = '/protected/images/edit/1';
  1595. $this->assertEquals($expected, $result);
  1596. $result = Router::url(['controller' => 'others', 'action' => 'edit', 1]);
  1597. $expected = '/others/edit/1';
  1598. $this->assertEquals($expected, $result);
  1599. $result = Router::url(['controller' => 'others', 'action' => 'edit', 1, 'prefix' => 'protected']);
  1600. $expected = '/protected/others/edit/1';
  1601. $this->assertEquals($expected, $result);
  1602. }
  1603. /**
  1604. * Test that the ssl option works.
  1605. *
  1606. * @return void
  1607. */
  1608. public function testGenerationWithSslOption()
  1609. {
  1610. Router::connect('/:controller/:action/*');
  1611. $request = new ServerRequest([
  1612. 'url' => '/images/index',
  1613. 'params' => [
  1614. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  1615. ],
  1616. 'environment' => ['HTTP_HOST' => 'localhost'],
  1617. ]);
  1618. Router::pushRequest($request);
  1619. $result = Router::url([
  1620. '_ssl' => true,
  1621. ]);
  1622. $this->assertEquals('https://localhost/images/index', $result);
  1623. $result = Router::url([
  1624. '_ssl' => false,
  1625. ]);
  1626. $this->assertEquals('http://localhost/images/index', $result);
  1627. }
  1628. /**
  1629. * Test that the _ssl + _full options work together.
  1630. *
  1631. * @return void
  1632. */
  1633. public function testGenerationWithSslAndFullOption()
  1634. {
  1635. Configure::write('App.fullBaseUrl', 'http://app.localhost');
  1636. Router::connect('/:controller/:action/*');
  1637. $request = new ServerRequest([
  1638. 'environment' => ['HTTP_HOST' => 'localhost'],
  1639. ]);
  1640. Router::pushRequest($request);
  1641. $result = Router::url([
  1642. 'controller' => 'images',
  1643. 'action' => 'index',
  1644. '_ssl' => true,
  1645. '_full' => true,
  1646. ]);
  1647. $this->assertEquals('https://app.localhost/images/index', $result);
  1648. $result = Router::url([
  1649. 'controller' => 'images',
  1650. 'action' => 'index',
  1651. '_ssl' => false,
  1652. '_full' => true,
  1653. ]);
  1654. $this->assertEquals('http://app.localhost/images/index', $result);
  1655. $result = Router::url([
  1656. 'controller' => 'images',
  1657. 'action' => 'index',
  1658. '_full' => false,
  1659. '_ssl' => false,
  1660. ]);
  1661. $this->assertEquals('http://localhost/images/index', $result);
  1662. }
  1663. /**
  1664. * Test ssl option when the current request is ssl.
  1665. *
  1666. * @return void
  1667. */
  1668. public function testGenerateWithSslInSsl()
  1669. {
  1670. Router::connect('/:controller/:action/*');
  1671. $request = new ServerRequest([
  1672. 'url' => '/images/index',
  1673. 'environment' => ['HTTP_HOST' => 'localhost', 'HTTPS' => 'on'],
  1674. 'params' => [
  1675. 'plugin' => null,
  1676. 'controller' => 'images',
  1677. 'action' => 'index',
  1678. ],
  1679. ]);
  1680. Router::pushRequest($request);
  1681. $result = Router::url([
  1682. '_ssl' => false,
  1683. ]);
  1684. $this->assertEquals('http://localhost/images/index', $result);
  1685. $result = Router::url([
  1686. '_ssl' => true,
  1687. ]);
  1688. $this->assertEquals('https://localhost/images/index', $result);
  1689. }
  1690. /**
  1691. * test that prefix routes persist when they are in the current request.
  1692. *
  1693. * @return void
  1694. */
  1695. public function testPrefixRoutePersistence()
  1696. {
  1697. Router::reload();
  1698. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1699. Router::connect('/:controller/:action');
  1700. $request = new ServerRequest([
  1701. 'url' => '/protected/images/index',
  1702. 'params' => [
  1703. 'plugin' => null,
  1704. 'controller' => 'images',
  1705. 'action' => 'index',
  1706. 'prefix' => 'protected',
  1707. ],
  1708. ]);
  1709. Router::setRequestInfo($request);
  1710. $result = Router::url(['prefix' => 'protected', 'controller' => 'images', 'action' => 'add']);
  1711. $expected = '/protected/images/add';
  1712. $this->assertEquals($expected, $result);
  1713. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  1714. $expected = '/protected/images/add';
  1715. $this->assertEquals($expected, $result);
  1716. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => false]);
  1717. $expected = '/images/add';
  1718. $this->assertEquals($expected, $result);
  1719. }
  1720. /**
  1721. * test that setting a prefix override the current one
  1722. *
  1723. * @return void
  1724. */
  1725. public function testPrefixOverride()
  1726. {
  1727. Router::connect('/admin/:controller/:action', ['prefix' => 'admin']);
  1728. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1729. $request = new ServerRequest([
  1730. 'url' => '/protected/images/index',
  1731. 'params' => [
  1732. 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'protected',
  1733. ],
  1734. ]);
  1735. Router::setRequestInfo($request);
  1736. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'admin']);
  1737. $expected = '/admin/images/add';
  1738. $this->assertEquals($expected, $result);
  1739. $request = new ServerRequest([
  1740. 'url' => '/admin/images/index',
  1741. 'params' => [
  1742. 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'admin',
  1743. ],
  1744. ]);
  1745. Router::setRequestInfo($request);
  1746. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  1747. $expected = '/protected/images/add';
  1748. $this->assertEquals($expected, $result);
  1749. }
  1750. /**
  1751. * Test that well known route parameters are passed through.
  1752. *
  1753. * @return void
  1754. */
  1755. public function testRouteParamDefaults()
  1756. {
  1757. Router::connect('/cache/*', ['prefix' => false, 'plugin' => true, 'controller' => 0, 'action' => 1]);
  1758. $url = Router::url(['prefix' => '0', 'plugin' => '1', 'controller' => '0', 'action' => '1', 'test']);
  1759. $expected = '/cache/test';
  1760. $this->assertEquals($expected, $url);
  1761. try {
  1762. Router::url(['controller' => '0', 'action' => '1', 'test']);
  1763. $this->fail('No exception raised');
  1764. } catch (\Exception $e) {
  1765. $this->assertTrue(true, 'Exception was raised');
  1766. }
  1767. try {
  1768. Router::url(['prefix' => '1', 'controller' => '0', 'action' => '1', 'test']);
  1769. $this->fail('No exception raised');
  1770. } catch (\Exception $e) {
  1771. $this->assertTrue(true, 'Exception was raised');
  1772. }
  1773. }
  1774. /**
  1775. * testRemoveBase method
  1776. *
  1777. * @return void
  1778. */
  1779. public function testRemoveBase()
  1780. {
  1781. Router::connect('/:controller/:action');
  1782. $request = new ServerRequest([
  1783. 'url' => '/',
  1784. 'base' => '/base',
  1785. 'params' => [
  1786. 'plugin' => null, 'controller' => 'controller', 'action' => 'index',
  1787. ],
  1788. ]);
  1789. Router::setRequestInfo($request);
  1790. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action']);
  1791. $expected = '/base/my_controller/my_action';
  1792. $this->assertEquals($expected, $result);
  1793. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action', '_base' => false]);
  1794. $expected = '/my_controller/my_action';
  1795. $this->assertEquals($expected, $result);
  1796. }
  1797. /**
  1798. * testPagesUrlParsing method
  1799. *
  1800. * @return void
  1801. */
  1802. public function testPagesUrlParsing()
  1803. {
  1804. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  1805. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  1806. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  1807. $expected = [
  1808. 'pass' => ['home'],
  1809. 'plugin' => null,
  1810. 'controller' => 'pages',
  1811. 'action' => 'display',
  1812. '_matchedRoute' => '/',
  1813. ];
  1814. $this->assertEquals($expected, $result);
  1815. $result = Router::parseRequest($this->makeRequest('/pages/home/', 'GET'));
  1816. $expected = [
  1817. 'pass' => ['home'],
  1818. 'plugin' => null,
  1819. 'controller' => 'pages',
  1820. 'action' => 'display',
  1821. '_matchedRoute' => '/pages/*',
  1822. ];
  1823. $this->assertEquals($expected, $result);
  1824. Router::reload();
  1825. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  1826. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  1827. $expected = [
  1828. 'pass' => ['home'],
  1829. 'plugin' => null,
  1830. 'controller' => 'pages',
  1831. 'action' => 'display',
  1832. '_matchedRoute' => '/',
  1833. ];
  1834. $this->assertEquals($expected, $result);
  1835. Router::reload();
  1836. Router::connect('/', ['controller' => 'posts', 'action' => 'index']);
  1837. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  1838. $result = Router::parseRequest($this->makeRequest('/pages/contact/', 'GET'));
  1839. $expected = [
  1840. 'pass' => ['contact'],
  1841. 'plugin' => null,
  1842. 'controller' => 'pages',
  1843. 'action' => 'display',
  1844. '_matchedRoute' => '/pages/*',
  1845. ];
  1846. $this->assertEquals($expected, $result);
  1847. }
  1848. /**
  1849. * test that requests with a trailing dot don't loose the do.
  1850. *
  1851. * @return void
  1852. */
  1853. public function testParsingWithTrailingPeriod()
  1854. {
  1855. Router::reload();
  1856. Router::connect('/:controller/:action/*');
  1857. $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET'));
  1858. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  1859. $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET'));
  1860. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  1861. }
  1862. /**
  1863. * test that requests with a trailing dot don't loose the do.
  1864. *
  1865. * @return void
  1866. */
  1867. public function testParsingWithTrailingPeriodAndParseExtensions()
  1868. {
  1869. Router::reload();
  1870. Router::connect('/:controller/:action/*');
  1871. $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET'));
  1872. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  1873. $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET'));
  1874. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  1875. }
  1876. /**
  1877. * test that patterns work for :action
  1878. *
  1879. * @return void
  1880. */
  1881. public function testParsingWithPatternOnAction()
  1882. {
  1883. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  1884. Router::connect(
  1885. '/blog/:action/*',
  1886. ['controller' => 'blog_posts'],
  1887. ['action' => 'other|actions']
  1888. );
  1889. $result = Router::parseRequest($this->makeRequest('/blog/other', 'GET'));
  1890. $expected = [
  1891. 'plugin' => null,
  1892. 'controller' => 'blog_posts',
  1893. 'action' => 'other',
  1894. 'pass' => [],
  1895. '_matchedRoute' => '/blog/:action/*',
  1896. ];
  1897. $this->assertEquals($expected, $result);
  1898. Router::parseRequest($this->makeRequest('/blog/foobar', 'GET'));
  1899. }
  1900. /**
  1901. * Test url() works with patterns on :action
  1902. *
  1903. * @return void
  1904. */
  1905. public function testUrlPatternOnAction()
  1906. {
  1907. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  1908. Router::connect(
  1909. '/blog/:action/*',
  1910. ['controller' => 'blog_posts'],
  1911. ['action' => 'other|actions']
  1912. );
  1913. $result = Router::url(['controller' => 'blog_posts', 'action' => 'actions']);
  1914. $this->assertEquals('/blog/actions', $result);
  1915. $result = Router::url(['controller' => 'blog_posts', 'action' => 'foo']);
  1916. $this->assertEquals('/', $result);
  1917. }
  1918. /**
  1919. * testParsingWithLiteralPrefixes method
  1920. *
  1921. * @return void
  1922. */
  1923. public function testParsingWithLiteralPrefixes()
  1924. {
  1925. Router::reload();
  1926. $adminParams = ['prefix' => 'admin'];
  1927. Router::connect('/admin/:controller', $adminParams);
  1928. Router::connect('/admin/:controller/:action/*', $adminParams);
  1929. $request = new ServerRequest([
  1930. 'url' => '/',
  1931. 'base' => '/base',
  1932. 'params' => ['plugin' => null, 'controller' => 'controller', 'action' => 'index'],
  1933. ]);
  1934. Router::setRequestInfo($request);
  1935. $result = Router::parseRequest($this->makeRequest('/admin/posts/', 'GET'));
  1936. $expected = [
  1937. 'pass' => [],
  1938. 'prefix' => 'admin',
  1939. 'plugin' => null,
  1940. 'controller' => 'posts',
  1941. 'action' => 'index',
  1942. '_matchedRoute' => '/admin/:controller',
  1943. ];
  1944. $this->assertEquals($expected, $result);
  1945. $result = Router::parseRequest($this->makeRequest('/admin/posts', 'GET'));
  1946. $this->assertEquals($expected, $result);
  1947. $result = Router::url(['prefix' => 'admin', 'controller' => 'posts']);
  1948. $expected = '/base/admin/posts';
  1949. $this->assertEquals($expected, $result);
  1950. Router::reload();
  1951. $prefixParams = ['prefix' => 'members'];
  1952. Router::connect('/members/:controller', $prefixParams);
  1953. Router::connect('/members/:controller/:action', $prefixParams);
  1954. Router::connect('/members/:controller/:action/*', $prefixParams);
  1955. $request = new ServerRequest([
  1956. 'url' => '/',
  1957. 'base' => '/base',
  1958. 'params' => ['plugin' => null, 'controller' => 'controller', 'action' => 'index'],
  1959. ]);
  1960. Router::setRequestInfo($request);
  1961. $result = Router::parseRequest($this->makeRequest('/members/posts/index', 'GET'));
  1962. $expected = [
  1963. 'pass' => [],
  1964. 'prefix' => 'members',
  1965. 'plugin' => null,
  1966. 'controller' => 'posts',
  1967. 'action' => 'index',
  1968. '_matchedRoute' => '/members/:controller/:action',
  1969. ];
  1970. $this->assertEquals($expected, $result);
  1971. $result = Router::url(['prefix' => 'members', 'controller' => 'users', 'action' => 'add']);
  1972. $expected = '/base/members/users/add';
  1973. $this->assertEquals($expected, $result);
  1974. }
  1975. /**
  1976. * Tests URL generation with flags and prefixes in and out of context
  1977. *
  1978. * @return void
  1979. */
  1980. public function testUrlWritingWithPrefixes()
  1981. {
  1982. Router::connect('/company/:controller/:action/*', ['prefix' => 'company']);
  1983. Router::connect('/:action', ['controller' => 'users']);
  1984. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => 'company']);
  1985. $expected = '/company/users/login';
  1986. $this->assertEquals($expected, $result);
  1987. $request = new ServerRequest([
  1988. 'url' => '/',
  1989. 'params' => [
  1990. 'plugin' => null,
  1991. 'controller' => 'users',
  1992. 'action' => 'login',
  1993. 'prefix' => 'company',
  1994. ],
  1995. ]);
  1996. Router::setRequestInfo($request);
  1997. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => false]);
  1998. $expected = '/login';
  1999. $this->assertEquals($expected, $result);
  2000. }
  2001. /**
  2002. * test url generation with prefixes and custom routes
  2003. *
  2004. * @return void
  2005. */
  2006. public function testUrlWritingWithPrefixesAndCustomRoutes()
  2007. {
  2008. Router::connect(
  2009. '/admin/login',
  2010. ['controller' => 'users', 'action' => 'login', 'prefix' => 'admin']
  2011. );
  2012. $request = new ServerRequest([
  2013. 'url' => '/',
  2014. 'params' => [
  2015. 'plugin' => null,
  2016. 'controller' => 'posts',
  2017. 'action' => 'index',
  2018. 'prefix' => 'admin',
  2019. ],
  2020. 'webroot' => '/',
  2021. ]);
  2022. Router::setRequestInfo($request);
  2023. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2024. $this->assertEquals('/admin/login', $result);
  2025. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2026. $this->assertEquals('/admin/login', $result);
  2027. }
  2028. /**
  2029. * testPassedArgsOrder method
  2030. *
  2031. * @return void
  2032. */
  2033. public function testPassedArgsOrder()
  2034. {
  2035. Router::connect('/test-passed/*', ['controller' => 'pages', 'action' => 'display', 'home']);
  2036. Router::connect('/test2/*', ['controller' => 'pages', 'action' => 'display', 2]);
  2037. Router::connect('/test/*', ['controller' => 'pages', 'action' => 'display', 1]);
  2038. $result = Router::url(['controller' => 'pages', 'action' => 'display', 1, 'whatever']);
  2039. $expected = '/test/whatever';
  2040. $this->assertEquals($expected, $result);
  2041. $result = Router::url(['controller' => 'pages', 'action' => 'display', 2, 'whatever']);
  2042. $expected = '/test2/whatever';
  2043. $this->assertEquals($expected, $result);
  2044. $result = Router::url(['controller' => 'pages', 'action' => 'display', 'home', 'whatever']);
  2045. $expected = '/test-passed/whatever';
  2046. $this->assertEquals($expected, $result);
  2047. }
  2048. /**
  2049. * testRegexRouteMatching method
  2050. *
  2051. * @return void
  2052. */
  2053. public function testRegexRouteMatching()
  2054. {
  2055. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2056. $result = Router::parseRequest($this->makeRequest('/eng/test/test_action', 'GET'));
  2057. $expected = [
  2058. 'pass' => [],
  2059. 'locale' => 'eng',
  2060. 'controller' => 'test',
  2061. 'action' => 'test_action',
  2062. 'plugin' => null,
  2063. '_matchedRoute' => '/:locale/:controller/:action/*',
  2064. ];
  2065. $this->assertEquals($expected, $result);
  2066. }
  2067. /**
  2068. * testRegexRouteMatching method
  2069. *
  2070. * @return void
  2071. */
  2072. public function testRegexRouteMatchUrl()
  2073. {
  2074. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2075. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2076. $request = new ServerRequest([
  2077. 'url' => '/test/test_action',
  2078. 'params' => [
  2079. 'plugin' => null,
  2080. 'controller' => 'test',
  2081. 'action' => 'index',
  2082. ],
  2083. 'webroot' => '/',
  2084. ]);
  2085. Router::setRequestInfo($request);
  2086. $result = Router::url(['action' => 'test_another_action', 'locale' => 'eng']);
  2087. $expected = '/eng/test/test_another_action';
  2088. $this->assertEquals($expected, $result);
  2089. $result = Router::url(['action' => 'test_another_action']);
  2090. $expected = '/';
  2091. $this->assertEquals($expected, $result);
  2092. }
  2093. /**
  2094. * test using a custom route class for route connection
  2095. *
  2096. * @return void
  2097. */
  2098. public function testUsingCustomRouteClass()
  2099. {
  2100. $this->loadPlugins(['TestPlugin']);
  2101. Router::connect(
  2102. '/:slug',
  2103. ['plugin' => 'TestPlugin', 'action' => 'index'],
  2104. ['routeClass' => 'PluginShortRoute', 'slug' => '[a-z_-]+']
  2105. );
  2106. $result = Router::parseRequest($this->makeRequest('/the-best', 'GET'));
  2107. $expected = [
  2108. 'plugin' => 'TestPlugin',
  2109. 'controller' => 'TestPlugin',
  2110. 'action' => 'index',
  2111. 'slug' => 'the-best',
  2112. 'pass' => [],
  2113. '_matchedRoute' => '/:slug',
  2114. ];
  2115. $this->assertEquals($expected, $result);
  2116. }
  2117. /**
  2118. * test using custom route class in PluginDot notation
  2119. *
  2120. * @return void
  2121. */
  2122. public function testUsingCustomRouteClassPluginDotSyntax()
  2123. {
  2124. $this->loadPlugins(['TestPlugin']);
  2125. Router::connect(
  2126. '/:slug',
  2127. ['controller' => 'posts', 'action' => 'view'],
  2128. ['routeClass' => 'TestPlugin.TestRoute', 'slug' => '[a-z_-]+']
  2129. );
  2130. $this->assertTrue(true); // Just to make sure the connect do not throw exception
  2131. $this->removePlugins(['TestPlugin']);
  2132. }
  2133. /**
  2134. * test that route classes must extend \Cake\Routing\Route\Route
  2135. *
  2136. * @return void
  2137. */
  2138. public function testCustomRouteException()
  2139. {
  2140. $this->expectException(\InvalidArgumentException::class);
  2141. Router::connect('/:controller', [], ['routeClass' => 'Object']);
  2142. }
  2143. /**
  2144. * test reversing parameter arrays back into strings.
  2145. *
  2146. * Mark the router as initialized so it doesn't auto-load routes
  2147. *
  2148. * @return void
  2149. */
  2150. public function testReverseToken()
  2151. {
  2152. Router::connect('/:controller/:action/*');
  2153. $params = [
  2154. 'controller' => 'posts',
  2155. 'action' => 'view',
  2156. 'pass' => [1],
  2157. 'url' => [],
  2158. 'autoRender' => 1,
  2159. 'bare' => 1,
  2160. 'return' => 1,
  2161. 'requested' => 1,
  2162. '_Token' => ['key' => 'sekret'],
  2163. ];
  2164. $result = Router::reverse($params);
  2165. $this->assertEquals('/posts/view/1', $result);
  2166. }
  2167. public function testReverseLocalized()
  2168. {
  2169. Router::reload();
  2170. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2171. $params = [
  2172. 'lang' => 'eng',
  2173. 'controller' => 'posts',
  2174. 'action' => 'view',
  2175. 'pass' => [1],
  2176. 'url' => ['url' => 'eng/posts/view/1'],
  2177. ];
  2178. $result = Router::reverse($params);
  2179. $this->assertEquals('/eng/posts/view/1', $result);
  2180. }
  2181. public function testReverseArrayQuery()
  2182. {
  2183. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2184. $params = [
  2185. 'lang' => 'eng',
  2186. 'controller' => 'posts',
  2187. 'action' => 'view',
  2188. 1,
  2189. '?' => ['foo' => 'bar'],
  2190. ];
  2191. $result = Router::reverse($params);
  2192. $this->assertEquals('/eng/posts/view/1?foo=bar', $result);
  2193. $params = [
  2194. 'lang' => 'eng',
  2195. 'controller' => 'posts',
  2196. 'action' => 'view',
  2197. 'pass' => [1],
  2198. 'url' => ['url' => 'eng/posts/view/1'],
  2199. 'paging' => [],
  2200. 'models' => [],
  2201. ];
  2202. $result = Router::reverse($params);
  2203. $this->assertEquals('/eng/posts/view/1', $result);
  2204. }
  2205. public function testReverseCakeRequestQuery()
  2206. {
  2207. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2208. $request = new ServerRequest([
  2209. 'url' => '/eng/posts/view/1',
  2210. 'params' => [
  2211. 'lang' => 'eng',
  2212. 'controller' => 'posts',
  2213. 'action' => 'view',
  2214. 'pass' => [1],
  2215. ],
  2216. 'query' => ['url' => 'eng/posts/view/1', 'test' => 'value'],
  2217. ]);
  2218. $result = Router::reverse($request);
  2219. $expected = '/eng/posts/view/1?test=value';
  2220. $this->assertEquals($expected, $result);
  2221. }
  2222. public function testReverseFull()
  2223. {
  2224. Router::scope('/', function (RouteBuilder $routes) {
  2225. $routes->fallbacks();
  2226. });
  2227. $params = [
  2228. 'lang' => 'eng',
  2229. 'controller' => 'posts',
  2230. 'action' => 'view',
  2231. 'pass' => [1],
  2232. 'url' => ['url' => 'eng/posts/view/1'],
  2233. ];
  2234. $result = Router::reverse($params, true);
  2235. $this->assertRegExp('/^http(s)?:\/\//', $result);
  2236. }
  2237. /**
  2238. * Test that extensions work with Router::reverse()
  2239. *
  2240. * @return void
  2241. */
  2242. public function testReverseWithExtension()
  2243. {
  2244. Router::connect('/:controller/:action/*');
  2245. Router::extensions('json', false);
  2246. $request = new ServerRequest([
  2247. 'url' => '/posts/view/1.json',
  2248. 'params' => [
  2249. 'controller' => 'posts',
  2250. 'action' => 'view',
  2251. 'pass' => [1],
  2252. '_ext' => 'json',
  2253. ],
  2254. ]);
  2255. $result = Router::reverse($request);
  2256. $expected = '/posts/view/1.json';
  2257. $this->assertEquals($expected, $result);
  2258. }
  2259. public function testReverseToArrayQuery()
  2260. {
  2261. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2262. $params = [
  2263. 'lang' => 'eng',
  2264. 'controller' => 'posts',
  2265. 'action' => 'view',
  2266. 'pass' => [123],
  2267. 'url' => ['url' => 'eng/posts/view/123', 'foo' => 'bar', 'baz' => 'quu'],
  2268. 'paging' => [],
  2269. 'models' => [],
  2270. ];
  2271. $actual = Router::reverseToArray($params);
  2272. $expected = [
  2273. 'lang' => 'eng',
  2274. 'controller' => 'posts',
  2275. 'action' => 'view',
  2276. 123,
  2277. '?' => ['foo' => 'bar', 'baz' => 'quu'],
  2278. ];
  2279. $this->assertEquals($expected, $actual);
  2280. }
  2281. public function testReverseToArrayRequestQuery()
  2282. {
  2283. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2284. $request = new ServerRequest([
  2285. 'url' => '/eng/posts/view/1',
  2286. 'params' => [
  2287. 'lang' => 'eng',
  2288. 'controller' => 'posts',
  2289. 'action' => 'view',
  2290. 'pass' => [123],
  2291. ],
  2292. 'query' => ['url' => 'eng/posts/view/1', 'test' => 'value'],
  2293. ]);
  2294. $actual = Router::reverseToArray($request);
  2295. $expected = [
  2296. 'lang' => 'eng',
  2297. 'controller' => 'posts',
  2298. 'action' => 'view',
  2299. 123,
  2300. '?' => [
  2301. 'test' => 'value',
  2302. ],
  2303. ];
  2304. $this->assertEquals($expected, $actual);
  2305. }
  2306. /**
  2307. * test get request.
  2308. *
  2309. * @return void
  2310. */
  2311. public function testGetRequest()
  2312. {
  2313. $requestA = new ServerRequest(['url' => '/']);
  2314. $requestB = new ServerRequest(['url' => '/posts']);
  2315. Router::pushRequest($requestA);
  2316. Router::pushRequest($requestB);
  2317. $this->assertSame($requestA, Router::getRequest(false));
  2318. $this->assertSame($requestB, Router::getRequest(true));
  2319. }
  2320. /**
  2321. * Test that Router::url() uses the first request
  2322. */
  2323. public function testUrlWithRequestAction()
  2324. {
  2325. Router::connect('/:controller', ['action' => 'index']);
  2326. Router::connect('/:controller/:action');
  2327. $firstRequest = new ServerRequest([
  2328. 'url' => '/posts/index',
  2329. 'params' => [
  2330. 'plugin' => null,
  2331. 'controller' => 'posts',
  2332. 'action' => 'index',
  2333. ],
  2334. ]);
  2335. $secondRequest = new ServerRequest([
  2336. 'url' => '/posts/index',
  2337. 'params' => [
  2338. 'requested' => 1,
  2339. 'plugin' => null,
  2340. 'controller' => 'comments',
  2341. 'action' => 'listing',
  2342. ],
  2343. ]);
  2344. Router::setRequestInfo($firstRequest);
  2345. Router::setRequestInfo($secondRequest);
  2346. $result = Router::url(['_base' => false]);
  2347. $this->assertEquals('/comments/listing', $result, 'with second requests, the last should win.');
  2348. Router::popRequest();
  2349. $result = Router::url(['_base' => false]);
  2350. $this->assertEquals('/posts', $result, 'with second requests, the last should win.');
  2351. // Make sure that popping an empty request doesn't fail.
  2352. Router::popRequest();
  2353. }
  2354. /**
  2355. * test that a route object returning a full URL is not modified.
  2356. *
  2357. * @return void
  2358. */
  2359. public function testUrlFullUrlReturnFromRoute()
  2360. {
  2361. $url = 'http://example.com/posts/view/1';
  2362. $route = $this->getMockBuilder('Cake\Routing\Route\Route')
  2363. ->setMethods(['match'])
  2364. ->setConstructorArgs(['/:controller/:action/*'])
  2365. ->getMock();
  2366. $route->expects($this->any())
  2367. ->method('match')
  2368. ->will($this->returnValue($url));
  2369. Router::connect($route);
  2370. $result = Router::url(['controller' => 'posts', 'action' => 'view', 1]);
  2371. $this->assertEquals($url, $result);
  2372. }
  2373. /**
  2374. * test protocol in url
  2375. *
  2376. * @return void
  2377. */
  2378. public function testUrlProtocol()
  2379. {
  2380. $url = 'http://example.com';
  2381. $this->assertEquals($url, Router::url($url));
  2382. $url = 'ed2k://example.com';
  2383. $this->assertEquals($url, Router::url($url));
  2384. $url = 'svn+ssh://example.com';
  2385. $this->assertEquals($url, Router::url($url));
  2386. $url = '://example.com';
  2387. $this->assertEquals($url, Router::url($url));
  2388. $url = '//example.com';
  2389. $this->assertEquals($url, Router::url($url));
  2390. $url = 'javascript:void(0)';
  2391. $this->assertEquals($url, Router::url($url));
  2392. $url = 'tel:012345-678';
  2393. $this->assertEquals($url, Router::url($url));
  2394. $url = 'sms:012345-678';
  2395. $this->assertEquals($url, Router::url($url));
  2396. $url = '#here';
  2397. $this->assertEquals($url, Router::url($url));
  2398. $url = '?param=0';
  2399. $this->assertEquals($url, Router::url($url));
  2400. $url = '/posts/index#here';
  2401. $expected = Configure::read('App.fullBaseUrl') . '/posts/index#here';
  2402. $this->assertEquals($expected, Router::url($url, true));
  2403. }
  2404. /**
  2405. * Testing that patterns on the :action param work properly.
  2406. *
  2407. * @return void
  2408. */
  2409. public function testPatternOnAction()
  2410. {
  2411. $route = new Route(
  2412. '/blog/:action/*',
  2413. ['controller' => 'blog_posts'],
  2414. ['action' => 'other|actions']
  2415. );
  2416. $result = $route->match(['controller' => 'blog_posts', 'action' => 'foo']);
  2417. $this->assertNull($result);
  2418. $result = $route->match(['controller' => 'blog_posts', 'action' => 'actions']);
  2419. $this->assertEquals('/blog/actions/', $result);
  2420. $result = $route->parseRequest($this->makeRequest('/blog/other', 'GET'));
  2421. $expected = [
  2422. 'controller' => 'blog_posts',
  2423. 'action' => 'other',
  2424. 'pass' => [],
  2425. '_matchedRoute' => '/blog/:action/*',
  2426. ];
  2427. $this->assertEquals($expected, $result);
  2428. $result = $route->parseRequest($this->makeRequest('/blog/foobar', 'GET'));
  2429. $this->assertNull($result);
  2430. }
  2431. /**
  2432. * Test the scope() method
  2433. *
  2434. * @return void
  2435. */
  2436. public function testScope()
  2437. {
  2438. Router::scope('/path', ['param' => 'value'], function (RouteBuilder $routes) {
  2439. $this->assertEquals('/path', $routes->path());
  2440. $this->assertEquals(['param' => 'value'], $routes->params());
  2441. $this->assertEquals('', $routes->namePrefix());
  2442. $routes->connect('/articles', ['controller' => 'Articles']);
  2443. });
  2444. }
  2445. /**
  2446. * Test the scope() method
  2447. *
  2448. * @return void
  2449. */
  2450. public function testScopeError()
  2451. {
  2452. $this->expectException(\InvalidArgumentException::class);
  2453. Router::scope('/path', 'derpy');
  2454. }
  2455. /**
  2456. * Test to ensure that extensions defined in scopes don't leak.
  2457. * And that global extensions are propagated.
  2458. *
  2459. * @return void
  2460. */
  2461. public function testScopeExtensionsContained()
  2462. {
  2463. Router::extensions(['json']);
  2464. Router::scope('/', function (RouteBuilder $routes) {
  2465. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2466. $routes->setExtensions(['rss']);
  2467. $this->assertEquals(
  2468. ['rss'],
  2469. $routes->getExtensions(),
  2470. 'Should include new extensions.'
  2471. );
  2472. $routes->connect('/home', []);
  2473. });
  2474. $this->assertEquals(['json', 'rss'], array_values(Router::extensions()));
  2475. Router::scope('/api', function (RouteBuilder $routes) {
  2476. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2477. $routes->setExtensions(['json', 'csv']);
  2478. $routes->connect('/export', []);
  2479. $routes->scope('/v1', function (RouteBuilder $routes) {
  2480. $this->assertEquals(['json', 'csv'], $routes->getExtensions());
  2481. });
  2482. });
  2483. $this->assertEquals(['json', 'rss', 'csv'], array_values(Router::extensions()));
  2484. }
  2485. /**
  2486. * Test the scope() options
  2487. *
  2488. * @return void
  2489. */
  2490. public function testScopeOptions()
  2491. {
  2492. $options = ['param' => 'value', 'routeClass' => 'InflectedRoute', 'extensions' => ['json']];
  2493. Router::scope('/path', $options, function (RouteBuilder $routes) {
  2494. $this->assertSame('InflectedRoute', $routes->getRouteClass());
  2495. $this->assertSame(['json'], $routes->getExtensions());
  2496. $this->assertEquals('/path', $routes->path());
  2497. $this->assertEquals(['param' => 'value'], $routes->params());
  2498. });
  2499. }
  2500. /**
  2501. * Test the scope() method
  2502. *
  2503. * @return void
  2504. */
  2505. public function testScopeNamePrefix()
  2506. {
  2507. Router::scope('/path', ['param' => 'value', '_namePrefix' => 'path:'], function (RouteBuilder $routes) {
  2508. $this->assertEquals('/path', $routes->path());
  2509. $this->assertEquals(['param' => 'value'], $routes->params());
  2510. $this->assertEquals('path:', $routes->namePrefix());
  2511. $routes->connect('/articles', ['controller' => 'Articles']);
  2512. });
  2513. }
  2514. /**
  2515. * Test that prefix() creates a scope.
  2516. *
  2517. * @return void
  2518. */
  2519. public function testPrefix()
  2520. {
  2521. Router::prefix('admin', function (RouteBuilder $routes) {
  2522. $this->assertEquals('/admin', $routes->path());
  2523. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2524. });
  2525. Router::prefix('admin', ['_namePrefix' => 'admin:'], function (RouteBuilder $routes) {
  2526. $this->assertEquals('admin:', $routes->namePrefix());
  2527. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2528. });
  2529. }
  2530. /**
  2531. * Test that prefix() accepts options
  2532. *
  2533. * @return void
  2534. */
  2535. public function testPrefixOptions()
  2536. {
  2537. Router::prefix('admin', ['param' => 'value'], function (RouteBuilder $routes) {
  2538. $this->assertEquals('/admin', $routes->path());
  2539. $this->assertEquals(['prefix' => 'admin', 'param' => 'value'], $routes->params());
  2540. });
  2541. Router::prefix('CustomPath', ['path' => '/custom-path'], function (RouteBuilder $routes) {
  2542. $this->assertEquals('/custom-path', $routes->path());
  2543. $this->assertEquals(['prefix' => 'custom_path'], $routes->params());
  2544. });
  2545. }
  2546. /**
  2547. * Test that plugin() creates a scope.
  2548. *
  2549. * @return void
  2550. */
  2551. public function testPlugin()
  2552. {
  2553. Router::plugin('DebugKit', function (RouteBuilder $routes) {
  2554. $this->assertEquals('/debug-kit', $routes->path());
  2555. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2556. });
  2557. }
  2558. /**
  2559. * Test that plugin() accepts options
  2560. *
  2561. * @return void
  2562. */
  2563. public function testPluginOptions()
  2564. {
  2565. Router::plugin('DebugKit', ['path' => '/debugger'], function (RouteBuilder $routes) {
  2566. $this->assertEquals('/debugger', $routes->path());
  2567. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2568. });
  2569. Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function (RouteBuilder $routes) {
  2570. $this->assertEquals('contacts:', $routes->namePrefix());
  2571. });
  2572. }
  2573. /**
  2574. * Test setting default route class.
  2575. *
  2576. * @return void
  2577. */
  2578. public function testDefaultRouteClass()
  2579. {
  2580. Router::connect('/:controller', ['action' => 'index']);
  2581. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2582. $this->assertEquals('/FooBar', $result);
  2583. // This is needed because tests/boostrap.php sets App.namespace to 'App'
  2584. static::setAppNamespace();
  2585. Router::defaultRouteClass('DashedRoute');
  2586. Router::connect('/cake/:controller', ['action' => 'cake']);
  2587. $result = Router::url(['controller' => 'FooBar', 'action' => 'cake']);
  2588. $this->assertEquals('/cake/foo-bar', $result);
  2589. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2590. $this->assertEquals('/FooBar', $result);
  2591. Router::reload();
  2592. Router::defaultRouteClass('DashedRoute');
  2593. Router::scope('/', function (RouteBuilder $routes) {
  2594. $routes->fallbacks();
  2595. });
  2596. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  2597. $this->assertEquals('/foo-bar', $result);
  2598. }
  2599. /**
  2600. * Test setting the request context.
  2601. *
  2602. * @return void
  2603. */
  2604. public function testSetRequestContextCakePHP()
  2605. {
  2606. Router::connect('/:controller/:action/*');
  2607. $request = new ServerRequest([
  2608. 'base' => '/subdir',
  2609. 'url' => 'articles/view/1',
  2610. ]);
  2611. Router::setRequestContext($request);
  2612. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  2613. $this->assertEquals('/subdir/things/add', $result);
  2614. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  2615. $this->assertEquals('http://localhost/subdir/things/add', $result);
  2616. $result = Router::url('/pages/home');
  2617. $this->assertEquals('/subdir/pages/home', $result);
  2618. }
  2619. /**
  2620. * Test setting the request context.
  2621. *
  2622. * @return void
  2623. */
  2624. public function testSetRequestContextPsr()
  2625. {
  2626. $server = [
  2627. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  2628. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php',
  2629. 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1',
  2630. 'REQUEST_URI' => '/subdir/articles/view/1',
  2631. 'QUERY_STRING' => '',
  2632. 'SERVER_PORT' => 80,
  2633. ];
  2634. Router::connect('/:controller/:action/*');
  2635. $request = ServerRequestFactory::fromGlobals($server);
  2636. Router::setRequestContext($request);
  2637. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  2638. $this->assertEquals('/subdir/things/add', $result);
  2639. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  2640. $this->assertEquals('http://localhost/subdir/things/add', $result);
  2641. $result = Router::url('/pages/home');
  2642. $this->assertEquals('/subdir/pages/home', $result);
  2643. }
  2644. /**
  2645. * Test getting the route collection
  2646. *
  2647. * @return void
  2648. */
  2649. public function testGetRouteCollection()
  2650. {
  2651. $collection = Router::getRouteCollection();
  2652. $this->assertInstanceOf(RouteCollection::class, $collection);
  2653. $this->assertCount(0, $collection->routes());
  2654. }
  2655. /**
  2656. * Test getting a route builder instance.
  2657. *
  2658. * @return void
  2659. */
  2660. public function testCreateRouteBuilder()
  2661. {
  2662. $builder = Router::createRouteBuilder('/api');
  2663. $this->assertInstanceOf(RouteBuilder::class, $builder);
  2664. $this->assertSame('/api', $builder->path());
  2665. $builder = Router::createRouteBuilder('/', [
  2666. 'routeClass' => 'InflectedRoute',
  2667. 'extensions' => ['json'],
  2668. ]);
  2669. $this->assertInstanceOf(RouteBuilder::class, $builder);
  2670. $this->assertSame(['json'], $builder->getExtensions());
  2671. }
  2672. /**
  2673. * test connect() with short string syntax
  2674. *
  2675. * @return void
  2676. */
  2677. public function testConnectShortStringSyntax()
  2678. {
  2679. Router::connect('/admin/articles/view', 'Admin/Articles::view');
  2680. $result = Router::parseRequest($this->makeRequest('/admin/articles/view', 'GET'));
  2681. $expected = [
  2682. 'pass' => [],
  2683. 'prefix' => 'admin',
  2684. 'controller' => 'Articles',
  2685. 'action' => 'view',
  2686. 'plugin' => null,
  2687. '_matchedRoute' => '/admin/articles/view',
  2688. ];
  2689. $this->assertEquals($result, $expected);
  2690. }
  2691. /**
  2692. * Connect some fallback routes for testing router behavior.
  2693. *
  2694. * @return void
  2695. */
  2696. protected function _connectDefaultRoutes()
  2697. {
  2698. Router::scope('/', function (RouteBuilder $routes) {
  2699. $routes->fallbacks('InflectedRoute');
  2700. });
  2701. }
  2702. /**
  2703. * Helper to create a request for a given URL and method.
  2704. *
  2705. * @param string $url The URL to create a request for
  2706. * @param string $method The HTTP method to use.
  2707. * @return \Cake\Http\ServerRequest
  2708. */
  2709. protected function makeRequest($url, $method)
  2710. {
  2711. $request = new ServerRequest([
  2712. 'url' => $url,
  2713. 'environment' => ['REQUEST_METHOD' => $method],
  2714. ]);
  2715. return $request;
  2716. }
  2717. }