Code Coverage for /workspace/src/extensions/Cargo/includes/formats/CargoExhibitFormat.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 12	CRAP	0.00% covered (danger)	0.00%	0 / 214
CargoExhibitFormat	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 12	2450	0.00% covered (danger)	0.00%	0 / 214
allowedParameters				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 11
prependDot				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 2
createMap				0.00% covered (danger)	0.00%	0 / 1	20	0.00% covered (danger)	0.00%	0 / 19
createTimeline				0.00% covered (danger)	0.00%	0 / 1	72	0.00% covered (danger)	0.00%	0 / 29
createTabular				0.00% covered (danger)	0.00%	0 / 1	12	0.00% covered (danger)	0.00%	0 / 17
createFacets				0.00% covered (danger)	0.00%	0 / 1	6	0.00% covered (danger)	0.00%	0 / 14
createSearch				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 8
createLens				0.00% covered (danger)	0.00%	0 / 1	30	0.00% covered (danger)	0.00%	0 / 15
queryAndDisplay				0.00% covered (danger)	0.00%	0 / 1	156	0.00% covered (danger)	0.00%	0 / 65
automateViews				0.00% covered (danger)	0.00%	0 / 1	12	0.00% covered (danger)	0.00%	0 / 12
getCoordinatesFields				0.00% covered (danger)	0.00%	0 / 1	20	0.00% covered (danger)	0.00%	0 / 11
getDateFields				0.00% covered (danger)	0.00%	0 / 1	30	0.00% covered (danger)	0.00%	0 / 11

1	<?php
2	/**
3	* Adds Exhibit format to Cargo queries.
4	*
5	* @author @lmorillas
6	*/
7
8	class CargoExhibitFormat extends CargoDeferredFormat {
9
10	public static function allowedParameters() {
11	return [
12	'view' => [ 'values' => [ 'map', 'tabular', 'timeline' ] ],
13	'facets' => [ 'type' => 'string' ],
14	'datalabel' => [ 'type' => 'string' ],
15	'end' => [ 'type' => 'string' ],
16	'color' => [ 'type' => 'string' ],
17	'topunit' => [ 'values' => [ 'millisecond', 'second', 'minute', 'hour', 'day', 'week', 'month', 'year', 'decade', 'century', 'millennium' ] ],
18	'toppx' => [ 'type' => 'int' ],
19	'bottompx' => [ 'type' => 'int' ]
20	];
21	}
22
23	/**
24	* @param string $p
25	* @return string
26	*/
27	private function prependDot( $p ) {
28	return '.' . trim( $p );
29	}
30
31	private function createMap( $sqlQueries ) {
32	$maps_script = '<link rel="exhibit-extension" href="//api.simile-widgets.org/exhibit/HEAD/extensions/map/map-extension.js"/>';
33	$this->mOutput->addHeadItem( $maps_script, $maps_script );
34
35	if ( !array_key_exists( "latlng", $this->displayParams ) ) {
36	$coordFields = $this->getCoordinatesFields( $sqlQueries );
37	if ( count( $coordFields ) > 0 ) {
38	$this->displayParams['latlng'] = $coordFields[0];
39	}
40	}
41
42	$attrs = [
43	'data-ex-role' => 'view',
44	'data-ex-view-class' => "Map",
45	'data-ex-latlng' => $this->prependDot( $this->displayParams['latlng'] ),
46	'data-ex-autoposition' => "true",
47	];
48
49	if ( array_key_exists( "color", $this->displayParams ) ) {
50	$attrs["data-ex-color-key"] = $this->prependDot( $this->displayParams['color'] );
51	}
52
53	return Html::element( 'div', $attrs );
54	}
55
56	private function createTimeline( $sqlQueries ) {
57	$timeline_script = '<link rel="exhibit-extension" href="//api.simile-widgets.org/exhibit/HEAD/extensions/time/time-extension.js"/>';
58	$this->mOutput->addHeadItem( $timeline_script, $timeline_script );
59
60	// div
61	$attrs = [];
62	$attrs['data-ex-role'] = 'view';
63	$attrs["data-ex-view-class"] = "Timeline";
64
65	if ( !array_key_exists( "start", $this->displayParams ) ) {
66	$dateFields = $this->getDateFields( $sqlQueries );
67	if ( count( $dateFields ) > 0 ) {
68	$this->displayParams['start'] = $dateFields[0];
69	}
70	}
71
72	$attrs["data-ex-start"] = $this->prependDot( $this->displayParams['start'] );
73
74	if ( array_key_exists( "end", $this->displayParams ) ) {
75	$attrs["data-ex-end"] = $this->prependDot( $this->displayParams['end'] );
76	}
77	if ( array_key_exists( "color", $this->displayParams ) ) {
78	$attrs["data-ex-color-key"] = $this->prependDot( $this->displayParams['color'] );
79	}
80	if ( array_key_exists( "topunit", $this->displayParams ) ) {
81	$attrs["data-ex-top-band-unit"] = $this->displayParams['topunit'];
82	}
83	if ( array_key_exists( "toppx", $this->displayParams ) ) {
84	$attrs["data-ex-top-band-pixels-per-unit"] = $this->displayParams['toppx'];
85	}
86	if ( array_key_exists( "bottompx", $this->displayParams ) ) {
87	$attrs["data-ex-bottom-band-pixels-per-unit"] = $this->displayParams['bottompx'];
88	}
89	return Html::element( 'div', $attrs );
90	}
91
92	/**
93	* @param string[] $fieldList
94	* @return string HTML
95	*/
96	private function createTabular( $fieldList ) {
97	$columnsList = [];
98	foreach ( $fieldList as $field ) {
99	if ( strpos( $field, '__' ) == false ) {
100	$columnsList[] = $field;
101	}
102	}
103
104	$attrs = [
105	'data-ex-role' => 'view',
106	'data-ex-view-class' => 'Tabular',
107	'data-ex-paginate' => "true",
108	'data-ex-table-styler' => "tableStyler",
109
110	'data-ex-columns' => implode( ',',
111	array_map( "CargoExhibitFormat::prependDot", $columnsList ) ),
112
113	'data-ex-column-labels' => implode( ',', array_map( "ucfirst", $columnsList ) )
114	];
115
116	return Html::element( 'div', $attrs );
117	}
118
119	private function createFacets( $facets ) {
120	// Explode facets and create the div for each of them.
121	$text = $this->createSearch();
122	foreach ( $facets as $f ) {
123	$attrs = [
124	'data-ex-role' => "facet",
125	'data-ex-collapsible' => "true",
126	'data-ex-expression' => '.' . $f,
127	'data-ex-show-missing' => 'false',
128	'data-ex-facet-label' => ucfirst( $f ),
129	'style' => "float: left; width: 24%; margin: 0 1% 0 0;"
130	];
131	$text .= Html::element( 'div', $attrs );
132	}
133	return Html::rawElement( 'div', [ "class" => "facets", "style" => "overflow: hidden; width: 100%;" ], $text );
134	}
135
136	/**
137	* @return string
138	*/
139	private function createSearch() {
140	$attrs = [
141	'data-ex-role' => "exhibit-facet",
142	'data-ex-facet-class' => "TextSearch",
143	'data-ex-facet-label' => wfMessage( 'search' )->text(),
144	'style' => "float: left; width: 24%; margin: 0 1% 0 0;"
145	];
146	return Html::element( 'div', $attrs );
147	}
148
149	private function createLens( $fieldList ) {
150	$lensBody = '<caption><strong data-ex-content=".label"></strong></caption>';
151	foreach ( $fieldList as $field ) {
152	if ( $field != "label" && strpos( $field, '__' ) === false &&
153	strpos( $field, ' ' ) === false ) {
154	$th = "<strong>" . ucfirst( $field ) . "</strong>";
155	$lensBody .= "<tr data-ex-if-exists=\".$field\"><td>$th</td><td data-ex-content=\".$field\"></td></tr>";
156	}
157	}
158	$tableAttrs = [
159	'data-ex-role' => 'lens',
160	'class' => 'cargoTable',
161	'style' => "display: none; width: 100%;"
162	];
163	return Html::rawElement( 'table', $tableAttrs, $lensBody );
164	}
165
166	/**
167	* @param CargoSQLQuery[] $sqlQueries
168	* @param array $displayParams
169	* @param array\|null $querySpecificParams
170	* @return string HTML
171	* @throws MWException
172	*/
173	public function queryAndDisplay( $sqlQueries, $displayParams, $querySpecificParams = null ) {
174	global $cgScriptPath;
175
176	$this->mOutput->addModules( [ 'ext.cargo.exhibit' ] );
177	$this->mOutput->addModuleStyles( [ 'ext.cargo.main' ] );
178
179	$exhibit_busy = $cgScriptPath . "/resources/images/loading.gif";
180	// The "loading" message is just alt-text, so it doesn't really
181	// matter that it's hardcoded in English.
182	$preViewsText = '<img id="loading_exhibit" src="' . $exhibit_busy . '" alt="Loading Exhibit" style="display: none;" >';
183
184	$field_list = [];
185	foreach ( $sqlQueries as $sqlQuery ) {
186	foreach ( $sqlQuery->mAliasedFieldNames as $alias => $fieldName ) {
187	$field_list[] = $alias;
188	}
189	}
190
191	$csv_properties = '';
192	if ( !in_array( "label", $field_list ) ) {
193	// first field will be label!
194	$field_list[0] = 'label';
195	$csv_properties = 'data-ex-properties="' . implode( ',', $field_list ) . '"';
196	}
197
198	$queryParams = $this->sqlQueriesToQueryParams( $sqlQueries );
199	$queryParams['format'] = 'csv';
200
201	$ce = SpecialPage::getTitleFor( 'CargoExport' );
202	$dataurl = htmlentities( $ce->getFullURL( $queryParams ) );
203
204	// Data imported as csv
205	$datalink = "<link href=\"$dataurl\" type=\"text/csv\" rel=\"exhibit/data\" data-ex-has-column-titles=\"true\" $csv_properties />";
206
207	$this->mOutput->addHeadItem( $datalink, $datalink );
208
209	$this->displayParams = $displayParams;
210
211	// lens
212	$preViewsText .= $this->createLens( $field_list );
213
214	// Facets
215	if ( array_key_exists( 'facets', $displayParams ) ) {
216	$facets = array_map( 'trim', explode( ',', $displayParams['facets'] ) );
217	$preViewsText .= $this->createFacets( $facets );
218	} else {
219	$preViewsText .= $this->createFacets( array_slice( $field_list, 0, 3 ) );
220	}
221
222	if ( array_key_exists( 'datalabel', $displayParams ) ) {
223	$datalabel = trim( $displayParams['datalabel'] );
224	// What is this used for?
225	$dataplural = $datalabel . 's';
226	$data_label_link = <<<EOLABEL
227	<link href="#cargoExhibit" type="text/html" rel="exhibit/data"
228	data-ex-item-type="Item" data-ex-label="$datalabel" data-ex-plural-label="$dataplural" />
229	EOLABEL;
230	$this->mOutput->addHeadItem( $data_label_link, $data_label_link );
231	}
232
233	// View
234	$this->views = [];
235
236	if ( array_key_exists( 'view', $displayParams ) ) {
237	$this->views = array_map( 'ucfirst', array_map( 'trim', explode( ',', $displayParams['view'] ) ) );
238	} else {
239	$this->automateViews( $sqlQueries );
240	}
241
242	$viewsText = "";
243	foreach ( $this->views as $view ) {
244	switch ( $view ) {
245	case "Timeline":
246	$viewsText .= $this->createTimeline( $sqlQueries );
247	break;
248	case "Map":
249	$viewsText .= $this->createMap( $sqlQueries );
250	break;
251	case "Tabular":
252	$viewsText .= $this->createTabular( $field_list );
253	}
254	}
255
256	if ( count( $this->views ) > 1 ) {
257	$viewsText = Html::rawElement( 'div',
258	[ 'data-ex-role' => "viewPanel" ],
259	$viewsText );
260	}
261
262	return $preViewsText . '<div id="cargoExhibit">' . $viewsText . '</div>';
263	}
264
265	/**
266	* Initializes $this->views[]
267	*/
268	private function automateViews( $sqlQueries ) {
269	// map ?
270	$coordFields = $this->getCoordinatesFields( $sqlQueries );
271	if ( count( $coordFields ) > 0 ) {
272	$this->views[] = 'Map';
273	$this->displayParams['latlng'] = $coordFields[0];
274	}
275
276	// timeline ?
277	$dateFields = $this->getDateFields( $sqlQueries );
278	if ( count( $dateFields ) > 0 ) {
279	$this->views[] = 'Timeline';
280	$this->displayParams['start'] = $dateFields[0];
281	}
282
283	$this->views[] = 'Tabular';
284	}
285
286	private function getCoordinatesFields( $sqlQueries ) {
287	$coordinatesFields = [];
288
289	foreach ( $sqlQueries as $query ) {
290	$fieldDescriptions = $query->mFieldDescriptions;
291	foreach ( $fieldDescriptions as $field => $description ) {
292	if ( $description->mType == 'Coordinates' ) {
293	$coordinatesFields[] = $field;
294	}
295	}
296	}
297	return $coordinatesFields;
298	}
299
300	private function getDateFields( $sqlQueries ) {
301	$dateFields = [];
302
303	foreach ( $sqlQueries as $query ) {
304	$fieldDescriptions = $query->mFieldDescriptions;
305	foreach ( $fieldDescriptions as $field => $description ) {
306	if ( $description->mType == 'Date' \|\| $description->mType == 'Datetime' ) {
307	$dateFields[] = $field;
308	}
309	}
310	}
311	return $dateFields;
312	}
313	}