ServerRequestTest.php 115 KB

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