3 * Virtual HTTP service client for RESTBase
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 * Virtual REST service for RESTBase
25 class RestbaseVirtualRESTService
extends VirtualRESTService
{
27 * Example RESTBase v1 requests:
28 * GET /local/v1/page/html/{title}{/revision}
29 * POST /local/v1/transform/html/to/wikitext{/title}{/revision}
30 * * body: array( 'html' => ... )
31 * POST /local/v1/transform/wikitext/to/html{/title}{/revision}
32 * * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body_only' => true/false )
34 * @param array $params Key/value map
35 * - url : RESTBase server URL
36 * - domain : Wiki domain to use
37 * - timeout : request timeout in seconds (optional)
38 * - forwardCookies : cookies to forward to RESTBase/Parsoid (as a Cookie
39 * header string) or false (optional)
40 * Note: forwardCookies will in the future be a boolean
41 * only, signifing request cookies should be forwarded
42 * to the service; the current state is due to the way
43 * VE handles this particular parameter
44 * - HTTPProxy : HTTP proxy to use (optional)
45 * - parsoidCompat : whether to parse URL as if they were meant for Parsoid
47 * - fixedUrl : Do not append domain to the url. For example to use
48 * English Wikipedia restbase, you would this to true
49 * and url to https://en.wikipedia.org/api/rest_#version#
51 public function __construct( array $params ) {
52 // set up defaults and merge them with the given params
53 $mparams = array_merge( [
55 'url' => 'http://localhost:7231/',
56 'domain' => 'localhost',
58 'forwardCookies' => false,
60 'parsoidCompat' => false,
63 // Ensure that the url parameter has a trailing slash.
64 if ( substr( $mparams['url'], -1 ) !== '/' ) {
65 $mparams['url'] .= '/';
67 // Ensure the correct domain format: strip protocol, port,
68 // and trailing slash if present. This lets us use
69 // $wgCanonicalServer as a default value, which is very convenient.
70 $mparams['domain'] = preg_replace(
71 '/^(https?:\/\/)?([^\/:]+?)(:\d+)?\/?$/',
75 parent
::__construct( $mparams );
78 public function onRequests( array $reqs, Closure
$idGenFunc ) {
79 if ( $this->params
['parsoidCompat'] ) {
80 return $this->onParsoidRequests( $reqs, $idGenFunc );
84 foreach ( $reqs as $key => $req ) {
85 if ( $this->params
['fixedUrl'] ) {
86 $version = explode( '/', $req['url'] )[1];
88 str_replace( '#version#', $version, $this->params
['url'] ) .
89 preg_replace( '#^local/v./#', '', $req['url'] );
91 // replace /local/ with the current domain
92 $req['url'] = preg_replace( '#^local/#', $this->params
['domain'] . '/', $req['url'] );
93 // and prefix it with the service URL
94 $req['url'] = $this->params
['url'] . $req['url'];
97 // set the appropriate proxy, timeout and headers
98 if ( $this->params
['HTTPProxy'] ) {
99 $req['proxy'] = $this->params
['HTTPProxy'];
101 if ( $this->params
['timeout'] != null ) {
102 $req['reqTimeout'] = $this->params
['timeout'];
104 if ( $this->params
['forwardCookies'] ) {
105 $req['headers']['Cookie'] = $this->params
['forwardCookies'];
107 $result[$key] = $req;
114 * Remaps Parsoid v1/v3 requests to RESTBase v1 requests.
116 * @param Closure $idGeneratorFunc
120 public function onParsoidRequests( array $reqs, Closure
$idGeneratorFunc ) {
122 foreach ( $reqs as $key => $req ) {
123 $version = explode( '/', $req['url'] )[1];
124 if ( $version === 'v3' ) {
125 $result[$key] = $this->onParsoid3Request( $req, $idGeneratorFunc );
126 } elseif ( $version === 'v1' ) {
127 $result[$key] = $this->onParsoid1Request( $req, $idGeneratorFunc );
129 throw new Exception( "Only v1 and v3 are supported." );
137 * Remap a Parsoid v1 request to a RESTBase v1 request.
139 * Example Parsoid v1 requests:
140 * GET /local/v1/page/$title/html/$oldid
141 * * $oldid is optional
142 * POST /local/v1/transform/html/to/wikitext/$title/$oldid
143 * * body: array( 'html' => ... )
144 * * $title and $oldid are optional
145 * POST /local/v1/transform/wikitext/to/html/$title
146 * * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body' => true/false )
147 * * $title is optional
149 * NOTE: the POST APIs aren't "real" Parsoid v1 APIs, they are just what
150 * Visual Editor "pretends" the V1 API is like. (See
151 * ParsoidVirtualRESTService.)
153 * @param Closure $idGeneratorFunc
156 * @deprecated since 1.26, upgrade your client to issue v3 requests.
158 public function onParsoid1Request( array $req, Closure
$idGeneratorFunc ) {
159 wfDeprecated( __METHOD__
, '1.26' );
160 $parts = explode( '/', $req['url'] );
162 $targetWiki, // 'local'
164 $reqType // 'page' or 'transform'
166 if ( $targetWiki !== 'local' ) {
167 throw new Exception( "Only 'local' target wiki is currently supported" );
168 } elseif ( $version !== 'v1' ) {
169 throw new Exception( "Version mismatch: should not happen." );
170 } elseif ( $reqType !== 'page' && $reqType !== 'transform' ) {
171 throw new Exception( "Request type must be either 'page' or 'transform'" );
173 $req['url'] = $this->params
['url'] . $this->params
['domain'] . '/v1/' . $reqType . '/';
174 if ( $reqType === 'page' ) {
176 if ( $parts[4] !== 'html' ) {
177 throw new Exception( "Only 'html' output format is currently supported" );
179 $req['url'] .= 'html/' . $title;
180 if ( isset( $parts[5] ) ) {
181 $req['url'] .= '/' . $parts[5];
182 } elseif ( isset( $req['query']['oldid'] ) && $req['query']['oldid'] ) {
183 $req['url'] .= '/' . $req['query']['oldid'];
184 unset( $req['query']['oldid'] );
186 } elseif ( $reqType === 'transform' ) {
187 // from / to transform
188 $req['url'] .= $parts[3] . '/to/' . $parts[5];
190 if ( isset( $parts[6] ) ) {
191 $req['url'] .= '/' . $parts[6];
194 if ( isset( $parts[7] ) ) {
195 $req['url'] .= '/' . $parts[7];
196 } elseif ( isset( $req['body']['oldid'] ) && $req['body']['oldid'] ) {
197 $req['url'] .= '/' . $req['body']['oldid'];
198 unset( $req['body']['oldid'] );
200 if ( $parts[4] !== 'to' ) {
201 throw new Exception( "Part index 4 is not 'to'" );
203 if ( $parts[3] === 'html' && $parts[5] === 'wikitext' ) {
204 if ( !isset( $req['body']['html'] ) ) {
205 throw new Exception( "You must set an 'html' body key for this request" );
207 } elseif ( $parts[3] == 'wikitext' && $parts[5] == 'html' ) {
208 if ( !isset( $req['body']['wikitext'] ) ) {
209 throw new Exception( "You must set a 'wikitext' body key for this request" );
211 if ( isset( $req['body']['body'] ) ) {
212 $req['body']['body_only'] = $req['body']['body'];
213 unset( $req['body']['body'] );
216 throw new Exception( "Transformation unsupported" );
219 // set the appropriate proxy, timeout and headers
220 if ( $this->params
['HTTPProxy'] ) {
221 $req['proxy'] = $this->params
['HTTPProxy'];
223 if ( $this->params
['timeout'] != null ) {
224 $req['reqTimeout'] = $this->params
['timeout'];
226 if ( $this->params
['forwardCookies'] ) {
227 $req['headers']['Cookie'] = $this->params
['forwardCookies'];
234 * Remap a Parsoid v3 request to a RESTBase v1 request.
236 * Example Parsoid v3 requests:
237 * GET /local/v3/page/html/$title/{$revision}
238 * * $revision is optional
239 * POST /local/v3/transform/html/to/wikitext/{$title}{/$revision}
240 * * body: array( 'html' => ... )
241 * * $title and $revision are optional
242 * POST /local/v3/transform/wikitext/to/html/{$title}{/$revision}
243 * * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body_only' => true/false )
244 * * $title is optional
245 * * $revision is optional
247 * @param Closure $idGeneratorFunc
251 public function onParsoid3Request( array $req, Closure
$idGeneratorFunc ) {
252 $parts = explode( '/', $req['url'] );
254 $targetWiki, // 'local'
256 $action, // 'transform' or 'page'
257 $format, // 'html' or 'wikitext'
258 // $title, // optional
259 // $revision, // optional
261 if ( $targetWiki !== 'local' ) {
262 throw new Exception( "Only 'local' target wiki is currently supported" );
263 } elseif ( $version !== 'v3' ) {
264 throw new Exception( "Version mismatch: should not happen." );
266 // replace /local/ with the current domain, change v3 to v1,
267 $req['url'] = preg_replace( '#^local/v3/#', $this->params
['domain'] . '/v1/', $req['url'] );
268 // and prefix it with the service URL
269 $req['url'] = $this->params
['url'] . $req['url'];
270 // set the appropriate proxy, timeout and headers
271 if ( $this->params
['HTTPProxy'] ) {
272 $req['proxy'] = $this->params
['HTTPProxy'];
274 if ( $this->params
['timeout'] != null ) {
275 $req['reqTimeout'] = $this->params
['timeout'];
277 if ( $this->params
['forwardCookies'] ) {
278 $req['headers']['Cookie'] = $this->params
['forwardCookies'];