ServerRequestTest.php 131 KB

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