MediaWiki REL1_32
PageDataRequestHandlerTest.php
Go to the documentation of this file.
1<?php
2
8
13
17 private $obLevel;
18
19 protected function setUp() {
20 parent::setUp();
21
22 $this->interfaceTitle = Title::newFromText( "Special:PageDataRequestHandlerTest" );
23
24 $this->obLevel = ob_get_level();
25 }
26
27 protected function tearDown() {
28 $obLevel = ob_get_level();
29
30 while ( ob_get_level() > $this->obLevel ) {
31 ob_end_clean();
32 }
33
34 if ( $obLevel !== $this->obLevel ) {
35 $this->fail( "Test changed output buffer level: was {$this->obLevel}" .
36 "before test, but $obLevel after test."
37 );
38 }
39
40 parent::tearDown();
41 }
42
46 protected function newHandler() {
47 return new PageDataRequestHandler( 'json' );
48 }
49
56 protected function makeOutputPage( array $params, array $headers ) {
57 // construct request
59 $request->response()->header( 'Status: 200 OK', true, 200 ); // init/reset
60
61 foreach ( $headers as $name => $value ) {
62 $request->setHeader( strtoupper( $name ), $value );
63 }
64
65 // construct Context and OutputPage
66 $context = new DerivativeContext( RequestContext::getMain() );
67 $context->setRequest( $request );
68
70 $output->setTitle( $this->interfaceTitle );
71 $context->setOutput( $output );
72
73 return $output;
74 }
75
76 public function handleRequestProvider() {
77 $cases = [];
78
79 $cases[] = [ '', [], [], '!!', 400 ];
80
81 $cases[] = [ '', [ 'target' => 'Helsinki' ], [], '!!', 303, [ 'Location' => '!.+!' ] ];
82
83 $subpageCases = [];
84 foreach ( $cases as $c ) {
85 $case = $c;
86 $case[0] = 'main/';
87
88 if ( isset( $case[1]['target'] ) ) {
89 $case[0] .= $case[1]['target'];
90 unset( $case[1]['target'] );
91 }
92
93 $subpageCases[] = $case;
94 }
95
96 $cases = array_merge( $cases, $subpageCases );
97
98 $cases[] = [
99 '',
100 [ 'target' => 'Helsinki' ],
101 [ 'Accept' => 'text/HTML' ],
102 '!!',
103 303,
104 [ 'Location' => '!Helsinki$!' ]
105 ];
106
107 $cases[] = [
108 '',
109 [
110 'target' => 'Helsinki',
111 'revision' => '4242',
112 ],
113 [ 'Accept' => 'text/HTML' ],
114 '!!',
115 303,
116 [ 'Location' => '!Helsinki(\?|&)oldid=4242!' ]
117 ];
118
119 $cases[] = [
120 '/Helsinki',
121 [],
122 [],
123 '!!',
124 303,
125 [ 'Location' => '!Helsinki&action=raw!' ]
126 ];
127
128 // #31: /Q5 with "Accept: text/foobar" triggers a 406
129 $cases[] = [
130 'main/Helsinki',
131 [],
132 [ 'Accept' => 'text/foobar' ],
133 '!!',
134 406,
135 [],
136 ];
137
138 $cases[] = [
139 'main/Helsinki',
140 [],
141 [ 'Accept' => 'text/HTML' ],
142 '!!',
143 303,
144 [ 'Location' => '!Helsinki$!' ]
145 ];
146
147 $cases[] = [
148 '/Helsinki',
149 [],
150 [ 'Accept' => 'text/HTML' ],
151 '!!',
152 303,
153 [ 'Location' => '!Helsinki$!' ]
154 ];
155
156 $cases[] = [
157 'main/AC/DC',
158 [],
159 [ 'Accept' => 'text/HTML' ],
160 '!!',
161 303,
162 [ 'Location' => '!AC/DC$!' ]
163 ];
164
165 return $cases;
166 }
167
178 public function testHandleRequest(
179 $subpage,
181 array $headers,
182 $expectedOutput,
183 $expectedStatusCode = 200,
184 array $expectedHeaders = []
185 ) {
186 $output = $this->makeOutputPage( $params, $headers );
187 $request = $output->getRequest();
188
189 /* @var FauxResponse $response */
190 $response = $request->response();
191
192 // construct handler
193 $handler = $this->newHandler();
194
195 try {
196 ob_start();
197 $handler->handleRequest( $subpage, $request, $output );
198
199 if ( $output->getRedirect() !== '' ) {
200 // hack to apply redirect to web response
201 $output->output();
202 }
203
204 $text = ob_get_contents();
205 ob_end_clean();
206
207 $this->assertEquals( $expectedStatusCode, $response->getStatusCode(), 'status code' );
208 $this->assertRegExp( $expectedOutput, $text, 'output' );
209
210 foreach ( $expectedHeaders as $name => $exp ) {
211 $value = $response->getHeader( $name );
212 $this->assertNotNull( $value, "header: $name" );
213 $this->assertInternalType( 'string', $value, "header: $name" );
214 $this->assertRegExp( $exp, $value, "header: $name" );
215 }
216 } catch ( HttpError $e ) {
217 ob_end_clean();
218 $this->assertEquals( $expectedStatusCode, $e->getStatusCode(), 'status code' );
219 $this->assertRegExp( $expectedOutput, $e->getHTML(), 'error output' );
220 }
221
222 // We always set "Access-Control-Allow-Origin: *"
223 $this->assertSame( '*', $response->getHeader( 'Access-Control-Allow-Origin' ) );
224 }
225
227 $helsinki = Title::newFromText( 'Helsinki' );
228 return [
229 'Accept Header of HTML' => [
230 $helsinki,
231 [ 'ACCEPT' => 'text/html' ], // headers
232 'Helsinki'
233 ],
234 'Accept Header without weights' => [
235 $helsinki,
236 [ 'ACCEPT' => '*/*, text/html, text/x-wiki' ],
237 'Helsinki&action=raw'
238 ],
239 'Accept Header with weights' => [
240 $helsinki,
241 [ 'ACCEPT' => 'text/*; q=0.5, text/json; q=0.7, application/rdf+xml; q=0.8' ],
242 'Helsinki&action=raw'
243 ],
244 'Accept Header accepting evertyhing and HTML' => [
245 $helsinki,
246 [ 'ACCEPT' => 'text/html, */*' ],
247 'Helsinki&action=raw'
248 ],
249 'No Accept Header' => [
250 $helsinki,
251 [],
252 'Helsinki&action=raw'
253 ],
254 ];
255 }
256
267 Title $title,
268 array $headers,
269 $expectedRedirectSuffix
270 ) {
271 /* @var FauxResponse $response */
272 $output = $this->makeOutputPage( [], $headers );
273 $request = $output->getRequest();
274
275 $handler = $this->newHandler();
276 $handler->httpContentNegotiation( $request, $output, $title );
277
278 $this->assertStringEndsWith(
279 $expectedRedirectSuffix,
280 $output->getRedirect(),
281 'redirect target'
282 );
283 }
284}
An IContextSource implementation which will inherit context from another source but allow individual ...
WebRequest clone which takes values from a provided array.
Show an error that looks like an HTTP server error.
Definition HttpError.php:30
This class should be covered by a general architecture document which does not exist as of January 20...
PageDataRequestHandler PageData.
makeOutputPage(array $params, array $headers)
testHandleRequest( $subpage, array $params, array $headers, $expectedOutput, $expectedStatusCode=200, array $expectedHeaders=[])
handleRequestProvider
testHttpContentNegotiation(Title $title, array $headers, $expectedRedirectSuffix)
provideHttpContentNegotiation
Request handler implementing a data interface for mediawiki pages.
Represents a title within MediaWiki.
Definition Title.php:39
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2880
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2885
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
this hook is for auditing only $response
Definition hooks.txt:813
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition hooks.txt:933
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2317
returning false will NOT prevent logging $e
Definition hooks.txt:2226
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$params