RouterTest.php 116 KB

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