Introduce CommentFormatter
CommentParser:
* Move comment formatting backend from Linker to a CommentParser service.
Allow link existence and file existence to be batched.
* Rename $local to $samePage since I think that is clearer.
* Rename $title to $selfLinkTarget since it was unclear what the title
was used for.
* Rename the "autocomment" concept to "section link" in public
interfaces, although the old term remains in CSS classes.
* Keep unsafe HTML pass-through in separate "unsafe" methods, for easier
static analysis and code review.
CommentFormatter:
* Add CommentFormatter and RowCommentFormatter services as a usable
frontend for comment batches, and to replace the Linker static methods.
* Provide fluent and parametric interfaces.
Linker:
* Remove Linker::makeCommentLink() without deprecation -- nothing calls
it and it is obviously an internal helper.
* Soft-deprecate Linker methods formatComment(), formatLinksInComment(),
commentBlock() and revComment().
Caller migration:
* CommentFormatter single: Linker, RollbackAction, ApiComparePages,
ApiParse
* CommentFormatter parametric batch: ImageHistoryPseudoPager
* CommentFormatter fluent batch: ApiQueryFilearchive
* RowCommentFormatter sequential: History feed, BlocklistPager,
ProtectedPagesPager, ApiQueryProtectedTitles
* RowCommentFormatter with index: ChangesFeed, ChangesList,
ApiQueryDeletedrevs, ApiQueryLogEvents, ApiQueryRecentChanges
* RevisionCommentBatch: HistoryPager, ContribsPager
Bug: T285917
Change-Id: Ia3fd50a4a13138ba5003d884962da24746d562d0
2021-07-01 06:55:03 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
namespace MediaWiki\CommentFormatter;
|
|
|
|
|
|
|
|
|
|
use Language;
|
|
|
|
|
use MediaWiki\Cache\LinkBatchFactory;
|
2024-02-08 19:09:50 +00:00
|
|
|
use MediaWiki\Cache\LinkCache;
|
Introduce CommentFormatter
CommentParser:
* Move comment formatting backend from Linker to a CommentParser service.
Allow link existence and file existence to be batched.
* Rename $local to $samePage since I think that is clearer.
* Rename $title to $selfLinkTarget since it was unclear what the title
was used for.
* Rename the "autocomment" concept to "section link" in public
interfaces, although the old term remains in CSS classes.
* Keep unsafe HTML pass-through in separate "unsafe" methods, for easier
static analysis and code review.
CommentFormatter:
* Add CommentFormatter and RowCommentFormatter services as a usable
frontend for comment batches, and to replace the Linker static methods.
* Provide fluent and parametric interfaces.
Linker:
* Remove Linker::makeCommentLink() without deprecation -- nothing calls
it and it is obviously an internal helper.
* Soft-deprecate Linker methods formatComment(), formatLinksInComment(),
commentBlock() and revComment().
Caller migration:
* CommentFormatter single: Linker, RollbackAction, ApiComparePages,
ApiParse
* CommentFormatter parametric batch: ImageHistoryPseudoPager
* CommentFormatter fluent batch: ApiQueryFilearchive
* RowCommentFormatter sequential: History feed, BlocklistPager,
ProtectedPagesPager, ApiQueryProtectedTitles
* RowCommentFormatter with index: ChangesFeed, ChangesList,
ApiQueryDeletedrevs, ApiQueryLogEvents, ApiQueryRecentChanges
* RevisionCommentBatch: HistoryPager, ContribsPager
Bug: T285917
Change-Id: Ia3fd50a4a13138ba5003d884962da24746d562d0
2021-07-01 06:55:03 +00:00
|
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
|
|
|
use MediaWiki\Linker\LinkRenderer;
|
2023-09-18 14:17:28 +00:00
|
|
|
use MediaWiki\Title\NamespaceInfo;
|
2023-09-18 14:35:57 +00:00
|
|
|
use MediaWiki\Title\TitleParser;
|
Introduce CommentFormatter
CommentParser:
* Move comment formatting backend from Linker to a CommentParser service.
Allow link existence and file existence to be batched.
* Rename $local to $samePage since I think that is clearer.
* Rename $title to $selfLinkTarget since it was unclear what the title
was used for.
* Rename the "autocomment" concept to "section link" in public
interfaces, although the old term remains in CSS classes.
* Keep unsafe HTML pass-through in separate "unsafe" methods, for easier
static analysis and code review.
CommentFormatter:
* Add CommentFormatter and RowCommentFormatter services as a usable
frontend for comment batches, and to replace the Linker static methods.
* Provide fluent and parametric interfaces.
Linker:
* Remove Linker::makeCommentLink() without deprecation -- nothing calls
it and it is obviously an internal helper.
* Soft-deprecate Linker methods formatComment(), formatLinksInComment(),
commentBlock() and revComment().
Caller migration:
* CommentFormatter single: Linker, RollbackAction, ApiComparePages,
ApiParse
* CommentFormatter parametric batch: ImageHistoryPseudoPager
* CommentFormatter fluent batch: ApiQueryFilearchive
* RowCommentFormatter sequential: History feed, BlocklistPager,
ProtectedPagesPager, ApiQueryProtectedTitles
* RowCommentFormatter with index: ChangesFeed, ChangesList,
ApiQueryDeletedrevs, ApiQueryLogEvents, ApiQueryRecentChanges
* RevisionCommentBatch: HistoryPager, ContribsPager
Bug: T285917
Change-Id: Ia3fd50a4a13138ba5003d884962da24746d562d0
2021-07-01 06:55:03 +00:00
|
|
|
use RepoGroup;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @internal
|
|
|
|
|
*/
|
|
|
|
|
class CommentParserFactory {
|
|
|
|
|
/** @var LinkRenderer */
|
|
|
|
|
private $linkRenderer;
|
|
|
|
|
/** @var LinkBatchFactory */
|
|
|
|
|
private $linkBatchFactory;
|
|
|
|
|
/** @var LinkCache */
|
|
|
|
|
private $linkCache;
|
|
|
|
|
/** @var RepoGroup */
|
|
|
|
|
private $repoGroup;
|
|
|
|
|
/** @var Language */
|
|
|
|
|
private $userLang;
|
|
|
|
|
/** @var Language */
|
|
|
|
|
private $contLang;
|
|
|
|
|
/** @var TitleParser */
|
|
|
|
|
private $titleParser;
|
|
|
|
|
/** @var NamespaceInfo */
|
|
|
|
|
private $namespaceInfo;
|
|
|
|
|
/** @var HookContainer */
|
|
|
|
|
private $hookContainer;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @param LinkRenderer $linkRenderer
|
|
|
|
|
* @param LinkBatchFactory $linkBatchFactory
|
|
|
|
|
* @param LinkCache $linkCache
|
|
|
|
|
* @param RepoGroup $repoGroup
|
|
|
|
|
* @param Language $userLang
|
|
|
|
|
* @param Language $contLang
|
|
|
|
|
* @param TitleParser $titleParser
|
|
|
|
|
* @param NamespaceInfo $namespaceInfo
|
|
|
|
|
* @param HookContainer $hookContainer
|
|
|
|
|
*/
|
|
|
|
|
public function __construct(
|
|
|
|
|
LinkRenderer $linkRenderer,
|
|
|
|
|
LinkBatchFactory $linkBatchFactory,
|
|
|
|
|
LinkCache $linkCache,
|
|
|
|
|
RepoGroup $repoGroup,
|
|
|
|
|
Language $userLang,
|
|
|
|
|
Language $contLang,
|
|
|
|
|
TitleParser $titleParser,
|
|
|
|
|
NamespaceInfo $namespaceInfo,
|
|
|
|
|
HookContainer $hookContainer
|
|
|
|
|
) {
|
|
|
|
|
$this->linkRenderer = $linkRenderer;
|
|
|
|
|
$this->linkBatchFactory = $linkBatchFactory;
|
|
|
|
|
$this->linkCache = $linkCache;
|
|
|
|
|
$this->repoGroup = $repoGroup;
|
|
|
|
|
$this->userLang = $userLang;
|
|
|
|
|
$this->contLang = $contLang;
|
|
|
|
|
$this->titleParser = $titleParser;
|
|
|
|
|
$this->namespaceInfo = $namespaceInfo;
|
|
|
|
|
$this->hookContainer = $hookContainer;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @return CommentParser
|
|
|
|
|
*/
|
|
|
|
|
public function create() {
|
|
|
|
|
return new CommentParser(
|
|
|
|
|
$this->linkRenderer,
|
|
|
|
|
$this->linkBatchFactory,
|
|
|
|
|
$this->linkCache,
|
|
|
|
|
$this->repoGroup,
|
|
|
|
|
$this->userLang,
|
|
|
|
|
$this->contLang,
|
|
|
|
|
$this->titleParser,
|
|
|
|
|
$this->namespaceInfo,
|
|
|
|
|
$this->hookContainer
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|