1
|
<?php
|
2
|
/**
|
3
|
* @file
|
4
|
* Functions for dealing maps
|
5
|
*
|
6
|
* @copyright
|
7
|
* (C) 2007-2013 EDIT
|
8
|
* European Distributed Institute of Taxonomy
|
9
|
* http://www.e-taxonomy.eu
|
10
|
*
|
11
|
* The contents of this module are subject to the Mozilla
|
12
|
* Public License Version 1.1.
|
13
|
* @see http://www.mozilla.org/MPL/MPL-1.1.html
|
14
|
*
|
15
|
* @author
|
16
|
* - Andreas Kohlbecker <a.kohlbecker@BGBM.org>
|
17
|
*/
|
18
|
|
19
|
/**
|
20
|
* Compose an render array for distribution and occurrence
|
21
|
* maps.
|
22
|
*
|
23
|
* The map can either be a plain image or a dynamic open layers map
|
24
|
* depending on the settings
|
25
|
*
|
26
|
* compose_hook() implementation
|
27
|
*
|
28
|
* @param string $occurrence_query
|
29
|
* @param string $distribution_query
|
30
|
* @param string $legend_format_query
|
31
|
* @param array $event_listeners
|
32
|
* An associative array of with OpenLayers.Map event names as key and corresponding js callbacks.
|
33
|
* In addition to the event names '#execute' as key is also allowed.
|
34
|
* Valid events are:
|
35
|
* - move
|
36
|
* - moveend
|
37
|
* - zoomend
|
38
|
* - changelayer
|
39
|
* - changebaselayer
|
40
|
* - #execute:
|
41
|
* force execution of the given callback after registration of the event handlers
|
42
|
* see http://dev.openlayers.org/apidocs/files/OpenLayers/Map-js.html#OpenLayers.Map.events for more
|
43
|
* @param bool $resizable
|
44
|
* only possible for openlayers_map
|
45
|
* @param string $force_map_type
|
46
|
* Can be used to override the map_type setting stored in the settings variable CDM_MAP_DISTRIBUTION
|
47
|
* - 1: openlayers_map
|
48
|
* - 0: image_map
|
49
|
*
|
50
|
* @return array
|
51
|
* A drupal render array
|
52
|
*
|
53
|
* Similar compose function compose_distribution_map()
|
54
|
*
|
55
|
* @ingroup compose
|
56
|
*/
|
57
|
function compose_map($occurrence_query = NULL, $distribution_query = NULL,
|
58
|
$legend_format_query = NULL, array $event_listeners = array(), $resizable = false,
|
59
|
$force_map_type = NULL) {
|
60
|
|
61
|
$map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
|
62
|
|
63
|
if($force_map_type === NULL){
|
64
|
$force_map_type = $map_settings['map_type'];
|
65
|
}
|
66
|
|
67
|
if ($force_map_type == 1) {
|
68
|
_add_jquery_ui();
|
69
|
$map_html = get_openlayers_map(
|
70
|
$occurrence_query,
|
71
|
$distribution_query,
|
72
|
$legend_format_query,
|
73
|
$map_settings['caption'],
|
74
|
$event_listeners,
|
75
|
$resizable
|
76
|
);
|
77
|
}
|
78
|
else {
|
79
|
$map_height = round($map_settings['image_map']['width'] / (float)$map_settings['aspect_ratio']);
|
80
|
$map_html = get_image_map(
|
81
|
$map_settings['image_map']['width'],
|
82
|
$map_height,
|
83
|
$occurrence_query,
|
84
|
$distribution_query,
|
85
|
$legend_format_query,
|
86
|
$map_settings['caption']
|
87
|
);
|
88
|
}
|
89
|
return markup_to_render_array($map_html);
|
90
|
}
|
91
|
|
92
|
/**
|
93
|
* @param $map_settings
|
94
|
* The map settings array as retrieved by e.g. get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
|
95
|
* @param array $event_listeners
|
96
|
* An associative array of with OpenLayers.Map event names as key and corresponding js callbacks.
|
97
|
* In addition to the event names '#execute' as key is also allowed.
|
98
|
* Valid events are:
|
99
|
* - move
|
100
|
* - moveend
|
101
|
* - zoomend
|
102
|
* - changelayer
|
103
|
* - changebaselayer
|
104
|
* - #execute:
|
105
|
* force execution of the given callback after registration of the event handlers
|
106
|
* see http://dev.openlayers.org/apidocs/files/OpenLayers/Map-js.html#OpenLayers.Map.events for more
|
107
|
* @param bool $resizable
|
108
|
* The map is made resizable when set to true
|
109
|
*/
|
110
|
function _add_js_openlayers_map($map_settings, array $event_listeners = array(), $resizable = false) {
|
111
|
|
112
|
font_awesome_icon_markup(); // no icon specified, only used to add the font and styles
|
113
|
|
114
|
_add_js_openlayers();
|
115
|
|
116
|
$edit_map_service = get_edit_map_service_settings();
|
117
|
|
118
|
drupal_add_js(drupal_get_path('module', 'cdm_dataportal') . '/js/map/openlayers_map.js');
|
119
|
drupal_add_js(drupal_get_path('module', 'cdm_dataportal') . '/js/map/openlayers_layers.js');
|
120
|
|
121
|
$cdm_openlayers_options = array(
|
122
|
'legendPosition' => '3',
|
123
|
'boundingBox' => $map_settings['bbox'],
|
124
|
'aspectRatio' => $map_settings['aspect_ratio'],
|
125
|
'distributionOpacity' => $map_settings['distribution_opacity'],
|
126
|
'legendOpacity' => $map_settings['legend']['opacity'],
|
127
|
'showLayerSwitcher' => $map_settings['openlayers']['show_layer_switcher'] == 1,
|
128
|
'displayOutsideMaxExtent' => $map_settings['openlayers']['display_outside_max_extent'] == 1,
|
129
|
'resizable' => $resizable
|
130
|
// 'imgPath' => drupal_get_path('module', 'cdm_dataportal') . '/js/map/OpenLayers-2.13.1/img/' // path to the control icons
|
131
|
// if no baseLayerNames or defaultBaseLayerName are not defined
|
132
|
// the defaults in cdm_openlayers.js will be used
|
133
|
);
|
134
|
|
135
|
// --- setting the base layer options
|
136
|
if (is_array($map_settings['openlayers']['base_layers']) && count($map_settings['openlayers']['base_layers']) > 0) {
|
137
|
|
138
|
$layer_names = $map_settings['openlayers']['base_layers'];
|
139
|
|
140
|
$cdm_openlayers_options['baseLayerNames'] = array_values($layer_names);
|
141
|
|
142
|
if($layer_names['PREFERRED']){
|
143
|
$cdm_openlayers_options['defaultBaseLayerName'] = $layer_names['PREFERRED'];
|
144
|
unset($layer_names['PREFERRED']); // why is this needed?
|
145
|
if(!array_search($cdm_openlayers_options['defaultBaseLayerName'], $cdm_openlayers_options['baseLayerNames'])){
|
146
|
// the default layer must also be in the list of base layers
|
147
|
$cdm_openlayers_options['baseLayerNames'][] = $cdm_openlayers_options['defaultBaseLayerName'];
|
148
|
}
|
149
|
}
|
150
|
|
151
|
|
152
|
}
|
153
|
|
154
|
// --- custom wms base layer
|
155
|
$map_settings['openlayers']['custom_wms_base_layer']['params'] = json_decode($map_settings['openlayers']['custom_wms_base_layer']['params']);
|
156
|
$cdm_openlayers_options['customWMSBaseLayerData'] = $map_settings['openlayers']['custom_wms_base_layer'];
|
157
|
|
158
|
// --- eventhandlers
|
159
|
$event_listeners_js = '';
|
160
|
$execute_handler = '';
|
161
|
foreach($event_listeners as $event=>$js_callback){
|
162
|
if($event == '#execute'){
|
163
|
$execute_handler = 'map_container.each(function(){' . $js_callback . '();});';
|
164
|
} else {
|
165
|
$event_listeners_js .= ($event_listeners_js ? ",\n": "\n") .'"' . $event . '": ' . $js_callback;
|
166
|
}
|
167
|
}
|
168
|
|
169
|
// // combine keys and values
|
170
|
// foreach($cdm_openlayers_options as $key=>&$val){
|
171
|
// $val = $key . ": " . $val;
|
172
|
// };
|
173
|
|
174
|
// window.onload - is executed when the document and images etc is fully loaded
|
175
|
// Query(document).ready - is executed much earlier, when the DOM is loaded
|
176
|
drupal_add_js("
|
177
|
jQuery(document).ready(function() {
|
178
|
jQuery(window).load(function () {
|
179
|
var map_container = jQuery('#openlayers_map').cdm_openlayers_map(
|
180
|
'" . $edit_map_service['base_uri'] . "',
|
181
|
'" . $edit_map_service['version'] . "',
|
182
|
" . json_encode($cdm_openlayers_options) . "
|
183
|
);
|
184
|
map_container.each(function(){
|
185
|
this.cdmOpenlayersMap.registerEvents({" . "
|
186
|
" . $event_listeners_js . "
|
187
|
});
|
188
|
});
|
189
|
" . $execute_handler . "
|
190
|
});
|
191
|
});
|
192
|
", array('type' => 'inline'));
|
193
|
|
194
|
}
|
195
|
|
196
|
|
197
|
/**
|
198
|
* @todo Enter description here ...
|
199
|
*
|
200
|
* @param unknown_type $bounding_box
|
201
|
* @param unknown_type $occurrenceQuery
|
202
|
* @param unknown_type $distributionQuery
|
203
|
* @param unknown_type $legendFormatQuery
|
204
|
* @param unknown_type $map_caption
|
205
|
* @param array $event_listeners
|
206
|
* An associative array of with OpenLayers.Map event names as key and corresponding js callbacks.
|
207
|
* In addition to the event names '#execute' as key is also allowed.
|
208
|
* Valid events are:
|
209
|
* - move
|
210
|
* - moveend
|
211
|
* - zoomend
|
212
|
* - changelayer
|
213
|
* - changebaselayer
|
214
|
* - #execute:
|
215
|
* force execution of the given callback after registration of the event handlers
|
216
|
* see http://dev.openlayers.org/apidocs/files/OpenLayers/Map-js.html#OpenLayers.Map.events for more
|
217
|
*
|
218
|
* @return String
|
219
|
* rendered html
|
220
|
*/
|
221
|
function get_openlayers_map($occurrenceQuery = FALSE, $distributionQuery = FALSE,
|
222
|
$legendFormatQuery = FALSE, $map_caption = FALSE, array $event_listeners = array(),
|
223
|
$resizable = false) {
|
224
|
|
225
|
$map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
|
226
|
|
227
|
_add_js_openlayers_map($map_settings, $event_listeners, $resizable);
|
228
|
|
229
|
$out = '<div id="openlayers_container" class="openlayers_width ui-widget-content" style="width: 100%;">';
|
230
|
$out .= '<div id="openlayers_map" class="smallmap" style="width:100%; height:100%; margin: 10px;"';
|
231
|
|
232
|
// Additional query parameters as set in the data portal admin section.
|
233
|
$labels_on = $map_settings['show_labels'];
|
234
|
|
235
|
// need to set the ms parameter to some value in order to satisfy the
|
236
|
// map service even if this value should not be required:
|
237
|
$width = 512;
|
238
|
|
239
|
$openlayers_map_query_string = '&img=false&ms=' . $width
|
240
|
. ($labels_on ? '&label=' . $labels_on : '');
|
241
|
|
242
|
if ($occurrenceQuery) {
|
243
|
// @todo Fix $occurrenceQuery.
|
244
|
// $occurrenceQuery .= '&bbox=-180,-90,180,90';
|
245
|
$occurrenceQuery .= '&l=v%3Aatbi%2Ce_w_0'; // TODO why are we using v:atbi,e_w_0 as layer ???
|
246
|
// $occurrenceQuery .= '&l=v:e_w_0';
|
247
|
// TODO add to cdm service?
|
248
|
$occurrenceQuery .= '&legend=0';
|
249
|
|
250
|
$out .= ' occurrenceQuery="' . $occurrenceQuery . '&' . $openlayers_map_query_string . '"';
|
251
|
}
|
252
|
|
253
|
if ($distributionQuery) {
|
254
|
//HACK for testing (this must be done in js)
|
255
|
// $distributionQuery .= "&layer=em_tiny_jan2003&dest_projection_epsg=7777777";
|
256
|
$out .= ' distributionQuery="' . $distributionQuery . '&' . $openlayers_map_query_string . '"';
|
257
|
}
|
258
|
|
259
|
if ($legendFormatQuery) {
|
260
|
$out .= ' legendFormatQuery="' . $legendFormatQuery . '"';
|
261
|
}
|
262
|
|
263
|
$out .= '></div></div>';
|
264
|
|
265
|
// Showing map caption.
|
266
|
if ($map_caption) {
|
267
|
$out .= '<div class="distribution_map_caption">' . $map_caption . '</div>';
|
268
|
}
|
269
|
return $out;
|
270
|
}
|
271
|
|
272
|
|
273
|
/**
|
274
|
* Composes the render array for a distribution map of the given taxon.
|
275
|
*
|
276
|
* The distribution map can either be a plain image or a dynamic open layers map
|
277
|
* depending on the settings.
|
278
|
*
|
279
|
* compose_hook() implementation
|
280
|
*
|
281
|
* @param $taxon
|
282
|
* The CDM Taxon instance to create the distribution map for.
|
283
|
* @return array
|
284
|
* A drupal render array
|
285
|
*
|
286
|
* Similar compose function compose_map()
|
287
|
*
|
288
|
* @ingroup compose
|
289
|
*/
|
290
|
function compose_distribution_map($taxon, $query_string) {
|
291
|
|
292
|
$out = '';
|
293
|
|
294
|
$fontStyles = array(
|
295
|
0 => "plane",
|
296
|
1 => "italic",
|
297
|
);
|
298
|
|
299
|
// // Query cdm server for map service uri parameters.
|
300
|
// $query_string = cdm_ws_get(CDM_WS_GEOSERVICE_DISTRIBUTIONMAP, $taxon->uuid, queryString(cdm_distribution_filter_query()));
|
301
|
// $query_string = $query_string->String;
|
302
|
$out .= "<!-- map_data_parameters:" . print_r($query_string, TRUE) . " -->";
|
303
|
if (!$query_string) {
|
304
|
// The $query_string is empty if there are no distribution areas defined.
|
305
|
return;
|
306
|
}
|
307
|
|
308
|
/* ------ choose the display mode, either openlayers or static image ------ */
|
309
|
|
310
|
$map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
|
311
|
|
312
|
if ($map_settings['map_type'] == 1) {
|
313
|
|
314
|
/* =========== display distributions using the openlayers map viewer =========== */
|
315
|
|
316
|
$legendFormatQueryStr = "format=image" . urlencode('/') . "png"
|
317
|
. "&TRANSPARENT=TRUE"
|
318
|
. "&WIDTH=" . $map_settings['legend']['icon_width']
|
319
|
. "&HEIGHT=" . $map_settings['legend']['icon_height']
|
320
|
// TODO why is the layer=topp:tdwg_level_4 parameter needed at all here??
|
321
|
// AK: i think the tdwg_level_4 is used as place holder and will be replaced later on
|
322
|
// => search for "tdwg_level_4" in the code
|
323
|
. "&layer=topp" . urlencode(':') . "tdwg_level_4"
|
324
|
. "&LEGEND_OPTIONS=forceLabels" . urlencode(':') . "on"
|
325
|
. ";fontStyle" . urlencode(':') . $fontStyles[$map_settings['legend']['font_style']]
|
326
|
. ";fontSize" . urlencode(':') . $map_settings['legend']['font_size']
|
327
|
. "&SLD=";
|
328
|
|
329
|
/*$out .= get_openlayers_map(
|
330
|
$map_settings['bbox'],
|
331
|
NULL,
|
332
|
$query_string,
|
333
|
$legendFormatQueryStr,
|
334
|
$map_settings['caption']
|
335
|
);
|
336
|
*/
|
337
|
}
|
338
|
else {
|
339
|
$legendFormatQueryStr = '';
|
340
|
/*
|
341
|
get_image_map(
|
342
|
$map_settings['image_map']['width'],
|
343
|
$map_settings['image_map']['height'],
|
344
|
$map_settings['bbox'],
|
345
|
NULL,
|
346
|
$query_string,
|
347
|
$legendFormatQueryStr,
|
348
|
$map_settings['caption']
|
349
|
);
|
350
|
*/
|
351
|
}
|
352
|
$out = compose_map(NULL, $query_string, $legendFormatQueryStr);
|
353
|
|
354
|
return $out;
|
355
|
}
|
356
|
|
357
|
|
358
|
|
359
|
|
360
|
/**
|
361
|
* @todo Enter description here ...
|
362
|
*
|
363
|
* @param unknown_type $width
|
364
|
* @param unknown_type $occurrenceQuery
|
365
|
* @param unknown_type $distributionQuery
|
366
|
* @param unknown_type $legendFormatQuery
|
367
|
* @param unknown_type $map_caption
|
368
|
*
|
369
|
* @return String
|
370
|
* rendered html
|
371
|
*/
|
372
|
function get_image_map($width, $height= NULL, $occurrenceQuery = FALSE, $distributionQuery = FALSE,
|
373
|
$legendFormatQuery = FALSE, $map_caption = FALSE) {
|
374
|
|
375
|
$map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
|
376
|
|
377
|
$baselayer_name = $map_settings['image_map']['base_layer'];
|
378
|
if(empty($baselayer_name)){
|
379
|
$baselayer_name = "earth";
|
380
|
}
|
381
|
|
382
|
$query_string = '&img=true&recalculate=false&ms=' . $width . ($height ? ',' . $height : '')
|
383
|
// Additional query parameters as set in the data portal admin section.
|
384
|
. ($map_settings['bbox'] ? '&bbox=' . $map_settings['bbox'] : '')
|
385
|
. ($map_settings['show_labels'] ? '&label=' . $map_settings['show_labels'] : '');
|
386
|
|
387
|
if ($map_caption) {
|
388
|
$query_string .= '&mlp=3&mc_s=Georgia,15,blue&mc=' . $map_caption;
|
389
|
}
|
390
|
|
391
|
if (get_edit_map_service_version_number() >= 1.1) {
|
392
|
|
393
|
// Either occurrence or distribution - combined maps will be possible
|
394
|
// in the future.
|
395
|
if ($occurrenceQuery) {
|
396
|
// @todo Fix $occurrenceQuery.
|
397
|
$occurrenceQuery = str_replace("&image=false", "", $occurrenceQuery);
|
398
|
// $occurrenceQuery .= '&l=v%3Aatbi%2Ce_w_0';
|
399
|
|
400
|
// Will be replaced below.. HACK!!!
|
401
|
$occurrenceQuery .= '&l=' . $baselayer_name . '&as=';
|
402
|
|
403
|
$query_string .= "&" . $occurrenceQuery;
|
404
|
}
|
405
|
elseif ($distributionQuery) {
|
406
|
$query_string .= '&l=' . $baselayer_name . "&" .$distributionQuery;
|
407
|
}
|
408
|
|
409
|
// Apply Plain Image map settings special for version >= 1.1.
|
410
|
/*
|
411
|
example : title=a:Naturalized++non-invasive
|
412
|
&ad=cyprusdivs:bdcode:a:5&as=a:ff9900,,0.1,&l=tdwg4
|
413
|
&ms=500&bbox=32,34,35,36&img=true&legend=1&mlp=3
|
414
|
&mc_s=Georgia,15,blue&mc=&recalculate=false
|
415
|
|
416
|
http://edit.br.fgov.be/edit_wp5/v1/rest_gen.php?
|
417
|
l=background_gis:b,cyprusdivs&ad=cyprusdivs%3Abdcode%3Aa%3A8%2C4
|
418
|
&as=a%3A339966%2C%2C0.1%2C|b:0000ff,,
|
419
|
&bbox=32%2C34%2C35%2C36&img=true&legend=1&mc=&mc_s=Georgia%2C15%2Cblue
|
420
|
&mlp=3&ms=500&recalculate=false&title=a%3Aindigenous
|
421
|
*/
|
422
|
|
423
|
$map_service_script_name = "rest_gen.php";
|
424
|
|
425
|
$bgcolor_areaStyleId = "Y";
|
426
|
$baselayer_areaStyleId = "Z";
|
427
|
$bgcolor_layer = '';
|
428
|
$additional_area_styles = array();
|
429
|
|
430
|
// Background color:
|
431
|
if ($map_settings['image_map']['bg_color'] ) {
|
432
|
$bgcolor_layer = "background_gis:" . $bgcolor_areaStyleId;
|
433
|
$additional_area_styles[] = $bgcolor_areaStyleId . ":" . $map_settings['image_map']['bg_color'] . ",,";
|
434
|
}
|
435
|
|
436
|
// TODO HACK to replace the default base layer which currently is tdwg4 !!!
|
437
|
// only needed for distribution maps.
|
438
|
if (strpos($query_string, "?l=") !== FALSE) {
|
439
|
$layer_param_token = "?l=";
|
440
|
}
|
441
|
else {
|
442
|
$layer_param_token = "&l=";
|
443
|
}
|
444
|
if (strpos($query_string, "?as=") !== FALSE) {
|
445
|
$areystyle_param_token = "?as=";
|
446
|
}
|
447
|
else {
|
448
|
$areystyle_param_token = "&as=";
|
449
|
}
|
450
|
if ($map_settings['image_map']['base_layer']) {
|
451
|
$query_string = str_replace($layer_param_token .$baselayer_name, "$layer_param_token" . $map_settings['image_map']['base_layer'] . ":" . $baselayer_areaStyleId, $query_string);
|
452
|
}
|
453
|
else {
|
454
|
$query_string = str_replace($layer_param_token . $baselayer_name, $layer_param_token . $baselayer_name . ":" . $baselayer_areaStyleId . ",", $query_string);
|
455
|
}
|
456
|
|
457
|
if ($bgcolor_layer) {
|
458
|
$query_string = str_replace($layer_param_token, $layer_param_token . $bgcolor_layer . ",", $query_string);
|
459
|
}
|
460
|
|
461
|
if ($map_settings['image_map']['layer_style']) {
|
462
|
$additional_area_styles[] = $baselayer_areaStyleId . ":" . $map_settings['image_map']['layer_style'];
|
463
|
}
|
464
|
|
465
|
if(isset($map_settings['projection'])){
|
466
|
$query_string .= "&srs=" . $map_settings['projection'];
|
467
|
}
|
468
|
|
469
|
if(isset($map_settings['legend']['show']) && $map_settings['legend']['show']){
|
470
|
$query_string .= "&legend=1";
|
471
|
}
|
472
|
|
473
|
foreach ($additional_area_styles as $as) {
|
474
|
$query_string = str_replace($areystyle_param_token, $areystyle_param_token . $as . "|", $query_string);
|
475
|
}
|
476
|
|
477
|
}
|
478
|
else {
|
479
|
// Pre 1.1. version of map service.
|
480
|
if ($occurrenceQuery) {
|
481
|
|
482
|
$map_service_script_name = "point.php";
|
483
|
|
484
|
// Fix $occurrenceQuery.
|
485
|
$occurrenceQuery = str_replace("&image=false", "", $occurrenceQuery);
|
486
|
// $occurrenceQuery .= '&l=v%3Aatbi%2Ce_w_0';
|
487
|
$occurrenceQuery .= '&l=v:e_w_0';
|
488
|
$query_string .= "&" . $occurrenceQuery;
|
489
|
}
|
490
|
elseif ($distributionQuery) {
|
491
|
$query_string .= "&" . $distributionQuery;
|
492
|
$map_service_script_name = "areas.php";
|
493
|
}
|
494
|
}
|
495
|
|
496
|
$mapUri = url(get_edit_map_service_full_uri() . '/' . $map_service_script_name . '?' . $query_string);
|
497
|
$out = '<img class="distribution_map" src="' . $mapUri . '" alt="Map" />';
|
498
|
// Showing map caption.
|
499
|
if ($map_caption) {
|
500
|
$out .= '<div class="distribution_map_caption">' . $map_caption . '</div>';
|
501
|
}
|
502
|
|
503
|
return $out;
|
504
|
}
|
505
|
|
506
|
|