ServerRequestTest.php 121 KB

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