includes/libs/virtualrest/RestbaseVirtualRESTService.php

   1 <?php
   2 /**
   3  * Virtual HTTP service client for RESTBase
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  */
  20
  21 /**
  22  * Virtual REST service for RESTBase
  23  * @since 1.25
  24  */
  25 class RestbaseVirtualRESTService extends VirtualRESTService {
  26         /**
  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 )
  33          *
  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
  46          *                       boolean (optional)
  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#
  50          */
  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                 $mparams['url'] = preg_replace(
  65                         '#/?$#',
  66                         '/',
  67                         $mparams['url']
  68                 );
  69                 // Ensure the correct domain format: strip protocol, port,
  70                 // and trailing slash if present.  This lets us use
  71                 // $wgCanonicalServer as a default value, which is very convenient.
  72                 $mparams['domain'] = preg_replace(
  73                         '/^(https?:\/\/)?([^\/:]+?)(:\d+)?\/?$/',
  74                         '$2',
  75                         $mparams['domain']
  76                 );
  77                 parent::__construct( $mparams );
  78         }
  79
  80         public function onRequests( array $reqs, Closure $idGenFunc ) {
  81
  82                 if ( $this->params['parsoidCompat'] ) {
  83                         return $this->onParsoidRequests( $reqs, $idGenFunc );
  84                 }
  85
  86                 $result = [];
  87                 foreach ( $reqs as $key => $req ) {
  88                         if ( $this->params['fixedUrl'] ) {
  89                                 $version = explode( '/', $req['url'] )[1];
  90                                 $req['url'] =
  91                                         str_replace( '#version#', $version, $this->params['url'] ) .
  92                                         preg_replace( '#^local/v./#', '', $req['url'] );
  93                         } else {
  94                                 // replace /local/ with the current domain
  95                                 $req['url'] = preg_replace( '#^local/#', $this->params['domain'] . '/', $req['url'] );
  96                                 // and prefix it with the service URL
  97                                 $req['url'] = $this->params['url'] . $req['url'];
  98                         }
  99
 100                         // set the appropriate proxy, timeout and headers
 101                         if ( $this->params['HTTPProxy'] ) {
 102                                 $req['proxy'] = $this->params['HTTPProxy'];
 103                         }
 104                         if ( $this->params['timeout'] != null ) {
 105                                 $req['reqTimeout'] = $this->params['timeout'];
 106                         }
 107                         if ( $this->params['forwardCookies'] ) {
 108                                 $req['headers']['Cookie'] = $this->params['forwardCookies'];
 109                         }
 110                         $result[$key] = $req;
 111                 }
 112
 113                 return $result;
 114         }
 115
 116         /**
 117          * Remaps Parsoid v1/v3 requests to RESTBase v1 requests.
 118          */
 119         public function onParsoidRequests( array $reqs, Closure $idGeneratorFunc ) {
 120
 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         }
 136
 137         /**
 138          * Remap a Parsoid v1 request to a RESTBase v1 request.
 139          *
 140          * Example Parsoid v1 requests:
 141          *  GET /local/v1/page/$title/html/$oldid
 142          *   * $oldid is optional
 143          *  POST /local/v1/transform/html/to/wikitext/$title/$oldid
 144          *   * body: array( 'html' => ... )
 145          *   * $title and $oldid are optional
 146          *  POST /local/v1/transform/wikitext/to/html/$title
 147          *   * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body' => true/false )
 148          *   * $title is optional
 149          *
 150          * NOTE: the POST APIs aren't "real" Parsoid v1 APIs, they are just what
 151          * Visual Editor "pretends" the V1 API is like.  (See
 152          * ParsoidVirtualRESTService.)
 153          */
 154         public function onParsoid1Request( array $req, Closure $idGeneratorFunc ) {
 155                 $parts = explode( '/', $req['url'] );
 156                 list(
 157                         $targetWiki, // 'local'
 158                         $version, // 'v1'
 159                         $reqType // 'page' or 'transform'
 160                 ) = $parts;
 161                 if ( $targetWiki !== 'local' ) {
 162                         throw new Exception( "Only 'local' target wiki is currently supported" );
 163                 } elseif ( $version !== 'v1' ) {
 164                         throw new Exception( "Version mismatch: should not happen." );
 165                 } elseif ( $reqType !== 'page' && $reqType !== 'transform' ) {
 166                         throw new Exception( "Request type must be either 'page' or 'transform'" );
 167                 }
 168                 $req['url'] = $this->params['url'] . $this->params['domain'] . '/v1/' . $reqType . '/';
 169                 if ( $reqType === 'page' ) {
 170                         $title = $parts[3];
 171                         if ( $parts[4] !== 'html' ) {
 172                                 throw new Exception( "Only 'html' output format is currently supported" );
 173                         }
 174                         $req['url'] .= 'html/' . $title;
 175                         if ( isset( $parts[5] ) ) {
 176                                 $req['url'] .= '/' . $parts[5];
 177                         } elseif ( isset( $req['query']['oldid'] ) && $req['query']['oldid'] ) {
 178                                 $req['url'] .= '/' . $req['query']['oldid'];
 179                                 unset( $req['query']['oldid'] );
 180                         }
 181                 } elseif ( $reqType === 'transform' ) {
 182                         // from / to transform
 183                         $req['url'] .= $parts[3] . '/to/' . $parts[5];
 184                         // the title
 185                         if ( isset( $parts[6] ) ) {
 186                                 $req['url'] .= '/' . $parts[6];
 187                         }
 188                         // revision id
 189                         if ( isset( $parts[7] ) ) {
 190                                 $req['url'] .= '/' . $parts[7];
 191                         } elseif ( isset( $req['body']['oldid'] ) && $req['body']['oldid'] ) {
 192                                 $req['url'] .= '/' . $req['body']['oldid'];
 193                                 unset( $req['body']['oldid'] );
 194                         }
 195                         if ( $parts[4] !== 'to' ) {
 196                                 throw new Exception( "Part index 4 is not 'to'" );
 197                         }
 198                         if ( $parts[3] === 'html' && $parts[5] === 'wikitext' ) {
 199                                 if ( !isset( $req['body']['html'] ) ) {
 200                                         throw new Exception( "You must set an 'html' body key for this request" );
 201                                 }
 202                         } elseif ( $parts[3] == 'wikitext' && $parts[5] == 'html' ) {
 203                                 if ( !isset( $req['body']['wikitext'] ) ) {
 204                                         throw new Exception( "You must set a 'wikitext' body key for this request" );
 205                                 }
 206                                 if ( isset( $req['body']['body'] ) ) {
 207                                         $req['body']['body_only'] = $req['body']['body'];
 208                                         unset( $req['body']['body'] );
 209                                 }
 210                         } else {
 211                                 throw new Exception( "Transformation unsupported" );
 212                         }
 213                 }
 214                 // set the appropriate proxy, timeout and headers
 215                 if ( $this->params['HTTPProxy'] ) {
 216                         $req['proxy'] = $this->params['HTTPProxy'];
 217                 }
 218                 if ( $this->params['timeout'] != null ) {
 219                         $req['reqTimeout'] = $this->params['timeout'];
 220                 }
 221                 if ( $this->params['forwardCookies'] ) {
 222                         $req['headers']['Cookie'] = $this->params['forwardCookies'];
 223                 }
 224
 225                 return $req;
 226
 227         }
 228
 229         /**
 230          * Remap a Parsoid v3 request to a RESTBase v1 request.
 231          *
 232          * Example Parsoid v3 requests:
 233          *  GET /local/v3/page/html/$title/{$revision}
 234          *   * $revision is optional
 235          *  POST /local/v3/transform/html/to/wikitext/{$title}{/$revision}
 236          *   * body: array( 'html' => ... )
 237          *   * $title and $revision are optional
 238          *  POST /local/v3/transform/wikitext/to/html/{$title}{/$revision}
 239          *   * body: array( 'wikitext' => ... ) or array( 'wikitext' => ..., 'body_only' => true/false )
 240          *   * $title is optional
 241          *   * $revision is optional
 242          */
 243         public function onParsoid3Request( array $req, Closure $idGeneratorFunc ) {
 244
 245                 $parts = explode( '/', $req['url'] );
 246                 list(
 247                         $targetWiki, // 'local'
 248                         $version, // 'v3'
 249                         $action, // 'transform' or 'page'
 250                         $format, // 'html' or 'wikitext'
 251                         // $title, // optional
 252                         // $revision, // optional
 253                 ) = $parts;
 254                 if ( $targetWiki !== 'local' ) {
 255                         throw new Exception( "Only 'local' target wiki is currently supported" );
 256                 } elseif ( $version !== 'v3' ) {
 257                         throw new Exception( "Version mismatch: should not happen." );
 258                 }
 259                 // replace /local/ with the current domain, change v3 to v1,
 260                 $req['url'] = preg_replace( '#^local/v3/#', $this->params['domain'] . '/v1/', $req['url'] );
 261                 // and prefix it with the service URL
 262                 $req['url'] = $this->params['url'] . $req['url'];
 263                 // set the appropriate proxy, timeout and headers
 264                 if ( $this->params['HTTPProxy'] ) {
 265                         $req['proxy'] = $this->params['HTTPProxy'];
 266                 }
 267                 if ( $this->params['timeout'] != null ) {
 268                         $req['reqTimeout'] = $this->params['timeout'];
 269                 }
 270                 if ( $this->params['forwardCookies'] ) {
 271                         $req['headers']['Cookie'] = $this->params['forwardCookies'];
 272                 }
 273
 274                 return $req;
 275
 276         }
 277
 278 }