RouterTest.php 116 KB

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