ServerRequestTest.php 110 KB

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