summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/SQLStore/EntityStore/IdCacheManager.php
blob: ca02bafbd7c5075ecfbbec7d25bf27868dacaf65 (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
223
224
225
226
<?php

namespace SMW\SQLStore\EntityStore;

use RuntimeException;
use SMW\DIWikiPage;
use SMW\SQLStore\SQLStore;

/**
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class IdCacheManager {

	/**
	 * @var SQLStore
	 */
	private $store;

	/**
	 * @since 3.0
	 *
	 * @param array $caches
	 */
	public function __construct( array $caches ) {
		$this->caches = $caches;

		if ( !isset( $this->caches['entity.id'] ) ) {
			throw new RuntimeException( "Missing 'entity.id' instance.");
		}

		if ( !isset( $this->caches['entity.sort'] ) ) {
			throw new RuntimeException( "Missing 'entity.sort' instance.");
		}

		if ( !isset( $this->caches['entity.lookup'] ) ) {
			throw new RuntimeException( "Missing 'entity.lookup' instance.");
		}

		if ( !isset( $this->caches['table.hash'] ) ) {
			throw new RuntimeException( "Missing 'table.hash' instance.");
		}
	}

 	/**
	 * @since 3.0
	 *
	 * @param string|array $args
	 *
	 * @return string
	 */
	public static function computeSha1( $args = '' ) {
		return sha1( json_encode( $args ) );
	}

	/**
	 * @since 3.0
	 *
	 * @param string $key
	 *
	 * @return boolean
	 */
	public function get( $key ) {

		if ( !isset( $this->caches[$key] ) ) {
			throw new RuntimeException( "$key is unknown");
		}

		return $this->caches[$key];
	}

	/**
	 * @since 3.0
	 *
	 * @param string $hash
	 *
	 * @return boolean
	 */
	public function hasCache( $hash ) {

		if ( !is_string( $hash ) ) {
			return false;
		}

		return $this->caches['entity.id']->contains( $hash );
	}

	/**
	 * @since 3.0
	 *
	 * @param string $title
	 * @param integer $namespace
	 * @param string $interwiki
	 * @param string $subobject
	 * @param integer $id
	 * @param string $sortkey
	 */
	public function setCache( $title, $namespace, $interwiki, $subobject, $id, $sortkey ) {

		if ( strpos( $title, ' ' ) !== false ) {
			throw new RuntimeException( "Somebody tried to use spaces in a cache title! ($title)");
		}

		$hash = $this->computeSha1(
			[ $title, (int)$namespace, $interwiki, $subobject ]
		);

		$this->caches['entity.id']->save( $hash, $id );
		$this->caches['entity.sort']->save( $hash, $sortkey );

		$dataItem = new DIWikiPage( $title, $namespace, $interwiki, $subobject );
		$dataItem->setId( $id );
		$dataItem->setSortKey( $sortkey );

		$this->caches['entity.lookup']->save( $id, $dataItem );

		// Speed up detection of redirects when fetching IDs
		if ( $interwiki == SMW_SQL3_SMWREDIIW ) {
			$this->setCache( $title, $namespace, '', $subobject, 0, '' );
		}
	}

	/**
	 * @since 3.0
	 *
	 * @param string $title
	 * @param integer $namespace
	 * @param string $interwiki
	 * @param string $subobject
	 */
	public function deleteCache( $title, $namespace, $interwiki, $subobject ) {

		$hash = $this->computeSha1(
			[ $title, (int)$namespace, $interwiki, $subobject ]
		);

		$this->caches['entity.id']->delete( $hash );
		$this->caches['entity.sort']->delete( $hash );

		if ( ( $id = $this->caches['entity.id']->fetch( $hash ) ) !== false ) {
			$this->caches['entity.lookup']->delete( $id );
		}
	}

	/**
	 * @since 3.0
	 *
	 * @param string $id
	 */
	public function deleteCacheById( $id ) {

		$dataItem = $this->caches['entity.lookup']->fetch( $id );

		if ( !$dataItem instanceof DIWikiPage ) {
			return;
		}

		$hash = $this->computeSha1(
			[
				$dataItem->getDBKey(),
				(int)$dataItem->getNamespace(),
				$dataItem->getInterwiki(),
				$dataItem->getSubobjectName()
			]
		);

		$this->caches['entity.id']->delete( $hash );
		$this->caches['entity.sort']->delete( $hash );
		$this->caches['entity.lookup']->delete( $id );
	}

	/**
	 * Get a cached SMW ID, or false if no cache entry is found.
	 *
	 * @since 3.0
	 *
	 * @param DIWikiPage|array $args
	 *
	 * @return integer|boolean
	 */
	public function getId( $args ) {

		if ( $args instanceof DIWikiPage ) {
			$args = [
				$args->getDBKey(),
				(int)$args->getNamespace(),
				$args->getInterwiki(),
				$args->getSubobjectName()
			];
		}

		$hash = $this->computeSha1( $args );

		if ( ( $id = $this->caches['entity.id']->fetch( $hash ) ) !== false ) {
			return (int)$id;
		}

		return false;
	}

	/**
	 * Get a cached SMW sortkey, or false if no cache entry is found.
	 *
	 * @since 3.0
	 *
	 * @param string $title
	 * @param integer $namespace
	 * @param string $interwiki
	 * @param string $subobject
	 *
	 * @return string|boolean
	 */
	public function getSort( $args ) {

		$hash = $this->computeSha1( $args );

		if ( ( $sort = $this->caches['entity.sort']->fetch( $hash ) ) !== false ) {
			return $sort;
		}

		return false;
	}

}