summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse/PSubjectLookup.php
blob: 2828755ad30eaf2be18b8bd44c975c7cfb2c6034 (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
<?php

namespace SMW\MediaWiki\Api\Browse;

use SMW\DIProperty;
use Exception;
use SMW\Store;
use SMW\DIWikiPage;
use SMW\RequestOptions;
use SMW\StringCondition;
use SMW\ApplicationFactory;
use SMW\DataValueFactory;

/**
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class PSubjectLookup extends Lookup {

	const VERSION = 1;

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

	/**
	 * @since 3.0
	 *
	 * @param Store $store
	 */
	public function __construct( Store $store ) {
		$this->store = $store;
	}

	/**
	 * @since 3.0
	 *
	 * @return string|integer
	 */
	public function getVersion() {
		return __METHOD__ . self::VERSION;
	}

	/**
	 * @since 3.0
	 *
	 * @param array $parameters
	 *
	 * @return array
	 */
	public function lookup( array $parameters ) {

		$limit = 20;
		$offset = 0;

		if ( isset( $parameters['limit'] ) ) {
			$limit = (int)$parameters['limit'];
		}

		if ( isset( $parameters['offset'] ) ) {
			$offset = (int)$parameters['offset'];
		}

		$list = [];
		$continueOffset = 0;
		$property = null;
		$value = null;

		if ( isset( $parameters['property'] ) ) {
			$property = $parameters['property'];

			// Get the last which represents the final output
			// Foo.Bar.Foobar.Baz
			if ( strpos( $property, '.' ) !== false ) {
				$chain = explode( '.', $property );
				$property = array_pop( $chain );
			}
		}

		if ( isset( $parameters['value'] ) ) {
			$value = $parameters['value'];
		}

		if ( $property === '' || $property === null ) {
			return [];
		}

		list( $list, $continueOffset ) = $this->findPropertySubjects(
			$property,
			$value,
			$limit,
			$offset,
			$parameters
		);

		// Changing this output format requires to set a new version
		$res = [
			'query' => $list,
			'query-continue-offset' => $continueOffset,
			'version' => self::VERSION,
			'meta' => [
				'type'  => 'psubject',
				'limit' => $limit,
				'count' => count( $list )
			]
		];

		return $res;
	}

	private function findPropertySubjects( $property, $value, $limit, $offset, $parameters ) {

		$list = [];
		$dataItem = null;

		$property = DIProperty::newFromUserLabel( $property );

		if ( $value !== '' && $value !== null ) {
			$dataItem = DataValueFactory::getInstance()->newDataValueByProperty( $property, $value )->getDataItem();
		}

		$continueOffset = 0;
		$count = 0;
		$requestOptions = $this->newRequestOptions( $parameters );

		$res = $this->store->getPropertySubjects(
			$property,
			$dataItem,
			$requestOptions
		);

		foreach ( $res as $dataItem ) {

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

			if ( isset( $parameters['title-prefix'] ) && (bool)$parameters['title-prefix'] === false ) {
				$list[] = $dataItem->getTitle()->getText();
			} else {
				$list[] = $dataItem->getTitle()->getPrefixedText();
			}
		}

		if ( $this->is_iterable( $res ) ) {
			$count = count( $res );
		}

		if ( $count > $limit ) {
			$continueOffset = $offset + $count;
			array_pop( $list );
		}

		return [ $list, $continueOffset ];
	}

	private function newRequestOptions( $parameters ) {

		$limit = 20;
		$offset = 0;
		$search = '';

		if ( isset( $parameters['limit'] ) ) {
			$limit = (int)$parameters['limit'];
		}

		if ( isset( $parameters['offset'] ) ) {
			$offset = (int)$parameters['offset'];
		}

		$requestOptions = new RequestOptions();
		$requestOptions->sort = true;
		$requestOptions->setLimit( $limit + 1 );
		$requestOptions->setOffset( $offset );

		if ( isset( $parameters['search'] ) && $parameters['search'] !== '' ) {
			$search = $parameters['search'];

			if ( $search !== '' && $search{0} !== '_' ) {
				$search = str_replace( "_", " ", $search );
			}

			$requestOptions->addStringCondition(
				$search,
				StringCondition::STRCOND_MID
			);

			// Disjunctive condition to allow for auto searches to match foaf OR Foaf
			$requestOptions->addStringCondition(
				ucfirst( $search ),
				StringCondition::STRCOND_MID,
				true
			);

			// Allow something like FOO to match the search string `foo`
			$requestOptions->addStringCondition(
				strtoupper( $search ),
				StringCondition::STRCOND_MID,
				true
			);

			$requestOptions->addStringCondition(
				strtolower( $search ),
				StringCondition::STRCOND_MID,
				true
			);
		}

		return $requestOptions;
	}

	private function is_iterable( $obj ) {
		return is_array( $obj ) || ( is_object( $obj ) && ( $obj instanceof \Traversable ) );
	}

}