RouterTest.php 100 KB

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