summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/includes/queryprinters/JsonResultPrinter.php
blob: 990e11d6325ccf6f6a81c9f32456579cb0bbf964 (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
<?php

namespace SMW;

use FormatJson;
use SMWQueryResult;

/**
 * Print links to JSON files representing query results.
 *
 * @see http://www.semantic-mediawiki.org/wiki/Help:JSON_format
 *
 * @since 1.5.3
 *
 *
 * @license GNU GPL v2 or later
 * @author mwjames
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 * @author Fabian Howahl
 */

/**
 * Print links to JSON files representing query results.
 *
 * @ingroup QueryPrinter
 */
class JsonResultPrinter extends FileExportPrinter {

	/**
	 * Returns human readable label for this printer
	 * @codeCoverageIgnore
	 *
	 * @return string
	 */
	public function getName() {
		return $this->msg( 'smw_printername_json' )->text();
	}

	/**
	 * @see SMWIExportPrinter::getMimeType
	 *
	 * @since 1.8
	 *
	 * @param SMWQueryResult $queryResult
	 *
	 * @return string
	 */
	public function getMimeType( SMWQueryResult $queryResult ) {
		return 'application/json';
	}

	/**
	 * @see SMWIExportPrinter::getFileName
	 *
	 * @since 1.8
	 *
	 * @param SMWQueryResult $queryResult
	 *
	 * @return string|boolean
	 */
	public function getFileName( SMWQueryResult $queryResult ) {

		if ( $this->getSearchLabel( SMW_OUTPUT_WIKI ) !== '' ) {
			return str_replace( ' ', '_', $this->getSearchLabel( SMW_OUTPUT_WIKI ) ) . '.json';
		}

		return 'result.json';
	}

	/**
	 * Returns a filename that is to be sent to the caller
	 *
	 * @param SMWQueryResult $res
	 * @param $outputMode integer
	 *
	 * @return string
	 */
	protected function getResultText( SMWQueryResult $res, $outputMode ) {

		if ( $outputMode == SMW_OUTPUT_FILE ) {

			// No results, just bailout
			if ( $res->getCount() == 0 ){
				return $this->params['default'] !== '' ? $this->params['default'] : '';
			}

			$flags = $this->params['prettyprint'] ? JSON_PRETTY_PRINT : 0;
			$flags = $flags | ( $this->params['unescape'] ? JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES : 0 );

			// Serialize queryResult
			if ( isset( $this->params['type'] ) && $this->params['type'] === 'simple' ) {
				$result = $this->serializeAsSimpleList( $res );
			} else {
				$result = array_merge(
					$res->serializeToArray(),
					[ 'rows' => $res->getCount() ]
				);
			}

			$result = json_encode(
				$result,
				$flags
			);

		} else {
			// Create a link that points to the JSON file
			$result = $this->getLink( $res, $outputMode )->getText( $outputMode, $this->mLinker );

			// Code can be viewed as HTML if requested, no more parsing needed
			$this->isHTML = $outputMode == SMW_OUTPUT_HTML;
		}

		return $result;
	}

	/**
	 * @see SMWResultPrinter::getParamDefinitions
	 * @codeCoverageIgnore
	 *
	 * @since 1.8
	 *
	 * @param ParamDefinition[] $definitions
	 *
	 * @return array
	 */
	public function getParamDefinitions( array $definitions ) {
		$params = parent::getParamDefinitions( $definitions );

		$params['searchlabel']->setDefault( $this->msg( 'smw_json_link' )->inContentLanguage()->text() );

		$params['limit']->setDefault( 100 );

		$params['type'] = [
			'values' => [ 'simple', 'full' ],
			'default' => 'full',
			'message' => 'smw-paramdesc-json-type',
		];

		$params['prettyprint'] = [
			'type' => 'boolean',
			'default' => '',
			'message' => 'smw-paramdesc-prettyprint',
		];

		$params['unescape'] = [
			'type' => 'boolean',
			'default' => '',
			'message' => 'smw-paramdesc-json-unescape',
		];

		return $params;
	}

	private function serializeAsSimpleList( $res ) {

		$result = [];

		while ( $row = $res->getNext() ) {
			$item = [];
			$subject = '';

			foreach ( $row as /* SMWResultArray */ $field ) {
				$label = $field->getPrintRequest()->getLabel();

				if ( $label === '' ) {
					continue;
				}

				$values = [];
				$subject = $field->getResultSubject()->getHash();

				while ( ( $dataValue = $field->getNextDataValue() ) !== false ) {
					$values[] = $dataValue->getWikiValue();
				}

				$item[$label] = $values;
			}

			if ( $this->params['mainlabel'] === '-' || $subject === '' ) {
				$result[] = $item;
			} else {
				$result[$subject] = $item;
			}
		}

		return $result;
	}

}