ServerRequestTest.php 114 KB

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