ServerRequestTest.php 98 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988
  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 2.0.0
  14. * @license https://opensource.org/licenses/mit-license.php MIT License
  15. */
  16. namespace Cake\Test\TestCase\Http;
  17. use Cake\Core\Configure;
  18. use Cake\Http\Cookie\Cookie;
  19. use Cake\Http\Cookie\CookieCollection;
  20. use Cake\Http\Exception\MethodNotAllowedException;
  21. use Cake\Http\ServerRequest;
  22. use Cake\Http\ServerRequestFactory;
  23. use Cake\Http\Session;
  24. use Cake\TestSuite\TestCase;
  25. use Laminas\Diactoros\UploadedFile;
  26. use Laminas\Diactoros\Uri;
  27. /**
  28. * ServerRequest Test
  29. */
  30. class ServerRequestTest extends TestCase
  31. {
  32. /**
  33. * Setup callback
  34. *
  35. * @return void
  36. */
  37. public function setUp(): void
  38. {
  39. parent::setUp();
  40. Configure::write('App.baseUrl', false);
  41. }
  42. /**
  43. * Test custom detector with extra arguments.
  44. *
  45. * @return void
  46. */
  47. public function testCustomArgsDetector()
  48. {
  49. $request = new ServerRequest();
  50. $request->addDetector('controller', function ($request, $name) {
  51. return $request->getParam('controller') === $name;
  52. });
  53. $request = $request->withParam('controller', 'cake');
  54. $this->assertTrue($request->is('controller', 'cake'));
  55. $this->assertFalse($request->is('controller', 'nonExistingController'));
  56. $this->assertTrue($request->isController('cake'));
  57. $this->assertFalse($request->isController('nonExistingController'));
  58. }
  59. /**
  60. * Test the header detector.
  61. *
  62. * @return void
  63. */
  64. public function testHeaderDetector()
  65. {
  66. $request = new ServerRequest();
  67. $request->addDetector('host', ['header' => ['host' => 'cakephp.org']]);
  68. $request = $request->withEnv('HTTP_HOST', 'cakephp.org');
  69. $this->assertTrue($request->is('host'));
  70. $request = $request->withEnv('HTTP_HOST', 'php.net');
  71. $this->assertFalse($request->is('host'));
  72. }
  73. /**
  74. * Test the accept header detector.
  75. *
  76. * @return void
  77. */
  78. public function testExtensionDetector()
  79. {
  80. $request = new ServerRequest();
  81. $request = $request->withParam('_ext', 'json');
  82. $this->assertTrue($request->is('json'));
  83. $request = new ServerRequest();
  84. $request = $request->withParam('_ext', 'xml');
  85. $this->assertFalse($request->is('json'));
  86. }
  87. /**
  88. * Test the accept header detector.
  89. *
  90. * @return void
  91. */
  92. public function testAcceptHeaderDetector()
  93. {
  94. $request = new ServerRequest();
  95. $request = $request->withEnv('HTTP_ACCEPT', 'application/json, text/plain, */*');
  96. $this->assertTrue($request->is('json'));
  97. $request = new ServerRequest();
  98. $request = $request->withEnv('HTTP_ACCEPT', 'text/plain, */*');
  99. $this->assertFalse($request->is('json'));
  100. }
  101. /**
  102. * Test construction
  103. *
  104. * @return void
  105. */
  106. public function testConstructionQueryData()
  107. {
  108. $data = [
  109. 'query' => [
  110. 'one' => 'param',
  111. 'two' => 'banana',
  112. ],
  113. 'url' => 'some/path',
  114. ];
  115. $request = new ServerRequest($data);
  116. $this->assertSame('param', $request->getQuery('one'));
  117. $this->assertEquals($data['query'], $request->getQueryParams());
  118. $this->assertSame('/some/path', $request->getRequestTarget());
  119. }
  120. /**
  121. * Test constructing with a string url.
  122. *
  123. * @return void
  124. */
  125. public function testConstructStringUrlIgnoreServer()
  126. {
  127. $request = new ServerRequest([
  128. 'url' => '/articles/view/1',
  129. 'environment' => ['REQUEST_URI' => '/some/other/path'],
  130. ]);
  131. $this->assertSame('/articles/view/1', $request->getUri()->getPath());
  132. $request = new ServerRequest(['url' => '/']);
  133. $this->assertSame('/', $request->getUri()->getPath());
  134. }
  135. /**
  136. * Test that querystring args provided in the URL string are parsed.
  137. *
  138. * @return void
  139. */
  140. public function testQueryStringParsingFromInputUrl()
  141. {
  142. $request = new ServerRequest(['url' => 'some/path?one=something&two=else']);
  143. $expected = ['one' => 'something', 'two' => 'else'];
  144. $this->assertEquals($expected, $request->getQueryParams());
  145. $this->assertSame('/some/path', $request->getUri()->getPath());
  146. $this->assertSame('one=something&two=else', $request->getUri()->getQuery());
  147. }
  148. /**
  149. * Test that querystrings are handled correctly.
  150. *
  151. * @return void
  152. */
  153. public function testQueryStringAndNamedParams()
  154. {
  155. $config = ['environment' => ['REQUEST_URI' => '/tasks/index?ts=123456']];
  156. $request = new ServerRequest($config);
  157. $this->assertSame('/tasks/index', $request->getRequestTarget());
  158. $config = ['environment' => ['REQUEST_URI' => '/some/path?url=http://cakephp.org']];
  159. $request = new ServerRequest($config);
  160. $this->assertSame('/some/path', $request->getRequestTarget());
  161. $config = ['environment' => [
  162. 'REQUEST_URI' => Configure::read('App.fullBaseUrl') . '/other/path?url=http://cakephp.org',
  163. ]];
  164. $request = new ServerRequest($config);
  165. $this->assertSame('/other/path', $request->getRequestTarget());
  166. }
  167. /**
  168. * Test that URL in path is handled correctly.
  169. */
  170. public function testUrlInPath()
  171. {
  172. $config = ['environment' => ['REQUEST_URI' => '/jump/http://cakephp.org']];
  173. $request = new ServerRequest($config);
  174. $this->assertSame('/jump/http://cakephp.org', $request->getRequestTarget());
  175. $config = ['environment' => [
  176. 'REQUEST_URI' => Configure::read('App.fullBaseUrl') . '/jump/http://cakephp.org',
  177. ]];
  178. $request = new ServerRequest($config);
  179. $this->assertSame('/jump/http://cakephp.org', $request->getRequestTarget());
  180. }
  181. /**
  182. * Test getPath().
  183. *
  184. * @return void
  185. */
  186. public function testGetPath()
  187. {
  188. $request = new ServerRequest(['url' => '']);
  189. $this->assertSame('/', $request->getPath());
  190. $request = new ServerRequest(['url' => 'some/path?one=something&two=else']);
  191. $this->assertSame('/some/path', $request->getPath());
  192. $request = $request->withRequestTarget('/foo/bar?x=y');
  193. $this->assertSame('/foo/bar', $request->getPath());
  194. }
  195. /**
  196. * Test parsing POST data into the object.
  197. *
  198. * @return void
  199. */
  200. public function testPostParsing()
  201. {
  202. $post = [
  203. 'Article' => ['title'],
  204. ];
  205. $request = new ServerRequest(compact('post'));
  206. $this->assertEquals($post, $request->getData());
  207. $post = ['one' => 1, 'two' => 'three'];
  208. $request = new ServerRequest(compact('post'));
  209. $this->assertEquals($post, $request->getData());
  210. $post = [
  211. 'Article' => ['title' => 'Testing'],
  212. 'action' => 'update',
  213. ];
  214. $request = new ServerRequest(compact('post'));
  215. $this->assertEquals($post, $request->getData());
  216. }
  217. /**
  218. * Test parsing json PUT data into the object.
  219. *
  220. * @return void
  221. */
  222. public function testPutParsingJSON()
  223. {
  224. $data = '{"Article":["title"]}';
  225. $request = new ServerRequest([
  226. 'input' => $data,
  227. 'environment' => [
  228. 'REQUEST_METHOD' => 'PUT',
  229. 'CONTENT_TYPE' => 'application/json',
  230. ],
  231. ]);
  232. $this->assertEquals([], $request->getData());
  233. $result = $request->input('json_decode', true);
  234. $this->assertEquals(['title'], $result['Article']);
  235. }
  236. /**
  237. * Test that the constructor uses uploaded file objects
  238. * if they are present. This could happen in test scenarios.
  239. *
  240. * @return void
  241. */
  242. public function testFilesObject()
  243. {
  244. $file = new UploadedFile(
  245. __FILE__,
  246. 123,
  247. UPLOAD_ERR_OK,
  248. 'test.php',
  249. 'text/plain'
  250. );
  251. $request = new ServerRequest(['files' => ['avatar' => $file]]);
  252. $this->assertSame(['avatar' => $file], $request->getUploadedFiles());
  253. }
  254. /**
  255. * Test passing an empty files list.
  256. *
  257. * @return void
  258. */
  259. public function testFilesWithEmptyList()
  260. {
  261. $request = new ServerRequest([
  262. 'files' => [],
  263. ]);
  264. $this->assertEmpty($request->getData());
  265. $this->assertEmpty($request->getUploadedFiles());
  266. }
  267. /**
  268. * Test replacing files.
  269. *
  270. * @return void
  271. */
  272. public function testWithUploadedFiles()
  273. {
  274. $file = new UploadedFile(
  275. __FILE__,
  276. 123,
  277. UPLOAD_ERR_OK,
  278. 'test.php',
  279. 'text/plain'
  280. );
  281. $request = new ServerRequest();
  282. $new = $request->withUploadedFiles(['picture' => $file]);
  283. $this->assertSame([], $request->getUploadedFiles());
  284. $this->assertNotSame($new, $request);
  285. $this->assertSame(['picture' => $file], $new->getUploadedFiles());
  286. }
  287. /**
  288. * Test getting a single file
  289. *
  290. * @return void
  291. */
  292. public function testGetUploadedFile()
  293. {
  294. $file = new UploadedFile(
  295. __FILE__,
  296. 123,
  297. UPLOAD_ERR_OK,
  298. 'test.php',
  299. 'text/plain'
  300. );
  301. $request = new ServerRequest();
  302. $new = $request->withUploadedFiles(['picture' => $file]);
  303. $this->assertNull($new->getUploadedFile(''));
  304. $this->assertSame($file, $new->getUploadedFile('picture'));
  305. $new = $request->withUploadedFiles([
  306. 'pictures' => [
  307. [
  308. 'image' => $file,
  309. ],
  310. ],
  311. ]);
  312. $this->assertNull($new->getUploadedFile('pictures'));
  313. $this->assertNull($new->getUploadedFile('pictures.0'));
  314. $this->assertNull($new->getUploadedFile('pictures.1'));
  315. $this->assertSame($file, $new->getUploadedFile('pictures.0.image'));
  316. }
  317. /**
  318. * Test replacing files with an invalid file
  319. *
  320. * @return void
  321. */
  322. public function testWithUploadedFilesInvalidFile()
  323. {
  324. $this->expectException(\InvalidArgumentException::class);
  325. $this->expectExceptionMessage('Invalid file at \'avatar\'');
  326. $request = new ServerRequest();
  327. $request->withUploadedFiles(['avatar' => 'not a file']);
  328. }
  329. /**
  330. * Test replacing files with an invalid file
  331. *
  332. * @return void
  333. */
  334. public function testWithUploadedFilesInvalidFileNested()
  335. {
  336. $this->expectException(\InvalidArgumentException::class);
  337. $this->expectExceptionMessage('Invalid file at \'user.avatar\'');
  338. $request = new ServerRequest();
  339. $request->withUploadedFiles(['user' => ['avatar' => 'not a file']]);
  340. }
  341. /**
  342. * Test the clientIp method.
  343. *
  344. * @return void
  345. */
  346. public function testClientIp()
  347. {
  348. $request = new ServerRequest(['environment' => [
  349. 'HTTP_X_FORWARDED_FOR' => '192.168.1.5, 10.0.1.1, proxy.com, real.ip',
  350. 'HTTP_X_REAL_IP' => '192.168.1.1',
  351. 'HTTP_CLIENT_IP' => '192.168.1.2',
  352. 'REMOTE_ADDR' => '192.168.1.3',
  353. ]]);
  354. $request->trustProxy = true;
  355. $this->assertSame('real.ip', $request->clientIp());
  356. $request = $request->withEnv('HTTP_X_FORWARDED_FOR', '');
  357. $this->assertSame('192.168.1.1', $request->clientIp());
  358. $request = $request->withEnv('HTTP_X_REAL_IP', '');
  359. $this->assertSame('192.168.1.2', $request->clientIp());
  360. $request->trustProxy = false;
  361. $this->assertSame('192.168.1.3', $request->clientIp());
  362. $request = $request->withEnv('HTTP_X_FORWARDED_FOR', '');
  363. $this->assertSame('192.168.1.3', $request->clientIp());
  364. $request = $request->withEnv('HTTP_CLIENT_IP', '');
  365. $this->assertSame('192.168.1.3', $request->clientIp());
  366. }
  367. /**
  368. * test clientIp method with trusted proxies
  369. *
  370. * @return void
  371. */
  372. public function testClientIpWithTrustedProxies()
  373. {
  374. $request = new ServerRequest(['environment' => [
  375. 'HTTP_X_FORWARDED_FOR' => 'real.ip, 192.168.1.0, 192.168.1.2, 192.168.1.3',
  376. 'HTTP_X_REAL_IP' => '192.168.1.1',
  377. 'HTTP_CLIENT_IP' => '192.168.1.2',
  378. 'REMOTE_ADDR' => '192.168.1.4',
  379. ]]);
  380. $request->setTrustedProxies([
  381. '192.168.1.0',
  382. '192.168.1.1',
  383. '192.168.1.2',
  384. '192.168.1.3',
  385. ]);
  386. $this->assertSame('real.ip', $request->clientIp());
  387. $request = $request->withEnv(
  388. 'HTTP_X_FORWARDED_FOR',
  389. 'spoof.fake.ip, real.ip, 192.168.1.0, 192.168.1.2, 192.168.1.3'
  390. );
  391. $this->assertSame('192.168.1.3', $request->clientIp());
  392. $request = $request->withEnv('HTTP_X_FORWARDED_FOR', '');
  393. $this->assertSame('192.168.1.1', $request->clientIp());
  394. $request->trustProxy = false;
  395. $this->assertSame('192.168.1.4', $request->clientIp());
  396. }
  397. /**
  398. * Test the referrer function.
  399. *
  400. * @return void
  401. */
  402. public function testReferer()
  403. {
  404. $request = new ServerRequest(['webroot' => '/']);
  405. $request = $request->withEnv('HTTP_REFERER', 'http://cakephp.org');
  406. $result = $request->referer(false);
  407. $this->assertSame('http://cakephp.org', $result);
  408. $request = $request->withEnv('HTTP_REFERER', '');
  409. $result = $request->referer(true);
  410. $this->assertNull($result);
  411. $result = $request->referer(false);
  412. $this->assertNull($result);
  413. $request = $request->withEnv('HTTP_REFERER', Configure::read('App.fullBaseUrl') . '/some/path');
  414. $result = $request->referer();
  415. $this->assertSame('/some/path', $result);
  416. $request = $request->withEnv('HTTP_REFERER', Configure::read('App.fullBaseUrl') . '///cakephp.org/');
  417. $result = $request->referer();
  418. $this->assertSame('/', $result); // Avoid returning scheme-relative URLs.
  419. $request = $request->withEnv('HTTP_REFERER', Configure::read('App.fullBaseUrl') . '/0');
  420. $result = $request->referer();
  421. $this->assertSame('/0', $result);
  422. $request = $request->withEnv('HTTP_REFERER', Configure::read('App.fullBaseUrl') . '/');
  423. $result = $request->referer();
  424. $this->assertSame('/', $result);
  425. $request = $request->withEnv('HTTP_REFERER', Configure::read('App.fullBaseUrl') . '/some/path');
  426. $result = $request->referer(false);
  427. $this->assertSame(Configure::read('App.fullBaseUrl') . '/some/path', $result);
  428. }
  429. /**
  430. * Test referer() with a base path that duplicates the
  431. * first segment.
  432. *
  433. * @return void
  434. */
  435. public function testRefererBasePath()
  436. {
  437. $request = new ServerRequest([
  438. 'url' => '/waves/users/login',
  439. 'webroot' => '/waves/',
  440. 'base' => '/waves',
  441. ]);
  442. $request = $request->withEnv('HTTP_REFERER', Configure::read('App.fullBaseUrl') . '/waves/waves/add');
  443. $result = $request->referer();
  444. $this->assertSame('/waves/add', $result);
  445. }
  446. /**
  447. * test the simple uses of is()
  448. *
  449. * @return void
  450. */
  451. public function testIsHttpMethods()
  452. {
  453. $request = new ServerRequest();
  454. $this->assertFalse($request->is('undefined-behavior'));
  455. $request = $request->withEnv('REQUEST_METHOD', 'GET');
  456. $this->assertTrue($request->is('get'));
  457. $request = $request->withEnv('REQUEST_METHOD', 'POST');
  458. $this->assertTrue($request->is('POST'));
  459. $request = $request->withEnv('REQUEST_METHOD', 'PUT');
  460. $this->assertTrue($request->is('put'));
  461. $this->assertFalse($request->is('get'));
  462. $request = $request->withEnv('REQUEST_METHOD', 'DELETE');
  463. $this->assertTrue($request->is('delete'));
  464. $this->assertTrue($request->isDelete());
  465. $request = $request->withEnv('REQUEST_METHOD', 'delete');
  466. $this->assertFalse($request->is('delete'));
  467. }
  468. /**
  469. * Test is() with json and xml.
  470. *
  471. * @return void
  472. */
  473. public function testIsJsonAndXml()
  474. {
  475. $request = new ServerRequest();
  476. $request = $request->withEnv('HTTP_ACCEPT', 'application/json, text/plain, */*');
  477. $this->assertTrue($request->is('json'));
  478. $request = new ServerRequest();
  479. $request = $request->withEnv('HTTP_ACCEPT', 'application/xml, text/plain, */*');
  480. $this->assertTrue($request->is('xml'));
  481. $request = new ServerRequest();
  482. $request = $request->withEnv('HTTP_ACCEPT', 'text/xml, */*');
  483. $this->assertTrue($request->is('xml'));
  484. }
  485. /**
  486. * Test is() with multiple types.
  487. *
  488. * @return void
  489. */
  490. public function testIsMultiple()
  491. {
  492. $request = new ServerRequest();
  493. $request = $request->withEnv('REQUEST_METHOD', 'GET');
  494. $this->assertTrue($request->is(['get', 'post']));
  495. $request = $request->withEnv('REQUEST_METHOD', 'POST');
  496. $this->assertTrue($request->is(['get', 'post']));
  497. $request = $request->withEnv('REQUEST_METHOD', 'PUT');
  498. $this->assertFalse($request->is(['get', 'post']));
  499. }
  500. /**
  501. * Test isAll()
  502. *
  503. * @return void
  504. */
  505. public function testIsAll()
  506. {
  507. $request = new ServerRequest();
  508. $request = $request->withEnv('HTTP_X_REQUESTED_WITH', 'XMLHttpRequest');
  509. $request = $request->withEnv('REQUEST_METHOD', 'GET');
  510. $this->assertTrue($request->isAll(['ajax', 'get']));
  511. $this->assertFalse($request->isAll(['post', 'get']));
  512. $this->assertFalse($request->isAll(['ajax', 'post']));
  513. }
  514. /**
  515. * Test getMethod()
  516. *
  517. * @return void
  518. */
  519. public function testGetMethod()
  520. {
  521. $request = new ServerRequest([
  522. 'environment' => ['REQUEST_METHOD' => 'delete'],
  523. ]);
  524. $this->assertSame('delete', $request->getMethod());
  525. }
  526. /**
  527. * Test withMethod()
  528. *
  529. * @return void
  530. */
  531. public function testWithMethod()
  532. {
  533. $request = new ServerRequest([
  534. 'environment' => ['REQUEST_METHOD' => 'delete'],
  535. ]);
  536. $new = $request->withMethod('put');
  537. $this->assertNotSame($new, $request);
  538. $this->assertSame('delete', $request->getMethod());
  539. $this->assertSame('put', $new->getMethod());
  540. }
  541. /**
  542. * Test withMethod() and invalid data
  543. *
  544. * @return void
  545. */
  546. public function testWithMethodInvalid()
  547. {
  548. $this->expectException(\InvalidArgumentException::class);
  549. $this->expectExceptionMessage('Unsupported HTTP method "no good" provided');
  550. $request = new ServerRequest([
  551. 'environment' => ['REQUEST_METHOD' => 'delete'],
  552. ]);
  553. $request->withMethod('no good');
  554. }
  555. /**
  556. * Test getProtocolVersion()
  557. *
  558. * @return void
  559. */
  560. public function testGetProtocolVersion()
  561. {
  562. $request = new ServerRequest();
  563. $this->assertSame('1.1', $request->getProtocolVersion());
  564. // SERVER var.
  565. $request = new ServerRequest([
  566. 'environment' => ['SERVER_PROTOCOL' => 'HTTP/1.0'],
  567. ]);
  568. $this->assertSame('1.0', $request->getProtocolVersion());
  569. }
  570. /**
  571. * Test withProtocolVersion()
  572. *
  573. * @return void
  574. */
  575. public function testWithProtocolVersion()
  576. {
  577. $request = new ServerRequest();
  578. $new = $request->withProtocolVersion('1.0');
  579. $this->assertNotSame($new, $request);
  580. $this->assertSame('1.1', $request->getProtocolVersion());
  581. $this->assertSame('1.0', $new->getProtocolVersion());
  582. }
  583. /**
  584. * Test withProtocolVersion() and invalid data
  585. *
  586. * @return void
  587. */
  588. public function testWithProtocolVersionInvalid()
  589. {
  590. $this->expectException(\InvalidArgumentException::class);
  591. $this->expectExceptionMessage('Unsupported protocol version \'no good\' provided');
  592. $request = new ServerRequest();
  593. $request->withProtocolVersion('no good');
  594. }
  595. /**
  596. * Test host retrieval.
  597. *
  598. * @return void
  599. */
  600. public function testHost()
  601. {
  602. $request = new ServerRequest(['environment' => [
  603. 'HTTP_HOST' => 'localhost',
  604. 'HTTP_X_FORWARDED_HOST' => 'cakephp.org',
  605. ]]);
  606. $this->assertSame('localhost', $request->host());
  607. $request->trustProxy = true;
  608. $this->assertSame('cakephp.org', $request->host());
  609. }
  610. /**
  611. * test port retrieval.
  612. *
  613. * @return void
  614. */
  615. public function testPort()
  616. {
  617. $request = new ServerRequest(['environment' => ['SERVER_PORT' => '80']]);
  618. $this->assertSame('80', $request->port());
  619. $request = $request->withEnv('SERVER_PORT', '443');
  620. $request = $request->withEnv('HTTP_X_FORWARDED_PORT', '80');
  621. $this->assertSame('443', $request->port());
  622. $request->trustProxy = true;
  623. $this->assertSame('80', $request->port());
  624. }
  625. /**
  626. * test domain retrieval.
  627. *
  628. * @return void
  629. */
  630. public function testDomain()
  631. {
  632. $request = new ServerRequest(['environment' => ['HTTP_HOST' => 'something.example.com']]);
  633. $this->assertSame('example.com', $request->domain());
  634. $request = $request->withEnv('HTTP_HOST', 'something.example.co.uk');
  635. $this->assertSame('example.co.uk', $request->domain(2));
  636. }
  637. /**
  638. * Test scheme() method.
  639. *
  640. * @return void
  641. */
  642. public function testScheme()
  643. {
  644. $request = new ServerRequest(['environment' => ['HTTPS' => 'on']]);
  645. $this->assertSame('https', $request->scheme());
  646. $request = $request->withEnv('HTTPS', '');
  647. $this->assertSame('http', $request->scheme());
  648. $request = $request->withEnv('HTTP_X_FORWARDED_PROTO', 'https');
  649. $request->trustProxy = true;
  650. $this->assertSame('https', $request->scheme());
  651. }
  652. /**
  653. * test getting subdomains for a host.
  654. *
  655. * @return void
  656. */
  657. public function testSubdomain()
  658. {
  659. $request = new ServerRequest(['environment' => ['HTTP_HOST' => 'something.example.com']]);
  660. $this->assertEquals(['something'], $request->subdomains());
  661. $request = $request->withEnv('HTTP_HOST', 'www.something.example.com');
  662. $this->assertEquals(['www', 'something'], $request->subdomains());
  663. $request = $request->withEnv('HTTP_HOST', 'www.something.example.co.uk');
  664. $this->assertEquals(['www', 'something'], $request->subdomains(2));
  665. $request = $request->withEnv('HTTP_HOST', 'example.co.uk');
  666. $this->assertEquals([], $request->subdomains(2));
  667. }
  668. /**
  669. * Test ajax, flash and friends
  670. *
  671. * @return void
  672. */
  673. public function testisAjax()
  674. {
  675. $request = new ServerRequest();
  676. $request = $request->withEnv('HTTP_X_REQUESTED_WITH', 'XMLHttpRequest');
  677. $this->assertTrue($request->is('ajax'));
  678. $request = $request->withEnv('HTTP_X_REQUESTED_WITH', 'XMLHTTPREQUEST');
  679. $this->assertFalse($request->is('ajax'));
  680. $this->assertFalse($request->isAjax());
  681. }
  682. /**
  683. * Test __call exceptions
  684. *
  685. * @return void
  686. */
  687. public function testMagicCallExceptionOnUnknownMethod()
  688. {
  689. $this->expectException(\BadMethodCallException::class);
  690. $request = new ServerRequest();
  691. $request->IamABanana();
  692. }
  693. /**
  694. * Test is(ssl)
  695. *
  696. * @return void
  697. */
  698. public function testIsSsl()
  699. {
  700. $request = new ServerRequest();
  701. $request = $request->withEnv('HTTPS', 'on');
  702. $this->assertTrue($request->is('ssl'));
  703. $request = $request->withEnv('HTTPS', '1');
  704. $this->assertTrue($request->is('ssl'));
  705. $request = $request->withEnv('HTTPS', 'I am not empty');
  706. $this->assertFalse($request->is('ssl'));
  707. $request = $request->withEnv('HTTPS', 'off');
  708. $this->assertFalse($request->is('ssl'));
  709. $request = $request->withEnv('HTTPS', '');
  710. $this->assertFalse($request->is('ssl'));
  711. }
  712. /**
  713. * Test adding detectors and having them work.
  714. *
  715. * @return void
  716. */
  717. public function testAddDetector()
  718. {
  719. $request = new ServerRequest();
  720. ServerRequest::addDetector('closure', function ($request) {
  721. return true;
  722. });
  723. $this->assertTrue($request->is('closure'));
  724. ServerRequest::addDetector('get', function ($request) {
  725. return $request->getEnv('REQUEST_METHOD') === 'GET';
  726. });
  727. $request = $request->withEnv('REQUEST_METHOD', 'GET');
  728. $this->assertTrue($request->is('get'));
  729. ServerRequest::addDetector('compare', ['env' => 'TEST_VAR', 'value' => 'something']);
  730. $request = $request->withEnv('TEST_VAR', 'something');
  731. $this->assertTrue($request->is('compare'), 'Value match failed.');
  732. $request = $request->withEnv('TEST_VAR', 'wrong');
  733. $this->assertFalse($request->is('compare'), 'Value mis-match failed.');
  734. ServerRequest::addDetector('compareCamelCase', ['env' => 'TEST_VAR', 'value' => 'foo']);
  735. $request = $request->withEnv('TEST_VAR', 'foo');
  736. $this->assertTrue($request->is('compareCamelCase'), 'Value match failed.');
  737. $this->assertTrue($request->is('comparecamelcase'), 'detectors should be case insensitive');
  738. $this->assertTrue($request->is('COMPARECAMELCASE'), 'detectors should be case insensitive');
  739. $request = $request->withEnv('TEST_VAR', 'not foo');
  740. $this->assertFalse($request->is('compareCamelCase'), 'Value match failed.');
  741. $this->assertFalse($request->is('comparecamelcase'), 'detectors should be case insensitive');
  742. $this->assertFalse($request->is('COMPARECAMELCASE'), 'detectors should be case insensitive');
  743. ServerRequest::addDetector('banana', ['env' => 'TEST_VAR', 'pattern' => '/^ban.*$/']);
  744. $request = $request->withEnv('TEST_VAR', 'banana');
  745. $this->assertTrue($request->isBanana());
  746. $request = $request->withEnv('TEST_VAR', 'wrong value');
  747. $this->assertFalse($request->isBanana());
  748. ServerRequest::addDetector('mobile', ['env' => 'HTTP_USER_AGENT', 'options' => ['Imagination']]);
  749. $request = $request->withEnv('HTTP_USER_AGENT', 'Imagination land');
  750. $this->assertTrue($request->isMobile());
  751. ServerRequest::addDetector('index', ['param' => 'action', 'value' => 'index']);
  752. $request = $request->withParam('action', 'index');
  753. $request->clearDetectorCache();
  754. $this->assertTrue($request->isIndex());
  755. $request = $request->withParam('action', 'add');
  756. $request->clearDetectorCache();
  757. $this->assertFalse($request->isIndex());
  758. ServerRequest::addDetector('callme', function ($request) {
  759. return $request->getAttribute('return');
  760. });
  761. $request = $request->withAttribute('return', true);
  762. $request->clearDetectorCache();
  763. $this->assertTrue($request->isCallMe());
  764. ServerRequest::addDetector('extension', ['param' => '_ext', 'options' => ['pdf', 'png', 'txt']]);
  765. $request = $request->withParam('_ext', 'pdf');
  766. $request->clearDetectorCache();
  767. $this->assertTrue($request->is('extension'));
  768. $request = $request->withParam('_ext', 'exe');
  769. $request->clearDetectorCache();
  770. $this->assertFalse($request->isExtension());
  771. }
  772. /**
  773. * Test getting headers
  774. *
  775. * @return void
  776. */
  777. public function testHeader()
  778. {
  779. $request = new ServerRequest(['environment' => [
  780. 'HTTP_HOST' => 'localhost',
  781. 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_4; en-ca) AppleWebKit/534.8+ (KHTML, like Gecko) Version/5.0 Safari/533.16',
  782. 'CONTENT_TYPE' => 'application/json',
  783. 'CONTENT_LENGTH' => '1337',
  784. 'HTTP_CONTENT_MD5' => 'abc123',
  785. ]]);
  786. $this->assertEquals($request->getEnv('HTTP_HOST'), $request->getHeaderLine('host'));
  787. $this->assertEquals($request->getEnv('HTTP_USER_AGENT'), $request->getHeaderLine('User-Agent'));
  788. $this->assertEquals($request->getEnv('CONTENT_LENGTH'), $request->getHeaderLine('content-length'));
  789. $this->assertEquals($request->getEnv('CONTENT_TYPE'), $request->getHeaderLine('content-type'));
  790. $this->assertEquals($request->getEnv('HTTP_CONTENT_MD5'), $request->getHeaderLine('content-md5'));
  791. }
  792. /**
  793. * Test getting headers with psr7 methods
  794. *
  795. * @return void
  796. */
  797. public function testGetHeaders()
  798. {
  799. $request = new ServerRequest(['environment' => [
  800. 'HTTP_HOST' => 'localhost',
  801. 'CONTENT_TYPE' => 'application/json',
  802. 'CONTENT_LENGTH' => 1337,
  803. 'HTTP_CONTENT_MD5' => 'abc123',
  804. 'HTTP_DOUBLE' => ['a', 'b'],
  805. ]]);
  806. $headers = $request->getHeaders();
  807. $expected = [
  808. 'Host' => ['localhost'],
  809. 'Content-Type' => ['application/json'],
  810. 'Content-Length' => [1337],
  811. 'Content-Md5' => ['abc123'],
  812. 'Double' => ['a', 'b'],
  813. ];
  814. $this->assertEquals($expected, $headers);
  815. }
  816. /**
  817. * Test hasHeader
  818. *
  819. * @return void
  820. */
  821. public function testHasHeader()
  822. {
  823. $request = new ServerRequest(['environment' => [
  824. 'HTTP_HOST' => 'localhost',
  825. 'CONTENT_TYPE' => 'application/json',
  826. 'CONTENT_LENGTH' => 1337,
  827. 'HTTP_CONTENT_MD5' => 'abc123',
  828. 'HTTP_DOUBLE' => ['a', 'b'],
  829. ]]);
  830. $this->assertTrue($request->hasHeader('Host'));
  831. $this->assertTrue($request->hasHeader('Content-Type'));
  832. $this->assertTrue($request->hasHeader('Content-MD5'));
  833. $this->assertTrue($request->hasHeader('Double'));
  834. $this->assertFalse($request->hasHeader('Authorization'));
  835. }
  836. /**
  837. * Test getting headers with psr7 methods
  838. *
  839. * @return void
  840. */
  841. public function testGetHeader()
  842. {
  843. $request = new ServerRequest(['environment' => [
  844. 'HTTP_HOST' => 'localhost',
  845. 'CONTENT_TYPE' => 'application/json',
  846. 'CONTENT_LENGTH' => 1337,
  847. 'HTTP_CONTENT_MD5' => 'abc123',
  848. 'HTTP_DOUBLE' => ['a', 'b'],
  849. ]]);
  850. $this->assertEquals([], $request->getHeader('Not-there'));
  851. $expected = [$request->getEnv('HTTP_HOST')];
  852. $this->assertEquals($expected, $request->getHeader('Host'));
  853. $this->assertEquals($expected, $request->getHeader('host'));
  854. $this->assertEquals($expected, $request->getHeader('HOST'));
  855. $this->assertEquals(['a', 'b'], $request->getHeader('Double'));
  856. }
  857. /**
  858. * Test getting headers with psr7 methods
  859. *
  860. * @return void
  861. */
  862. public function testGetHeaderLine()
  863. {
  864. $request = new ServerRequest(['environment' => [
  865. 'HTTP_HOST' => 'localhost',
  866. 'CONTENT_TYPE' => 'application/json',
  867. 'CONTENT_LENGTH' => '1337',
  868. 'HTTP_CONTENT_MD5' => 'abc123',
  869. 'HTTP_DOUBLE' => ['a', 'b'],
  870. ]]);
  871. $this->assertSame('', $request->getHeaderLine('Authorization'));
  872. $expected = $request->getEnv('CONTENT_LENGTH');
  873. $this->assertEquals($expected, $request->getHeaderLine('Content-Length'));
  874. $this->assertEquals($expected, $request->getHeaderLine('content-Length'));
  875. $this->assertEquals($expected, $request->getHeaderLine('ConTent-LenGth'));
  876. $this->assertSame('a, b', $request->getHeaderLine('Double'));
  877. }
  878. /**
  879. * Test setting a header.
  880. *
  881. * @return void
  882. */
  883. public function testWithHeader()
  884. {
  885. $request = new ServerRequest(['environment' => [
  886. 'HTTP_HOST' => 'localhost',
  887. 'CONTENT_TYPE' => 'application/json',
  888. 'CONTENT_LENGTH' => 1337,
  889. 'HTTP_CONTENT_MD5' => 'abc123',
  890. 'HTTP_DOUBLE' => ['a', 'b'],
  891. ]]);
  892. $new = $request->withHeader('Content-Length', 999);
  893. $this->assertNotSame($new, $request);
  894. $this->assertEquals(1337, $request->getHeaderLine('Content-length'), 'old request is unchanged');
  895. $this->assertEquals(999, $new->getHeaderLine('Content-length'), 'new request is correct');
  896. $new = $request->withHeader('Double', ['a']);
  897. $this->assertEquals(['a'], $new->getHeader('Double'), 'List values are overwritten');
  898. }
  899. /**
  900. * Test adding a header.
  901. *
  902. * @return void
  903. */
  904. public function testWithAddedHeader()
  905. {
  906. $request = new ServerRequest(['environment' => [
  907. 'HTTP_HOST' => 'localhost',
  908. 'CONTENT_TYPE' => 'application/json',
  909. 'CONTENT_LENGTH' => 1337,
  910. 'HTTP_CONTENT_MD5' => 'abc123',
  911. 'HTTP_DOUBLE' => ['a', 'b'],
  912. ]]);
  913. $new = $request->withAddedHeader('Double', 'c');
  914. $this->assertNotSame($new, $request);
  915. $this->assertSame('a, b', $request->getHeaderLine('Double'), 'old request is unchanged');
  916. $this->assertSame('a, b, c', $new->getHeaderLine('Double'), 'new request is correct');
  917. $new = $request->withAddedHeader('Content-Length', 777);
  918. $this->assertEquals([1337, 777], $new->getHeader('Content-Length'), 'scalar values are appended');
  919. $new = $request->withAddedHeader('Content-Length', [123, 456]);
  920. $this->assertEquals([1337, 123, 456], $new->getHeader('Content-Length'), 'List values are merged');
  921. }
  922. /**
  923. * Test removing a header.
  924. *
  925. * @return void
  926. */
  927. public function testWithoutHeader()
  928. {
  929. $request = new ServerRequest(['environment' => [
  930. 'HTTP_HOST' => 'localhost',
  931. 'CONTENT_TYPE' => 'application/json',
  932. 'CONTENT_LENGTH' => 1337,
  933. 'HTTP_CONTENT_MD5' => 'abc123',
  934. 'HTTP_DOUBLE' => ['a', 'b'],
  935. ]]);
  936. $new = $request->withoutHeader('Content-Length', 999);
  937. $this->assertNotSame($new, $request);
  938. $this->assertEquals(1337, $request->getHeaderLine('Content-length'), 'old request is unchanged');
  939. $this->assertSame('', $new->getHeaderLine('Content-length'), 'new request is correct');
  940. }
  941. /**
  942. * Test accepts() with and without parameters
  943. *
  944. * @return void
  945. */
  946. public function testAccepts()
  947. {
  948. $request = new ServerRequest(['environment' => [
  949. 'HTTP_ACCEPT' => 'text/xml,application/xml;q=0.9,application/xhtml+xml,text/html,text/plain,image/png',
  950. ]]);
  951. $result = $request->accepts();
  952. $expected = [
  953. 'text/xml', 'application/xhtml+xml', 'text/html', 'text/plain', 'image/png', 'application/xml',
  954. ];
  955. $this->assertEquals($expected, $result, 'Content types differ.');
  956. $result = $request->accepts('text/html');
  957. $this->assertTrue($result);
  958. $result = $request->accepts('image/gif');
  959. $this->assertFalse($result);
  960. }
  961. /**
  962. * Test that accept header types are trimmed for comparisons.
  963. *
  964. * @return void
  965. */
  966. public function testAcceptWithWhitespace()
  967. {
  968. $request = new ServerRequest(['environment' => [
  969. 'HTTP_ACCEPT' => 'text/xml , text/html , text/plain,image/png',
  970. ]]);
  971. $result = $request->accepts();
  972. $expected = [
  973. 'text/xml', 'text/html', 'text/plain', 'image/png',
  974. ];
  975. $this->assertEquals($expected, $result, 'Content types differ.');
  976. $this->assertTrue($request->accepts('text/html'));
  977. }
  978. /**
  979. * Content types from accepts() should respect the client's q preference values.
  980. *
  981. * @return void
  982. */
  983. public function testAcceptWithQvalueSorting()
  984. {
  985. $request = new ServerRequest(['environment' => [
  986. 'HTTP_ACCEPT' => 'text/html;q=0.8,application/json;q=0.7,application/xml;q=1.0',
  987. ]]);
  988. $result = $request->accepts();
  989. $expected = ['application/xml', 'text/html', 'application/json'];
  990. $this->assertEquals($expected, $result);
  991. }
  992. /**
  993. * Test the raw parsing of accept headers into the q value formatting.
  994. *
  995. * @return void
  996. */
  997. public function testParseAcceptWithQValue()
  998. {
  999. $request = new ServerRequest(['environment' => [
  1000. 'HTTP_ACCEPT' => 'text/html;q=0.8,application/json;q=0.7,application/xml;q=1.0,image/png',
  1001. ]]);
  1002. $result = $request->parseAccept();
  1003. $expected = [
  1004. '1.0' => ['application/xml', 'image/png'],
  1005. '0.8' => ['text/html'],
  1006. '0.7' => ['application/json'],
  1007. ];
  1008. $this->assertEquals($expected, $result);
  1009. }
  1010. /**
  1011. * Test parsing accept with a confusing accept value.
  1012. *
  1013. * @return void
  1014. */
  1015. public function testParseAcceptNoQValues()
  1016. {
  1017. $request = new ServerRequest(['environment' => [
  1018. 'HTTP_ACCEPT' => 'application/json, text/plain, */*',
  1019. ]]);
  1020. $result = $request->parseAccept();
  1021. $expected = [
  1022. '1.0' => ['application/json', 'text/plain', '*/*'],
  1023. ];
  1024. $this->assertEquals($expected, $result);
  1025. }
  1026. /**
  1027. * Test parsing accept ignores index param
  1028. *
  1029. * @return void
  1030. */
  1031. public function testParseAcceptIgnoreAcceptExtensions()
  1032. {
  1033. $request = new ServerRequest(['environment' => [
  1034. 'url' => '/',
  1035. 'HTTP_ACCEPT' => 'application/json;level=1, text/plain, */*',
  1036. ]], false);
  1037. $result = $request->parseAccept();
  1038. $expected = [
  1039. '1.0' => ['application/json', 'text/plain', '*/*'],
  1040. ];
  1041. $this->assertEquals($expected, $result);
  1042. }
  1043. /**
  1044. * Test that parsing accept headers with invalid syntax works.
  1045. *
  1046. * The header used is missing a q value for application/xml.
  1047. *
  1048. * @return void
  1049. */
  1050. public function testParseAcceptInvalidSyntax()
  1051. {
  1052. $request = new ServerRequest(['environment' => [
  1053. 'url' => '/',
  1054. 'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;image/png,image/jpeg,image/*;q=0.9,*/*;q=0.8',
  1055. ]], false);
  1056. $result = $request->parseAccept();
  1057. $expected = [
  1058. '1.0' => ['text/html', 'application/xhtml+xml', 'application/xml', 'image/jpeg'],
  1059. '0.9' => ['image/*'],
  1060. '0.8' => ['*/*'],
  1061. ];
  1062. $this->assertEquals($expected, $result);
  1063. }
  1064. /**
  1065. * Test baseUrl and webroot with ModRewrite
  1066. *
  1067. * @return void
  1068. */
  1069. public function testBaseUrlAndWebrootWithModRewrite()
  1070. {
  1071. Configure::write('App.baseUrl', false);
  1072. $request = ServerRequestFactory::fromGlobals([
  1073. 'DOCUMENT_ROOT' => '/cake/repo/branches',
  1074. 'PHP_SELF' => '/urlencode me/webroot/index.php',
  1075. 'PATH_INFO' => '/posts/view/1',
  1076. ]);
  1077. $this->assertSame('/urlencode%20me', $request->getAttribute('base'));
  1078. $this->assertSame('/urlencode%20me/', $request->getAttribute('webroot'));
  1079. $this->assertSame('/posts/view/1', $request->getRequestTarget());
  1080. $request = ServerRequestFactory::fromGlobals([
  1081. 'DOCUMENT_ROOT' => '/cake/repo/branches',
  1082. 'PHP_SELF' => '/1.2.x.x/webroot/index.php',
  1083. 'PATH_INFO' => '/posts/view/1',
  1084. ]);
  1085. $this->assertSame('/1.2.x.x', $request->getAttribute('base'));
  1086. $this->assertSame('/1.2.x.x/', $request->getAttribute('webroot'));
  1087. $this->assertSame('/posts/view/1', $request->getRequestTarget());
  1088. $request = ServerRequestFactory::fromGlobals([
  1089. 'DOCUMENT_ROOT' => '/cake/repo/branches/1.2.x.x/webroot',
  1090. 'PHP_SELF' => '/index.php',
  1091. 'PATH_INFO' => '/posts/add',
  1092. ]);
  1093. $this->assertSame('', $request->getAttribute('base'));
  1094. $this->assertSame('/', $request->getAttribute('webroot'));
  1095. $this->assertSame('/posts/add', $request->getRequestTarget());
  1096. $request = ServerRequestFactory::fromGlobals([
  1097. 'DOCUMENT_ROOT' => '/cake/repo/branches/1.2.x.x/test/',
  1098. 'PHP_SELF' => '/webroot/index.php',
  1099. ]);
  1100. $this->assertSame('', $request->getAttribute('base'));
  1101. $this->assertSame('/', $request->getAttribute('webroot'));
  1102. $request = ServerRequestFactory::fromGlobals([
  1103. 'DOCUMENT_ROOT' => '/some/apps/where',
  1104. 'PHP_SELF' => '/webroot/index.php',
  1105. ]);
  1106. $this->assertSame('', $request->getAttribute('base'));
  1107. $this->assertSame('/', $request->getAttribute('webroot'));
  1108. Configure::write('App.dir', 'auth');
  1109. $request = ServerRequestFactory::fromGlobals([
  1110. 'DOCUMENT_ROOT' => '/cake/repo/branches',
  1111. 'PHP_SELF' => '/demos/webroot/index.php',
  1112. ]);
  1113. $this->assertSame('/demos', $request->getAttribute('base'));
  1114. $this->assertSame('/demos/', $request->getAttribute('webroot'));
  1115. Configure::write('App.dir', 'code');
  1116. $request = ServerRequestFactory::fromGlobals([
  1117. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1118. 'PHP_SELF' => '/clients/PewterReport/webroot/index.php',
  1119. ]);
  1120. $this->assertSame('/clients/PewterReport', $request->getAttribute('base'));
  1121. $this->assertSame('/clients/PewterReport/', $request->getAttribute('webroot'));
  1122. }
  1123. /**
  1124. * Test baseUrl with ModRewrite alias
  1125. *
  1126. * @return void
  1127. */
  1128. public function testBaseUrlwithModRewriteAlias()
  1129. {
  1130. Configure::write('App.base', '/control');
  1131. $request = ServerRequestFactory::fromGlobals([
  1132. 'DOCUMENT_ROOT' => '/home/aplusnur/public_html',
  1133. 'PHP_SELF' => '/control/index.php',
  1134. ]);
  1135. $this->assertSame('/control', $request->getAttribute('base'));
  1136. $this->assertSame('/control/', $request->getAttribute('webroot'));
  1137. Configure::write('App.base', false);
  1138. Configure::write('App.dir', 'affiliate');
  1139. Configure::write('App.webroot', 'newaffiliate');
  1140. $request = ServerRequestFactory::fromGlobals([
  1141. 'DOCUMENT_ROOT' => '/var/www/abtravaff/html',
  1142. 'PHP_SELF' => '/newaffiliate/index.php',
  1143. ]);
  1144. $this->assertSame('', $request->getAttribute('base'));
  1145. $this->assertSame('/', $request->getAttribute('webroot'));
  1146. }
  1147. /**
  1148. * Test base, webroot, URL and here parsing when there is URL rewriting but
  1149. * CakePHP gets called with index.php in URL nonetheless.
  1150. *
  1151. * Tests uri with
  1152. *
  1153. * - index.php/
  1154. * - index.php/
  1155. * - index.php/apples/
  1156. * - index.php/bananas/eat/tasty_banana
  1157. *
  1158. * @return void
  1159. */
  1160. public function testBaseUrlWithModRewriteAndIndexPhp()
  1161. {
  1162. $request = ServerRequestFactory::fromGlobals([
  1163. 'DOCUMENT_ROOT' => '/cakephp/webroot/index.php',
  1164. 'PHP_SELF' => '/cakephp/webroot/index.php',
  1165. ]);
  1166. $this->assertSame('/cakephp', $request->getAttribute('base'));
  1167. $this->assertSame('/cakephp/', $request->getAttribute('webroot'));
  1168. $this->assertSame('/', $request->getRequestTarget());
  1169. $request = ServerRequestFactory::fromGlobals([
  1170. 'REQUEST_URI' => '/cakephp/webroot/index.php/',
  1171. 'PHP_SELF' => '/cakephp/webroot/index.php/',
  1172. 'PATH_INFO' => '/',
  1173. ]);
  1174. $this->assertSame('/cakephp', $request->getAttribute('base'));
  1175. $this->assertSame('/cakephp/', $request->getAttribute('webroot'));
  1176. $this->assertSame('/', $request->getRequestTarget());
  1177. $request = ServerRequestFactory::fromGlobals([
  1178. 'REQUEST_URI' => '/cakephp/webroot/index.php/apples',
  1179. 'PHP_SELF' => '/cakephp/webroot/index.php/apples',
  1180. 'PATH_INFO' => '/apples',
  1181. ]);
  1182. $this->assertSame('/cakephp', $request->getAttribute('base'));
  1183. $this->assertSame('/cakephp/', $request->getAttribute('webroot'));
  1184. $this->assertSame('/apples', $request->getRequestTarget());
  1185. $request = ServerRequestFactory::fromGlobals([
  1186. 'REQUEST_URI' => '/cakephp/webroot/index.php/melons/share/',
  1187. 'PHP_SELF' => '/cakephp/webroot/index.php/melons/share/',
  1188. 'PATH_INFO' => '/melons/share/',
  1189. ]);
  1190. $this->assertSame('/cakephp', $request->getAttribute('base'));
  1191. $this->assertSame('/cakephp/', $request->getAttribute('webroot'));
  1192. $this->assertSame('/melons/share/', $request->getRequestTarget());
  1193. $request = ServerRequestFactory::fromGlobals([
  1194. 'REQUEST_URI' => '/cakephp/webroot/index.php/bananas/eat/tasty_banana',
  1195. 'PHP_SELF' => '/cakephp/webroot/index.php/bananas/eat/tasty_banana',
  1196. 'PATH_INFO' => '/bananas/eat/tasty_banana',
  1197. ]);
  1198. $this->assertSame('/cakephp', $request->getAttribute('base'));
  1199. $this->assertSame('/cakephp/', $request->getAttribute('webroot'));
  1200. $this->assertSame('/bananas/eat/tasty_banana', $request->getRequestTarget());
  1201. }
  1202. /**
  1203. * Test that even if mod_rewrite is on, and the url contains index.php
  1204. * and there are numerous //s that the base/webroot is calculated correctly.
  1205. *
  1206. * @return void
  1207. */
  1208. public function testBaseUrlWithModRewriteAndExtraSlashes()
  1209. {
  1210. $request = ServerRequestFactory::fromGlobals([
  1211. 'REQUEST_URI' => '/cakephp/webroot///index.php/bananas/eat',
  1212. 'PHP_SELF' => '/cakephp/webroot///index.php/bananas/eat',
  1213. 'PATH_INFO' => '/bananas/eat',
  1214. ]);
  1215. $this->assertSame('/cakephp', $request->getAttribute('base'));
  1216. $this->assertSame('/cakephp/', $request->getAttribute('webroot'));
  1217. $this->assertSame('/bananas/eat', $request->getRequestTarget());
  1218. }
  1219. /**
  1220. * Test base, webroot, and URL parsing when there is no URL rewriting
  1221. *
  1222. * @return void
  1223. */
  1224. public function testBaseUrlWithNoModRewrite()
  1225. {
  1226. Configure::write('App', [
  1227. 'dir' => APP_DIR,
  1228. 'webroot' => 'webroot',
  1229. 'base' => false,
  1230. 'baseUrl' => '/cake/index.php',
  1231. ]);
  1232. $request = ServerRequestFactory::fromGlobals([
  1233. 'DOCUMENT_ROOT' => '/Users/markstory/Sites',
  1234. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/cake/index.php',
  1235. 'PHP_SELF' => '/cake/index.php/posts/index',
  1236. 'REQUEST_URI' => '/cake/index.php/posts/index',
  1237. ]);
  1238. $this->assertSame('/cake/index.php', $request->getAttribute('base'));
  1239. $this->assertSame('/cake/webroot/', $request->getAttribute('webroot'));
  1240. $this->assertSame('/posts/index', $request->getRequestTarget());
  1241. }
  1242. /**
  1243. * Test baseUrl and webroot with baseUrl
  1244. *
  1245. * @return void
  1246. */
  1247. public function testBaseUrlAndWebrootWithBaseUrl()
  1248. {
  1249. Configure::write('App.dir', 'App');
  1250. Configure::write('App.baseUrl', '/App/webroot/index.php');
  1251. $request = ServerRequestFactory::fromGlobals();
  1252. $this->assertSame('/App/webroot/index.php', $request->getAttribute('base'));
  1253. $this->assertSame('/App/webroot/', $request->getAttribute('webroot'));
  1254. Configure::write('App.baseUrl', '/App/webroot/test.php');
  1255. $request = ServerRequestFactory::fromGlobals();
  1256. $this->assertSame('/App/webroot/test.php', $request->getAttribute('base'));
  1257. $this->assertSame('/App/webroot/', $request->getAttribute('webroot'));
  1258. Configure::write('App.baseUrl', '/App/index.php');
  1259. $request = ServerRequestFactory::fromGlobals();
  1260. $this->assertSame('/App/index.php', $request->getAttribute('base'));
  1261. $this->assertSame('/App/webroot/', $request->getAttribute('webroot'));
  1262. Configure::write('App.baseUrl', '/CakeBB/App/webroot/index.php');
  1263. $request = ServerRequestFactory::fromGlobals();
  1264. $this->assertSame('/CakeBB/App/webroot/index.php', $request->getAttribute('base'));
  1265. $this->assertSame('/CakeBB/App/webroot/', $request->getAttribute('webroot'));
  1266. Configure::write('App.baseUrl', '/CakeBB/App/index.php');
  1267. $request = ServerRequestFactory::fromGlobals();
  1268. $this->assertSame('/CakeBB/App/index.php', $request->getAttribute('base'));
  1269. $this->assertSame('/CakeBB/App/webroot/', $request->getAttribute('webroot'));
  1270. Configure::write('App.baseUrl', '/CakeBB/index.php');
  1271. $request = ServerRequestFactory::fromGlobals();
  1272. $this->assertSame('/CakeBB/index.php', $request->getAttribute('base'));
  1273. $this->assertSame('/CakeBB/webroot/', $request->getAttribute('webroot'));
  1274. Configure::write('App.baseUrl', '/dbhauser/index.php');
  1275. $request = ServerRequestFactory::fromGlobals([
  1276. 'DOCUMENT_ROOT' => '/kunden/homepages/4/d181710652/htdocs/joomla',
  1277. 'SCRIPT_FILENAME' => '/kunden/homepages/4/d181710652/htdocs/joomla/dbhauser/index.php',
  1278. ]);
  1279. $this->assertSame('/dbhauser/index.php', $request->getAttribute('base'));
  1280. $this->assertSame('/dbhauser/webroot/', $request->getAttribute('webroot'));
  1281. }
  1282. /**
  1283. * Test baseUrl with no rewrite and using the top level index.php.
  1284. *
  1285. * @return void
  1286. */
  1287. public function testBaseUrlNoRewriteTopLevelIndex()
  1288. {
  1289. Configure::write('App.baseUrl', '/index.php');
  1290. $request = ServerRequestFactory::fromGlobals([
  1291. 'DOCUMENT_ROOT' => '/Users/markstory/Sites/cake_dev',
  1292. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/cake_dev/index.php',
  1293. ]);
  1294. $this->assertSame('/index.php', $request->getAttribute('base'));
  1295. $this->assertSame('/webroot/', $request->getAttribute('webroot'));
  1296. }
  1297. /**
  1298. * Check that a sub-directory containing app|webroot doesn't get mishandled when re-writing is off.
  1299. *
  1300. * @return void
  1301. */
  1302. public function testBaseUrlWithAppAndWebrootInDirname()
  1303. {
  1304. Configure::write('App.baseUrl', '/approval/index.php');
  1305. $request = ServerRequestFactory::fromGlobals([
  1306. 'DOCUMENT_ROOT' => '/Users/markstory/Sites/',
  1307. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/approval/index.php',
  1308. ]);
  1309. $this->assertSame('/approval/index.php', $request->getAttribute('base'));
  1310. $this->assertSame('/approval/webroot/', $request->getAttribute('webroot'));
  1311. Configure::write('App.baseUrl', '/webrootable/index.php');
  1312. $request = ServerRequestFactory::fromGlobals([
  1313. 'DOCUMENT_ROOT' => '/Users/markstory/Sites/',
  1314. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/webrootable/index.php',
  1315. ]);
  1316. $this->assertSame('/webrootable/index.php', $request->getAttribute('base'));
  1317. $this->assertSame('/webrootable/webroot/', $request->getAttribute('webroot'));
  1318. }
  1319. /**
  1320. * Test baseUrl with no rewrite, and using the app/webroot/index.php file as is normal with virtual hosts.
  1321. *
  1322. * @return void
  1323. */
  1324. public function testBaseUrlNoRewriteWebrootIndex()
  1325. {
  1326. Configure::write('App.baseUrl', '/index.php');
  1327. $request = ServerRequestFactory::fromGlobals([
  1328. 'DOCUMENT_ROOT' => '/Users/markstory/Sites/cake_dev/webroot',
  1329. 'SCRIPT_FILENAME' => '/Users/markstory/Sites/cake_dev/webroot/index.php',
  1330. ]);
  1331. $this->assertSame('/index.php', $request->getAttribute('base'));
  1332. $this->assertSame('/', $request->getAttribute('webroot'));
  1333. }
  1334. /**
  1335. * Test that a request with a . in the main GET parameter is filtered out.
  1336. * PHP changes GET parameter keys containing dots to _.
  1337. *
  1338. * @return void
  1339. */
  1340. public function testGetParamsWithDot()
  1341. {
  1342. $request = ServerRequestFactory::fromGlobals([
  1343. 'PHP_SELF' => '/webroot/index.php',
  1344. 'REQUEST_URI' => '/posts/index/add.add',
  1345. ]);
  1346. $this->assertSame('', $request->getAttribute('base'));
  1347. $this->assertEquals([], $request->getQueryParams());
  1348. $request = ServerRequestFactory::fromGlobals([
  1349. 'PHP_SELF' => '/cake_dev/webroot/index.php',
  1350. 'REQUEST_URI' => '/cake_dev/posts/index/add.add',
  1351. ]);
  1352. $this->assertSame('/cake_dev', $request->getAttribute('base'));
  1353. $this->assertEquals([], $request->getQueryParams());
  1354. }
  1355. /**
  1356. * Test that a request with urlencoded bits in the main GET parameter are filtered out.
  1357. *
  1358. * @return void
  1359. */
  1360. public function testGetParamWithUrlencodedElement()
  1361. {
  1362. $config = [
  1363. 'environment' => [
  1364. 'PHP_SELF' => '/webroot/index.php',
  1365. 'REQUEST_URI' => '/posts/add/%E2%88%82%E2%88%82',
  1366. ],
  1367. ];
  1368. $request = new ServerRequest($config);
  1369. $this->assertSame('', $request->getAttribute('base'));
  1370. $this->assertEquals([], $request->getQueryParams());
  1371. $request = ServerRequestFactory::fromGlobals([
  1372. 'PHP_SELF' => '/cake_dev/webroot/index.php',
  1373. 'REQUEST_URI' => '/cake_dev/posts/add/%E2%88%82%E2%88%82',
  1374. ]);
  1375. $this->assertSame('/cake_dev', $request->getAttribute('base'));
  1376. $this->assertEquals([], $request->getQueryParams());
  1377. }
  1378. /**
  1379. * Generator for environment configurations
  1380. *
  1381. * @return array Environment array
  1382. */
  1383. public static function environmentGenerator()
  1384. {
  1385. return [
  1386. [
  1387. 'IIS - No rewrite base path',
  1388. [
  1389. 'App' => [
  1390. 'base' => false,
  1391. 'baseUrl' => '/index.php',
  1392. 'dir' => 'TestApp',
  1393. 'webroot' => 'webroot',
  1394. ],
  1395. 'SERVER' => [
  1396. 'SCRIPT_NAME' => '/index.php',
  1397. 'PATH_TRANSLATED' => 'C:\\Inetpub\\wwwroot',
  1398. 'QUERY_STRING' => '',
  1399. 'REQUEST_URI' => '/index.php',
  1400. 'URL' => '/index.php',
  1401. 'SCRIPT_FILENAME' => 'C:\\Inetpub\\wwwroot\\index.php',
  1402. 'ORIG_PATH_INFO' => '/index.php',
  1403. 'PATH_INFO' => '',
  1404. 'ORIG_PATH_TRANSLATED' => 'C:\\Inetpub\\wwwroot\\index.php',
  1405. 'DOCUMENT_ROOT' => 'C:\\Inetpub\\wwwroot',
  1406. 'PHP_SELF' => '/index.php',
  1407. ],
  1408. ],
  1409. [
  1410. 'base' => '/index.php',
  1411. 'webroot' => '/webroot/',
  1412. 'url' => '',
  1413. ],
  1414. ],
  1415. [
  1416. 'IIS - No rewrite with path, no PHP_SELF',
  1417. [
  1418. 'App' => [
  1419. 'base' => false,
  1420. 'baseUrl' => '/index.php?',
  1421. 'dir' => 'TestApp',
  1422. 'webroot' => 'webroot',
  1423. ],
  1424. 'SERVER' => [
  1425. 'QUERY_STRING' => '/posts/add',
  1426. 'REQUEST_URI' => '/index.php?/posts/add',
  1427. 'PHP_SELF' => '',
  1428. 'URL' => '/index.php?/posts/add',
  1429. 'DOCUMENT_ROOT' => 'C:\\Inetpub\\wwwroot',
  1430. 'argv' => ['/posts/add'],
  1431. 'argc' => 1,
  1432. ],
  1433. ],
  1434. [
  1435. 'url' => 'posts/add',
  1436. 'base' => '/index.php?',
  1437. 'webroot' => '/webroot/',
  1438. ],
  1439. ],
  1440. [
  1441. 'IIS - No rewrite sub dir 2',
  1442. [
  1443. 'App' => [
  1444. 'base' => false,
  1445. 'baseUrl' => '/site/index.php',
  1446. 'dir' => 'TestApp',
  1447. 'webroot' => 'webroot',
  1448. ],
  1449. 'SERVER' => [
  1450. 'SCRIPT_NAME' => '/site/index.php',
  1451. 'PATH_TRANSLATED' => 'C:\\Inetpub\\wwwroot',
  1452. 'QUERY_STRING' => '',
  1453. 'REQUEST_URI' => '/site/index.php',
  1454. 'URL' => '/site/index.php',
  1455. 'SCRIPT_FILENAME' => 'C:\\Inetpub\\wwwroot\\site\\index.php',
  1456. 'DOCUMENT_ROOT' => 'C:\\Inetpub\\wwwroot',
  1457. 'PHP_SELF' => '/site/index.php',
  1458. 'argv' => [],
  1459. 'argc' => 0,
  1460. ],
  1461. ],
  1462. [
  1463. 'url' => '',
  1464. 'base' => '/site/index.php',
  1465. 'webroot' => '/site/webroot/',
  1466. ],
  1467. ],
  1468. [
  1469. 'IIS - No rewrite sub dir 2 with path',
  1470. [
  1471. 'App' => [
  1472. 'base' => false,
  1473. 'baseUrl' => '/site/index.php',
  1474. 'dir' => 'TestApp',
  1475. 'webroot' => 'webroot',
  1476. ],
  1477. 'SERVER' => [
  1478. 'SCRIPT_NAME' => '/site/index.php',
  1479. 'PATH_TRANSLATED' => 'C:\\Inetpub\\wwwroot',
  1480. 'QUERY_STRING' => '/posts/add',
  1481. 'REQUEST_URI' => '/site/index.php/posts/add',
  1482. 'URL' => '/site/index.php/posts/add',
  1483. 'ORIG_PATH_TRANSLATED' => 'C:\\Inetpub\\wwwroot\\site\\index.php',
  1484. 'DOCUMENT_ROOT' => 'C:\\Inetpub\\wwwroot',
  1485. 'PHP_SELF' => '/site/index.php/posts/add',
  1486. 'argv' => ['/posts/add'],
  1487. 'argc' => 1,
  1488. ],
  1489. ],
  1490. [
  1491. 'url' => 'posts/add',
  1492. 'base' => '/site/index.php',
  1493. 'webroot' => '/site/webroot/',
  1494. ],
  1495. ],
  1496. [
  1497. 'Apache - No rewrite, document root set to webroot, requesting path',
  1498. [
  1499. 'App' => [
  1500. 'base' => false,
  1501. 'baseUrl' => '/index.php',
  1502. 'dir' => 'TestApp',
  1503. 'webroot' => 'webroot',
  1504. ],
  1505. 'SERVER' => [
  1506. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents/site/App/webroot',
  1507. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/App/webroot/index.php',
  1508. 'QUERY_STRING' => '',
  1509. 'REQUEST_URI' => '/index.php/posts/index',
  1510. 'SCRIPT_NAME' => '/index.php',
  1511. 'PATH_INFO' => '/posts/index',
  1512. 'PHP_SELF' => '/index.php/posts/index',
  1513. ],
  1514. ],
  1515. [
  1516. 'url' => 'posts/index',
  1517. 'base' => '/index.php',
  1518. 'webroot' => '/',
  1519. ],
  1520. ],
  1521. [
  1522. 'Apache - No rewrite, document root set to webroot, requesting root',
  1523. [
  1524. 'App' => [
  1525. 'base' => false,
  1526. 'baseUrl' => '/index.php',
  1527. 'dir' => 'TestApp',
  1528. 'webroot' => 'webroot',
  1529. ],
  1530. 'SERVER' => [
  1531. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents/site/App/webroot',
  1532. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/App/webroot/index.php',
  1533. 'QUERY_STRING' => '',
  1534. 'REQUEST_URI' => '/index.php',
  1535. 'SCRIPT_NAME' => '/index.php',
  1536. 'PATH_INFO' => '',
  1537. 'PHP_SELF' => '/index.php',
  1538. ],
  1539. ],
  1540. [
  1541. 'url' => '',
  1542. 'base' => '/index.php',
  1543. 'webroot' => '/',
  1544. ],
  1545. ],
  1546. [
  1547. 'Apache - No rewrite, document root set above top level cake dir, requesting path',
  1548. [
  1549. 'App' => [
  1550. 'base' => false,
  1551. 'baseUrl' => '/site/index.php',
  1552. 'dir' => 'TestApp',
  1553. 'webroot' => 'webroot',
  1554. ],
  1555. 'SERVER' => [
  1556. 'SERVER_NAME' => 'localhost',
  1557. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1558. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/index.php',
  1559. 'REQUEST_URI' => '/site/index.php/posts/index',
  1560. 'SCRIPT_NAME' => '/site/index.php',
  1561. 'PATH_INFO' => '/posts/index',
  1562. 'PHP_SELF' => '/site/index.php/posts/index',
  1563. ],
  1564. ],
  1565. [
  1566. 'url' => 'posts/index',
  1567. 'base' => '/site/index.php',
  1568. 'webroot' => '/site/webroot/',
  1569. ],
  1570. ],
  1571. [
  1572. 'Apache - No rewrite, document root set above top level cake dir, request root, no PATH_INFO',
  1573. [
  1574. 'App' => [
  1575. 'base' => false,
  1576. 'baseUrl' => '/site/index.php',
  1577. 'dir' => 'TestApp',
  1578. 'webroot' => 'webroot',
  1579. ],
  1580. 'SERVER' => [
  1581. 'SERVER_NAME' => 'localhost',
  1582. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1583. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/index.php',
  1584. 'REQUEST_URI' => '/site/index.php/',
  1585. 'SCRIPT_NAME' => '/site/index.php',
  1586. 'PHP_SELF' => '/site/index.php/',
  1587. ],
  1588. ],
  1589. [
  1590. 'url' => '',
  1591. 'base' => '/site/index.php',
  1592. 'webroot' => '/site/webroot/',
  1593. ],
  1594. ],
  1595. [
  1596. 'Apache - No rewrite, document root set above top level cake dir, request path, with GET',
  1597. [
  1598. 'App' => [
  1599. 'base' => false,
  1600. 'baseUrl' => '/site/index.php',
  1601. 'dir' => 'TestApp',
  1602. 'webroot' => 'webroot',
  1603. ],
  1604. 'GET' => ['a' => 'b', 'c' => 'd'],
  1605. 'SERVER' => [
  1606. 'SERVER_NAME' => 'localhost',
  1607. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1608. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/index.php',
  1609. 'REQUEST_URI' => '/site/index.php/posts/index?a=b&c=d',
  1610. 'SCRIPT_NAME' => '/site/index.php',
  1611. 'PATH_INFO' => '/posts/index',
  1612. 'PHP_SELF' => '/site/index.php/posts/index',
  1613. 'QUERY_STRING' => 'a=b&c=d',
  1614. ],
  1615. ],
  1616. [
  1617. 'urlParams' => ['a' => 'b', 'c' => 'd'],
  1618. 'url' => 'posts/index',
  1619. 'base' => '/site/index.php',
  1620. 'webroot' => '/site/webroot/',
  1621. ],
  1622. ],
  1623. [
  1624. 'Apache - w/rewrite, document root set above top level cake dir, request root, no PATH_INFO',
  1625. [
  1626. 'App' => [
  1627. 'base' => false,
  1628. 'baseUrl' => false,
  1629. 'dir' => 'TestApp',
  1630. 'webroot' => 'webroot',
  1631. ],
  1632. 'SERVER' => [
  1633. 'SERVER_NAME' => 'localhost',
  1634. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1635. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/index.php',
  1636. 'REQUEST_URI' => '/site/',
  1637. 'SCRIPT_NAME' => '/site/webroot/index.php',
  1638. 'PHP_SELF' => '/site/webroot/index.php',
  1639. ],
  1640. ],
  1641. [
  1642. 'url' => '',
  1643. 'base' => '/site',
  1644. 'webroot' => '/site/',
  1645. ],
  1646. ],
  1647. [
  1648. 'Apache - w/rewrite, document root above top level cake dir, request root, no PATH_INFO/REQUEST_URI',
  1649. [
  1650. 'App' => [
  1651. 'base' => false,
  1652. 'baseUrl' => false,
  1653. 'dir' => 'TestApp',
  1654. 'webroot' => 'webroot',
  1655. ],
  1656. 'SERVER' => [
  1657. 'SERVER_NAME' => 'localhost',
  1658. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1659. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/index.php',
  1660. 'SCRIPT_NAME' => '/site/webroot/index.php',
  1661. 'PHP_SELF' => '/site/webroot/index.php',
  1662. 'PATH_INFO' => null,
  1663. 'REQUEST_URI' => null,
  1664. ],
  1665. ],
  1666. [
  1667. 'url' => '',
  1668. 'base' => '/site',
  1669. 'webroot' => '/site/',
  1670. ],
  1671. ],
  1672. [
  1673. 'Apache - w/rewrite, document root set to webroot, request root, no PATH_INFO/REQUEST_URI',
  1674. [
  1675. 'App' => [
  1676. 'base' => false,
  1677. 'baseUrl' => false,
  1678. 'dir' => 'TestApp',
  1679. 'webroot' => 'webroot',
  1680. ],
  1681. 'SERVER' => [
  1682. 'SERVER_NAME' => 'localhost',
  1683. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents/site/webroot',
  1684. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/webroot/index.php',
  1685. 'SCRIPT_NAME' => '/index.php',
  1686. 'PHP_SELF' => '/index.php',
  1687. 'PATH_INFO' => null,
  1688. 'REQUEST_URI' => null,
  1689. ],
  1690. ],
  1691. [
  1692. 'url' => '',
  1693. 'base' => '',
  1694. 'webroot' => '/',
  1695. ],
  1696. ],
  1697. [
  1698. 'Apache - w/rewrite, document root set above top level cake dir, request root, absolute REQUEST_URI',
  1699. [
  1700. 'App' => [
  1701. 'base' => false,
  1702. 'baseUrl' => false,
  1703. 'dir' => 'TestApp',
  1704. 'webroot' => 'webroot',
  1705. ],
  1706. 'SERVER' => [
  1707. 'SERVER_NAME' => 'localhost',
  1708. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1709. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/index.php',
  1710. 'REQUEST_URI' => '/site/posts/index',
  1711. 'SCRIPT_NAME' => '/site/webroot/index.php',
  1712. 'PHP_SELF' => '/site/webroot/index.php',
  1713. ],
  1714. ],
  1715. [
  1716. 'url' => 'posts/index',
  1717. 'base' => '/site',
  1718. 'webroot' => '/site/',
  1719. ],
  1720. ],
  1721. [
  1722. 'Nginx - w/rewrite, document root set to webroot, request root, no PATH_INFO',
  1723. [
  1724. 'App' => [
  1725. 'base' => false,
  1726. 'baseUrl' => false,
  1727. 'dir' => 'TestApp',
  1728. 'webroot' => 'webroot',
  1729. ],
  1730. 'SERVER' => [
  1731. 'SERVER_NAME' => 'localhost',
  1732. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents/site/webroot',
  1733. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/webroot/index.php',
  1734. 'SCRIPT_NAME' => '/index.php',
  1735. 'PHP_SELF' => '/index.php',
  1736. 'PATH_INFO' => null,
  1737. 'REQUEST_URI' => '/posts/add',
  1738. ],
  1739. ],
  1740. [
  1741. 'url' => 'posts/add',
  1742. 'base' => '',
  1743. 'webroot' => '/',
  1744. 'urlParams' => [],
  1745. ],
  1746. ],
  1747. [
  1748. 'Nginx - w/rewrite, document root set above top level cake dir, request root, no PATH_INFO, base parameter set',
  1749. [
  1750. 'App' => [
  1751. 'base' => false,
  1752. 'baseUrl' => false,
  1753. 'dir' => 'app',
  1754. 'webroot' => 'webroot',
  1755. ],
  1756. 'SERVER' => [
  1757. 'SERVER_NAME' => 'localhost',
  1758. 'DOCUMENT_ROOT' => '/Library/WebServer/Documents',
  1759. 'SCRIPT_FILENAME' => '/Library/WebServer/Documents/site/App/webroot/index.php',
  1760. 'SCRIPT_NAME' => '/site/app/webroot/index.php',
  1761. 'PHP_SELF' => '/site/webroot/index.php',
  1762. 'PATH_INFO' => null,
  1763. 'REQUEST_URI' => '/site/posts/add',
  1764. ],
  1765. ],
  1766. [
  1767. 'url' => 'posts/add',
  1768. 'base' => '/site',
  1769. 'webroot' => '/site/',
  1770. 'urlParams' => [],
  1771. ],
  1772. ],
  1773. ];
  1774. }
  1775. /**
  1776. * Test environment detection
  1777. *
  1778. * @dataProvider environmentGenerator
  1779. * @param $name
  1780. * @param $data
  1781. * @param $expected
  1782. * @return void
  1783. */
  1784. public function testEnvironmentDetection($name, $data, $expected)
  1785. {
  1786. if (isset($data['App'])) {
  1787. Configure::write('App', $data['App']);
  1788. }
  1789. $request = ServerRequestFactory::fromGlobals(
  1790. $data['SERVER'] ?? null,
  1791. $data['GET'] ?? null
  1792. );
  1793. $uri = $request->getUri();
  1794. $this->assertSame('/' . $expected['url'], $uri->getPath(), 'Uri->getPath() is incorrect');
  1795. $this->assertEquals($expected['base'], $request->getAttribute('base'), 'base is incorrect');
  1796. $this->assertEquals($expected['webroot'], $request->getAttribute('webroot'), 'webroot is incorrect');
  1797. if (isset($expected['urlParams'])) {
  1798. $this->assertEquals($expected['urlParams'], $request->getQueryParams(), 'GET param mismatch');
  1799. }
  1800. }
  1801. /**
  1802. * Test the getQuery() method
  1803. *
  1804. * @return void
  1805. */
  1806. public function testGetQuery()
  1807. {
  1808. $array = [
  1809. 'query' => [
  1810. 'foo' => 'bar',
  1811. 'zero' => '0',
  1812. 'test' => [
  1813. 'foo', 'bar',
  1814. ],
  1815. ],
  1816. ];
  1817. $request = new ServerRequest($array);
  1818. $this->assertEquals([
  1819. 'foo' => 'bar',
  1820. 'zero' => '0',
  1821. 'test' => [
  1822. 'foo', 'bar',
  1823. ],
  1824. ], $request->getQuery());
  1825. $this->assertSame('bar', $request->getQuery('foo'));
  1826. $this->assertSame('0', $request->getQuery('zero'));
  1827. $this->assertNull($request->getQuery('imaginary'));
  1828. $this->assertSame('default', $request->getQuery('imaginary', 'default'));
  1829. $this->assertFalse($request->getQuery('imaginary', false));
  1830. $this->assertSame(['foo', 'bar'], $request->getQuery('test'));
  1831. $this->assertSame('bar', $request->getQuery('test.1'));
  1832. $this->assertNull($request->getQuery('test.2'));
  1833. $this->assertSame('default', $request->getQuery('test.2', 'default'));
  1834. }
  1835. /**
  1836. * Test getQueryParams
  1837. *
  1838. * @return void
  1839. */
  1840. public function testGetQueryParams()
  1841. {
  1842. $get = [
  1843. 'test' => ['foo', 'bar'],
  1844. 'key' => 'value',
  1845. ];
  1846. $request = new ServerRequest([
  1847. 'query' => $get,
  1848. ]);
  1849. $this->assertSame($get, $request->getQueryParams());
  1850. }
  1851. /**
  1852. * Test withQueryParams and immutability
  1853. *
  1854. * @return void
  1855. */
  1856. public function testWithQueryParams()
  1857. {
  1858. $get = [
  1859. 'test' => ['foo', 'bar'],
  1860. 'key' => 'value',
  1861. ];
  1862. $request = new ServerRequest([
  1863. 'query' => $get,
  1864. ]);
  1865. $new = $request->withQueryParams(['new' => 'data']);
  1866. $this->assertSame($get, $request->getQueryParams());
  1867. $this->assertSame(['new' => 'data'], $new->getQueryParams());
  1868. }
  1869. /**
  1870. * Test using param()
  1871. *
  1872. * @return void
  1873. */
  1874. public function testReadingParams()
  1875. {
  1876. $request = new ServerRequest([
  1877. 'params' => [
  1878. 'controller' => 'posts',
  1879. 'admin' => true,
  1880. 'truthy' => 1,
  1881. 'zero' => '0',
  1882. ],
  1883. ]);
  1884. $this->assertNull($request->getParam('not_set'));
  1885. $this->assertTrue($request->getParam('admin'));
  1886. $this->assertSame(1, $request->getParam('truthy'));
  1887. $this->assertSame('posts', $request->getParam('controller'));
  1888. $this->assertSame('0', $request->getParam('zero'));
  1889. }
  1890. /**
  1891. * Test the data() method reading
  1892. *
  1893. * @return void
  1894. */
  1895. public function testGetData()
  1896. {
  1897. $post = [
  1898. 'Model' => [
  1899. 'field' => 'value',
  1900. ],
  1901. ];
  1902. $request = new ServerRequest(compact('post'));
  1903. $this->assertEquals($post['Model'], $request->getData('Model'));
  1904. $this->assertEquals($post, $request->getData());
  1905. $this->assertNull($request->getData('Model.imaginary'));
  1906. $this->assertSame('value', $request->getData('Model.field', 'default'));
  1907. $this->assertSame('default', $request->getData('Model.imaginary', 'default'));
  1908. }
  1909. /**
  1910. * Test that getData() doesn't fail on scalar data.
  1911. *
  1912. * @return void
  1913. */
  1914. public function testGetDataOnStringData()
  1915. {
  1916. $post = 'strange, but could happen';
  1917. $request = new ServerRequest(compact('post'));
  1918. $this->assertNull($request->getData('Model'));
  1919. $this->assertNull($request->getData('Model.field'));
  1920. }
  1921. /**
  1922. * Test writing falsey values.
  1923. *
  1924. * @return void
  1925. */
  1926. public function testDataWritingFalsey()
  1927. {
  1928. $request = new ServerRequest();
  1929. $request = $request->withData('Post.null', null);
  1930. $this->assertNull($request->getData('Post.null'));
  1931. $request = $request->withData('Post.false', false);
  1932. $this->assertFalse($request->getData('Post.false'));
  1933. $request = $request->withData('Post.zero', 0);
  1934. $this->assertSame(0, $request->getData('Post.zero'));
  1935. $request = $request->withData('Post.empty', '');
  1936. $this->assertSame('', $request->getData('Post.empty'));
  1937. }
  1938. /**
  1939. * Test reading params
  1940. *
  1941. * @dataProvider paramReadingDataProvider
  1942. */
  1943. public function testGetParam($toRead, $expected)
  1944. {
  1945. $request = new ServerRequest([
  1946. 'url' => '/',
  1947. 'params' => [
  1948. 'action' => 'index',
  1949. 'foo' => 'bar',
  1950. 'baz' => [
  1951. 'a' => [
  1952. 'b' => 'c',
  1953. ],
  1954. ],
  1955. 'admin' => true,
  1956. 'truthy' => 1,
  1957. 'zero' => '0',
  1958. ],
  1959. ]);
  1960. $this->assertSame($expected, $request->getParam($toRead));
  1961. }
  1962. /**
  1963. * Test getParam returning a default value.
  1964. *
  1965. * @return void
  1966. */
  1967. public function testGetParamDefault()
  1968. {
  1969. $request = new ServerRequest([
  1970. 'params' => [
  1971. 'controller' => 'Articles',
  1972. 'null' => null,
  1973. ],
  1974. ]);
  1975. $this->assertSame('Articles', $request->getParam('controller', 'default'));
  1976. $this->assertSame('default', $request->getParam('null', 'default'));
  1977. $this->assertFalse($request->getParam('unset', false));
  1978. $this->assertNull($request->getParam('unset'));
  1979. }
  1980. /**
  1981. * Data provider for testing reading values with ServerRequestFactory::param()
  1982. *
  1983. * @return array
  1984. */
  1985. public function paramReadingDataProvider()
  1986. {
  1987. return [
  1988. [
  1989. 'action',
  1990. 'index',
  1991. ],
  1992. [
  1993. 'baz',
  1994. [
  1995. 'a' => [
  1996. 'b' => 'c',
  1997. ],
  1998. ],
  1999. ],
  2000. [
  2001. 'baz.a.b',
  2002. 'c',
  2003. ],
  2004. [
  2005. 'does_not_exist',
  2006. null,
  2007. ],
  2008. [
  2009. 'admin',
  2010. true,
  2011. ],
  2012. [
  2013. 'truthy',
  2014. 1,
  2015. ],
  2016. [
  2017. 'zero',
  2018. '0',
  2019. ],
  2020. ];
  2021. }
  2022. /**
  2023. * test writing request params with param()
  2024. *
  2025. * @return void
  2026. */
  2027. public function testParamWriting()
  2028. {
  2029. $request = new ServerRequest(['url' => '/']);
  2030. $request = $request->withParam('action', 'index');
  2031. $this->assertInstanceOf(
  2032. 'Cake\Http\ServerRequest',
  2033. $request->withParam('some', 'thing'),
  2034. 'Method has not returned $this'
  2035. );
  2036. $request = $request->withParam('Post.null', null);
  2037. $this->assertNull($request->getParam('Post.null'), 'default value should be used.');
  2038. $request = $request->withParam('Post.false', false);
  2039. $this->assertFalse($request->getParam('Post.false'));
  2040. $request = $request->withParam('Post.zero', 0);
  2041. $this->assertSame(0, $request->getParam('Post.zero'));
  2042. $request = $request->withParam('Post.empty', '');
  2043. $this->assertSame('', $request->getParam('Post.empty'));
  2044. $this->assertSame('index', $request->getParam('action'));
  2045. $request = $request->withParam('action', 'edit');
  2046. $this->assertSame('edit', $request->getParam('action'));
  2047. }
  2048. /**
  2049. * Test accept language
  2050. *
  2051. * @return void
  2052. */
  2053. public function testAcceptLanguage()
  2054. {
  2055. $request = new ServerRequest();
  2056. // Weird language
  2057. $request = $request->withEnv('HTTP_ACCEPT_LANGUAGE', 'inexistent,en-ca');
  2058. $result = $request->acceptLanguage();
  2059. $this->assertEquals(['inexistent', 'en-ca'], $result, 'Languages do not match');
  2060. // No qualifier
  2061. $request = $request->withEnv('HTTP_ACCEPT_LANGUAGE', 'es_mx,en_ca');
  2062. $result = $request->acceptLanguage();
  2063. $this->assertEquals(['es-mx', 'en-ca'], $result, 'Languages do not match');
  2064. // With qualifier
  2065. $request = $request->withEnv('HTTP_ACCEPT_LANGUAGE', 'en-US,en;q=0.8,pt-BR;q=0.6,pt;q=0.4');
  2066. $result = $request->acceptLanguage();
  2067. $this->assertEquals(['en-us', 'en', 'pt-br', 'pt'], $result, 'Languages do not match');
  2068. // With spaces
  2069. $request = $request->withEnv('HTTP_ACCEPT_LANGUAGE', 'da, en-gb;q=0.8, en;q=0.7');
  2070. $result = $request->acceptLanguage();
  2071. $this->assertEquals(['da', 'en-gb', 'en'], $result, 'Languages do not match');
  2072. // Checking if requested
  2073. $request = $request->withEnv('HTTP_ACCEPT_LANGUAGE', 'es_mx,en_ca');
  2074. $result = $request->acceptLanguage('en-ca');
  2075. $this->assertTrue($result);
  2076. $result = $request->acceptLanguage('en-CA');
  2077. $this->assertTrue($result);
  2078. $result = $request->acceptLanguage('en-us');
  2079. $this->assertFalse($result);
  2080. $result = $request->acceptLanguage('en-US');
  2081. $this->assertFalse($result);
  2082. }
  2083. /**
  2084. * Test the input() method.
  2085. *
  2086. * @return void
  2087. */
  2088. public function testInput()
  2089. {
  2090. $request = new ServerRequest([
  2091. 'input' => 'I came from stdin',
  2092. ]);
  2093. $result = $request->input();
  2094. $this->assertSame('I came from stdin', $result);
  2095. }
  2096. /**
  2097. * Test input() decoding.
  2098. *
  2099. * @return void
  2100. */
  2101. public function testInputDecode()
  2102. {
  2103. $request = new ServerRequest([
  2104. 'input' => '{"name":"value"}',
  2105. ]);
  2106. $result = $request->input('json_decode');
  2107. $this->assertEquals(['name' => 'value'], (array)$result);
  2108. }
  2109. /**
  2110. * Test input() decoding with additional arguments.
  2111. *
  2112. * @return void
  2113. */
  2114. public function testInputDecodeExtraParams()
  2115. {
  2116. $xml = <<<XML
  2117. <?xml version="1.0" encoding="utf-8"?>
  2118. <post>
  2119. <title id="title">Test</title>
  2120. </post>
  2121. XML;
  2122. $request = new ServerRequest([
  2123. 'input' => $xml,
  2124. ]);
  2125. $result = $request->input('Cake\Utility\Xml::build', ['return' => 'domdocument']);
  2126. $this->assertInstanceOf('DOMDocument', $result);
  2127. $this->assertEquals(
  2128. 'Test',
  2129. $result->getElementsByTagName('title')->item(0)->childNodes->item(0)->wholeText
  2130. );
  2131. }
  2132. /**
  2133. * Test getBody
  2134. *
  2135. * @return void
  2136. */
  2137. public function testGetBody()
  2138. {
  2139. $request = new ServerRequest([
  2140. 'input' => 'key=val&some=data',
  2141. ]);
  2142. $result = $request->getBody();
  2143. $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $result);
  2144. $this->assertSame('key=val&some=data', $result->getContents());
  2145. }
  2146. /**
  2147. * Test withBody
  2148. *
  2149. * @return void
  2150. */
  2151. public function testWithBody()
  2152. {
  2153. $request = new ServerRequest([
  2154. 'input' => 'key=val&some=data',
  2155. ]);
  2156. $body = $this->getMockBuilder('Psr\Http\Message\StreamInterface')->getMock();
  2157. $new = $request->withBody($body);
  2158. $this->assertNotSame($new, $request);
  2159. $this->assertNotSame($body, $request->getBody());
  2160. $this->assertSame($body, $new->getBody());
  2161. }
  2162. /**
  2163. * Test getUri
  2164. *
  2165. * @return void
  2166. */
  2167. public function testGetUri()
  2168. {
  2169. $request = new ServerRequest(['url' => 'articles/view/3']);
  2170. $result = $request->getUri();
  2171. $this->assertInstanceOf('Psr\Http\Message\UriInterface', $result);
  2172. $this->assertSame('/articles/view/3', $result->getPath());
  2173. }
  2174. /**
  2175. * Test withUri
  2176. *
  2177. * @return void
  2178. */
  2179. public function testWithUri()
  2180. {
  2181. $request = new ServerRequest([
  2182. 'environment' => [
  2183. 'HTTP_HOST' => 'example.com',
  2184. ],
  2185. 'url' => 'articles/view/3',
  2186. ]);
  2187. $uri = $this->getMockBuilder('Psr\Http\Message\UriInterface')->getMock();
  2188. $new = $request->withUri($uri);
  2189. $this->assertNotSame($new, $request);
  2190. $this->assertNotSame($uri, $request->getUri());
  2191. $this->assertSame($uri, $new->getUri());
  2192. }
  2193. /**
  2194. * Test withUri() and preserveHost
  2195. *
  2196. * @return void
  2197. */
  2198. public function testWithUriPreserveHost()
  2199. {
  2200. $request = new ServerRequest([
  2201. 'environment' => [
  2202. 'HTTP_HOST' => 'localhost',
  2203. ],
  2204. 'url' => 'articles/view/3',
  2205. ]);
  2206. $uri = new Uri();
  2207. $uri = $uri->withHost('example.com')
  2208. ->withPort(123)
  2209. ->withPath('articles/view/3');
  2210. $new = $request->withUri($uri, false);
  2211. $this->assertNotSame($new, $request);
  2212. $this->assertSame('example.com:123', $new->getHeaderLine('Host'));
  2213. }
  2214. /**
  2215. * Test withUri() and preserveHost missing the host header
  2216. *
  2217. * @return void
  2218. */
  2219. public function testWithUriPreserveHostNoHostHeader()
  2220. {
  2221. $request = new ServerRequest([
  2222. 'url' => 'articles/view/3',
  2223. ]);
  2224. $uri = new Uri();
  2225. $uri = $uri->withHost('example.com')
  2226. ->withPort(123)
  2227. ->withPath('articles/view/3');
  2228. $new = $request->withUri($uri, false);
  2229. $this->assertSame('example.com:123', $new->getHeaderLine('Host'));
  2230. }
  2231. /**
  2232. * Test the cookie() method.
  2233. *
  2234. * @return void
  2235. */
  2236. public function testGetCookie()
  2237. {
  2238. $request = new ServerRequest([
  2239. 'cookies' => [
  2240. 'testing' => 'A value in the cookie',
  2241. 'user' => [
  2242. 'remember' => '1',
  2243. ],
  2244. ],
  2245. ]);
  2246. $this->assertSame('A value in the cookie', $request->getCookie('testing'));
  2247. $this->assertNull($request->getCookie('not there'));
  2248. $this->assertSame('default', $request->getCookie('not there', 'default'));
  2249. $this->assertSame('1', $request->getCookie('user.remember'));
  2250. $this->assertSame('1', $request->getCookie('user.remember', 'default'));
  2251. $this->assertSame('default', $request->getCookie('user.not there', 'default'));
  2252. }
  2253. /**
  2254. * Test getCookieParams()
  2255. *
  2256. * @return void
  2257. */
  2258. public function testGetCookieParams()
  2259. {
  2260. $cookies = [
  2261. 'testing' => 'A value in the cookie',
  2262. ];
  2263. $request = new ServerRequest(['cookies' => $cookies]);
  2264. $this->assertSame($cookies, $request->getCookieParams());
  2265. }
  2266. /**
  2267. * Test withCookieParams()
  2268. *
  2269. * @return void
  2270. */
  2271. public function testWithCookieParams()
  2272. {
  2273. $cookies = [
  2274. 'testing' => 'A value in the cookie',
  2275. ];
  2276. $request = new ServerRequest(['cookies' => $cookies]);
  2277. $new = $request->withCookieParams(['remember_me' => 1]);
  2278. $this->assertNotSame($new, $request);
  2279. $this->assertSame($cookies, $request->getCookieParams());
  2280. $this->assertSame(['remember_me' => 1], $new->getCookieParams());
  2281. }
  2282. /**
  2283. * Test getting a cookie collection from a request.
  2284. *
  2285. * @return void
  2286. */
  2287. public function testGetCookieCollection()
  2288. {
  2289. $cookies = [
  2290. 'remember_me' => '1',
  2291. 'color' => 'blue',
  2292. ];
  2293. $request = new ServerRequest(['cookies' => $cookies]);
  2294. $cookies = $request->getCookieCollection();
  2295. $this->assertInstanceOf(CookieCollection::class, $cookies);
  2296. $this->assertCount(2, $cookies);
  2297. $this->assertSame('1', $cookies->get('remember_me')->getValue());
  2298. $this->assertSame('blue', $cookies->get('color')->getValue());
  2299. }
  2300. /**
  2301. * Test replacing cookies from a collection
  2302. *
  2303. * @return void
  2304. */
  2305. public function testWithCookieCollection()
  2306. {
  2307. $cookies = new CookieCollection([new Cookie('remember_me', 1), new Cookie('color', 'red')]);
  2308. $request = new ServerRequest(['cookies' => ['bad' => 'goaway']]);
  2309. $new = $request->withCookieCollection($cookies);
  2310. $this->assertNotSame($new, $request, 'Should clone');
  2311. $this->assertSame(['bad' => 'goaway'], $request->getCookieParams());
  2312. $this->assertSame(['remember_me' => 1, 'color' => 'red'], $new->getCookieParams());
  2313. $cookies = $new->getCookieCollection();
  2314. $this->assertCount(2, $cookies);
  2315. $this->assertSame('red', $cookies->get('color')->getValue());
  2316. }
  2317. /**
  2318. * TestAllowMethod
  2319. *
  2320. * @return void
  2321. */
  2322. public function testAllowMethod()
  2323. {
  2324. $request = new ServerRequest(['environment' => [
  2325. 'url' => '/posts/edit/1',
  2326. 'REQUEST_METHOD' => 'PUT',
  2327. ]]);
  2328. $this->assertTrue($request->allowMethod('put'));
  2329. $request = $request->withEnv('REQUEST_METHOD', 'DELETE');
  2330. $this->assertTrue($request->allowMethod(['post', 'delete']));
  2331. }
  2332. /**
  2333. * Test allowMethod throwing exception
  2334. *
  2335. * @return void
  2336. */
  2337. public function testAllowMethodException()
  2338. {
  2339. $request = new ServerRequest([
  2340. 'url' => '/posts/edit/1',
  2341. 'environment' => ['REQUEST_METHOD' => 'PUT'],
  2342. ]);
  2343. try {
  2344. $request->allowMethod(['POST', 'DELETE']);
  2345. $this->fail('An expected exception has not been raised.');
  2346. } catch (MethodNotAllowedException $e) {
  2347. $this->assertEquals(['Allow' => 'POST, DELETE'], $e->responseHeader());
  2348. }
  2349. $this->expectException(MethodNotAllowedException::class);
  2350. $request->allowMethod('POST');
  2351. }
  2352. /**
  2353. * Tests getting the session from the request
  2354. *
  2355. * @return void
  2356. */
  2357. public function testGetSession()
  2358. {
  2359. $session = new Session();
  2360. $request = new ServerRequest(['session' => $session]);
  2361. $this->assertSame($session, $request->getSession());
  2362. $request = ServerRequestFactory::fromGlobals();
  2363. $this->assertEquals($session, $request->getSession());
  2364. }
  2365. /**
  2366. * Test the content type method.
  2367. *
  2368. * @return void
  2369. */
  2370. public function testContentType()
  2371. {
  2372. $request = new ServerRequest([
  2373. 'environment' => ['HTTP_CONTENT_TYPE' => 'application/json'],
  2374. ]);
  2375. $this->assertSame('application/json', $request->contentType());
  2376. $request = new ServerRequest([
  2377. 'environment' => ['HTTP_CONTENT_TYPE' => 'application/xml'],
  2378. ]);
  2379. $this->assertSame('application/xml', $request->contentType(), 'prefer non http header.');
  2380. }
  2381. /**
  2382. * Test updating params in a psr7 fashion.
  2383. *
  2384. * @return void
  2385. */
  2386. public function testWithParam()
  2387. {
  2388. $request = new ServerRequest([
  2389. 'params' => ['controller' => 'Articles'],
  2390. ]);
  2391. $result = $request->withParam('action', 'view');
  2392. $this->assertNotSame($result, $request, 'New instance should be made');
  2393. $this->assertNull($request->getParam('action'), 'No side-effect on original');
  2394. $this->assertSame('view', $result->getParam('action'));
  2395. $result = $request->withParam('action', 'index')
  2396. ->withParam('plugin', 'DebugKit')
  2397. ->withParam('prefix', 'Admin');
  2398. $this->assertNotSame($result, $request, 'New instance should be made');
  2399. $this->assertNull($request->getParam('action'), 'No side-effect on original');
  2400. $this->assertSame('index', $result->getParam('action'));
  2401. $this->assertSame('DebugKit', $result->getParam('plugin'));
  2402. $this->assertSame('Admin', $result->getParam('prefix'));
  2403. }
  2404. /**
  2405. * Test getting the parsed body parameters.
  2406. *
  2407. * @return void
  2408. */
  2409. public function testGetParsedBody()
  2410. {
  2411. $data = ['title' => 'First', 'body' => 'Best Article!'];
  2412. $request = new ServerRequest(['post' => $data]);
  2413. $this->assertSame($data, $request->getParsedBody());
  2414. $request = new ServerRequest();
  2415. $this->assertSame([], $request->getParsedBody());
  2416. }
  2417. /**
  2418. * Test replacing the parsed body parameters.
  2419. *
  2420. * @return void
  2421. */
  2422. public function testWithParsedBody()
  2423. {
  2424. $data = ['title' => 'First', 'body' => 'Best Article!'];
  2425. $request = new ServerRequest([]);
  2426. $new = $request->withParsedBody($data);
  2427. $this->assertNotSame($request, $new);
  2428. $this->assertSame([], $request->getParsedBody());
  2429. $this->assertSame($data, $new->getParsedBody());
  2430. }
  2431. /**
  2432. * Test updating POST data in a psr7 fashion.
  2433. *
  2434. * @return void
  2435. */
  2436. public function testWithData()
  2437. {
  2438. $request = new ServerRequest([
  2439. 'post' => [
  2440. 'Model' => [
  2441. 'field' => 'value',
  2442. ],
  2443. ],
  2444. ]);
  2445. $result = $request->withData('Model.new_value', 'new value');
  2446. $this->assertNull($request->getData('Model.new_value'), 'Original request should not change.');
  2447. $this->assertNotSame($result, $request);
  2448. $this->assertSame('new value', $result->getData('Model.new_value'));
  2449. $this->assertSame('new value', $result->getData()['Model']['new_value']);
  2450. $this->assertSame('value', $result->getData('Model.field'));
  2451. }
  2452. /**
  2453. * Test removing data from a request
  2454. *
  2455. * @return void
  2456. */
  2457. public function testWithoutData()
  2458. {
  2459. $request = new ServerRequest([
  2460. 'post' => [
  2461. 'Model' => [
  2462. 'id' => 1,
  2463. 'field' => 'value',
  2464. ],
  2465. ],
  2466. ]);
  2467. $updated = $request->withoutData('Model.field');
  2468. $this->assertNotSame($updated, $request);
  2469. $this->assertSame('value', $request->getData('Model.field'), 'Original request should not change.');
  2470. $this->assertNull($updated->getData('Model.field'), 'data removed from updated request');
  2471. $this->assertFalse(isset($updated->getData()['Model']['field']), 'data removed from updated request');
  2472. }
  2473. /**
  2474. * Test updating POST data when keys don't exist
  2475. *
  2476. * @return void
  2477. */
  2478. public function testWithDataMissingIntermediaryKeys()
  2479. {
  2480. $request = new ServerRequest([
  2481. 'post' => [
  2482. 'Model' => [
  2483. 'field' => 'value',
  2484. ],
  2485. ],
  2486. ]);
  2487. $result = $request->withData('Model.field.new_value', 'new value');
  2488. $this->assertEquals(
  2489. 'new value',
  2490. $result->getData('Model.field.new_value')
  2491. );
  2492. $this->assertEquals(
  2493. 'new value',
  2494. $result->getData()['Model']['field']['new_value']
  2495. );
  2496. }
  2497. /**
  2498. * Test updating POST data with falsey values
  2499. *
  2500. * @return void
  2501. */
  2502. public function testWithDataFalseyValues()
  2503. {
  2504. $request = new ServerRequest([
  2505. 'post' => [],
  2506. ]);
  2507. $result = $request->withData('false', false)
  2508. ->withData('null', null)
  2509. ->withData('empty_string', '')
  2510. ->withData('zero', 0)
  2511. ->withData('zero_string', '0');
  2512. $expected = [
  2513. 'false' => false,
  2514. 'null' => null,
  2515. 'empty_string' => '',
  2516. 'zero' => 0,
  2517. 'zero_string' => '0',
  2518. ];
  2519. $this->assertSame($expected, $result->getData());
  2520. }
  2521. /**
  2522. * Test setting attributes.
  2523. *
  2524. * @return void
  2525. */
  2526. public function testWithAttribute()
  2527. {
  2528. $request = new ServerRequest([]);
  2529. $this->assertNull($request->getAttribute('key'));
  2530. $this->assertSame('default', $request->getAttribute('key', 'default'));
  2531. $new = $request->withAttribute('key', 'value');
  2532. $this->assertNotEquals($new, $request, 'Should be different');
  2533. $this->assertNull($request->getAttribute('key'), 'Old instance not modified');
  2534. $this->assertSame('value', $new->getAttribute('key'));
  2535. $update = $new->withAttribute('key', ['complex']);
  2536. $this->assertNotEquals($update, $new, 'Should be different');
  2537. $this->assertSame(['complex'], $update->getAttribute('key'));
  2538. }
  2539. /**
  2540. * Test getting all attributes.
  2541. *
  2542. * @return void
  2543. */
  2544. public function testGetAttributes()
  2545. {
  2546. $request = new ServerRequest([]);
  2547. $new = $request->withAttribute('key', 'value')
  2548. ->withAttribute('nully', null)
  2549. ->withAttribute('falsey', false);
  2550. $this->assertFalse($new->getAttribute('falsey'));
  2551. $this->assertNull($new->getAttribute('nully'));
  2552. $expected = [
  2553. 'key' => 'value',
  2554. 'nully' => null,
  2555. 'falsey' => false,
  2556. 'params' => [
  2557. 'plugin' => null,
  2558. 'controller' => null,
  2559. 'action' => null,
  2560. '_ext' => null,
  2561. 'pass' => [],
  2562. ],
  2563. 'webroot' => '',
  2564. 'base' => '',
  2565. 'here' => '/',
  2566. ];
  2567. $this->assertEquals($expected, $new->getAttributes());
  2568. }
  2569. /**
  2570. * Test unsetting attributes.
  2571. *
  2572. * @return void
  2573. */
  2574. public function testWithoutAttribute()
  2575. {
  2576. $request = new ServerRequest([]);
  2577. $new = $request->withAttribute('key', 'value');
  2578. $update = $request->withoutAttribute('key');
  2579. $this->assertNotEquals($update, $new, 'Should be different');
  2580. $this->assertNull($update->getAttribute('key'));
  2581. }
  2582. /**
  2583. * Test that withoutAttribute() cannot remove emulatedAttributes properties.
  2584. *
  2585. * @dataProvider emulatedPropertyProvider
  2586. * @return void
  2587. */
  2588. public function testWithoutAttributesDenyEmulatedProperties($prop)
  2589. {
  2590. $this->expectException(\InvalidArgumentException::class);
  2591. $request = new ServerRequest([]);
  2592. $request->withoutAttribute($prop);
  2593. }
  2594. /**
  2595. * Test the requestTarget methods.
  2596. *
  2597. * @return void
  2598. */
  2599. public function testWithRequestTarget()
  2600. {
  2601. $request = new ServerRequest([
  2602. 'environment' => [
  2603. 'REQUEST_URI' => '/articles/view/1',
  2604. 'QUERY_STRING' => 'comments=1&open=0',
  2605. ],
  2606. 'base' => '/basedir',
  2607. ]);
  2608. $this->assertEquals(
  2609. '/articles/view/1?comments=1&open=0',
  2610. $request->getRequestTarget(),
  2611. 'Should not include basedir.'
  2612. );
  2613. $new = $request->withRequestTarget('/articles/view/3');
  2614. $this->assertNotSame($new, $request);
  2615. $this->assertEquals(
  2616. '/articles/view/1?comments=1&open=0',
  2617. $request->getRequestTarget(),
  2618. 'should be unchanged.'
  2619. );
  2620. $this->assertSame('/articles/view/3', $new->getRequestTarget(), 'reflects method call');
  2621. }
  2622. /**
  2623. * Test withEnv()
  2624. *
  2625. * @return void
  2626. */
  2627. public function testWithEnv()
  2628. {
  2629. $request = new ServerRequest();
  2630. $newRequest = $request->withEnv('HTTP_HOST', 'cakephp.org');
  2631. $this->assertNotSame($request, $newRequest);
  2632. $this->assertSame('cakephp.org', $newRequest->getEnv('HTTP_HOST'));
  2633. }
  2634. /**
  2635. * Test getEnv()
  2636. *
  2637. * @return void
  2638. */
  2639. public function testGetEnv()
  2640. {
  2641. $request = new ServerRequest([
  2642. 'environment' => ['TEST' => 'ing'],
  2643. ]);
  2644. //Test default null
  2645. $this->assertNull($request->getEnv('Foo'));
  2646. //Test default set
  2647. $this->assertSame('Bar', $request->getEnv('Foo', 'Bar'));
  2648. //Test env() fallback
  2649. $this->assertSame('ing', $request->getEnv('test'));
  2650. }
  2651. /**
  2652. * Data provider for emulated property tests.
  2653. *
  2654. * @return array
  2655. */
  2656. public function emulatedPropertyProvider()
  2657. {
  2658. return [
  2659. ['here'],
  2660. ['params'],
  2661. ['base'],
  2662. ['webroot'],
  2663. ['session'],
  2664. ];
  2665. }
  2666. }