summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/SQLStore/PropertyTableIdReferenceFinder.php
blob: bd36d587e8f74c00333c0ceb4da4eae19ccbf13d (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
256
257
258
259
260
261
262
263
264
265
266
267
<?php

namespace SMW\SQLStore;

use SMW\ApplicationFactory;
use SMW\DIProperty;
use SMWDataItem as DataItem;

/**
 * @license GNU GPL v2+
 * @since 2.4
 *
 * @author mwjames
 */
class PropertyTableIdReferenceFinder {

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

	/**
	 * @var Database
	 */
	private $connection;

	/**
	 * @var NamespaceExaminer
	 */
	private $namespaceExaminer;

	/**
	 * @var boolean
	 */
	private $isCapitalLinks = true;

	/**
	 * @since 2.4
	 *
	 * @param SQLStore $store
	 */
	public function __construct( SQLStore $store ) {
		$this->store = $store;
		$this->connection = $this->store->getConnection( 'mw.db' );
		$this->namespaceExaminer = ApplicationFactory::getInstance()->getNamespaceExaminer();
	}

	/**
	 * @note If $wgCapitalLinks is set false then it will avoid forcing the first
	 * letter of page titles (including included pages, images and categories)
	 * to capitals
	 *
	 * @since 2.4
	 *
	 * @param booelan $isCapitalLinks
	 */
	public function isCapitalLinks( $isCapitalLinks ) {
		$this->isCapitalLinks = $isCapitalLinks;
	}

	/**
	 * @since 2.4
	 *
	 * @param DIProperty $property
	 *
	 * @return DataItem|false
	 */
	public function tryToFindAtLeastOneReferenceForProperty( DIProperty $property ) {

		$dataItem = $property->getDiWikiPage();

		$sid = $this->store->getObjectIds()->getSMWPageID(
			$dataItem->getDBkey(),
			$dataItem->getNamespace(),
			$dataItem->getInterwiki(),
			''
		);

		// Lets see if we have some lower/upper case matching for
		// when wgCapitalLinks setting was involved
		if ( !$this->isCapitalLinks && $sid == 0 ) {
			$sid = $this->store->getObjectIds()->getSMWPageID(
				lcfirst( $dataItem->getDBkey() ),
				$dataItem->getNamespace(),
				$dataItem->getInterwiki(),
				''
			);
		}

		return $this->findAtLeastOneActiveReferenceById( $sid );
	}

	/**
	 * @since 3.0
	 *
	 * @param integer $id
	 *
	 * @return boolean
	 */
	public function hasResidualPropertyTableReference( $id ) {

		if ( $id == SQLStore::FIXED_PROPERTY_ID_UPPERBOUND ) {
			return true;
		}

		return (bool)$this->findAtLeastOneActiveReferenceById( $id, false );
	}

	/**
	 * @since 2.4
	 *
	 * @param integer $id
	 *
	 * @return boolean
	 */
	public function hasResidualReferenceForId( $id ) {

		if ( $id == SQLStore::FIXED_PROPERTY_ID_UPPERBOUND ) {
			return true;
		}

		return (bool)$this->findAtLeastOneActiveReferenceById( $id );
	}

	/**
	 * @since 2.5
	 *
	 * @param integer $id
	 *
	 * @return array
	 */
	public function searchAllTablesToFindAtLeastOneReferenceById( $id ) {

		$references = [];

		foreach ( $this->store->getPropertyTables() as $proptable ) {
			$reference = false;

			if ( ( $reference = $this->findReferenceByPropertyTable( $proptable, $id ) ) !== false ) {
				$references[$proptable->getName()] = $reference;
			}
		}

		if ( ( $reference = $this->findQueryLinksTableReferenceById( $id ) ) !== false ) {
			$references[SQLStore::QUERY_LINKS_TABLE] = $reference;
		}

		return $references;
	}

	/**
	 * @since 2.4
	 *
	 * @param integer $id
	 * @param boolean $secondary_ref
	 *
	 * @return DataItem|false
	 */
	public function findAtLeastOneActiveReferenceById( $id, $secondary_ref = true ) {

		$reference = false;

		foreach ( $this->store->getPropertyTables() as $proptable ) {

			if ( ( $reference = $this->findReferenceByPropertyTable( $proptable, $id ) ) !== false ) {

				// If null is returned it means that a reference was found but no DI could
				// be matched therefore is categorized as false positive
				if ( isset( $reference->s_id ) ) {
					$reference = $this->store->getObjectIds()->getDataItemById( $reference->s_id );

					// If the reference is for some reason not part of a  supported namespace,
					// it is assumed to be invalid
					if ( $reference !== null && !$this->namespaceExaminer->isSemanticEnabled( $reference->getNamespace() ) ) {
						$reference = false;
					}
				}
			}

			if ( $reference instanceof DataItem ) {
				return $reference;
			}
		}

		if ( $secondary_ref && !isset( $reference->s_id ) ) {
			$reference = $this->findQueryLinksTableReferenceById( $id );
		}

		if ( isset( $reference->s_id ) ) {
			$reference = $this->store->getObjectIds()->getDataItemById( $reference->s_id );
		}

		if ( $reference === false || $reference === null ) {
			return false;
		}

		return $reference;
	}

	private function findReferenceByPropertyTable( $proptable, $id ) {

		$row = false;

		if ( $proptable->usesIdSubject() ) {
			$row = $this->connection->selectRow(
				$proptable->getName(),
				[ 's_id' ],
				[ 's_id' => $id ],
				__METHOD__
			);
		}

		if ( $row !== false ) {
			return $row;
		}

		$fields = $proptable->getFields( $this->store );

		// Check whether an object reference exists or not
		if ( isset( $fields['o_id'] ) ) {

			// This next time someone ... I'm going to Alaska
			$field = strpos( $proptable->getName(), 'redi' ) ? [ 's_title', 's_namespace' ] : [ 's_id' ];

			$row = $this->connection->selectRow(
				$proptable->getName(),
				$field,
				[ 'o_id' => $id ],
				__METHOD__
			);

			if ( $row !== false && strpos( $proptable->getName(), 'redi' ) ) {
				$row->s_id = $this->store->getObjectIds()->findRedirect( $row->s_title, $row->s_namespace );
			}
		}

		// If the property table is not a fixed table (== assigns a whole
		// table to a specific property with the p_id column being suppressed)
		// then check for the p_id field
		if ( $row === false && !$proptable->isFixedPropertyTable() ) {
			$row = $this->connection->selectRow(
				$proptable->getName(),
				[ 's_id' ],
				[ 'p_id' => $id ],
				__METHOD__
			);
		}

		return $row;
	}

	private function findQueryLinksTableReferenceById( $id ) {

		// If the query table contains a reference then we keep the object (could
		// be a subject, property, or printrequest) where in case the query is
		// removed the object will also loose its reference
		$row = $this->connection->selectRow(
			SQLStore::QUERY_LINKS_TABLE,
			[ 's_id' ],
			[ 'o_id' => $id ],
			__METHOD__
		);

		return $row;
	}

}