4dd7bd16b5
This introduces the ParsoidOutputStash config setting, which defines the storage backend and cache duration. The storage backend name refers to an entry in the ObjectCache setting, and defaults to the main stash. Bug: T267990 Bug: T309016 Change-Id: Ic67dc43ed9843810e4b180127f9a3bb7608f7608
67 lines
1.7 KiB
PHP
67 lines
1.7 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Edit;
|
|
|
|
use BagOStuff;
|
|
use FormatJson;
|
|
use MediaWiki\Parser\Parsoid\PageBundleJsonTrait;
|
|
use MediaWiki\Parser\Parsoid\ParsoidRenderID;
|
|
use Wikimedia\Parsoid\Core\PageBundle;
|
|
|
|
/**
|
|
* @since 1.39
|
|
* @unstable since 1.39, should be stable before release.
|
|
*/
|
|
class SimpleParsoidOutputStash implements ParsoidOutputStash {
|
|
use PageBundleJsonTrait;
|
|
|
|
/** @var BagOStuff */
|
|
private $bagOfStuff;
|
|
|
|
/** @var int */
|
|
private $duration;
|
|
|
|
/**
|
|
* @param BagOStuff $bagOfStuff storage backend
|
|
* @param int $duration cache duration in seconds
|
|
*/
|
|
public function __construct( BagOStuff $bagOfStuff, int $duration ) {
|
|
$this->bagOfStuff = $bagOfStuff;
|
|
$this->duration = $duration;
|
|
}
|
|
|
|
/**
|
|
* Before we stash, we serialize & encode into JSON the relevant
|
|
* parts of the data we need to construct a page bundle in the future.
|
|
*
|
|
* @param ParsoidRenderId $renderId
|
|
* @param PageBundle $bundle
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function set( ParsoidRenderId $renderId, PageBundle $bundle ): bool {
|
|
$pageBundleJson = FormatJson::encode( $this->jsonSerializePageBundle( $bundle ) );
|
|
|
|
return $this->bagOfStuff->set( $renderId->getKey(), $pageBundleJson, $this->duration );
|
|
}
|
|
|
|
/**
|
|
* This will decode the JSON data and create a page bundle from it
|
|
* if we have something in the stash that matches a given rendering or
|
|
* will just return an empty array if no entry in the stash.
|
|
*
|
|
* @param ParsoidRenderId $renderId
|
|
*
|
|
* @return PageBundle|null
|
|
*/
|
|
public function get( ParsoidRenderId $renderId ): ?PageBundle {
|
|
$pageBundleArray = FormatJson::decode(
|
|
$this->bagOfStuff->get( $renderId->getKey() ),
|
|
true
|
|
) ?? [];
|
|
$pageBundle = $this->newPageBundleFromJson( $pageBundleArray );
|
|
|
|
return $pageBundle ?: null;
|
|
}
|
|
|
|
}
|