summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/SQLStore/QueryDependency/DependencyLinksUpdateJournal.php
blob: ff9d8526c56936602736163e40aa45eb811f5c0a (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
<?php

namespace SMW\SQLStore\QueryDependency;

use Onoi\Cache\Cache;
use Psr\Log\LoggerAwareTrait;
use SMW\DIWikiPage;
use SMW\MediaWiki\Deferred\CallableUpdate;
use Title;

/**
 * Temporary storage of entities that are expected to be refreshed (or updated)
 * during an article view due to being a dependency of an altered query.
 *
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class DependencyLinksUpdateJournal {

	use LoggerAwareTrait;

	/**
	 * @var string
	 */
	const VERSION = '0.1';

	/**
	 * Namespace for the cache instance
	 */
	const CACHE_NAMESPACE = 'smw:update:qdep';

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

	/**
	 * @var CallableUpdate
	 */
	private $callableUpdate;

	/**
	 * @since 3.0
	 *
	 * @param Cache $cache
	 * @param callableUpdate $callableUpdate
	 */
	public function __construct( Cache $cache, CallableUpdate $callableUpdate ) {
		$this->cache = $cache;
		$this->callableUpdate = $callableUpdate;
	}

	/**
	 * @since 3.0
	 *
	 * @param DIWikiPage $subject
	 *
	 * @return string
	 */
	public static function makeKey( $subject ) {

		$segments = [];

		if ( $subject instanceof DIWikiPage || $subject instanceof Title ) {
			$segments = [ $subject->getDBKey(), $subject->getNamespace(), $subject->getInterwiki(), '' ];
		}

		return smwfCacheKey(
			self::CACHE_NAMESPACE,
			[
				implode( '#', $segments ),
				self::VERSION
			]
		);
	}

	/**
	 * @since 3.0
	 *
	 * @param array $hashList
	 * @param integer|true $revID
	 */
	public function updateFromList( array $hashList, $revID = true ) {

		foreach ( $hashList as $hash ) {

			$key = smwfCacheKey(
				self::CACHE_NAMESPACE,
				[
					$hash,
					self::VERSION
				]
			);

			$this->cache->save( $key, $revID );
		}

	}

	/**
	 * @since 3.0
	 *
	 * @param DIWikiPage|Title $subject
	 * @param integer|true $revID
	 */
	public function update( $subject, $revID = true ) {
		$this->cache->save( self::makeKey( $subject ), $revID );
	}

	/**
	 * @since 3.0
	 *
	 * @param DIWikiPage|Title $subject
	 */
	public function has( $subject ) {
		return $this->cache->contains( self::makeKey( $subject ) ) === true;
	}

	/**
	 * @since 3.0
	 *
	 * @param DIWikiPage $subject
	 */
	public function delete( $subject ) {

		if ( !$subject instanceof Title && !$subject instanceof DIWikiPage ) {
			throw new RuntimeException( "Invalid subject instance" );
		}

		// Avoid interference with any other process during a preOutputCommit
		// stage especially when CACHE_DB is used as instance
		$this->callableUpdate->setCallback( function() use( $subject ) {
			$this->cache->delete( self::makeKey( $subject ) );
		} );

		$this->callableUpdate->setOrigin(
			[
				__METHOD__,
				$subject->getDBKey() . '#' . $subject->getNamespace() . '#' . $subject->getInterwiki()
			]
		);

		$this->callableUpdate->pushUpdate();
	}

}