ServerRequestTest.php 115 KB

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