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
|
<?php
namespace MediaWiki\Rest\Handler;
use MediaWiki\Languages\LanguageNameUtils;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Page\PageLookup;
use MediaWiki\Rest\Handler\Helper\PageRedirectHelper;
use MediaWiki\Rest\Handler\Helper\PageRestHelperFactory;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\SimpleHandler;
use MediaWiki\Title\MalformedTitleException;
use MediaWiki\Title\TitleFormatter;
use MediaWiki\Title\TitleParser;
use Wikimedia\Message\MessageValue;
use Wikimedia\Message\ParamType;
use Wikimedia\Message\ScalarParam;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* Class LanguageLinksHandler
* REST API handler for /page/{title}/links/language endpoint.
*
* @package MediaWiki\Rest\Handler
*/
class LanguageLinksHandler extends SimpleHandler {
private IConnectionProvider $dbProvider;
private LanguageNameUtils $languageNameUtils;
private TitleFormatter $titleFormatter;
private TitleParser $titleParser;
private PageLookup $pageLookup;
private PageRestHelperFactory $helperFactory;
/**
* @var ExistingPageRecord|false|null
*/
private $page = false;
/**
* @param IConnectionProvider $dbProvider
* @param LanguageNameUtils $languageNameUtils
* @param TitleFormatter $titleFormatter
* @param TitleParser $titleParser
* @param PageLookup $pageLookup
* @param PageRestHelperFactory $helperFactory
*/
public function __construct(
IConnectionProvider $dbProvider,
LanguageNameUtils $languageNameUtils,
TitleFormatter $titleFormatter,
TitleParser $titleParser,
PageLookup $pageLookup,
PageRestHelperFactory $helperFactory
) {
$this->dbProvider = $dbProvider;
$this->languageNameUtils = $languageNameUtils;
$this->titleFormatter = $titleFormatter;
$this->titleParser = $titleParser;
$this->pageLookup = $pageLookup;
$this->helperFactory = $helperFactory;
}
private function getRedirectHelper(): PageRedirectHelper {
return $this->helperFactory->newPageRedirectHelper(
$this->getResponseFactory(),
$this->getRouter(),
$this->getPath(),
$this->getRequest()
);
}
/**
* @return ExistingPageRecord|null
*/
private function getPage(): ?ExistingPageRecord {
if ( $this->page === false ) {
$this->page = $this->pageLookup->getExistingPageByText(
$this->getValidatedParams()['title']
);
}
return $this->page;
}
/**
* @param string $title
* @return Response
* @throws LocalizedHttpException
*/
public function run( $title ) {
$page = $this->getPage();
$params = $this->getValidatedParams();
if ( !$page ) {
throw new LocalizedHttpException(
new MessageValue( 'rest-nonexistent-title',
[ new ScalarParam( ParamType::PLAINTEXT, $title ) ]
),
404
);
}
'@phan-var \MediaWiki\Page\ExistingPageRecord $page';
$redirectResponse = $this->getRedirectHelper()->createNormalizationRedirectResponseIfNeeded(
$page,
$params['title'] ?? null
);
if ( $redirectResponse !== null ) {
return $redirectResponse;
}
if ( !$this->getAuthority()->authorizeRead( 'read', $page ) ) {
throw new LocalizedHttpException(
new MessageValue( 'rest-permission-denied-title',
[ new ScalarParam( ParamType::PLAINTEXT, $title ) ] ),
403
);
}
return $this->getResponseFactory()
->createJson( $this->fetchLinks( $page->getId() ) );
}
private function fetchLinks( $pageId ) {
$result = [];
$res = $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder()
->select( [ 'll_title', 'll_lang' ] )
->from( 'langlinks' )
->where( [ 'll_from' => $pageId ] )
->orderBy( 'll_lang' )
->caller( __METHOD__ )->fetchResultSet();
foreach ( $res as $item ) {
try {
$targetTitle = $this->titleParser->parseTitle( $item->ll_title );
$result[] = [
'code' => $item->ll_lang,
'name' => $this->languageNameUtils->getLanguageName( $item->ll_lang ),
'key' => $this->titleFormatter->getPrefixedDBkey( $targetTitle ),
'title' => $this->titleFormatter->getPrefixedText( $targetTitle )
];
} catch ( MalformedTitleException $e ) {
// skip malformed titles
}
}
return $result;
}
public function needsWriteAccess() {
return false;
}
public function getParamSettings() {
return [
'title' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
],
];
}
/**
* @return string|null
*/
protected function getETag(): ?string {
$page = $this->getPage();
if ( !$page ) {
return null;
}
// XXX: use hash of the rendered HTML?
return '"' . $page->getLatest() . '@' . wfTimestamp( TS_MW, $page->getTouched() ) . '"';
}
/**
* @return string|null
*/
protected function getLastModified(): ?string {
$page = $this->getPage();
return $page ? $page->getTouched() : null;
}
/**
* @return bool
*/
protected function hasRepresentation() {
return (bool)$this->getPage();
}
}
|