ServerRequestTest.php 110 KB

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