-
Benachrichtigungen
You must be signed in to change notification settings - Fork 1.4k
/
HtmlInputTransformHelper.php
749 lines (670 loc) · 23.8 KB
/
HtmlInputTransformHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Rest\Handler\Helper;
use InvalidArgumentException;
use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
use MediaWiki\Content\Content;
use MediaWiki\Edit\ParsoidOutputStash;
use MediaWiki\Edit\ParsoidRenderID;
use MediaWiki\Edit\SelserContext;
use MediaWiki\Language\LanguageCode;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageLookup;
use MediaWiki\Page\PageRecord;
use MediaWiki\Page\ParserOutputAccess;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\Parsoid\HtmlToContentTransform;
use MediaWiki\Parser\Parsoid\HtmlTransformFactory;
use MediaWiki\Parser\Parsoid\PageBundleParserOutputConverter;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\HttpException;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\ResponseInterface;
use MediaWiki\Revision\RevisionAccessException;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Status\Status;
use MWUnknownContentModelException;
use ParserOptions;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Parsoid\Core\ClientError;
use Wikimedia\Parsoid\Core\PageBundle;
use Wikimedia\Parsoid\Core\ResourceLimitExceededException;
use Wikimedia\Parsoid\Parsoid;
/**
* REST helper for converting HTML to page content source (e.g. wikitext).
*
* @since 1.40
*
* @unstable Pending consolidation of the Parsoid extension with core code.
*/
class HtmlInputTransformHelper {
/**
* @internal
* @var string[]
*/
public const CONSTRUCTOR_OPTIONS = [
MainConfigNames::ParsoidCacheConfig
];
/** @var PageIdentity|null */
private $page = null;
/**
* @var HtmlToContentTransform
*/
private $transform;
/**
* @var array
*/
private $envOptions;
private StatsdDataFactoryInterface $stats;
private HtmlTransformFactory $htmlTransformFactory;
private ParsoidOutputStash $parsoidOutputStash;
private ParserOutputAccess $parserOutputAccess;
private PageLookup $pageLookup;
private RevisionLookup $revisionLookup;
/**
* @param StatsdDataFactoryInterface $statsDataFactory
* @param HtmlTransformFactory $htmlTransformFactory
* @param ParsoidOutputStash $parsoidOutputStash
* @param ParserOutputAccess $parserOutputAccess
* @param PageLookup $pageLookup
* @param RevisionLookup $revisionLookup
* @param array $envOptions
* @param ?PageIdentity $page
* @param array|string $body Body structure, or an HTML string
* @param array $parameters
* @param RevisionRecord|null $originalRevision
* @param Bcp47Code|null $pageLanguage
*/
public function __construct(
StatsdDataFactoryInterface $statsDataFactory,
HtmlTransformFactory $htmlTransformFactory,
ParsoidOutputStash $parsoidOutputStash,
ParserOutputAccess $parserOutputAccess,
PageLookup $pageLookup,
RevisionLookup $revisionLookup,
array $envOptions = [],
?PageIdentity $page = null,
$body = '',
array $parameters = [],
?RevisionRecord $originalRevision = null,
?Bcp47Code $pageLanguage = null
) {
$this->stats = $statsDataFactory;
$this->htmlTransformFactory = $htmlTransformFactory;
$this->parsoidOutputStash = $parsoidOutputStash;
$this->envOptions = $envOptions + [
'outputContentVersion' => Parsoid::defaultHTMLVersion(),
'offsetType' => 'byte',
];
$this->parserOutputAccess = $parserOutputAccess;
$this->pageLookup = $pageLookup;
$this->revisionLookup = $revisionLookup;
if ( $page === null ) {
wfDeprecated( __METHOD__ . ' without $page', '1.43' );
} else {
$this->initInternal( $page, $body, $parameters, $originalRevision, $pageLanguage );
}
}
/**
* @return array
*/
public function getParamSettings(): array {
// JSON body schema:
/*
doc:
properties:
headers:
type: array
items:
type: string
body:
type: [ string, object ]
required: [ body ]
body:
properties:
offsetType:
type: string
revid:
type: integer
renderid:
type: string
etag:
type: string
html:
type: [ doc, string ]
data-mw:
type: doc
original:
properties:
html:
type: doc
source:
type: doc
data-mw:
type: doc
data-parsoid:
type: doc
required: [ html ]
*/
// FUTURE: more params
// - slot (for loading the base content)
return [
// XXX: should we really declare this here? Or should end endpoint do this?
// We are not reading this property...
'title' => [
Handler::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
ParamValidator::PARAM_REQUIRED => false,
],
// XXX: Needed for compatibility with the parsoid transform endpoint.
// But revid should just be part of the info about the original data
// in the body.
'oldid' => [
Handler::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'int',
ParamValidator::PARAM_DEFAULT => 0,
ParamValidator::PARAM_REQUIRED => false,
],
// XXX: Supported for compatibility with the parsoid transform endpoint.
// If given, it should be 'html' or 'pagebundle'.
'from' => [
Handler::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
ParamValidator::PARAM_REQUIRED => false,
],
// XXX: Supported for compatibility with the parsoid transform endpoint.
// Ignored.
'format' => [
Handler::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
ParamValidator::PARAM_REQUIRED => false,
],
'contentmodel' => [ // XXX: get this from the Accept header?
Handler::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
ParamValidator::PARAM_REQUIRED => false,
],
'language' => [ // TODO: get this from Accept-Language header?!
Handler::PARAM_SOURCE => 'query',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
ParamValidator::PARAM_REQUIRED => false,
]
];
}
/**
* Modify body and parameters to provide compatibility with legacy endpoints.
*
* @see ParsoidHandler::getRequestAttributes
*
* @param array<string,mixed> &$body
* @param array<string,mixed> &$parameters
*
* @throws HttpException
*
* @return void
*/
private static function normalizeParameters( array &$body, array &$parameters ) {
// If the revision ID is given in the path, pretend it was given in the body.
if ( isset( $parameters['oldid'] ) && (int)$parameters['oldid'] > 0 ) {
$body['original']['revid'] = (int)$parameters['oldid'];
}
// If an etag is given in the body, use it as the render ID.
// Note that we support ETag format in the renderid field.
if ( !empty( $body['original']['etag'] ) ) {
// @phan-suppress-next-line PhanTypeInvalidDimOffset false positive
$body['original']['renderid'] = $body['original']['etag'];
}
// Accept 'wikitext' as an alias for 'source'.
if ( isset( $body['original']['wikitext'] ) ) {
// @phan-suppress-next-line PhanTypeInvalidDimOffset false positive
$body['original']['source'] = $body['original']['wikitext'];
unset( $body['original']['wikitext'] );
}
// If 'from' is not set, we accept page bundle style input as well as full HTML.
// If 'from' is set, we only accept page bundle style input if it is set to FORMAT_PAGEBUNDLE.
if (
isset( $parameters['from'] ) && $parameters['from'] !== '' &&
$parameters['from'] !== ParsoidFormatHelper::FORMAT_PAGEBUNDLE
) {
unset( $body['original']['data-parsoid']['body'] );
unset( $body['original']['data-mw']['body'] );
unset( $body['data-mw']['body'] );
}
// If 'from' is given, it must be html or pagebundle.
if (
isset( $parameters['from'] ) && $parameters['from'] !== '' &&
$parameters['from'] !== ParsoidFormatHelper::FORMAT_HTML &&
$parameters['from'] !== ParsoidFormatHelper::FORMAT_PAGEBUNDLE
) {
throw new LocalizedHttpException(
new MessageValue( "rest-unsupported-transform-input", [ $parameters['from'] ] ), 400
);
}
if ( isset( $body['contentmodel'] ) && $body['contentmodel'] !== '' ) {
$parameters['contentmodel'] = $body['contentmodel'];
} elseif ( isset( $parameters['format'] ) && $parameters['format'] !== '' ) {
$parameters['contentmodel'] = $parameters['format'];
}
}
/**
* @param PageIdentity $page
* @param array|string $body Body structure, or an HTML string
* @param array $parameters
* @param RevisionRecord|null $originalRevision
* @param Bcp47Code|null $pageLanguage
*
* @throws HttpException
* @deprecated since 1.43; pass arguments to constructor instead
*/
public function init(
PageIdentity $page,
$body,
array $parameters,
?RevisionRecord $originalRevision = null,
?Bcp47Code $pageLanguage = null
) {
wfDeprecated( __METHOD__, '1.43' );
$this->initInternal( $page, $body, $parameters, $originalRevision, $pageLanguage );
}
/**
* @param PageIdentity $page
* @param array|string $body Body structure, or an HTML string
* @param array $parameters
* @param RevisionRecord|null $originalRevision
* @param Bcp47Code|null $pageLanguage
*
* @throws HttpException
*/
private function initInternal(
PageIdentity $page,
$body,
array $parameters,
?RevisionRecord $originalRevision = null,
?Bcp47Code $pageLanguage = null
) {
if ( is_string( $body ) ) {
$body = [ 'html' => $body ];
}
self::normalizeParameters( $body, $parameters );
$this->page = $page;
if ( !isset( $body['html'] ) ) {
throw new LocalizedHttpException( new MessageValue( "rest-missing-body-field", [ 'html' ] ) );
}
$html = is_array( $body['html'] ) ? $body['html']['body'] : $body['html'];
// TODO: validate $body against a proper schema.
$this->transform = $this->htmlTransformFactory->getHtmlToContentTransform(
$html,
$this->page
);
$this->transform->setMetrics( $this->stats );
// NOTE: Env::getContentModel will fall back to the page's recorded content model
// if none is set here.
$this->transform->setOptions( [
'contentmodel' => $parameters['contentmodel'] ?? null,
'offsetType' => $body['offsetType'] ?? $this->envOptions['offsetType'],
] );
$original = $body['original'] ?? [];
$originalRendering = null;
if ( !isset( $original['html'] ) && !empty( $original['renderid'] ) ) {
$key = $original['renderid'];
if ( preg_match( '!^(W/)?".*"$!', $key ) ) {
$originalRendering = ParsoidRenderID::newFromETag( $key );
if ( !$originalRendering ) {
throw new LocalizedHttpException( new MessageValue( "rest-bad-etag", [ $key ] ), 400 );
}
} else {
$originalRendering = ParsoidRenderID::newFromKey( $key );
}
} elseif ( !empty( $original['html'] ) || !empty( $original['data-parsoid'] ) ) {
// NOTE: We might have an incomplete PageBundle here, with no HTML but with data-parsoid!
// XXX: Do we need to support that, or can that just be a 400?
$originalRendering = new PageBundle(
$original['html']['body'] ?? '',
$original['data-parsoid']['body'] ?? null,
$original['data-mw']['body'] ?? null,
null, // will be derived from $original['html']['headers']['content-type']
$original['html']['headers'] ?? []
);
}
if ( !$originalRevision && !empty( $original['revid'] ) ) {
$originalRevision = (int)$original['revid'];
}
if ( $originalRevision || $originalRendering ) {
$this->setOriginal( $originalRevision, $originalRendering );
} else {
if ( $this->page->exists() ) {
$this->stats->increment( 'html_input_transform.original_html.not_given.page_exists' );
} else {
$this->stats->increment( 'html_input_transform.original_html.not_given.page_not_exist' );
}
}
if ( isset( $body['data-mw']['body'] ) ) {
$this->transform->setModifiedDataMW( $body['data-mw']['body'] );
}
if ( $pageLanguage ) {
$this->transform->setContentLanguage( $pageLanguage );
} elseif ( isset( $parameters['language'] ) && $parameters['language'] !== '' ) {
$pageLanguage = LanguageCode::normalizeNonstandardCodeAndWarn(
$parameters['language']
);
$this->transform->setContentLanguage( $pageLanguage );
}
if ( isset( $original['source']['body'] ) ) {
// XXX: do we really have to support wikitext overrides?
$this->transform->setOriginalText( $original['source']['body'] );
}
}
/**
* Return HTMLTransform object, so additional context can be provided by calling setters on it.
* @return HtmlToContentTransform
*/
public function getTransform(): HtmlToContentTransform {
return $this->transform;
}
/**
* Set metrics sink.
*
* @param StatsdDataFactoryInterface $stats
*/
public function setMetrics( StatsdDataFactoryInterface $stats ) {
$this->stats = $stats;
if ( $this->transform ) {
$this->transform->setMetrics( $stats );
}
}
/**
* Supply information about the revision and rendering that was the original basis of
* the input HTML. This is used to apply selective serialization (selser), if possible.
*
* @param RevisionRecord|int|null $rev
* @param ParsoidRenderID|PageBundle|ParserOutput|null $originalRendering
*/
public function setOriginal( $rev, $originalRendering ) {
if ( $originalRendering instanceof ParsoidRenderID ) {
$renderId = $originalRendering;
// If the client asked for a render ID, load original data from stash
try {
$selserContext = $this->fetchSelserContextFromStash( $renderId );
} catch ( InvalidArgumentException $ex ) {
$this->stats->increment( 'html_input_transform.original_html.given.as_renderid.bad' );
throw new LocalizedHttpException( new MessageValue( "rest-bad-stash-key" ),
400,
[
'reason' => $ex->getMessage(),
'key' => "$renderId"
]
);
}
if ( !$selserContext ) {
// NOTE: When the client asked for a specific stash key (resp. etag),
// we should fail with a 412 if we don't have the specific rendering.
// On the other hand, of the client only provided a base revision ID,
// we can re-parse and hope for the best.
throw new LocalizedHttpException(
new MessageValue( "rest-no-stashed-content", [ $renderId->getKey() ] ), 412
);
// TODO: This class should provide getETag and getLastModified methods for use by
// the REST endpoint, to provide proper support for conditionals.
// However, that requires some refactoring of how HTTP conditional checks
// work in the Handler base class.
}
if ( !$rev ) {
$rev = $renderId->getRevisionID();
}
$originalRendering = $selserContext->getPageBundle();
$content = $selserContext->getContent();
if ( $content ) {
$this->transform->setOriginalContent( $content );
}
} elseif ( !$originalRendering && $rev ) {
// The client provided a revision ID, but not stash key.
// Try to get a rendering for the given revision, and use it as the basis for selser.
// Chances are good that the resulting diff will be reasonably clean.
// NOTE: If we don't have a revision ID, we should not attempt selser!
$originalRendering = $this->fetchParserOutputFromParsoid( $this->page, $rev, true );
if ( $originalRendering ) {
$this->stats->increment( 'html_input_transform.original_html.given.as_revid.found' );
} else {
$this->stats->increment( 'html_input_transform.original_html.given.as_revid.not_found' );
}
} elseif ( $originalRendering ) {
$this->stats->increment( 'html_input_transform.original_html.given.verbatim' );
}
if ( $originalRendering instanceof ParserOutput ) {
$originalRendering = PageBundleParserOutputConverter::pageBundleFromParserOutput( $originalRendering );
// NOTE: Use the default if we got a ParserOutput object.
// Don't apply the default if we got passed a PageBundle,
// in that case, we want to require the version to be explicit.
if ( $originalRendering->version === null && !isset( $originalRendering->headers['content-type'] ) ) {
$originalRendering->version = Parsoid::defaultHTMLVersion();
}
}
if ( !$originalRendering instanceof PageBundle ) {
return;
}
if ( $originalRendering->version !== null ) {
$this->transform->setOriginalSchemaVersion( $originalRendering->version );
} elseif ( !empty( $originalRendering->headers['content-type'] ) ) {
$vOriginal = ParsoidFormatHelper::parseContentTypeHeader(
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable Silly Phan, we just checked.
$originalRendering->headers['content-type']
);
if ( $vOriginal ) {
$this->transform->setOriginalSchemaVersion( $vOriginal );
}
}
if ( $rev instanceof RevisionRecord ) {
$this->transform->setOriginalRevision( $rev );
} elseif ( $rev && is_int( $rev ) ) {
$this->transform->setOriginalRevisionId( $rev );
}
// NOTE: We might have an incomplete PageBundle here, with no HTML.
// PageBundle::$html is declared to not be nullable, so it would be set to the empty
// string if not given. Note however that it might also be null, since it's a public field.
if ( $originalRendering->html !== null && $originalRendering->html !== '' ) {
$this->transform->setOriginalHtml( $originalRendering->html );
}
if ( $originalRendering->parsoid !== null ) {
$this->transform->setOriginalDataParsoid( $originalRendering->parsoid );
}
if ( $originalRendering->mw !== null ) {
$this->transform->setOriginalDataMW( $originalRendering->mw );
}
}
/**
* @return Content the content derived from the input HTML.
* @throws HttpException
*/
public function getContent(): Content {
try {
return $this->transform->htmlToContent();
} catch ( ClientError $e ) {
throw new LocalizedHttpException(
new MessageValue( 'rest-html-backend-error', [ $e->getMessage() ] ),
400,
[ 'reason' => $e->getMessage() ]
);
} catch ( ResourceLimitExceededException $e ) {
throw new LocalizedHttpException(
new MessageValue( 'rest-resource-limit-exceeded' ),
413,
[ 'reason' => $e->getMessage() ]
);
} catch ( MWUnknownContentModelException $e ) {
throw new LocalizedHttpException(
new MessageValue( "rest-unknown-content-model", [ $e->getModelId() ] ),
400
);
}
}
/**
* Creates a response containing the content derived from the input HTML.
* This will set the appropriate Content-Type header.
*
* @param ResponseInterface $response
*/
public function putContent( ResponseInterface $response ) {
$content = $this->getContent();
$data = $content->serialize();
try {
$contentType = ParsoidFormatHelper::getContentType(
$content->getModel(),
$this->envOptions['outputContentVersion']
);
} catch ( InvalidArgumentException $e ) {
// If Parsoid doesn't know the content type,
// ask the ContentHandler!
$contentType = $content->getDefaultFormat();
}
$response->setHeader( 'Content-Type', $contentType );
$response->getBody()->write( $data );
}
/**
* @param PageIdentity $page
* @param RevisionRecord|int $revision
* @param bool $mayParse
*
* @return ParserOutput|null
* @throws HttpException
*/
private function fetchParserOutputFromParsoid( PageIdentity $page, $revision, bool $mayParse ): ?ParserOutput {
$parserOptions = ParserOptions::newFromAnon();
$parserOptions->setUseParsoid();
try {
if ( !$page instanceof PageRecord ) {
$name = "$page";
$page = $this->pageLookup->getPageByReference( $page );
if ( !$page ) {
throw new RevisionAccessException( 'Page {name} not found',
[ 'name' => $name ] );
}
}
if ( is_int( $revision ) ) {
$revId = $revision;
$revision = $this->revisionLookup->getRevisionById( $revId, 0, $page );
if ( !$revision ) {
throw new RevisionAccessException( 'Revision {revId} not found',
[ 'revId' => $revId ] );
}
}
if ( $page->getId() !== $revision->getPageId() ) {
throw new RevisionAccessException( 'Revision {revId} does not belong to page {name}',
[ 'name' => $page->getDBkey(),
'revId' => $revision->getId() ] );
}
if ( $mayParse ) {
try {
$status = $this->parserOutputAccess->getParserOutput(
$page, $parserOptions, $revision
);
} catch ( ClientError $e ) {
$status = Status::newFatal( 'parsoid-client-error', $e->getMessage() );
} catch ( ResourceLimitExceededException $e ) {
$status = Status::newFatal( 'parsoid-resource-limit-exceeded', $e->getMessage() );
}
if ( !$status->isOK() ) {
$this->throwHttpExceptionForStatus( $status );
}
$parserOutput = $status->getValue();
} else {
$parserOutput = $this->parserOutputAccess->getCachedParserOutput(
$page, $parserOptions, $revision
);
}
} catch ( RevisionAccessException $e ) {
// The client supplied bad revision ID, or the revision was deleted or suppressed.
throw new LocalizedHttpException( new MessageValue( "rest-specified-revision-unavailable" ),
404,
[ 'reason' => $e->getMessage() ]
);
}
return $parserOutput;
}
/**
* @param ParsoidRenderID $renderID
*
* @return SelserContext|null
*/
private function fetchSelserContextFromStash( $renderID ): ?SelserContext {
$selserContext = $this->parsoidOutputStash->get( $renderID );
if ( $selserContext ) {
$this->stats->increment( 'html_input_transform.original_html.given.as_renderid.' .
'stash_hit.found.hit' );
return $selserContext;
} else {
// Looks like the rendering is gone from stash (or the client send us a bogus key).
// Try to load it from the parser cache instead.
// On a wiki with low edit frequency, there is a good chance that it's still there.
try {
$parserOutput = $this->fetchParserOutputFromParsoid( $this->page, $renderID->getRevisionID(), false );
if ( !$parserOutput ) {
$this->stats->increment( 'html_input_transform.original_html.given.as_renderid.' .
'stash_miss_pc_fallback.not_found.miss' );
return null;
}
$cachedRenderID = ParsoidRenderID::newFromParserOutput( $parserOutput );
if ( $cachedRenderID->getKey() !== $renderID->getKey() ) {
$this->stats->increment( 'html_input_transform.original_html.given.as_renderid.' .
'stash_miss_pc_fallback.not_found.mismatch' );
// It's not the correct rendering.
return null;
}
$this->stats->increment( 'html_input_transform.original_html.given.as_renderid.' .
'stash_miss_pc_fallback.found.hit' );
$pb = PageBundleParserOutputConverter::pageBundleFromParserOutput( $parserOutput );
return new SelserContext( $pb, $renderID->getRevisionID() );
} catch ( HttpException $e ) {
$this->stats->increment( 'html_input_transform.original_html.given.as_renderid.' .
'stash_miss_pc_fallback.not_found.failed' );
// If the revision isn't found, don't trigger a 404. Return null to trigger a 412.
return null;
}
}
}
/**
* @param Status $status
*
* @return never
* @throws HttpException
*/
private function throwHttpExceptionForStatus( Status $status ) {
// TODO: make this nicer.
if ( $status->hasMessage( 'parsoid-resource-limit-exceeded' ) ) {
throw new LocalizedHttpException( new MessageValue( "rest-parsoid-resource-exceeded" ),
413,
[ 'reason' => $status->getHTML() ]
);
} else {
throw new LocalizedHttpException( new MessageValue( "rest-parsoid-error" ),
400,
[ 'reason' => $status->getHTML() ]
);
}
}
}