ServerRequestTest.php 114 KB

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