ServerRequestTest.php 119 KB

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