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
|
<?php
namespace MediaWiki\Rest\Handler\Helper;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\ExistingPageRecord;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\ResponseInterface;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
/**
* @internal for use by core REST infrastructure
*/
class RevisionContentHelper extends PageContentHelper {
/**
* @return int|null The ID of the target revision
*/
public function getRevisionId(): ?int {
return isset( $this->parameters['id'] ) ? (int)$this->parameters['id'] : null;
}
/**
* @return string|null title text or null if unable to retrieve title
*/
public function getTitleText(): ?string {
$revision = $this->getTargetRevision();
return $revision
? $this->titleFormatter->getPrefixedText( $revision->getPageAsLinkTarget() )
: null;
}
/**
* @return ExistingPageRecord|null
*/
public function getPage(): ?ExistingPageRecord {
$revision = $this->getTargetRevision();
return $revision ? $this->pageLookup->getPageByReference( $revision->getPage() ) : null;
}
/**
* @return RevisionRecord|null latest revision or null if unable to retrieve revision
*/
public function getTargetRevision(): ?RevisionRecord {
if ( $this->targetRevision === false ) {
$revId = $this->getRevisionId();
if ( $revId ) {
$this->targetRevision = $this->revisionLookup->getRevisionById( $revId );
} else {
$this->targetRevision = null;
}
}
return $this->targetRevision;
}
/**
* @return bool
*/
public function isAccessible(): bool {
if ( !parent::isAccessible() ) {
return false;
}
$revision = $this->getTargetRevision();
// TODO: allow authorized users to see suppressed content. Set cache control accordingly.
if ( !$revision ||
!$revision->audienceCan( RevisionRecord::DELETED_TEXT, RevisionRecord::FOR_PUBLIC )
) {
return false;
}
return true;
}
/**
* @return bool
*/
public function hasContent(): bool {
return (bool)$this->getTargetRevision();
}
public function setCacheControl( ResponseInterface $response, ?int $expiry = null ) {
$revision = $this->getTargetRevision();
if ( $revision && $revision->getVisibility() !== 0 ) {
// The revision is not public, so it's not cacheable!
return;
}
parent::setCacheControl( $response, $expiry );
}
/**
* @return array
*/
public function constructMetadata(): array {
$page = $this->getPage();
$revision = $this->getTargetRevision();
$mainSlot = $revision->getSlot( SlotRecord::MAIN, RevisionRecord::RAW );
$metadata = [
'id' => $revision->getId(),
'size' => $revision->getSize(),
'minor' => $revision->isMinor(),
'timestamp' => wfTimestampOrNull( TS_ISO_8601, $revision->getTimestamp() ),
'content_model' => $mainSlot->getModel(),
'page' => [
'id' => $page->getId(),
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable
'key' => $this->titleFormatter->getPrefixedDBkey( $page ),
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable
'title' => $this->titleFormatter->getPrefixedText( $page ),
],
'license' => [
'url' => $this->options->get( MainConfigNames::RightsUrl ),
'title' => $this->options->get( MainConfigNames::RightsText )
],
];
$revUser = $revision->getUser( RevisionRecord::FOR_THIS_USER, $this->authority );
if ( $revUser ) {
$metadata['user'] = [
'id' => $revUser->isRegistered() ? $revUser->getId() : null,
'name' => $revUser->getName()
];
} else {
$metadata['user'] = null;
}
$comment = $revision->getComment( RevisionRecord::FOR_THIS_USER, $this->authority );
$metadata['comment'] = $comment ? $comment->text : null;
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable
$parent = $this->revisionLookup->getPreviousRevision( $revision );
if ( $parent ) {
$metadata['delta'] = $revision->getSize() - $parent->getSize();
} else {
$metadata['delta'] = null;
}
// FIXME: test fall fields
return $metadata;
}
/**
* @return array[]
*/
public function getParamSettings(): array {
return [
'id' => [
Handler::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_REQUIRED => true,
Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-revision-id' )
],
];
}
/**
* @throws LocalizedHttpException if the content is not accessible
*/
public function checkAccess() {
$revId = $this->getRevisionId() ?? '';
if ( !$this->hasContent() ) {
throw new LocalizedHttpException(
MessageValue::new( 'rest-nonexistent-revision' )->plaintextParams( $revId ),
404
);
}
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable Validated by hasContent
if ( !$this->isAccessible() || !$this->authority->authorizeRead( 'read', $this->getPageIdentity() ) ) {
throw new LocalizedHttpException(
MessageValue::new( 'rest-permission-denied-revision' )->plaintextParams( $revId ),
403
);
}
}
}
|
