wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-09-24 18:58:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Factor out API deflation and change storeInSerializationCache API

Browse source 
Change-Id: I7e2e15a8ba5088e6c370cb035c71f7af18c13b61
This commit is contained in:
Ed Sanders 2016-08-09 15:36:43 -07:00
parent c813e5e5a2
commit f1482627fa
2 changed files with 39 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
ApiVisualEditor.php
View file

@ -123,24 +123,22 @@ class ApiVisualEditor extends ApiBase {
return $response['body'];
}
protected function storeInSerializationCache( $title, $oldid, $html, $etag ) {
protected function storeInSerializationCache( $title, $wikitext ) {
global $wgMemc;
// Convert the VE HTML to wikitext
$text = $this->postHTML( $title, $html, [ 'oldid' => $oldid ], $etag );
if ( $text === false ) {
if ( $wikitext === false ) {
return false;
}
// Store the corresponding wikitext, referenceable by a new key
$hash = md5( $text );
$hash = md5( $wikitext );
$key = wfMemcKey( 'visualeditor', 'serialization', $hash );
$wgMemc->set( $key, $text,
$wgMemc->set( $key, $wikitext,
$this->veConfig->get( 'VisualEditorSerializationCacheTimeout' ) );
// Also parse and prepare the edit in case it might be saved later
$page = WikiPage::factory( $title );
$content = ContentHandler::makeContent( $text, $title, CONTENT_MODEL_WIKITEXT );
$content = ContentHandler::makeContent( $wikitext, $title, CONTENT_MODEL_WIKITEXT );
$status = ApiStashEdit::parseAndStash( $page, $content, $this->getUser(), '' );
if ( $status === ApiStashEdit::ERROR_NONE ) {
@ -167,7 +165,7 @@ class ApiVisualEditor extends ApiBase {
$path .= '/' . $parserParams['oldid'];
}
if ( !is_string( $etag ) || $etag === '' ) {
wfDebugLog( 'AdHocDebug', 'VisualEditr T135171 - bad etag: ' . var_export( $etag, true ) );
wfDebugLog( 'AdHocDebug', 'VisualEditor T135171 - bad etag: ' . var_export( $etag, true ) );
}
return $this->requestRestbase(
'POST',
@ -285,6 +283,20 @@ class ApiVisualEditor extends ApiBase {
return $langlinks;
}
protected function tryDeflate( $content ) {
if ( substr( $content, 0, 11 ) === 'rawdeflate,' ) {
$deflated = base64_decode( substr( $content, 11 ) );
wfSuppressWarnings();
$inflated = gzinflate( $deflated );
wfRestoreWarnings();
if ( $deflated === $inflated || $inflated === false ) {
$this->dieUsage( "Content provided is not properly deflated", 'invaliddeflate' );
}
return $inflated;
}
return $content;
}
public function execute() {
$user = $this->getUser();
$params = $this->extractRequestParams();
@ -305,17 +317,6 @@ class ApiVisualEditor extends ApiBase {
$parserParams['oldid'] = $params['oldid'];
}
$html = $params['html'];
if ( substr( $html, 0, 11 ) === 'rawdeflate,' ) {
$deflated = base64_decode( substr( $html, 11 ) );
wfSuppressWarnings();
$html = gzinflate( $deflated );
wfRestoreWarnings();
if ( $deflated === $html || $html === false ) {
$this->dieUsage( "HTML provided is not properly deflated", 'invaliddeflate' );
}
}
wfDebugLog( 'visualeditor', "called on '$title' with paction: '{$params['paction']}'" );
switch ( $params['paction'] ) {
case 'parse':
@ -582,7 +583,9 @@ class ApiVisualEditor extends ApiBase {
if ( $params['html'] === null ) {
$this->dieUsageMsg( 'missingparam', 'html' );
}
$content = $this->postHTML( $title, $html, $parserParams, $params['etag'] );
$content = $this->postHTML(
$title, $this->tryDeflate( $params['html'] ), $parserParams, $params['etag']
);
if ( $content === false ) {
$this->dieUsage( 'Error contacting the document server', 'docserver' );
}
@ -597,7 +600,12 @@ class ApiVisualEditor extends ApiBase {
$this->dieUsage( 'No cached serialization found with that key', 'badcachekey' );
}
} else {
$wikitext = $this->postHTML( $title, $html, $parserParams, $params['etag'] );
if ( $params['html'] === null ) {
$this->dieUsageMsg( 'missingparam', 'html' );
}
$wikitext = $this->postHTML(
$title, $this->tryDeflate( $params['html'] ), $parserParams, $params['etag']
);
if ( $wikitext === false ) {
$this->dieUsage( 'Error contacting the document server', 'docserver' );
}
@ -615,11 +623,15 @@ class ApiVisualEditor extends ApiBase {
if ( !isset( $parserParams['oldid'] ) ) {
$parserParams['oldid'] = Revision::newFromTitle( $title )->getId();
}
if ( $params['html'] === null ) {
$this->dieUsageMsg( 'missingparam', 'html' );
}
$wikitext = $this->postHTML(
$title, $this->tryDeflate( $params['html'] ), $parserParams, $params['etag']
);
$key = $this->storeInSerializationCache(
$title,
$parserParams['oldid'],
$html,
$params['etag']
$wikitext
);
$result = [ 'result' => 'success', 'cachekey' => $key ];
break;

9
ApiVisualEditorEdit.php
View file

@ -134,18 +134,15 @@ class ApiVisualEditorEdit extends ApiVisualEditor {
$parserParams['oldid'] = $params['oldid'];
}
$html = $params['html'];
if ( substr( $html, 0, 11 ) === 'rawdeflate,' ) {
$html = gzinflate( base64_decode( substr( $html, 11 ) ) );
}
if ( $params['cachekey'] !== null ) {
$wikitext = $this->trySerializationCache( $params['cachekey'] );
if ( !is_string( $wikitext ) ) {
$this->dieUsage( 'No cached serialization found with that key', 'badcachekey' );
}
} else {
$wikitext = $this->postHTML( $title, $html, $parserParams, $params['etag'] );
$wikitext = $this->postHTML(
$title, $this->tryDeflate( $params['html'] ), $parserParams, $params['etag']
);
if ( $wikitext === false ) {
$this->dieUsage( 'Error contacting the Parsoid/RESTbase server', 'docserver' );
}