summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/Protection/ProtectionValidator.php
blob: ff8103ea47cbd0a2f333536b62423305fe1dd84e (plain)
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
<?php

namespace SMW\Protection;

use Onoi\Cache\Cache;
use SMW\CachedPropertyValuesPrefetcher;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMW\RequestOptions;
use Title;

/**
 * Handles protection validation.
 *
 * The lookup is cached using the `CachedPropertyValuesPrefetcher` to avoid a
 * continued access to the Store or DB layer.
 *
 * @license GNU GPL v2+
 * @since 2.5
 *
 * @author mwjames
 */
class ProtectionValidator {

	/**
	 * Reference used in InMemoryPoolCache
	 */
	const POOLCACHE_ID = 'protection.validator';

	/**
	 * @var CachedPropertyValuesPrefetcher
	 */
	private $cachedPropertyValuesPrefetcher;

	/**
	 * @var Cache
	 */
	private $intermediaryMemoryCache;

	/**
	 * @var boolean|string
	 */
	private $editProtectionRight = false;

	/**
	 * @var boolean|string
	 */
	private $createProtectionRight = false;

	/**
	 * @var boolean|string
	 */
	private $changePropagationProtection = true;

	/**
	 * @since 2.5
	 *
	 * @param CachedPropertyValuesPrefetcher $cachedPropertyValuesPrefetcher
	 * @param Cache $intermediaryMemoryCache
	 */
	public function __construct( CachedPropertyValuesPrefetcher $cachedPropertyValuesPrefetcher, Cache $intermediaryMemoryCache ) {
		$this->cachedPropertyValuesPrefetcher = $cachedPropertyValuesPrefetcher;
		$this->intermediaryMemoryCache = $intermediaryMemoryCache;
	}

	/**
	 * @since 2.5
	 *
	 * @param string|boolean $editProtectionRight
	 */
	public function setEditProtectionRight( $editProtectionRight ) {
		$this->editProtectionRight = $editProtectionRight;
	}

	/**
	 * @since 3.0
	 *
	 * @return string|false
	 */
	public function getEditProtectionRight() {
		return $this->editProtectionRight;
	}

	/**
	 * @since 2.5
	 *
	 * @param string|boolean $createProtectionRight
	 */
	public function setCreateProtectionRight( $createProtectionRight ) {
		$this->createProtectionRight = $createProtectionRight;
	}

	/**
	 * @since 3.0
	 *
	 * @return string|false
	 */
	public function getCreateProtectionRight() {
		return $this->createProtectionRight;
	}

	/**
	 * @since 3.0
	 *
	 * @param boolean $changePropagationProtection
	 */
	public function setChangePropagationProtection( $changePropagationProtection ) {
		$this->changePropagationProtection = (bool)$changePropagationProtection;
	}

	/**
	 * @since 2.5
	 *
	 * @param DIWikiPage $subject
	 */
	private function resetCacheBy( DIWikiPage $subject ) {
		$this->cachedPropertyValuesPrefetcher->resetCacheBy( $subject );
	}

	/**
	 * @since 2.5
	 *
	 * @param Title $title
	 *
	 * @return boolean
	 */
	public function hasEditProtectionOnNamespace( Title $title ) {
		return $this->editProtectionRight && $this->checkProtection( DIWikiPage::newFromTitle( $title )->asBase() );
	}

	/**
	 * @since 2.5
	 *
	 * @param Title $title
	 *
	 * @return boolean
	 */
	public function hasChangePropagationProtection( Title $title ) {

		$subject = DIWikiPage::newFromTitle( $title )->asBase();
		$namespace = $subject->getNamespace();

		if ( ( $namespace !== SMW_NS_PROPERTY && $namespace !== NS_CATEGORY ) || $this->changePropagationProtection === false ) {
			return false;
		}

		return $this->checkProtection( $subject, new DIProperty( '_CHGPRO' ) );
	}

	/**
	 * @since 2.5
	 *
	 * @param Title $title
	 *
	 * @return boolean
	 */
	public function hasProtection( Title $title ) {
		return $this->checkProtection( DIWikiPage::newFromTitle( $title )->asBase() );
	}

	/**
	 * @since 3.0
	 *
	 * @param Title $title
	 * @param Title $title
	 *
	 * @return boolean
	 */
	public function hasCreateProtection( Title $title ) {
		return $this->createProtectionRight && !$title->userCan( 'edit' );
	}

	/**
	 * @note There is not direct validation of the permission within this method,
	 * it is done by the Title::userCan when probing against the User and hooks
	 * that carry out the permission check including the validation provided by
	 * SMW's `PermissionPthValidator`.
	 *
	 * @since 2.5
	 *
	 * @param Title $title
	 *
	 * @return boolean
	 */
	public function hasEditProtection( Title $title ) {
		return !$title->userCan( 'edit' ) && $this->checkProtection( DIWikiPage::newFromTitle( $title )->asBase() );
	}

	private function checkProtection( $subject, $property = null ) {

		if ( $property === null ) {
			$property = new DIProperty( '_EDIP' );
		}

		$key = $subject->getHash() . $property->getKey();
		$hasProtection = false;

		if ( $this->intermediaryMemoryCache->contains( $key ) ) {
			return $this->intermediaryMemoryCache->fetch( $key );
		}

		// Set editProtectionRight to influence the key to detect changes
		// before the cache is evicted
		$requestOptions = new RequestOptions();
		$requestOptions->addExtraCondition( $this->editProtectionRight );

		$dataItems = $this->cachedPropertyValuesPrefetcher->getPropertyValues(
			$subject,
			$property,
			$requestOptions
		);

		if ( $dataItems !== null && $dataItems !== [] ) {
			$hasProtection = $property->getKey() === '_EDIP' ? end( $dataItems )->getBoolean() : true;
		}

		$this->intermediaryMemoryCache->save( $key, $hasProtection );

		return $hasProtection;
	}

}