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