ServerRequestTest.php 120 KB

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