ServerRequestTest.php 121 KB

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