Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6008682
DirectParsoidClient.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
DirectParsoidClient.php
View Options
<?php
/**
* Helper functions for using the REST interface to Parsoid.
*
* @file
* @ingroup Extensions
* @copyright 2022 VisualEditor Team and others; see AUTHORS.txt
* @license MIT
*/
namespace
MediaWiki\Extension\VisualEditor
;
use
MediaWiki\Content\WikitextContent
;
use
MediaWiki\MediaWikiServices
;
use
MediaWiki\Page\PageIdentity
;
use
MediaWiki\Permissions\Authority
;
use
MediaWiki\Rest\Handler\Helper\HtmlInputTransformHelper
;
use
MediaWiki\Rest\Handler\Helper\HtmlOutputRendererHelper
;
use
MediaWiki\Rest\Handler\Helper\PageRestHelperFactory
;
use
MediaWiki\Revision\MutableRevisionRecord
;
use
MediaWiki\Revision\RevisionRecord
;
use
MediaWiki\Revision\SlotRecord
;
use
MediaWiki\User\User
;
use
Wikimedia\Bcp47Code\Bcp47Code
;
class
DirectParsoidClient
implements
ParsoidClient
{
/**
* Requested Parsoid HTML version.
* Keep this in sync with the Accept: header in
* ve.init.mw.ArticleTargetLoader.js
*/
public
const
PARSOID_VERSION
=
'2.8.0'
;
private
const
FLAVOR_DEFAULT
=
'view'
;
private
PageRestHelperFactory
$helperFactory
;
private
Authority
$performer
;
public
function
__construct
(
PageRestHelperFactory
$helperFactory
,
Authority
$performer
)
{
$this
->
performer
=
$performer
;
$this
->
helperFactory
=
$helperFactory
;
}
private
function
getHtmlOutputRendererHelper
(
PageIdentity
$page
,
?
RevisionRecord
$revision
=
null
,
?
Bcp47Code
$pageLanguage
=
null
,
bool
$stash
=
false
,
string
$flavor
=
self
::
FLAVOR_DEFAULT
):
HtmlOutputRendererHelper
{
// TODO: remove this once we no longer need a User object for rate limiting (T310476).
if
(
$this
->
performer
instanceof
User
)
{
$user
=
$this
->
performer
;
}
else
{
$user
=
User
::
newFromIdentity
(
$this
->
performer
->
getUser
()
);
}
$helper
=
$this
->
helperFactory
->
newHtmlOutputRendererHelper
(
$page
,
[],
$user
,
$revision
);
// Ensure we get a compatible version, not just the default
$helper
->
setOutputProfileVersion
(
self
::
PARSOID_VERSION
);
$helper
->
setStashingEnabled
(
$stash
);
if
(
!
$stash
)
{
$helper
->
setFlavor
(
$flavor
);
}
if
(
$revision
)
{
$helper
->
setRevision
(
$revision
);
}
if
(
$pageLanguage
)
{
$helper
->
setPageLanguage
(
$pageLanguage
);
}
return
$helper
;
}
private
function
getHtmlInputTransformHelper
(
PageIdentity
$page
,
string
$html
,
?
int
$oldid
=
null
,
?
string
$etag
=
null
,
?
Bcp47Code
$pageLanguage
=
null
):
HtmlInputTransformHelper
{
// Fake REST body
$body
=
[
'html'
=>
[
'body'
=>
$html
,
]
];
if
(
$oldid
||
$etag
)
{
$body
[
'original'
][
'revid'
]
=
$oldid
;
$body
[
'original'
][
'renderid'
]
=
$etag
;
}
$helper
=
$this
->
helperFactory
->
newHtmlInputTransformHelper
(
/* envOptions: */
[],
$page
,
$body
,
/* parameters: */
[],
/* originalRevision: */
null
,
$pageLanguage
);
$statsFactory
=
MediaWikiServices
::
getInstance
()->
getParsoidSiteConfig
()->
prefixedStatsFactory
();
$helper
->
setMetrics
(
$statsFactory
);
return
$helper
;
}
/**
* Request page HTML from Parsoid.
*
* @param RevisionRecord $revision Page revision
* @param ?Bcp47Code $targetLanguage Page language (default: `null`)
*
* @return array An array mimicking a RESTbase server's response, with keys: 'headers' and 'body'
* @phan-return array{body:string,headers:array<string,string>}
*/
public
function
getPageHtml
(
RevisionRecord
$revision
,
?
Bcp47Code
$targetLanguage
=
null
):
array
{
// In the VE client, we always want to stash.
$page
=
$revision
->
getPage
();
$helper
=
$this
->
getHtmlOutputRendererHelper
(
$page
,
$revision
,
$targetLanguage
,
true
);
$parserOutput
=
$helper
->
getHtml
();
return
$this
->
fakeRESTbaseHTMLResponse
(
$parserOutput
->
getRawText
(),
$helper
);
}
private
function
makeFakeRevision
(
PageIdentity
$page
,
string
$wikitext
):
RevisionRecord
{
$rev
=
new
MutableRevisionRecord
(
$page
);
$rev
->
setId
(
0
);
$rev
->
setPageId
(
$page
->
getId
()
);
$rev
->
setContent
(
SlotRecord
::
MAIN
,
new
WikitextContent
(
$wikitext
)
);
return
$rev
;
}
/**
* Transform wikitext to HTML with Parsoid.
*
* @param PageIdentity $page The page the content belongs to use as the parsing context
* @param Bcp47Code $targetLanguage Page language
* @param string $wikitext The wikitext fragment to parse
* @param bool $bodyOnly Whether to provide only the contents of the `<body>` tag
* @param int|null $oldid What oldid revision, if any, to base the request from (default: `null`)
* @param bool $stash Whether to stash the result in the server-side cache (default: `false`)
*
* @return array An array mimicking a RESTbase server's response, with keys: 'headers' and 'body'
* @phan-return array{body:string,headers:array<string,string>}
*/
public
function
transformWikitext
(
PageIdentity
$page
,
Bcp47Code
$targetLanguage
,
string
$wikitext
,
bool
$bodyOnly
,
?
int
$oldid
,
bool
$stash
):
array
{
$revision
=
$this
->
makeFakeRevision
(
$page
,
$wikitext
);
$helper
=
$this
->
getHtmlOutputRendererHelper
(
$page
,
$revision
,
$targetLanguage
,
$stash
);
if
(
$bodyOnly
)
{
$helper
->
setFlavor
(
'fragment'
);
}
$parserOutput
=
$helper
->
getHtml
();
$html
=
$parserOutput
->
getRawText
();
return
$this
->
fakeRESTbaseHTMLResponse
(
$html
,
$helper
);
}
/**
* Transform HTML to wikitext with Parsoid
*
* @param PageIdentity $page The page the content belongs to
* @param Bcp47Code $targetLanguage The desired output language
* @param string $html The HTML of the page to be transformed
* @param ?int $oldid What oldid revision, if any, to base the request from (default: `null`)
* @param ?string $etag The ETag to set in the HTTP request header
*
* @return array An array mimicking a RESTbase server's response, with keys: 'headers' and 'body'
* @phan-return array{body:string,headers:array<string,string>}
*/
public
function
transformHTML
(
PageIdentity
$page
,
Bcp47Code
$targetLanguage
,
string
$html
,
?
int
$oldid
,
?
string
$etag
):
array
{
$helper
=
$this
->
getHtmlInputTransformHelper
(
$page
,
$html
,
$oldid
,
$etag
,
$targetLanguage
);
$content
=
$helper
->
getContent
();
$format
=
$content
->
getDefaultFormat
();
return
[
'headers'
=>
[
'Content-Type'
=>
$format
,
],
'body'
=>
$content
->
serialize
(
$format
),
];
}
/**
* @param mixed $data
* @param HtmlOutputRendererHelper $helper
*
* @return array
*/
private
function
fakeRESTbaseHTMLResponse
(
$data
,
HtmlOutputRendererHelper
$helper
):
array
{
$contentLanguage
=
$helper
->
getHtmlOutputContentLanguage
();
return
[
'headers'
=>
[
'content-language'
=>
$contentLanguage
->
toBcp47Code
(),
'etag'
=>
$helper
->
getETag
()
],
'body'
=>
$data
,
];
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 4 2026, 09:12 (6 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
5e/f2/472ad433107dcece0b4569f64568
Default Alt Text
DirectParsoidClient.php (6 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment