ServerRequestTest.php 130 KB

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