MediaWiki  1.30.0
RestbaseVirtualRESTService.php
Go to the documentation of this file.
1 <?php
51  public function __construct( array $params ) {
52  // set up defaults and merge them with the given params
53  $mparams = array_merge( [
54  'name' => 'restbase',
55  'url' => 'http://localhost:7231/',
56  'domain' => 'localhost',
57  'timeout' => 100,
58  'forwardCookies' => false,
59  'HTTPProxy' => null,
60  'parsoidCompat' => false,
61  'fixedUrl' => false,
62  ], $params );
63  // Ensure that the url parameter has a trailing slash.
64  if ( substr( $mparams['url'], -1 ) !== '/' ) {
65  $mparams['url'] .= '/';
66  }
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+)?\/?$/',
72  '$2',
73  $mparams['domain']
74  );
75  parent::__construct( $mparams );
76  }
77 
78  public function onRequests( array $reqs, Closure $idGenFunc ) {
79  if ( $this->params['parsoidCompat'] ) {
80  return $this->onParsoidRequests( $reqs, $idGenFunc );
81  }
82 
83  $result = [];
84  foreach ( $reqs as $key => $req ) {
85  if ( $this->params['fixedUrl'] ) {
86  $version = explode( '/', $req['url'] )[1];
87  $req['url'] =
88  str_replace( '#version#', $version, $this->params['url'] ) .
89  preg_replace( '#^local/v./#', '', $req['url'] );
90  } else {
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'];
95  }
96 
97  // set the appropriate proxy, timeout and headers
98  if ( $this->params['HTTPProxy'] ) {
99  $req['proxy'] = $this->params['HTTPProxy'];
100  }
101  if ( $this->params['timeout'] != null ) {
102  $req['reqTimeout'] = $this->params['timeout'];
103  }
104  if ( $this->params['forwardCookies'] ) {
105  $req['headers']['Cookie'] = $this->params['forwardCookies'];
106  }
107  $result[$key] = $req;
108  }
109 
110  return $result;
111  }
112 
120  public function onParsoidRequests( array $reqs, Closure $idGeneratorFunc ) {
121  $result = [];
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 );
128  } else {
129  throw new Exception( "Only v1 and v3 are supported." );
130  }
131  }
132 
133  return $result;
134  }
135 
157  public function onParsoid1Request( array $req, Closure $idGeneratorFunc ) {
158  $parts = explode( '/', $req['url'] );
159  list(
160  $targetWiki, // 'local'
161  $version, // 'v1'
162  $reqType // 'page' or 'transform'
163  ) = $parts;
164  if ( $targetWiki !== 'local' ) {
165  throw new Exception( "Only 'local' target wiki is currently supported" );
166  } elseif ( $version !== 'v1' ) {
167  throw new Exception( "Version mismatch: should not happen." );
168  } elseif ( $reqType !== 'page' && $reqType !== 'transform' ) {
169  throw new Exception( "Request type must be either 'page' or 'transform'" );
170  }
171  $req['url'] = $this->params['url'] . $this->params['domain'] . '/v1/' . $reqType . '/';
172  if ( $reqType === 'page' ) {
173  $title = $parts[3];
174  if ( $parts[4] !== 'html' ) {
175  throw new Exception( "Only 'html' output format is currently supported" );
176  }
177  $req['url'] .= 'html/' . $title;
178  if ( isset( $parts[5] ) ) {
179  $req['url'] .= '/' . $parts[5];
180  } elseif ( isset( $req['query']['oldid'] ) && $req['query']['oldid'] ) {
181  $req['url'] .= '/' . $req['query']['oldid'];
182  unset( $req['query']['oldid'] );
183  }
184  } elseif ( $reqType === 'transform' ) {
185  // from / to transform
186  $req['url'] .= $parts[3] . '/to/' . $parts[5];
187  // the title
188  if ( isset( $parts[6] ) ) {
189  $req['url'] .= '/' . $parts[6];
190  }
191  // revision id
192  if ( isset( $parts[7] ) ) {
193  $req['url'] .= '/' . $parts[7];
194  } elseif ( isset( $req['body']['oldid'] ) && $req['body']['oldid'] ) {
195  $req['url'] .= '/' . $req['body']['oldid'];
196  unset( $req['body']['oldid'] );
197  }
198  if ( $parts[4] !== 'to' ) {
199  throw new Exception( "Part index 4 is not 'to'" );
200  }
201  if ( $parts[3] === 'html' && $parts[5] === 'wikitext' ) {
202  if ( !isset( $req['body']['html'] ) ) {
203  throw new Exception( "You must set an 'html' body key for this request" );
204  }
205  } elseif ( $parts[3] == 'wikitext' && $parts[5] == 'html' ) {
206  if ( !isset( $req['body']['wikitext'] ) ) {
207  throw new Exception( "You must set a 'wikitext' body key for this request" );
208  }
209  if ( isset( $req['body']['body'] ) ) {
210  $req['body']['body_only'] = $req['body']['body'];
211  unset( $req['body']['body'] );
212  }
213  } else {
214  throw new Exception( "Transformation unsupported" );
215  }
216  }
217  // set the appropriate proxy, timeout and headers
218  if ( $this->params['HTTPProxy'] ) {
219  $req['proxy'] = $this->params['HTTPProxy'];
220  }
221  if ( $this->params['timeout'] != null ) {
222  $req['reqTimeout'] = $this->params['timeout'];
223  }
224  if ( $this->params['forwardCookies'] ) {
225  $req['headers']['Cookie'] = $this->params['forwardCookies'];
226  }
227 
228  return $req;
229  }
230 
249  public function onParsoid3Request( array $req, Closure $idGeneratorFunc ) {
250  $parts = explode( '/', $req['url'] );
251  list(
252  $targetWiki, // 'local'
253  $version, // 'v3'
254  $action, // 'transform' or 'page'
255  $format, // 'html' or 'wikitext'
256  // $title, // optional
257  // $revision, // optional
258  ) = $parts;
259  if ( $targetWiki !== 'local' ) {
260  throw new Exception( "Only 'local' target wiki is currently supported" );
261  } elseif ( $version !== 'v3' ) {
262  throw new Exception( "Version mismatch: should not happen." );
263  }
264  // replace /local/ with the current domain, change v3 to v1,
265  $req['url'] = preg_replace( '#^local/v3/#', $this->params['domain'] . '/v1/', $req['url'] );
266  // and prefix it with the service URL
267  $req['url'] = $this->params['url'] . $req['url'];
268  // set the appropriate proxy, timeout and headers
269  if ( $this->params['HTTPProxy'] ) {
270  $req['proxy'] = $this->params['HTTPProxy'];
271  }
272  if ( $this->params['timeout'] != null ) {
273  $req['reqTimeout'] = $this->params['timeout'];
274  }
275  if ( $this->params['forwardCookies'] ) {
276  $req['headers']['Cookie'] = $this->params['forwardCookies'];
277  }
278 
279  return $req;
280  }
281 
282 }
RestbaseVirtualRESTService\onParsoid3Request
onParsoid3Request(array $req, Closure $idGeneratorFunc)
Remap a Parsoid v3 request to a RESTBase v1 request.
Definition: RestbaseVirtualRESTService.php:249
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1963
$req
this hook is for auditing only $req
Definition: hooks.txt:988
RestbaseVirtualRESTService\onRequests
onRequests(array $reqs, Closure $idGenFunc)
Prepare virtual HTTP(S) requests (for this service) for execution.
Definition: RestbaseVirtualRESTService.php:78
php
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:35
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
RestbaseVirtualRESTService\__construct
__construct(array $params)
Example RESTBase v1 requests: GET /local/v1/page/html/{title}{/revision} POST /local/v1/transform/htm...
Definition: RestbaseVirtualRESTService.php:51
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
RestbaseVirtualRESTService\onParsoidRequests
onParsoidRequests(array $reqs, Closure $idGeneratorFunc)
Remaps Parsoid v1/v3 requests to RESTBase v1 requests.
Definition: RestbaseVirtualRESTService.php:120
RestbaseVirtualRESTService\onParsoid1Request
onParsoid1Request(array $req, Closure $idGeneratorFunc)
Remap a Parsoid v1 request to a RESTBase v1 request.
Definition: RestbaseVirtualRESTService.php:157
as
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
Definition: distributors.txt:9
RestbaseVirtualRESTService
Virtual HTTP service client for RESTBase.
Definition: RestbaseVirtualRESTService.php:25
VirtualRESTService
Virtual HTTP service instance that can be mounted on to a VirtualRESTService.
Definition: VirtualRESTService.php:36
VirtualRESTService\$params
array $params
Key/value map.
Definition: VirtualRESTService.php:38
array
the array() calling protocol came about after MediaWiki 1.4rc1.