summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Maps/src/LeafletService.php
blob: 6d189fdb87a00ec110fd74d30b6ce01d74e21c72 (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
<?php

namespace Maps;

use Html;
use ParamProcessor\ParameterTypes;
use ParamProcessor\ProcessingResult;

/**
 * @licence GNU GPL v2+
 */
class LeafletService implements MappingService {

	private $addedDependencies = [];

	public function getName(): string {
		return 'leaflet';
	}

	public function getAliases(): array {
		return [ 'leafletmaps', 'leaflet' ]; // TODO: main name should not be in here?
	}

	public function hasAlias( string $alias ): bool {
		return in_array( $alias, [ 'leafletmaps', 'leaflet' ] );
	}

	public function getParameterInfo(): array {
		$params = MapsFunctions::getCommonParameters();

		$params['zoom'] = [
			'type' => ParameterTypes::INTEGER,
			'range' => [ 0, 20 ],
			'default' => false,
			'message' => 'maps-par-zoom'
		];

		$params['defzoom'] = [
			'type' => ParameterTypes::INTEGER,
			'range' => [ 0, 20 ],
			'default' => self::getDefaultZoom(),
			'message' => 'maps-leaflet-par-defzoom'
		];

		$params['layers'] = [
			'aliases' => 'layer',
			'type' => 'string',
			'values' => array_keys( $GLOBALS['egMapsLeafletAvailableLayers'], true, true ),
			'default' => $GLOBALS['egMapsLeafletLayers'],
			'message' => 'maps-leaflet-par-layers',
			'islist' => true,
		];

		$params['overlays'] = [
			'aliases' => [ 'overlaylayers' ],
			'type' => ParameterTypes::STRING,
			'values' => array_keys( $GLOBALS['egMapsLeafletAvailableOverlayLayers'], true, true ),
			'default' => $GLOBALS['egMapsLeafletOverlayLayers'],
			'message' => 'maps-leaflet-par-overlaylayers',
			'islist' => true,
		];

		$params['resizable'] = [
			'type' => ParameterTypes::BOOLEAN,
			'default' => $GLOBALS['egMapsResizableByDefault'],
			'message' => 'maps-par-resizable'
		];

		$params['fullscreen'] = [
			'aliases' => [ 'enablefullscreen' ],
			'type' => ParameterTypes::BOOLEAN,
			'default' => false,
			'message' => 'maps-par-enable-fullscreen',
		];

		$params['scrollwheelzoom'] = [
			'aliases' => [ 'scrollzoom' ],
			'type' => ParameterTypes::BOOLEAN,
			'default' => true,
			'message' => 'maps-par-scrollwheelzoom',
		];

		$params['cluster'] = [
			'aliases' => [ 'markercluster' ],
			'type' => ParameterTypes::BOOLEAN,
			'default' => false,
			'message' => 'maps-par-markercluster',
		];

		$params['clustermaxzoom'] = [
			'type' => ParameterTypes::INTEGER,
			'default' => 20,
			'message' => 'maps-par-clustermaxzoom',
		];

		$params['clusterzoomonclick'] = [
			'type' => ParameterTypes::BOOLEAN,
			'default' => true,
			'message' => 'maps-par-clusterzoomonclick',
		];

		$params['clustermaxradius'] = [
			'type' => ParameterTypes::INTEGER,
			'default' => 80,
			'message' => 'maps-par-maxclusterradius',
		];

		$params['clusterspiderfy'] = [
			'type' => ParameterTypes::BOOLEAN,
			'default' => true,
			'message' => 'maps-leaflet-par-clusterspiderfy',
		];

		$params['geojson'] = [
			'type' => ParameterTypes::STRING,
			'default' => '',
			'message' => 'maps-displaymap-par-geojson',
		];

		$params['clicktarget'] = [
			'type' => ParameterTypes::STRING,
			'default' => '',
			'message' => 'maps-leaflet-par-clicktarget',
		];

		return $params;
	}

	/**
	 * @since 3.0
	 */
	public function getDefaultZoom() {
		return $GLOBALS['egMapsLeafletZoom'];
	}

	public function newMapId(): string {
		static $mapsOnThisPage = 0;

		$mapsOnThisPage++;

		return 'map_leaflet_' . $mapsOnThisPage;
	}

	public function getResourceModules(): array {
		return [ 'ext.maps.leaflet.loader', 'ext.maps.leaflet.leafletajax' ];
	}

	public function getDependencyHtml( array $params ): string {
		$dependencies = [];

		// Only add dependencies that have not yet been added.
		foreach ( $this->getDependencies( $params ) as $dependency ) {
			if ( !in_array( $dependency, $this->addedDependencies ) ) {
				$dependencies[] = $dependency;
				$this->addedDependencies[] = $dependency;
			}
		}

		// If there are dependencies, put them all together in a string, otherwise return false.
		return $dependencies !== [] ? implode( '', $dependencies ) : false;
	}

	private function getDependencies( array $params ): array {
		$leafletPath = $GLOBALS['wgScriptPath'] . '/extensions/Maps/resources/lib/leaflet';

		return array_merge(
			[
				Html::linkedStyle( "$leafletPath/leaflet.css" ),
				Html::linkedScript( "$leafletPath/leaflet.js" ),
			],
			$this->getLayerDependencies( $params )
		);
	}

	private function getLayerDependencies( array $params ) {
		global $egMapsLeafletLayerDependencies, $egMapsLeafletAvailableLayers,
			   $egMapsLeafletLayersApiKeys;

		$layerDependencies = [];

		foreach ( $params['layers'] as $layerName ) {
			if ( array_key_exists( $layerName, $egMapsLeafletAvailableLayers )
				&& $egMapsLeafletAvailableLayers[$layerName]
				&& array_key_exists( $layerName, $egMapsLeafletLayersApiKeys )
				&& array_key_exists( $layerName, $egMapsLeafletLayerDependencies ) ) {
				$layerDependencies[] = '<script src="' . $egMapsLeafletLayerDependencies[$layerName] .
					$egMapsLeafletLayersApiKeys[$layerName] . '"></script>';
			}
		}

		return array_unique( $layerDependencies );
	}

	public function processingResultToMapParams( ProcessingResult $processingResult ): array {
		$mapParams = $processingResult->getParameterArray();

		if ( $mapParams['geojson'] !== '' ) {
			$fetcher = MapsFactory::newDefault()->newGeoJsonFetcher();

			$result = $fetcher->fetch( $mapParams['geojson'] );

			$mapParams['geojson'] = $result->getContent();
			$mapParams['GeoJsonSource'] = $result->getTitleValue() === null ? null : $result->getTitleValue()->getText();
			$mapParams['GeoJsonRevisionId'] = $result->getRevisionId();
		}

		return $mapParams;
	}

}