RouterTest.php 117 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580
  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. public function testParseError()
  1643. {
  1644. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  1645. Router::connect('/', ['controller' => 'Pages', 'action' => 'display', 'home']);
  1646. Router::parseRequest($this->makeRequest('/nope', 'GET'));
  1647. }
  1648. /**
  1649. * Test deprecated behavior
  1650. *
  1651. * @group deprecated
  1652. * @return void
  1653. */
  1654. public function testParseMethodCondition()
  1655. {
  1656. $this->deprecated(function () {
  1657. Router::connect('/posts', ['controller' => 'Posts', '_method' => 'POST']);
  1658. $_SERVER['REQUEST_METHOD'] = 'POST';
  1659. $this->assertNotEmpty(Router::parse('/posts'));
  1660. });
  1661. }
  1662. /**
  1663. * Test parse and reverse symmetry
  1664. *
  1665. * @return void
  1666. * @dataProvider parseReverseSymmetryData
  1667. */
  1668. public function testParseReverseSymmetry($url)
  1669. {
  1670. $this->_connectDefaultRoutes();
  1671. $this->assertSame($url, Router::reverse(Router::parseRequest($this->makeRequest($url, 'GET')) + ['url' => []]));
  1672. }
  1673. /**
  1674. * Data for parse and reverse test
  1675. *
  1676. * @return array
  1677. */
  1678. public function parseReverseSymmetryData()
  1679. {
  1680. return [
  1681. ['/controller/action'],
  1682. ['/controller/action/param'],
  1683. ['/controller/action?param1=value1&param2=value2'],
  1684. ['/controller/action/param?param1=value1'],
  1685. ];
  1686. }
  1687. /**
  1688. * testSetExtensions method
  1689. *
  1690. * @return void
  1691. */
  1692. public function testSetExtensions()
  1693. {
  1694. Router::extensions('rss', false);
  1695. $this->assertContains('rss', Router::extensions());
  1696. $this->_connectDefaultRoutes();
  1697. $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET'));
  1698. $this->assertEquals('rss', $result['_ext']);
  1699. $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET'));
  1700. $this->assertArrayNotHasKey('_ext', $result);
  1701. Router::extensions(['xml']);
  1702. }
  1703. /**
  1704. * Test that route builders propagate extensions to the top.
  1705. *
  1706. * @return void
  1707. */
  1708. public function testExtensionsWithScopedRoutes()
  1709. {
  1710. Router::extensions(['json']);
  1711. Router::scope('/', function (RouteBuilder $routes) {
  1712. $routes->setExtensions('rss');
  1713. $routes->connect('/', ['controller' => 'Pages', 'action' => 'index']);
  1714. $routes->scope('/api', function (RouteBuilder $routes) {
  1715. $routes->setExtensions('xml');
  1716. $routes->connect('/docs', ['controller' => 'ApiDocs', 'action' => 'index']);
  1717. });
  1718. });
  1719. $this->assertEquals(['json', 'rss', 'xml'], array_values(Router::extensions()));
  1720. }
  1721. /**
  1722. * Test connecting resources.
  1723. *
  1724. * @return void
  1725. */
  1726. public function testResourcesInScope()
  1727. {
  1728. Router::scope('/api', ['prefix' => 'api'], function (RouteBuilder $routes) {
  1729. $routes->setExtensions(['json']);
  1730. $routes->resources('Articles');
  1731. });
  1732. $url = Router::url([
  1733. 'prefix' => 'api',
  1734. 'controller' => 'Articles',
  1735. 'action' => 'edit',
  1736. '_method' => 'PUT',
  1737. 'id' => 99,
  1738. ]);
  1739. $this->assertEquals('/api/articles/99', $url);
  1740. $url = Router::url([
  1741. 'prefix' => 'api',
  1742. 'controller' => 'Articles',
  1743. 'action' => 'edit',
  1744. '_method' => 'PUT',
  1745. '_ext' => 'json',
  1746. 'id' => 99,
  1747. ]);
  1748. $this->assertEquals('/api/articles/99.json', $url);
  1749. }
  1750. /**
  1751. * testExtensionParsing method
  1752. *
  1753. * @return void
  1754. */
  1755. public function testExtensionParsing()
  1756. {
  1757. Router::extensions('rss', false);
  1758. $this->_connectDefaultRoutes();
  1759. $result = Router::parseRequest($this->makeRequest('/posts.rss', 'GET'));
  1760. $expected = [
  1761. 'plugin' => null,
  1762. 'controller' => 'Posts',
  1763. 'action' => 'index',
  1764. '_ext' => 'rss',
  1765. 'pass' => [],
  1766. '_matchedRoute' => '/{controller}',
  1767. ];
  1768. $this->assertEquals($expected, $result);
  1769. $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss', 'GET'));
  1770. $expected = [
  1771. 'plugin' => null,
  1772. 'controller' => 'Posts',
  1773. 'action' => 'view',
  1774. 'pass' => ['1'],
  1775. '_ext' => 'rss',
  1776. '_matchedRoute' => '/{controller}/{action}/*',
  1777. ];
  1778. $this->assertEquals($expected, $result);
  1779. $result = Router::parseRequest($this->makeRequest('/posts/view/1.rss?query=test', 'GET'));
  1780. $expected['?'] = ['query' => 'test'];
  1781. $this->assertEquals($expected, $result);
  1782. Router::reload();
  1783. Router::extensions(['rss', 'xml'], false);
  1784. $this->_connectDefaultRoutes();
  1785. $result = Router::parseRequest($this->makeRequest('/posts.xml', 'GET'));
  1786. $expected = [
  1787. 'plugin' => null,
  1788. 'controller' => 'Posts',
  1789. 'action' => 'index',
  1790. '_ext' => 'xml',
  1791. 'pass' => [],
  1792. '_matchedRoute' => '/{controller}',
  1793. ];
  1794. $this->assertEquals($expected, $result);
  1795. $result = Router::parseRequest($this->makeRequest('/posts.atom?hello=goodbye', 'GET'));
  1796. $expected = [
  1797. 'plugin' => null,
  1798. 'controller' => 'Posts.atom',
  1799. 'action' => 'index',
  1800. 'pass' => [],
  1801. '?' => ['hello' => 'goodbye'],
  1802. '_matchedRoute' => '/{controller}',
  1803. ];
  1804. $this->assertEquals($expected, $result);
  1805. Router::reload();
  1806. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1807. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1808. $expected = [
  1809. 'controller' => 'controller',
  1810. 'action' => 'action',
  1811. 'plugin' => null,
  1812. '_ext' => 'rss',
  1813. 'pass' => [],
  1814. '_matchedRoute' => '/controller/action',
  1815. ];
  1816. $this->assertEquals($expected, $result);
  1817. Router::reload();
  1818. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1819. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1820. $expected = [
  1821. 'controller' => 'controller',
  1822. 'action' => 'action',
  1823. 'plugin' => null,
  1824. '_ext' => 'rss',
  1825. 'pass' => [],
  1826. '_matchedRoute' => '/controller/action',
  1827. ];
  1828. $this->assertEquals($expected, $result);
  1829. Router::reload();
  1830. Router::extensions('rss', false);
  1831. Router::connect('/controller/action', ['controller' => 'controller', 'action' => 'action', '_ext' => 'rss']);
  1832. $result = Router::parseRequest($this->makeRequest('/controller/action', 'GET'));
  1833. $expected = [
  1834. 'controller' => 'controller',
  1835. 'action' => 'action',
  1836. 'plugin' => null,
  1837. '_ext' => 'rss',
  1838. 'pass' => [],
  1839. '_matchedRoute' => '/controller/action',
  1840. ];
  1841. $this->assertEquals($expected, $result);
  1842. }
  1843. /**
  1844. * Test newer style automatically generated prefix routes.
  1845. *
  1846. * @return void
  1847. * @see testUrlGenerationWithAutoPrefixes
  1848. */
  1849. public function testUrlGenerationWithAutoPrefixes()
  1850. {
  1851. Router::reload();
  1852. Router::connect('/protected/:controller/:action/*', ['prefix' => 'protected']);
  1853. Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
  1854. Router::connect('/:controller/:action/*');
  1855. $request = new ServerRequest([
  1856. 'url' => '/images/index',
  1857. 'params' => [
  1858. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  1859. 'prefix' => null, 'protected' => false, 'url' => ['url' => 'images/index'],
  1860. ],
  1861. ]);
  1862. Router::setRequestInfo($request);
  1863. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  1864. $expected = '/images/add';
  1865. $this->assertEquals($expected, $result);
  1866. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  1867. $expected = '/protected/images/add';
  1868. $this->assertEquals($expected, $result);
  1869. $result = Router::url(['controller' => 'images', 'action' => 'add_protected_test', 'prefix' => 'protected']);
  1870. $expected = '/protected/images/add_protected_test';
  1871. $this->assertEquals($expected, $result);
  1872. $result = Router::url(['action' => 'edit', 1]);
  1873. $expected = '/images/edit/1';
  1874. $this->assertEquals($expected, $result);
  1875. $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']);
  1876. $expected = '/protected/images/edit/1';
  1877. $this->assertEquals($expected, $result);
  1878. $result = Router::url(['action' => 'protectededit', 1, 'prefix' => 'protected']);
  1879. $expected = '/protected/images/protectededit/1';
  1880. $this->assertEquals($expected, $result);
  1881. $result = Router::url(['action' => 'edit', 1, 'prefix' => 'protected']);
  1882. $expected = '/protected/images/edit/1';
  1883. $this->assertEquals($expected, $result);
  1884. $result = Router::url(['controller' => 'others', 'action' => 'edit', 1]);
  1885. $expected = '/others/edit/1';
  1886. $this->assertEquals($expected, $result);
  1887. $result = Router::url(['controller' => 'others', 'action' => 'edit', 1, 'prefix' => 'protected']);
  1888. $expected = '/protected/others/edit/1';
  1889. $this->assertEquals($expected, $result);
  1890. }
  1891. /**
  1892. * Test that the ssl option works.
  1893. *
  1894. * @return void
  1895. */
  1896. public function testGenerationWithSslOption()
  1897. {
  1898. Router::connect('/:controller/:action/*');
  1899. $request = new ServerRequest([
  1900. 'url' => '/images/index',
  1901. 'params' => [
  1902. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  1903. ],
  1904. 'environment' => ['HTTP_HOST' => 'localhost'],
  1905. ]);
  1906. Router::pushRequest($request);
  1907. $result = Router::url([
  1908. '_ssl' => true,
  1909. ]);
  1910. $this->assertEquals('https://localhost/images/index', $result);
  1911. $result = Router::url([
  1912. '_ssl' => false,
  1913. ]);
  1914. $this->assertEquals('http://localhost/images/index', $result);
  1915. }
  1916. /**
  1917. * Test that the _ssl + _full options work together.
  1918. *
  1919. * @return void
  1920. */
  1921. public function testGenerationWithSslAndFullOption()
  1922. {
  1923. Configure::write('App.fullBaseUrl', 'http://app.localhost');
  1924. Router::connect('/:controller/:action/*');
  1925. $request = new ServerRequest([
  1926. 'environment' => ['HTTP_HOST' => 'localhost'],
  1927. ]);
  1928. Router::pushRequest($request);
  1929. $result = Router::url([
  1930. 'controller' => 'images',
  1931. 'action' => 'index',
  1932. '_ssl' => true,
  1933. '_full' => true,
  1934. ]);
  1935. $this->assertEquals('https://app.localhost/images/index', $result);
  1936. $result = Router::url([
  1937. 'controller' => 'images',
  1938. 'action' => 'index',
  1939. '_ssl' => false,
  1940. '_full' => true,
  1941. ]);
  1942. $this->assertEquals('http://app.localhost/images/index', $result);
  1943. $result = Router::url([
  1944. 'controller' => 'images',
  1945. 'action' => 'index',
  1946. '_full' => false,
  1947. '_ssl' => false,
  1948. ]);
  1949. $this->assertEquals('http://localhost/images/index', $result);
  1950. }
  1951. /**
  1952. * Test ssl option when the current request is ssl.
  1953. *
  1954. * @return void
  1955. */
  1956. public function testGenerateWithSslInSsl()
  1957. {
  1958. Router::connect('/:controller/:action/*');
  1959. $request = new ServerRequest([
  1960. 'url' => '/images/index',
  1961. 'environment' => ['HTTP_HOST' => 'localhost', 'HTTPS' => 'on'],
  1962. 'params' => [
  1963. 'plugin' => null,
  1964. 'controller' => 'images',
  1965. 'action' => 'index',
  1966. ],
  1967. ]);
  1968. Router::pushRequest($request);
  1969. $result = Router::url([
  1970. '_ssl' => false,
  1971. ]);
  1972. $this->assertEquals('http://localhost/images/index', $result);
  1973. $result = Router::url([
  1974. '_ssl' => true,
  1975. ]);
  1976. $this->assertEquals('https://localhost/images/index', $result);
  1977. }
  1978. /**
  1979. * test that prefix routes persist when they are in the current request.
  1980. *
  1981. * @return void
  1982. */
  1983. public function testPrefixRoutePersistence()
  1984. {
  1985. Router::reload();
  1986. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  1987. Router::connect('/:controller/:action');
  1988. $request = new ServerRequest([
  1989. 'url' => '/protected/images/index',
  1990. 'params' => [
  1991. 'plugin' => null,
  1992. 'controller' => 'images',
  1993. 'action' => 'index',
  1994. 'prefix' => 'protected',
  1995. ],
  1996. ]);
  1997. Router::setRequestInfo($request);
  1998. $result = Router::url(['prefix' => 'protected', 'controller' => 'images', 'action' => 'add']);
  1999. $expected = '/protected/images/add';
  2000. $this->assertEquals($expected, $result);
  2001. $result = Router::url(['controller' => 'images', 'action' => 'add']);
  2002. $expected = '/protected/images/add';
  2003. $this->assertEquals($expected, $result);
  2004. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => false]);
  2005. $expected = '/images/add';
  2006. $this->assertEquals($expected, $result);
  2007. }
  2008. /**
  2009. * test that setting a prefix override the current one
  2010. *
  2011. * @return void
  2012. */
  2013. public function testPrefixOverride()
  2014. {
  2015. Router::connect('/admin/:controller/:action', ['prefix' => 'admin']);
  2016. Router::connect('/protected/:controller/:action', ['prefix' => 'protected']);
  2017. $request = new ServerRequest([
  2018. 'url' => '/protected/images/index',
  2019. 'params' => [
  2020. 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'protected',
  2021. ],
  2022. ]);
  2023. Router::setRequestInfo($request);
  2024. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'admin']);
  2025. $expected = '/admin/images/add';
  2026. $this->assertEquals($expected, $result);
  2027. $request = new ServerRequest([
  2028. 'url' => '/admin/images/index',
  2029. 'params' => [
  2030. 'plugin' => null, 'controller' => 'images', 'action' => 'index', 'prefix' => 'admin',
  2031. ],
  2032. ]);
  2033. Router::setRequestInfo($request);
  2034. $result = Router::url(['controller' => 'images', 'action' => 'add', 'prefix' => 'protected']);
  2035. $expected = '/protected/images/add';
  2036. $this->assertEquals($expected, $result);
  2037. }
  2038. /**
  2039. * Test that well known route parameters are passed through.
  2040. *
  2041. * @return void
  2042. */
  2043. public function testRouteParamDefaults()
  2044. {
  2045. Router::connect('/cache/*', ['prefix' => false, 'plugin' => true, 'controller' => 0, 'action' => 1]);
  2046. $url = Router::url(['prefix' => 0, 'plugin' => 1, 'controller' => 0, 'action' => 1, 'test']);
  2047. $expected = '/cache/test';
  2048. $this->assertEquals($expected, $url);
  2049. try {
  2050. Router::url(['controller' => 0, 'action' => 1, 'test']);
  2051. $this->fail('No exception raised');
  2052. } catch (\Exception $e) {
  2053. $this->assertTrue(true, 'Exception was raised');
  2054. }
  2055. try {
  2056. Router::url(['prefix' => 1, 'controller' => 0, 'action' => 1, 'test']);
  2057. $this->fail('No exception raised');
  2058. } catch (\Exception $e) {
  2059. $this->assertTrue(true, 'Exception was raised');
  2060. }
  2061. }
  2062. /**
  2063. * testRemoveBase method
  2064. *
  2065. * @return void
  2066. */
  2067. public function testRemoveBase()
  2068. {
  2069. Router::connect('/:controller/:action');
  2070. $request = new ServerRequest([
  2071. 'url' => '/',
  2072. 'base' => '/base',
  2073. 'params' => [
  2074. 'plugin' => null, 'controller' => 'controller', 'action' => 'index',
  2075. ],
  2076. ]);
  2077. Router::setRequestInfo($request);
  2078. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action']);
  2079. $expected = '/base/my_controller/my_action';
  2080. $this->assertEquals($expected, $result);
  2081. $result = Router::url(['controller' => 'my_controller', 'action' => 'my_action', '_base' => false]);
  2082. $expected = '/my_controller/my_action';
  2083. $this->assertEquals($expected, $result);
  2084. }
  2085. /**
  2086. * testPagesUrlParsing method
  2087. *
  2088. * @return void
  2089. */
  2090. public function testPagesUrlParsing()
  2091. {
  2092. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  2093. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  2094. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  2095. $expected = [
  2096. 'pass' => ['home'],
  2097. 'plugin' => null,
  2098. 'controller' => 'pages',
  2099. 'action' => 'display',
  2100. '_matchedRoute' => '/',
  2101. ];
  2102. $this->assertEquals($expected, $result);
  2103. $result = Router::parseRequest($this->makeRequest('/pages/home/', 'GET'));
  2104. $expected = [
  2105. 'pass' => ['home'],
  2106. 'plugin' => null,
  2107. 'controller' => 'pages',
  2108. 'action' => 'display',
  2109. '_matchedRoute' => '/pages/*',
  2110. ];
  2111. $this->assertEquals($expected, $result);
  2112. Router::reload();
  2113. Router::connect('/', ['controller' => 'pages', 'action' => 'display', 'home']);
  2114. $result = Router::parseRequest($this->makeRequest('/', 'GET'));
  2115. $expected = [
  2116. 'pass' => ['home'],
  2117. 'plugin' => null,
  2118. 'controller' => 'pages',
  2119. 'action' => 'display',
  2120. '_matchedRoute' => '/',
  2121. ];
  2122. $this->assertEquals($expected, $result);
  2123. Router::reload();
  2124. Router::connect('/', ['controller' => 'posts', 'action' => 'index']);
  2125. Router::connect('/pages/*', ['controller' => 'pages', 'action' => 'display']);
  2126. $result = Router::parseRequest($this->makeRequest('/pages/contact/', 'GET'));
  2127. $expected = [
  2128. 'pass' => ['contact'],
  2129. 'plugin' => null,
  2130. 'controller' => 'pages',
  2131. 'action' => 'display',
  2132. '_matchedRoute' => '/pages/*',
  2133. ];
  2134. $this->assertEquals($expected, $result);
  2135. }
  2136. /**
  2137. * test that requests with a trailing dot don't loose the do.
  2138. *
  2139. * @return void
  2140. */
  2141. public function testParsingWithTrailingPeriod()
  2142. {
  2143. Router::reload();
  2144. Router::connect('/:controller/:action/*');
  2145. $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET'));
  2146. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  2147. $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET'));
  2148. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  2149. }
  2150. /**
  2151. * test that requests with a trailing dot don't loose the do.
  2152. *
  2153. * @return void
  2154. */
  2155. public function testParsingWithTrailingPeriodAndParseExtensions()
  2156. {
  2157. Router::reload();
  2158. Router::connect('/:controller/:action/*');
  2159. $result = Router::parseRequest($this->makeRequest('/posts/view/something.', 'GET'));
  2160. $this->assertEquals('something.', $result['pass'][0], 'Period was chopped off');
  2161. $result = Router::parseRequest($this->makeRequest('/posts/view/something. . .', 'GET'));
  2162. $this->assertEquals('something. . .', $result['pass'][0], 'Period was chopped off');
  2163. }
  2164. /**
  2165. * test that patterns work for :action
  2166. *
  2167. * @return void
  2168. */
  2169. public function testParsingWithPatternOnAction()
  2170. {
  2171. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2172. Router::connect(
  2173. '/blog/:action/*',
  2174. ['controller' => 'blog_posts'],
  2175. ['action' => 'other|actions']
  2176. );
  2177. $result = Router::parseRequest($this->makeRequest('/blog/other', 'GET'));
  2178. $expected = [
  2179. 'plugin' => null,
  2180. 'controller' => 'blog_posts',
  2181. 'action' => 'other',
  2182. 'pass' => [],
  2183. '_matchedRoute' => '/blog/:action/*',
  2184. ];
  2185. $this->assertEquals($expected, $result);
  2186. Router::parseRequest($this->makeRequest('/blog/foobar', 'GET'));
  2187. }
  2188. /**
  2189. * Test url() works with patterns on :action
  2190. *
  2191. * @return void
  2192. */
  2193. public function testUrlPatternOnAction()
  2194. {
  2195. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2196. Router::connect(
  2197. '/blog/:action/*',
  2198. ['controller' => 'blog_posts'],
  2199. ['action' => 'other|actions']
  2200. );
  2201. $result = Router::url(['controller' => 'blog_posts', 'action' => 'actions']);
  2202. $this->assertEquals('/blog/actions', $result);
  2203. $result = Router::url(['controller' => 'blog_posts', 'action' => 'foo']);
  2204. $this->assertEquals('/', $result);
  2205. }
  2206. /**
  2207. * testParsingWithLiteralPrefixes method
  2208. *
  2209. * @return void
  2210. */
  2211. public function testParsingWithLiteralPrefixes()
  2212. {
  2213. Router::reload();
  2214. $adminParams = ['prefix' => 'admin'];
  2215. Router::connect('/admin/:controller', $adminParams);
  2216. Router::connect('/admin/:controller/:action/*', $adminParams);
  2217. $request = new ServerRequest([
  2218. 'url' => '/',
  2219. 'base' => '/base',
  2220. 'params' => ['plugin' => null, 'controller' => 'controller', 'action' => 'index'],
  2221. ]);
  2222. Router::setRequestInfo($request);
  2223. $result = Router::parseRequest($this->makeRequest('/admin/posts/', 'GET'));
  2224. $expected = [
  2225. 'pass' => [],
  2226. 'prefix' => 'admin',
  2227. 'plugin' => null,
  2228. 'controller' => 'posts',
  2229. 'action' => 'index',
  2230. '_matchedRoute' => '/admin/:controller',
  2231. ];
  2232. $this->assertEquals($expected, $result);
  2233. $result = Router::parseRequest($this->makeRequest('/admin/posts', 'GET'));
  2234. $this->assertEquals($expected, $result);
  2235. $result = Router::url(['prefix' => 'admin', 'controller' => 'posts']);
  2236. $expected = '/base/admin/posts';
  2237. $this->assertEquals($expected, $result);
  2238. Router::reload();
  2239. $prefixParams = ['prefix' => 'members'];
  2240. Router::connect('/members/:controller', $prefixParams);
  2241. Router::connect('/members/:controller/:action', $prefixParams);
  2242. Router::connect('/members/:controller/:action/*', $prefixParams);
  2243. $request = new ServerRequest([
  2244. 'url' => '/',
  2245. 'base' => '/base',
  2246. 'params' => ['plugin' => null, 'controller' => 'controller', 'action' => 'index'],
  2247. ]);
  2248. Router::setRequestInfo($request);
  2249. $result = Router::parseRequest($this->makeRequest('/members/posts/index', 'GET'));
  2250. $expected = [
  2251. 'pass' => [],
  2252. 'prefix' => 'members',
  2253. 'plugin' => null,
  2254. 'controller' => 'posts',
  2255. 'action' => 'index',
  2256. '_matchedRoute' => '/members/:controller/:action',
  2257. ];
  2258. $this->assertEquals($expected, $result);
  2259. $result = Router::url(['prefix' => 'members', 'controller' => 'users', 'action' => 'add']);
  2260. $expected = '/base/members/users/add';
  2261. $this->assertEquals($expected, $result);
  2262. }
  2263. /**
  2264. * Tests URL generation with flags and prefixes in and out of context
  2265. *
  2266. * @return void
  2267. */
  2268. public function testUrlWritingWithPrefixes()
  2269. {
  2270. Router::connect('/company/:controller/:action/*', ['prefix' => 'company']);
  2271. Router::connect('/:action', ['controller' => 'users']);
  2272. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => 'company']);
  2273. $expected = '/company/users/login';
  2274. $this->assertEquals($expected, $result);
  2275. $request = new ServerRequest([
  2276. 'url' => '/',
  2277. 'params' => [
  2278. 'plugin' => null,
  2279. 'controller' => 'users',
  2280. 'action' => 'login',
  2281. 'prefix' => 'company',
  2282. ],
  2283. ]);
  2284. Router::setRequestInfo($request);
  2285. $result = Router::url(['controller' => 'users', 'action' => 'login', 'prefix' => false]);
  2286. $expected = '/login';
  2287. $this->assertEquals($expected, $result);
  2288. }
  2289. /**
  2290. * test url generation with prefixes and custom routes
  2291. *
  2292. * @return void
  2293. */
  2294. public function testUrlWritingWithPrefixesAndCustomRoutes()
  2295. {
  2296. Router::connect(
  2297. '/admin/login',
  2298. ['controller' => 'users', 'action' => 'login', 'prefix' => 'admin']
  2299. );
  2300. $request = new ServerRequest([
  2301. 'url' => '/',
  2302. 'params' => [
  2303. 'plugin' => null,
  2304. 'controller' => 'posts',
  2305. 'action' => 'index',
  2306. 'prefix' => 'admin',
  2307. ],
  2308. 'webroot' => '/',
  2309. ]);
  2310. Router::setRequestInfo($request);
  2311. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2312. $this->assertEquals('/admin/login', $result);
  2313. $result = Router::url(['controller' => 'users', 'action' => 'login']);
  2314. $this->assertEquals('/admin/login', $result);
  2315. }
  2316. /**
  2317. * testPassedArgsOrder method
  2318. *
  2319. * @return void
  2320. */
  2321. public function testPassedArgsOrder()
  2322. {
  2323. Router::connect('/test-passed/*', ['controller' => 'pages', 'action' => 'display', 'home']);
  2324. Router::connect('/test2/*', ['controller' => 'pages', 'action' => 'display', 2]);
  2325. Router::connect('/test/*', ['controller' => 'pages', 'action' => 'display', 1]);
  2326. $result = Router::url(['controller' => 'pages', 'action' => 'display', 1, 'whatever']);
  2327. $expected = '/test/whatever';
  2328. $this->assertEquals($expected, $result);
  2329. $result = Router::url(['controller' => 'pages', 'action' => 'display', 2, 'whatever']);
  2330. $expected = '/test2/whatever';
  2331. $this->assertEquals($expected, $result);
  2332. $result = Router::url(['controller' => 'pages', 'action' => 'display', 'home', 'whatever']);
  2333. $expected = '/test-passed/whatever';
  2334. $this->assertEquals($expected, $result);
  2335. }
  2336. /**
  2337. * testRegexRouteMatching method
  2338. *
  2339. * @return void
  2340. */
  2341. public function testRegexRouteMatching()
  2342. {
  2343. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2344. $result = Router::parseRequest($this->makeRequest('/eng/test/test_action', 'GET'));
  2345. $expected = [
  2346. 'pass' => [],
  2347. 'locale' => 'eng',
  2348. 'controller' => 'test',
  2349. 'action' => 'test_action',
  2350. 'plugin' => null,
  2351. '_matchedRoute' => '/:locale/:controller/:action/*',
  2352. ];
  2353. $this->assertEquals($expected, $result);
  2354. }
  2355. /**
  2356. * testRegexRouteMatching error
  2357. *
  2358. * @group deprecated
  2359. * @return void
  2360. */
  2361. public function testRegexRouteMatchingError()
  2362. {
  2363. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2364. $this->deprecated(function () {
  2365. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2366. Router::parse('/badness/test/test_action', 'GET');
  2367. });
  2368. }
  2369. /**
  2370. * testRegexRouteMatching method
  2371. *
  2372. * @return void
  2373. */
  2374. public function testRegexRouteMatchUrl()
  2375. {
  2376. $this->expectException(\Cake\Routing\Exception\MissingRouteException::class);
  2377. Router::connect('/:locale/:controller/:action/*', [], ['locale' => 'dan|eng']);
  2378. $request = new ServerRequest([
  2379. 'url' => '/test/test_action',
  2380. 'params' => [
  2381. 'plugin' => null,
  2382. 'controller' => 'test',
  2383. 'action' => 'index',
  2384. ],
  2385. 'webroot' => '/',
  2386. ]);
  2387. Router::setRequestInfo($request);
  2388. $result = Router::url(['action' => 'test_another_action', 'locale' => 'eng']);
  2389. $expected = '/eng/test/test_another_action';
  2390. $this->assertEquals($expected, $result);
  2391. $result = Router::url(['action' => 'test_another_action']);
  2392. $expected = '/';
  2393. $this->assertEquals($expected, $result);
  2394. }
  2395. /**
  2396. * test using a custom route class for route connection
  2397. *
  2398. * @return void
  2399. */
  2400. public function testUsingCustomRouteClass()
  2401. {
  2402. $this->loadPlugins(['TestPlugin']);
  2403. Router::connect(
  2404. '/:slug',
  2405. ['plugin' => 'TestPlugin', 'action' => 'index'],
  2406. ['routeClass' => 'PluginShortRoute', 'slug' => '[a-z_-]+']
  2407. );
  2408. $result = Router::parseRequest($this->makeRequest('/the-best', 'GET'));
  2409. $expected = [
  2410. 'plugin' => 'TestPlugin',
  2411. 'controller' => 'TestPlugin',
  2412. 'action' => 'index',
  2413. 'slug' => 'the-best',
  2414. 'pass' => [],
  2415. '_matchedRoute' => '/:slug',
  2416. ];
  2417. $this->assertEquals($expected, $result);
  2418. }
  2419. /**
  2420. * test using custom route class in PluginDot notation
  2421. *
  2422. * @return void
  2423. */
  2424. public function testUsingCustomRouteClassPluginDotSyntax()
  2425. {
  2426. $this->loadPlugins(['TestPlugin']);
  2427. Router::connect(
  2428. '/:slug',
  2429. ['controller' => 'posts', 'action' => 'view'],
  2430. ['routeClass' => 'TestPlugin.TestRoute', 'slug' => '[a-z_-]+']
  2431. );
  2432. $this->assertTrue(true); // Just to make sure the connect do not throw exception
  2433. $this->removePlugins(['TestPlugin']);
  2434. }
  2435. /**
  2436. * test that route classes must extend \Cake\Routing\Route\Route
  2437. *
  2438. * @return void
  2439. */
  2440. public function testCustomRouteException()
  2441. {
  2442. $this->expectException(\InvalidArgumentException::class);
  2443. Router::connect('/:controller', [], ['routeClass' => 'Object']);
  2444. }
  2445. /**
  2446. * test reversing parameter arrays back into strings.
  2447. *
  2448. * Mark the router as initialized so it doesn't auto-load routes
  2449. *
  2450. * @return void
  2451. */
  2452. public function testReverseToken()
  2453. {
  2454. Router::connect('/:controller/:action/*');
  2455. $params = [
  2456. 'controller' => 'posts',
  2457. 'action' => 'view',
  2458. 'pass' => [1],
  2459. 'url' => [],
  2460. 'autoRender' => 1,
  2461. 'bare' => 1,
  2462. 'return' => 1,
  2463. 'requested' => 1,
  2464. '_Token' => ['key' => 'sekret'],
  2465. '_csrfToken' => 'foo',
  2466. 'isAjax' => true,
  2467. ];
  2468. $result = Router::reverse($params);
  2469. $this->assertEquals('/posts/view/1', $result);
  2470. }
  2471. public function testReverseLocalized()
  2472. {
  2473. Router::reload();
  2474. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2475. $params = [
  2476. 'lang' => 'eng',
  2477. 'controller' => 'posts',
  2478. 'action' => 'view',
  2479. 'pass' => [1],
  2480. 'url' => ['url' => 'eng/posts/view/1'],
  2481. ];
  2482. $result = Router::reverse($params);
  2483. $this->assertEquals('/eng/posts/view/1', $result);
  2484. }
  2485. public function testReverseRouteKeyAndPass()
  2486. {
  2487. Router::reload();
  2488. $routes = Router::createRouteBuilder('/');
  2489. $routes->connect('/articles/{slug}', ['controller' => 'Articles', 'action' => 'view'])->setPass(['slug']);
  2490. $request = new ServerRequest([
  2491. 'url' => '/articles/first-post',
  2492. 'params' => [
  2493. 'controller' => 'Articles',
  2494. 'action' => 'view',
  2495. 'pass' => ['first-post'],
  2496. 'slug' => 'first-post',
  2497. ],
  2498. ]);
  2499. $result = Router::reverse($request);
  2500. $this->assertSame('/articles/first-post', $result);
  2501. }
  2502. public function testReverseArrayQuery()
  2503. {
  2504. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2505. $params = [
  2506. 'lang' => 'eng',
  2507. 'controller' => 'posts',
  2508. 'action' => 'view',
  2509. 1,
  2510. '?' => ['foo' => 'bar'],
  2511. ];
  2512. $result = Router::reverse($params);
  2513. $this->assertEquals('/eng/posts/view/1?foo=bar', $result);
  2514. $params = [
  2515. 'lang' => 'eng',
  2516. 'controller' => 'posts',
  2517. 'action' => 'view',
  2518. 'pass' => [1],
  2519. 'url' => ['url' => 'eng/posts/view/1', 'foo' => 'bar', 'baz' => 'quu'],
  2520. 'paging' => [],
  2521. 'models' => [],
  2522. ];
  2523. $result = Router::reverse($params);
  2524. $this->assertEquals('/eng/posts/view/1?foo=bar&baz=quu', $result);
  2525. }
  2526. public function testReverseCakeRequestQuery()
  2527. {
  2528. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2529. $request = new ServerRequest([
  2530. 'url' => '/eng/posts/view/1',
  2531. 'params' => [
  2532. 'lang' => 'eng',
  2533. 'controller' => 'posts',
  2534. 'action' => 'view',
  2535. 'pass' => [1],
  2536. ],
  2537. 'query' => ['url' => 'eng/posts/view/1', 'test' => 'value'],
  2538. ]);
  2539. $result = Router::reverse($request);
  2540. $expected = '/eng/posts/view/1?test=value';
  2541. $this->assertEquals($expected, $result);
  2542. }
  2543. public function testReverseFull()
  2544. {
  2545. $params = [
  2546. 'lang' => 'eng',
  2547. 'controller' => 'posts',
  2548. 'action' => 'view',
  2549. 'pass' => [1],
  2550. 'url' => ['url' => 'eng/posts/view/1'],
  2551. ];
  2552. $result = Router::reverse($params, true);
  2553. $this->assertRegExp('/^http(s)?:\/\//', $result);
  2554. }
  2555. /**
  2556. * Test that extensions work with Router::reverse()
  2557. *
  2558. * @return void
  2559. */
  2560. public function testReverseWithExtension()
  2561. {
  2562. Router::connect('/:controller/:action/*');
  2563. Router::extensions('json', false);
  2564. $request = new ServerRequest([
  2565. 'url' => '/posts/view/1.json',
  2566. 'params' => [
  2567. 'controller' => 'posts',
  2568. 'action' => 'view',
  2569. 'pass' => [1],
  2570. '_ext' => 'json',
  2571. ],
  2572. ]);
  2573. $result = Router::reverse($request);
  2574. $expected = '/posts/view/1.json';
  2575. $this->assertEquals($expected, $result);
  2576. }
  2577. public function testReverseToArrayQuery()
  2578. {
  2579. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2580. $params = [
  2581. 'lang' => 'eng',
  2582. 'controller' => 'posts',
  2583. 'action' => 'view',
  2584. 'pass' => [123],
  2585. 'url' => ['url' => 'eng/posts/view/123', 'foo' => 'bar', 'baz' => 'quu'],
  2586. 'paging' => [],
  2587. 'models' => [],
  2588. ];
  2589. $actual = Router::reverseToArray($params);
  2590. $expected = [
  2591. 'lang' => 'eng',
  2592. 'controller' => 'posts',
  2593. 'action' => 'view',
  2594. 123,
  2595. '?' => ['foo' => 'bar', 'baz' => 'quu'],
  2596. ];
  2597. $this->assertEquals($expected, $actual);
  2598. }
  2599. public function testReverseToArrayRequestQuery()
  2600. {
  2601. Router::connect('/:lang/:controller/:action/*', [], ['lang' => '[a-z]{3}']);
  2602. $request = new ServerRequest([
  2603. 'url' => '/eng/posts/view/1',
  2604. 'params' => [
  2605. 'lang' => 'eng',
  2606. 'controller' => 'posts',
  2607. 'action' => 'view',
  2608. 'pass' => [123],
  2609. ],
  2610. 'query' => ['url' => 'eng/posts/view/1', 'test' => 'value'],
  2611. ]);
  2612. $actual = Router::reverseToArray($request);
  2613. $expected = [
  2614. 'lang' => 'eng',
  2615. 'controller' => 'posts',
  2616. 'action' => 'view',
  2617. 123,
  2618. '?' => [
  2619. 'test' => 'value',
  2620. ],
  2621. ];
  2622. $this->assertEquals($expected, $actual);
  2623. }
  2624. /**
  2625. * test that setRequestInfo can accept arrays and turn that into a Request object.
  2626. *
  2627. * @group deprecated
  2628. * @return void
  2629. */
  2630. public function testSetRequestInfoLegacy()
  2631. {
  2632. $this->deprecated(function () {
  2633. Router::setRequestInfo([
  2634. [
  2635. 'plugin' => null, 'controller' => 'images', 'action' => 'index',
  2636. 'url' => ['url' => 'protected/images/index'],
  2637. ],
  2638. [
  2639. 'base' => '',
  2640. 'here' => '/protected/images/index',
  2641. 'webroot' => '/',
  2642. ],
  2643. ]);
  2644. $result = Router::getRequest();
  2645. $this->assertEquals('images', $result->getParam('controller'));
  2646. $this->assertEquals('index', $result->getParam('action'));
  2647. $this->assertEquals('', $result->getAttribute('base'));
  2648. $this->assertEquals('', $result->base);
  2649. $this->assertEquals('/protected/images/index', $result->getRequestTarget());
  2650. $this->assertEquals('/protected/images/index', $result->here);
  2651. $this->assertEquals('/', $result->getAttribute('webroot'));
  2652. $this->assertEquals('/', $result->webroot);
  2653. });
  2654. }
  2655. /**
  2656. * test get request.
  2657. *
  2658. * @return void
  2659. */
  2660. public function testGetRequest()
  2661. {
  2662. $requestA = new ServerRequest('/');
  2663. $requestB = new ServerRequest('/posts');
  2664. Router::pushRequest($requestA);
  2665. Router::pushRequest($requestB);
  2666. $this->assertSame($requestA, Router::getRequest(false));
  2667. $this->assertSame($requestB, Router::getRequest(true));
  2668. }
  2669. /**
  2670. * Test that Router::url() uses the first request
  2671. */
  2672. public function testUrlWithRequestAction()
  2673. {
  2674. Router::connect('/:controller', ['action' => 'index']);
  2675. Router::connect('/:controller/:action');
  2676. $firstRequest = new ServerRequest([
  2677. 'url' => '/posts/index',
  2678. 'params' => [
  2679. 'plugin' => null,
  2680. 'controller' => 'posts',
  2681. 'action' => 'index',
  2682. ],
  2683. ]);
  2684. $secondRequest = new ServerRequest([
  2685. 'url' => '/posts/index',
  2686. 'params' => [
  2687. 'requested' => 1,
  2688. 'plugin' => null,
  2689. 'controller' => 'comments',
  2690. 'action' => 'listing',
  2691. ],
  2692. ]);
  2693. Router::setRequestInfo($firstRequest);
  2694. Router::setRequestInfo($secondRequest);
  2695. $result = Router::url(['_base' => false]);
  2696. $this->assertEquals('/comments/listing', $result, 'with second requests, the last should win.');
  2697. Router::popRequest();
  2698. $result = Router::url(['_base' => false]);
  2699. $this->assertEquals('/posts', $result, 'with second requests, the last should win.');
  2700. // Make sure that popping an empty request doesn't fail.
  2701. Router::popRequest();
  2702. }
  2703. /**
  2704. * test that a route object returning a full URL is not modified.
  2705. *
  2706. * @return void
  2707. */
  2708. public function testUrlFullUrlReturnFromRoute()
  2709. {
  2710. $url = 'http://example.com/posts/view/1';
  2711. $route = $this->getMockBuilder('Cake\Routing\Route\Route')
  2712. ->setMethods(['match'])
  2713. ->setConstructorArgs(['/:controller/:action/*'])
  2714. ->getMock();
  2715. $route->expects($this->any())
  2716. ->method('match')
  2717. ->will($this->returnValue($url));
  2718. Router::connect($route);
  2719. $result = Router::url(['controller' => 'posts', 'action' => 'view', 1]);
  2720. $this->assertEquals($url, $result);
  2721. }
  2722. /**
  2723. * test protocol in url
  2724. *
  2725. * @return void
  2726. */
  2727. public function testUrlProtocol()
  2728. {
  2729. $url = 'http://example.com';
  2730. $this->assertEquals($url, Router::url($url));
  2731. $url = 'ed2k://example.com';
  2732. $this->assertEquals($url, Router::url($url));
  2733. $url = 'svn+ssh://example.com';
  2734. $this->assertEquals($url, Router::url($url));
  2735. $url = '://example.com';
  2736. $this->assertEquals($url, Router::url($url));
  2737. $url = '//example.com';
  2738. $this->assertEquals($url, Router::url($url));
  2739. $url = 'javascript:void(0)';
  2740. $this->assertEquals($url, Router::url($url));
  2741. $url = 'tel:012345-678';
  2742. $this->assertEquals($url, Router::url($url));
  2743. $url = 'sms:012345-678';
  2744. $this->assertEquals($url, Router::url($url));
  2745. $url = '#here';
  2746. $this->assertEquals($url, Router::url($url));
  2747. $url = '?param=0';
  2748. $this->assertEquals($url, Router::url($url));
  2749. $url = '/posts/index#here';
  2750. $expected = Configure::read('App.fullBaseUrl') . '/posts/index#here';
  2751. $this->assertEquals($expected, Router::url($url, true));
  2752. }
  2753. /**
  2754. * Testing that patterns on the :action param work properly.
  2755. *
  2756. * @return void
  2757. */
  2758. public function testPatternOnAction()
  2759. {
  2760. $route = new Route(
  2761. '/blog/:action/*',
  2762. ['controller' => 'blog_posts'],
  2763. ['action' => 'other|actions']
  2764. );
  2765. $result = $route->match(['controller' => 'blog_posts', 'action' => 'foo']);
  2766. $this->assertFalse($result);
  2767. $result = $route->match(['controller' => 'blog_posts', 'action' => 'actions']);
  2768. $this->assertEquals('/blog/actions/', $result);
  2769. $result = $route->parseRequest($this->makeRequest('/blog/other', 'GET'));
  2770. $expected = [
  2771. 'controller' => 'blog_posts',
  2772. 'action' => 'other',
  2773. 'pass' => [],
  2774. '_matchedRoute' => '/blog/:action/*',
  2775. ];
  2776. $this->assertEquals($expected, $result);
  2777. $result = $route->parseRequest($this->makeRequest('/blog/foobar', 'GET'));
  2778. $this->assertFalse($result);
  2779. }
  2780. /**
  2781. * Test that redirect() works.
  2782. *
  2783. * @group deprecated
  2784. * @return void
  2785. */
  2786. public function testRedirect()
  2787. {
  2788. $this->deprecated(function () {
  2789. Router::redirect('/mobile', '/', ['status' => 301]);
  2790. $routes = Router::routes();
  2791. $route = $routes[0];
  2792. $this->assertInstanceOf('Cake\Routing\Route\RedirectRoute', $route);
  2793. });
  2794. }
  2795. /**
  2796. * Test that redirect() works with another route class.
  2797. *
  2798. * @group deprecated
  2799. * @return void
  2800. */
  2801. public function testRedirectWithAnotherRouteClass()
  2802. {
  2803. $this->deprecated(function () {
  2804. $route1 = $this->getMockBuilder('Cake\Routing\Route\RedirectRoute')
  2805. ->setConstructorArgs(['/mobile\''])
  2806. ->setMethods(['parse'])
  2807. ->getMock();
  2808. $class = '\\' . get_class($route1);
  2809. Router::redirect('/mobile', '/', [
  2810. 'status' => 301,
  2811. 'routeClass' => $class,
  2812. ]);
  2813. $routes = Router::routes();
  2814. $route = $routes[0];
  2815. $this->assertInstanceOf($class, $route);
  2816. });
  2817. }
  2818. /**
  2819. * Test that the compatibility method for incoming urls works.
  2820. *
  2821. * @group deprecated
  2822. * @return void
  2823. */
  2824. public function testParseNamedParameters()
  2825. {
  2826. $this->deprecated(function () {
  2827. $request = new ServerRequest();
  2828. $request->addParams([
  2829. 'controller' => 'posts',
  2830. 'action' => 'index',
  2831. ]);
  2832. $result = Router::parseNamedParams($request);
  2833. $this->assertSame([], $result->params['named']);
  2834. $request = new ServerRequest();
  2835. $request->addParams([
  2836. 'controller' => 'posts',
  2837. 'action' => 'index',
  2838. 'pass' => ['home', 'one:two', 'three:four', 'five[nested][0]:six', 'five[nested][1]:seven'],
  2839. ]);
  2840. $request = Router::parseNamedParams($request);
  2841. $expected = [
  2842. 'plugin' => null,
  2843. 'controller' => 'posts',
  2844. 'action' => 'index',
  2845. '_ext' => null,
  2846. 'pass' => ['home'],
  2847. 'named' => [
  2848. 'one' => 'two',
  2849. 'three' => 'four',
  2850. 'five' => [
  2851. 'nested' => ['six', 'seven'],
  2852. ],
  2853. ],
  2854. ];
  2855. $this->assertEquals($expected, $request->params);
  2856. });
  2857. }
  2858. /**
  2859. * Test the scope() method
  2860. *
  2861. * @return void
  2862. */
  2863. public function testScope()
  2864. {
  2865. Router::scope('/path', ['param' => 'value'], function (RouteBuilder $routes) {
  2866. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2867. $this->assertEquals('/path', $routes->path());
  2868. $this->assertEquals(['param' => 'value'], $routes->params());
  2869. $this->assertEquals('', $routes->namePrefix());
  2870. $routes->connect('/articles', ['controller' => 'Articles']);
  2871. });
  2872. }
  2873. /**
  2874. * Test the scope() method
  2875. *
  2876. * @return void
  2877. */
  2878. public function testScopeError()
  2879. {
  2880. $this->expectException(\InvalidArgumentException::class);
  2881. Router::scope('/path', 'derpy');
  2882. }
  2883. /**
  2884. * Test to ensure that extensions defined in scopes don't leak.
  2885. * And that global extensions are propagated.
  2886. *
  2887. * @return void
  2888. */
  2889. public function testScopeExtensionsContained()
  2890. {
  2891. Router::extensions(['json']);
  2892. Router::scope('/', function (RouteBuilder $routes) {
  2893. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2894. $routes->setExtensions(['rss']);
  2895. $this->assertEquals(
  2896. ['rss'],
  2897. $routes->getExtensions(),
  2898. 'Should include new extensions.'
  2899. );
  2900. $routes->connect('/home', []);
  2901. });
  2902. $this->assertEquals(['json', 'rss'], array_values(Router::extensions()));
  2903. Router::scope('/api', function (RouteBuilder $routes) {
  2904. $this->assertEquals(['json'], $routes->getExtensions(), 'Should default to global extensions.');
  2905. $routes->setExtensions(['json', 'csv']);
  2906. $routes->connect('/export', []);
  2907. $routes->scope('/v1', function (RouteBuilder $routes) {
  2908. $this->assertEquals(['json', 'csv'], $routes->getExtensions());
  2909. });
  2910. });
  2911. $this->assertEquals(['json', 'rss', 'csv'], array_values(Router::extensions()));
  2912. }
  2913. /**
  2914. * Test the scope() options
  2915. *
  2916. * @return void
  2917. */
  2918. public function testScopeOptions()
  2919. {
  2920. $options = ['param' => 'value', 'routeClass' => 'InflectedRoute', 'extensions' => ['json']];
  2921. Router::scope('/path', $options, function (RouteBuilder $routes) {
  2922. $this->assertSame('InflectedRoute', $routes->getRouteClass());
  2923. $this->assertSame(['json'], $routes->getExtensions());
  2924. $this->assertEquals('/path', $routes->path());
  2925. $this->assertEquals(['param' => 'value'], $routes->params());
  2926. });
  2927. }
  2928. /**
  2929. * Test the scope() method
  2930. *
  2931. * @return void
  2932. */
  2933. public function testScopeNamePrefix()
  2934. {
  2935. Router::scope('/path', ['param' => 'value', '_namePrefix' => 'path:'], function (RouteBuilder $routes) {
  2936. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2937. $this->assertEquals('/path', $routes->path());
  2938. $this->assertEquals(['param' => 'value'], $routes->params());
  2939. $this->assertEquals('path:', $routes->namePrefix());
  2940. $routes->connect('/articles', ['controller' => 'Articles']);
  2941. });
  2942. }
  2943. /**
  2944. * Test that prefix() creates a scope.
  2945. *
  2946. * @return void
  2947. */
  2948. public function testPrefix()
  2949. {
  2950. Router::prefix('admin', function (RouteBuilder $routes) {
  2951. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2952. $this->assertEquals('/admin', $routes->path());
  2953. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2954. });
  2955. Router::prefix('admin', ['_namePrefix' => 'admin:'], function (RouteBuilder $routes) {
  2956. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2957. $this->assertEquals('admin:', $routes->namePrefix());
  2958. $this->assertEquals(['prefix' => 'admin'], $routes->params());
  2959. });
  2960. }
  2961. /**
  2962. * Test that prefix() accepts options
  2963. *
  2964. * @return void
  2965. */
  2966. public function testPrefixOptions()
  2967. {
  2968. Router::prefix('admin', ['param' => 'value'], function (RouteBuilder $routes) {
  2969. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2970. $this->assertEquals('/admin', $routes->path());
  2971. $this->assertEquals(['prefix' => 'admin', 'param' => 'value'], $routes->params());
  2972. });
  2973. Router::prefix('CustomPath', ['path' => '/custom-path'], function (RouteBuilder $routes) {
  2974. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2975. $this->assertEquals('/custom-path', $routes->path());
  2976. $this->assertEquals(['prefix' => 'custom_path'], $routes->params());
  2977. });
  2978. }
  2979. /**
  2980. * Test that plugin() creates a scope.
  2981. *
  2982. * @return void
  2983. */
  2984. public function testPlugin()
  2985. {
  2986. Router::plugin('DebugKit', function (RouteBuilder $routes) {
  2987. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  2988. $this->assertEquals('/debug_kit', $routes->path());
  2989. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  2990. });
  2991. }
  2992. /**
  2993. * Test that plugin() accepts options
  2994. *
  2995. * @return void
  2996. */
  2997. public function testPluginOptions()
  2998. {
  2999. Router::plugin('DebugKit', ['path' => '/debugger'], function (RouteBuilder $routes) {
  3000. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  3001. $this->assertEquals('/debugger', $routes->path());
  3002. $this->assertEquals(['plugin' => 'DebugKit'], $routes->params());
  3003. });
  3004. Router::plugin('Contacts', ['_namePrefix' => 'contacts:'], function (RouteBuilder $routes) {
  3005. $this->assertInstanceOf('Cake\Routing\RouteBuilder', $routes);
  3006. $this->assertEquals('contacts:', $routes->namePrefix());
  3007. });
  3008. }
  3009. /**
  3010. * Test setting default route class.
  3011. *
  3012. * @return void
  3013. */
  3014. public function testDefaultRouteClass()
  3015. {
  3016. Router::connect('/:controller', ['action' => 'index']);
  3017. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  3018. $this->assertEquals('/FooBar', $result);
  3019. // This is needed because tests/boostrap.php sets App.namespace to 'App'
  3020. static::setAppNamespace();
  3021. Router::defaultRouteClass('DashedRoute');
  3022. Router::connect('/cake/:controller', ['action' => 'cake']);
  3023. $result = Router::url(['controller' => 'FooBar', 'action' => 'cake']);
  3024. $this->assertEquals('/cake/foo-bar', $result);
  3025. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  3026. $this->assertEquals('/FooBar', $result);
  3027. Router::reload();
  3028. Router::defaultRouteClass('DashedRoute');
  3029. Router::scope('/', function (RouteBuilder $routes) {
  3030. $routes->fallbacks();
  3031. });
  3032. $result = Router::url(['controller' => 'FooBar', 'action' => 'index']);
  3033. $this->assertEquals('/foo-bar', $result);
  3034. }
  3035. /**
  3036. * Test generation of routes with collisions between the query string
  3037. * and other url params
  3038. *
  3039. * @return void
  3040. */
  3041. public function testUrlWithCollidingQueryString()
  3042. {
  3043. Router::connect('/:controller/:action/:id');
  3044. $query = ['controller' => 'Foo', 'action' => 'bar', 'id' => 100];
  3045. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]);
  3046. $this->assertEquals('/posts/view/1?controller=Foo&action=bar&id=100', $result);
  3047. $query = ['_host' => 'foo.bar', '_ssl' => 0, '_scheme' => 'ftp://', '_base' => 'baz', '_port' => '15'];
  3048. $result = Router::url(['controller' => 'posts', 'action' => 'view', 'id' => 1, '?' => $query]);
  3049. $this->assertEquals('/posts/view/1?_host=foo.bar&_ssl=0&_scheme=ftp%3A%2F%2F&_base=baz&_port=15', $result);
  3050. }
  3051. /**
  3052. * Test setting the request context.
  3053. *
  3054. * @return void
  3055. */
  3056. public function testSetRequestContextCakePHP()
  3057. {
  3058. Router::connect('/:controller/:action/*');
  3059. $request = new ServerRequest([
  3060. 'base' => '/subdir',
  3061. 'url' => 'articles/view/1',
  3062. ]);
  3063. Router::setRequestContext($request);
  3064. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  3065. $this->assertEquals('/subdir/things/add', $result);
  3066. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  3067. $this->assertEquals('http://localhost/subdir/things/add', $result);
  3068. $result = Router::url('/pages/home');
  3069. $this->assertEquals('/subdir/pages/home', $result);
  3070. }
  3071. /**
  3072. * Test setting the request context.
  3073. *
  3074. * @return void
  3075. */
  3076. public function testSetRequestContextPsr()
  3077. {
  3078. $server = [
  3079. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  3080. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/subdir/webroot/index.php',
  3081. 'PHP_SELF' => '/subdir/webroot/index.php/articles/view/1',
  3082. 'REQUEST_URI' => '/subdir/articles/view/1',
  3083. 'QUERY_STRING' => '',
  3084. 'SERVER_PORT' => 80,
  3085. ];
  3086. Router::connect('/:controller/:action/*');
  3087. $request = ServerRequestFactory::fromGlobals($server);
  3088. Router::setRequestContext($request);
  3089. $result = Router::url(['controller' => 'things', 'action' => 'add']);
  3090. $this->assertEquals('/subdir/things/add', $result);
  3091. $result = Router::url(['controller' => 'things', 'action' => 'add'], true);
  3092. $this->assertEquals('http://localhost/subdir/things/add', $result);
  3093. $result = Router::url('/pages/home');
  3094. $this->assertEquals('/subdir/pages/home', $result);
  3095. }
  3096. /**
  3097. * Test getting the route collection
  3098. *
  3099. * @return void
  3100. */
  3101. public function testGetRouteCollection()
  3102. {
  3103. $collection = Router::getRouteCollection();
  3104. $this->assertInstanceOf(RouteCollection::class, $collection);
  3105. $this->assertCount(0, $collection->routes());
  3106. }
  3107. /**
  3108. * Test getting a route builder instance.
  3109. *
  3110. * @return void
  3111. */
  3112. public function testCreateRouteBuilder()
  3113. {
  3114. $builder = Router::createRouteBuilder('/api');
  3115. $this->assertInstanceOf(RouteBuilder::class, $builder);
  3116. $this->assertSame('/api', $builder->path());
  3117. $builder = Router::createRouteBuilder('/', [
  3118. 'routeClass' => 'InflectedRoute',
  3119. 'extensions' => ['json'],
  3120. ]);
  3121. $this->assertInstanceOf(RouteBuilder::class, $builder);
  3122. $this->assertSame(['json'], $builder->getExtensions());
  3123. }
  3124. /**
  3125. * test connect() with short string syntax
  3126. *
  3127. * @return void
  3128. */
  3129. public function testConnectShortStringSyntax()
  3130. {
  3131. Router::connect('/admin/articles/view', 'Admin/Articles::view');
  3132. $result = Router::parseRequest($this->makeRequest('/admin/articles/view', 'GET'));
  3133. $expected = [
  3134. 'pass' => [],
  3135. 'prefix' => 'admin',
  3136. 'controller' => 'Articles',
  3137. 'action' => 'view',
  3138. 'plugin' => null,
  3139. '_matchedRoute' => '/admin/articles/view',
  3140. ];
  3141. $this->assertEquals($result, $expected);
  3142. }
  3143. /**
  3144. * Connect some fallback routes for testing router behavior.
  3145. *
  3146. * @return void
  3147. */
  3148. protected function _connectDefaultRoutes()
  3149. {
  3150. Router::scope('/', function (RouteBuilder $routes) {
  3151. $routes->fallbacks('InflectedRoute');
  3152. });
  3153. }
  3154. /**
  3155. * Helper to create a request for a given URL and method.
  3156. *
  3157. * @param string $url The URL to create a request for
  3158. * @param string $method The HTTP method to use.
  3159. * @return \Cake\Http\ServerRequest
  3160. */
  3161. protected function makeRequest($url, $method)
  3162. {
  3163. $request = new ServerRequest([
  3164. 'url' => $url,
  3165. 'environment' => ['REQUEST_METHOD' => $method],
  3166. ]);
  3167. return $request;
  3168. }
  3169. }