summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/SQLStore/ChangeOp/ChangeDiff.php
blob: 7c6fe8d747591ddd0f4b38b356fe30d8cca8e69f (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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<?php

namespace SMW\SQLStore\ChangeOp;

use Onoi\Cache\Cache;
use SMW\DIWikiPage;
use SMW\Utils\HmacSerializer;

/**
 * @license GNU GPL v2+
 * @since 2.3
 *
 * @author mwjames
 */
class ChangeDiff {

	/**
	 * Identifies the cache namespace
	 */
	const CACHE_NAMESPACE = 'smw:store:diff';

	/**
	 * Identifies the cache TTL (one week)
	 */
	const CACHE_TTL = 604800;

	/**
	 * @var string
	 */
	private $time;

	/**
	 * @var DIWikiPage
	 */
	private $subject;

	/**
	 * @var array
	 */
	private $tableChangeOps = [];

	/**
	 * @var array
	 */
	private $dataOps = [];

	/**
	 * @var array
	 */
	private $propertyList = [];

	/**
	 * @var array
	 */
	private $textItems = [];

	/**
	 * @var array
	 */
	private $changeList = [];

	/**
	 * @since 3.0
	 *
	 * @param DIWikiPage $subject
	 * @param array $tableChangeOps
	 * @param array $dataOps
	 * @param array $propertyList
	 * @param array $textItems
	 */
	public function __construct( DIWikiPage $subject, array $tableChangeOps, array $dataOps, array $propertyList, array $textItems = [] ) {
		$this->time = time();
		$this->subject = $subject;
		$this->tableChangeOps = $tableChangeOps;
		$this->dataOps = $dataOps;
		$this->propertyList = $propertyList;
		$this->textItems = $textItems;
	}

	/**
	 * @since 3.0
	 *
	 * @return DIWikiPage
	 */
	public function getSubject() {
		return $this->subject;
	}

	/**
	 * @since 3.0
	 *
	 * @return TableChangeOps[]
	 */
	public function getTableChangeOps() {
		return $this->tableChangeOps;
	}

	/**
	 * @since 3.0
	 *
	 * @return TableChangeOps[]
	 */
	public function getDataOps() {
		return $this->dataOps;
	}

	/**
	 * @since 3.0
	 *
	 * @return []
	 */
	public function getTextItems() {
		return $this->textItems;
	}

	/**
	 * @since 3.0
	 *
	 * @param boolean $op
	 *
	 * @return []
	 */
	public function getPropertyList( $op = false ) {

		if ( $op === true || $op === 'flip' ) {
			$list = [];

			foreach ( $this->propertyList as $key => $value ) {
				if ( is_array( $value ) ) {
					$list[$value['_id']] = $key;
				} else {
					$list[$value] = $key;
				}
			}

			return $list;
		}

		if ( $op === 'id' ) {
			$list = [];

			foreach ( $this->propertyList as $key => $value ) {
				if ( is_array( $value ) ) {
					$list[$value['_id']] = [ '_key' => $key, '_type'=> $value['_type'] ];
				}
			}

			return $list;
		}

		return $this->propertyList;
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 * @param array $changes
	 */
	public function setChangeList( $type, array $changes ) {
		$this->changeList[$type] = $changes;
	}

	/**
	 * @since 3.0
	 *
	 * @param string $type
	 *
	 * @return array
	 */
	public function getChangeListByType( $type ) {
		return isset( $this->changeList[$type] ) ? $this->changeList[$type] : [];
	}

	/**
	 * @since 3.0
	 *
	 * @return string
	 */
	public function serialize() {
		return HmacSerializer::compress( $this );
	}

	/**
	 * @since 3.0
	 *
	 * @return string
	 */
	public function toJson( $prettify = false ) {

		$changes = [];

		foreach ( $this->tableChangeOps as $tableChangeOp ) {
			$changes[] = $tableChangeOp->toArray();
		}

		$data = [];

		foreach ( $this->dataOps as $dataOp ) {
			$data[] = $dataOp->toArray();
		}

		$flags = $prettify ? JSON_PRETTY_PRINT : 0;

		return json_encode(
			[
				'time' => $this->time,
				'subject' => $this->subject->getHash(),
				'changes' => $changes,
				'change_list' => $this->changeList,
				'data' => $data,
				'text_items' => $this->textItems,
				'property_list' => $this->propertyList
			],
			$flags
		);
	}

	/**
	 * @since 3.0
	 *
	 * @param Cache $cache
	 */
	public function save( Cache $cache ) {

		$key = smwfCacheKey(
			self::CACHE_NAMESPACE,
			$this->subject->getHash()
		);

		// Keep it a week
		$cache->save( $key, HmacSerializer::compress( $this ), self::CACHE_TTL );
	}

	/**
	 * @since 3.0
	 *
	 * @param Cache $cache
	 * @param DIWikiPage $subject
	 */
	public static function fetch( Cache $cache, DIWikiPage $subject ) {

		$key = smwfCacheKey(
			self::CACHE_NAMESPACE,
			$subject->getHash()
		);

		if ( ( $diff = $cache->fetch( $key ) ) !== false ) {
			return HmacSerializer::uncompress( $diff );
		}

		return false;
	}

}