ServerRequestTest.php 108 KB

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