RouterTest.php 121 KB

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