ServerRequestTest.php 116 KB

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