ServerRequestTest.php 113 KB

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