ServerRequestTest.php 123 KB

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