summaryrefslogtreecommitdiff
path: root/www/wiki/includes/libs/virtualrest/ParsoidVirtualRESTService.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/libs/virtualrest/ParsoidVirtualRESTService.php')
-rw-r--r--www/wiki/includes/libs/virtualrest/ParsoidVirtualRESTService.php227
1 files changed, 227 insertions, 0 deletions
diff --git a/www/wiki/includes/libs/virtualrest/ParsoidVirtualRESTService.php b/www/wiki/includes/libs/virtualrest/ParsoidVirtualRESTService.php
new file mode 100644
index 00000000..37a967ff
--- /dev/null
+++ b/www/wiki/includes/libs/virtualrest/ParsoidVirtualRESTService.php
@@ -0,0 +1,227 @@
+<?php
+/**
+ * Virtual HTTP service client for Parsoid
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+/**
+ * Virtual REST service for Parsoid
+ * @since 1.25
+ */
+class ParsoidVirtualRESTService extends VirtualRESTService {
+ /**
+ * Example Parsoid v3 requests:
+ * GET /local/v3/page/html/$title/{$revision}
+ * * $revision is optional
+ * POST /local/v3/transform/html/to/wikitext/{$title}{/$revision}
+ * * body: array( 'html' => ... )
+ * * $title and $revision are optional
+ * POST /local/v3/transform/wikitext/to/html/{$title}{/$revision}
+ * * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body_only' => true/false )
+ * * $title is optional
+ * * $revision is optional
+ *
+ * There are also deprecated "v1" requests; see onParsoid1Request
+ * for details.
+ * @param array $params Key/value map
+ * - url : Parsoid server URL
+ * - domain : Wiki domain to use
+ * - timeout : Parsoid timeout (optional)
+ * - forwardCookies : Cookies to forward to Parsoid, or false. (optional)
+ * - HTTPProxy : Parsoid HTTP proxy (optional)
+ * - restbaseCompat : whether to parse URL as if they were meant for RESTBase
+ * boolean (optional)
+ */
+ public function __construct( array $params ) {
+ // for backwards compatibility:
+ if ( isset( $params['URL'] ) ) {
+ $params['url'] = $params['URL'];
+ unset( $params['URL'] );
+ }
+ // set up defaults and merge them with the given params
+ $mparams = array_merge( [
+ 'name' => 'parsoid',
+ 'url' => 'http://localhost:8000/',
+ 'prefix' => 'localhost',
+ 'domain' => 'localhost',
+ 'timeout' => null,
+ 'forwardCookies' => false,
+ 'HTTPProxy' => null,
+ ], $params );
+ // Ensure that the url parameter has a trailing slash.
+ if ( substr( $mparams['url'], -1 ) !== '/' ) {
+ $mparams['url'] .= '/';
+ }
+ // Ensure the correct domain format: strip protocol, port,
+ // and trailing slash if present. This lets us use
+ // $wgCanonicalServer as a default value, which is very convenient.
+ $mparams['domain'] = preg_replace(
+ '/^(https?:\/\/)?([^\/:]+?)(:\d+)?\/?$/',
+ '$2',
+ $mparams['domain']
+ );
+ parent::__construct( $mparams );
+ }
+
+ public function onRequests( array $reqs, Closure $idGeneratorFunc ) {
+ $result = [];
+ foreach ( $reqs as $key => $req ) {
+ $parts = explode( '/', $req['url'] );
+
+ list(
+ $targetWiki, // 'local'
+ $version, // 'v3' ('v1' for restbase compatibility)
+ $reqType, // 'page' or 'transform'
+ $format, // 'html' or 'wikitext'
+ // $title (optional)
+ // $revision (optional)
+ ) = $parts;
+
+ if ( isset( $this->params['restbaseCompat'] ) && $this->params['restbaseCompat'] ) {
+ if ( $version !== 'v1' ) {
+ throw new Exception( "Only RESTBase v1 API is supported." );
+ }
+ # Map RESTBase v1 API to Parsoid v3 API (pretty easy)
+ $req['url'] = preg_replace( '#^local/v1/#', 'local/v3/', $req['url'] );
+ } elseif ( $version !== 'v3' ) {
+ $result[$key] = $this->onParsoid1Request( $req, $idGeneratorFunc );
+ continue;
+ }
+ if ( $targetWiki !== 'local' ) {
+ throw new Exception( "Only 'local' target wiki is currently supported" );
+ }
+ if ( $reqType !== 'page' && $reqType !== 'transform' ) {
+ throw new Exception( "Request action must be either 'page' or 'transform'" );
+ }
+ if ( $format !== 'html' && $format !== 'wikitext' ) {
+ throw new Exception( "Request format must be either 'html' or 'wt'" );
+ }
+ // replace /local/ with the current domain
+ $req['url'] = preg_replace( '#^local/#', $this->params['domain'] . '/', $req['url'] );
+ // and prefix it with the service URL
+ $req['url'] = $this->params['url'] . $req['url'];
+ // set the appropriate proxy, timeout and headers
+ if ( $this->params['HTTPProxy'] ) {
+ $req['proxy'] = $this->params['HTTPProxy'];
+ }
+ if ( $this->params['timeout'] != null ) {
+ $req['reqTimeout'] = $this->params['timeout'];
+ }
+ if ( $this->params['forwardCookies'] ) {
+ $req['headers']['Cookie'] = $this->params['forwardCookies'];
+ }
+ $result[$key] = $req;
+ }
+ return $result;
+ }
+
+ /**
+ * Remap a Parsoid v1 request to a Parsoid v3 request.
+ *
+ * Example Parsoid v1 requests:
+ * GET /local/v1/page/$title/html/$oldid
+ * * $oldid is optional
+ * POST /local/v1/transform/html/to/wikitext/$title/$oldid
+ * * body: array( 'html' => ... )
+ * * $title and $oldid are optional
+ * POST /local/v1/transform/wikitext/to/html/$title
+ * * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body' => true/false )
+ * * $title is optional
+ *
+ * NOTE: the POST APIs aren't "real" Parsoid v1 APIs, they are just what
+ * Visual Editor "pretends" the V1 API is like. A previous version of
+ * ParsoidVirtualRESTService translated these to the "real" Parsoid v1
+ * API. We now translate these to the "real" Parsoid v3 API.
+ * @param array $req
+ * @param Closure $idGeneratorFunc
+ * @return array
+ * @throws Exception
+ */
+ public function onParsoid1Request( array $req, Closure $idGeneratorFunc ) {
+ $parts = explode( '/', $req['url'] );
+ list(
+ $targetWiki, // 'local'
+ $version, // 'v1'
+ $reqType // 'page' or 'transform'
+ ) = $parts;
+ if ( $targetWiki !== 'local' ) {
+ throw new Exception( "Only 'local' target wiki is currently supported" );
+ } elseif ( $version !== 'v1' ) {
+ throw new Exception( "Only v1 and v3 are supported." );
+ } elseif ( $reqType !== 'page' && $reqType !== 'transform' ) {
+ throw new Exception( "Request type must be either 'page' or 'transform'" );
+ }
+ $req['url'] = $this->params['url'] . $this->params['domain'] . '/v3/';
+ if ( $reqType === 'page' ) {
+ $title = $parts[3];
+ if ( $parts[4] !== 'html' ) {
+ throw new Exception( "Only 'html' output format is currently supported" );
+ }
+ $req['url'] .= 'page/html/' . $title;
+ if ( isset( $parts[5] ) ) {
+ $req['url'] .= '/' . $parts[5];
+ } elseif ( isset( $req['query']['oldid'] ) && $req['query']['oldid'] ) {
+ $req['url'] .= '/' . $req['query']['oldid'];
+ unset( $req['query']['oldid'] );
+ }
+ } elseif ( $reqType === 'transform' ) {
+ $req['url'] .= 'transform/'. $parts[3] . '/to/' . $parts[5];
+ // the title
+ if ( isset( $parts[6] ) ) {
+ $req['url'] .= '/' . $parts[6];
+ }
+ // revision id
+ if ( isset( $parts[7] ) ) {
+ $req['url'] .= '/' . $parts[7];
+ } elseif ( isset( $req['body']['oldid'] ) && $req['body']['oldid'] ) {
+ $req['url'] .= '/' . $req['body']['oldid'];
+ unset( $req['body']['oldid'] );
+ }
+ if ( $parts[4] !== 'to' ) {
+ throw new Exception( "Part index 4 is not 'to'" );
+ }
+ if ( $parts[3] === 'html' && $parts[5] === 'wikitext' ) {
+ if ( !isset( $req['body']['html'] ) ) {
+ throw new Exception( "You must set an 'html' body key for this request" );
+ }
+ } elseif ( $parts[3] == 'wikitext' && $parts[5] == 'html' ) {
+ if ( !isset( $req['body']['wikitext'] ) ) {
+ throw new Exception( "You must set a 'wikitext' body key for this request" );
+ }
+ if ( isset( $req['body']['body'] ) ) {
+ $req['body']['body_only'] = $req['body']['body'];
+ unset( $req['body']['body'] );
+ }
+ } else {
+ throw new Exception( "Transformation unsupported" );
+ }
+ }
+ // set the appropriate proxy, timeout and headers
+ if ( $this->params['HTTPProxy'] ) {
+ $req['proxy'] = $this->params['HTTPProxy'];
+ }
+ if ( $this->params['timeout'] != null ) {
+ $req['reqTimeout'] = $this->params['timeout'];
+ }
+ if ( $this->params['forwardCookies'] ) {
+ $req['headers']['Cookie'] = $this->params['forwardCookies'];
+ }
+
+ return $req;
+ }
+
+}
generated by cgit v1.2.1 (git 2.18.0) at 2024-05-05 03:02:58 +0000