Project

General

Profile

Download (17.3 KB) Statistics
| Branch: | Tag: | Revision:
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
    if(isset($layer_names['PREFERRED'])){
141
      $cdm_openlayers_options['defaultBaseLayerName'] = $layer_names['PREFERRED'];
142
      unset($layer_names['PREFERRED']);
143
    }
144

    
145
    $cdm_openlayers_options['baseLayerNames'] = array_values($layer_names);
146

    
147
  }
148

    
149
  // --- custom wms base layer
150
  $map_settings['openlayers']['custom_wms_base_layer']['params'] = json_decode($map_settings['openlayers']['custom_wms_base_layer']['params']);
151
  $cdm_openlayers_options['customWMSBaseLayerData'] = $map_settings['openlayers']['custom_wms_base_layer'];
152

    
153
  // --- eventhandlers
154
  $event_listeners_js = '';
155
  $execute_handler = '';
156
  foreach($event_listeners as $event=>$js_callback){
157
    if($event == '#execute'){
158
      $execute_handler = 'map_container.each(function(){' . $js_callback . '();});';
159
    } else {
160
      $event_listeners_js .= ($event_listeners_js ? ",\n": "\n") .'"' . $event . '": ' . $js_callback;
161
    }
162
  }
163

    
164
//   // combine keys and values
165
//   foreach($cdm_openlayers_options as $key=>&$val){
166
//     $val = $key . ": " . $val;
167
//   };
168

    
169
  // window.onload - is executed when the document and images etc is fully loaded
170
  // Query(document).ready - is executed much earlier, when the DOM is loaded
171
  drupal_add_js("
172
          jQuery(document).ready(function() {
173
                jQuery(window).load(function () {
174
                  var map_container = jQuery('#openlayers_map').cdm_openlayers_map(
175
                   '" . $edit_map_service['base_uri'] . "',
176
                   '" . $edit_map_service['version'] . "',
177
                   " .  json_encode($cdm_openlayers_options) . "
178
                );
179
                map_container.each(function(){
180
                        this.cdmOpenlayersMap.registerEvents({" . "
181
                        " . $event_listeners_js . "
182
                        });
183
                });
184
                " . $execute_handler . "
185
        });
186
      });
187
    ", array('type' => 'inline'));
188

    
189
}
190

    
191

    
192
/**
193
 * @todo Enter description here ...
194
 *
195
 * @param unknown_type $bounding_box
196
 * @param unknown_type $occurrenceQuery
197
 * @param unknown_type $distributionQuery
198
 * @param unknown_type $legendFormatQuery
199
 * @param unknown_type $map_caption
200
 * @param array $event_listeners
201
 *   An associative array of with OpenLayers.Map event names as key and corresponding js callbacks.
202
 *   In addition to the event names '#execute' as key is also allowed.
203
 *   Valid events are:
204
 *      - move
205
 *      - moveend
206
 *      - zoomend
207
 *      - changelayer
208
 *      - changebaselayer
209
 *      - #execute:
210
 *            force execution of the given callback after registration of the event handlers
211
 *   see http://dev.openlayers.org/apidocs/files/OpenLayers/Map-js.html#OpenLayers.Map.events for more
212
 *
213
 * @return String
214
 *    rendered html
215
 */
216
function get_openlayers_map($occurrenceQuery = FALSE, $distributionQuery = FALSE,
217
                            $legendFormatQuery = FALSE, $map_caption = FALSE, array $event_listeners = array(),
218
                            $resizable = false) {
219

    
220
  $map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
221

    
222
  _add_js_openlayers_map($map_settings, $event_listeners, $resizable);
223

    
224
  $out = '<div id="openlayers_container" class="openlayers_width ui-widget-content" style="width: 100%;">';
225
  $out .= '<div id="openlayers_map" class="smallmap" style="width:100%; height:100%; margin: 10px;"';
226

    
227
  // Additional query parameters as set in the data portal admin section.
228
  $labels_on = $map_settings['show_labels'];
229

    
230
  // need to set the ms parameter to some value in order to satisfy the
231
  // map service even if this value should not be required:
232
  $width = 512;
233

    
234
  $openlayers_map_query_string = '&img=false&ms=' . $width
235
  . ($labels_on ? '&label=' . $labels_on : '');
236

    
237
  if ($occurrenceQuery) {
238
    // @todo Fix $occurrenceQuery.
239
    //     $occurrenceQuery .= '&bbox=-180,-90,180,90';
240
    $occurrenceQuery .= '&l=v%3Aatbi%2Ce_w_0'; // TODO why are we using v:atbi,e_w_0 as layer ???
241
    // $occurrenceQuery .= '&l=v:e_w_0';
242
    // TODO add to cdm service?
243
    $occurrenceQuery .= '&legend=0';
244

    
245
    $out .= ' occurrenceQuery="' . $occurrenceQuery . '&' . $openlayers_map_query_string . '"';
246
  }
247

    
248
  if ($distributionQuery) {
249
    //HACK for testing (this must be done in js)
250
//     $distributionQuery .= "&layer=em_tiny_jan2003&dest_projection_epsg=7777777";
251
    $out .= ' distributionQuery="' . $distributionQuery . '&' . $openlayers_map_query_string . '"';
252
  }
253

    
254
  if ($legendFormatQuery) {
255
    $out .= ' legendFormatQuery="' . $legendFormatQuery . '"';
256
  }
257

    
258
  $out .= '></div></div>';
259

    
260
  // Showing map caption.
261
  if ($map_caption) {
262
    // FIXME: replace <br> by according css style.
263
    $out .= '<div class="distribution_map_caption">' . $map_caption . '</div>' . '<br />';
264
    $out .= '</div>';
265
  }
266
  return $out;
267
}
268

    
269

    
270
/**
271
 * Composes the render array for a distribution map of the given taxon.
272
 *
273
 * The distribution map can either be a plain image or a dynamic open layers map
274
 * depending on the settings.
275
 *
276
 * compose_hook() implementation
277
 *
278
 * @param $taxon
279
 *   The CDM Taxon instance to create the distribution map for.
280
 * @return array
281
 *    A drupal render array
282
 *
283
 * Similar compose function compose_map()
284
 *
285
 * @ingroup compose
286
 */
287
function compose_distribution_map($taxon, $query_string) {
288

    
289
  $out = '';
290
  $settings = get_edit_map_service_settings();
291

    
292
  $fontStyles = array(
293
      0 => "plane",
294
      1 => "italic",
295
  );
296

    
297
//   // Query cdm server for map service uri parameters.
298
//   $query_string = cdm_ws_get(CDM_WS_GEOSERVICE_DISTRIBUTIONMAP, $taxon->uuid, queryString(cdm_distribution_filter_query()));
299
//   $query_string = $query_string->String;
300
  $out .= "<!-- map_data_parameters:" . print_r($query_string, TRUE) . " -->";
301
  if (!$query_string) {
302
    // The $query_string is empty if there are no distribution areas defined.
303
    return;
304
  }
305

    
306
  /* ------ choose the display mode, either openlayers or static image ------ */
307

    
308
  $map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
309

    
310
  if ($map_settings['map_type'] == 1) {
311

    
312
    /* =========== display distributions using the openlayers map viewer =========== */
313

    
314
    $legendFormatQueryStr = "format=image" . urlencode('/') . "png"
315
      . "&TRANSPARENT=TRUE"
316
      . "&WIDTH=" . $map_settings['legend']['icon_width']
317
      . "&HEIGHT=" . $map_settings['legend']['icon_height']
318
      // TODO why is the layer=topp:tdwg_level_4 parameter needed at all here??
319
      // AK: i think the tdwg_level_4 is used as place holder and will be replaced later on
320
      // => search for "tdwg_level_4" in the code
321
      . "&layer=topp" . urlencode(':') . "tdwg_level_4"
322
      . "&LEGEND_OPTIONS=forceLabels" . urlencode(':') . "on"
323
      . ";fontStyle" . urlencode(':') . $fontStyles[$map_settings['legend']['font_style']]
324
      . ";fontSize" . urlencode(':') .  $map_settings['legend']['font_size']
325
      . "&SLD=";
326

    
327
    /*$out .= get_openlayers_map(
328
        $map_settings['bbox'],
329
        NULL,
330
        $query_string,
331
        $legendFormatQueryStr,
332
        $map_settings['caption']
333
    );
334
    */
335
  }
336
  else {
337
    $legendFormatQueryStr = '';
338
    /*
339
        get_image_map(
340
            $map_settings['image_map']['width'],
341
            $map_settings['image_map']['height'],
342
            $map_settings['bbox'],
343
            NULL,
344
            $query_string,
345
            $legendFormatQueryStr,
346
            $map_settings['caption']
347
        );
348
    */
349
  }
350
  $out = compose_map(NULL, $query_string, $legendFormatQueryStr);
351

    
352
  return $out;
353
}
354

    
355

    
356

    
357

    
358
/**
359
 * @todo Enter description here ...
360
 *
361
 * @param unknown_type $width
362
 * @param unknown_type $occurrenceQuery
363
 * @param unknown_type $distributionQuery
364
 * @param unknown_type $legendFormatQuery
365
 * @param unknown_type $map_caption
366
 *
367
* @return String
368
 *    rendered html
369
 */
370
function get_image_map($width, $height= NULL, $occurrenceQuery = FALSE, $distributionQuery = FALSE, $legendFormatQuery = FALSE, $map_caption = FALSE) {
371

    
372
  $map_settings = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
373

    
374
  $baselayer_name = $map_settings['image_map']['base_layer'];
375
  if(empty($baselayer_name)){
376
    $baselayer_name = "earth";
377
  }
378

    
379
  $query_string = '&img=true&recalculate=false&ms=' . $width . ($height ? ',' . $height : '')
380
  // Additional query parameters as set in the data portal admin section.
381
  . ($map_settings['bbox'] ? '&bbox=' . $map_settings['bbox'] : '')
382
  . ($map_settings['show_labels'] ? '&label=' . $map_settings['show_labels'] : '');
383

    
384
  if ($map_caption) {
385
    $query_string .= '&mlp=3&mc_s=Georgia,15,blue&mc=' . $map_caption;
386
  }
387

    
388
  if (get_edit_map_service_version_number() >= 1.1) {
389

    
390
    // Either occurrence or distribution - combined maps will be possible
391
    // in the future.
392
    if ($occurrenceQuery) {
393
      // @todo Fix $occurrenceQuery.
394
      $occurrenceQuery = str_replace("&image=false", "", $occurrenceQuery);
395
      // $occurrenceQuery .= '&l=v%3Aatbi%2Ce_w_0';
396

    
397
      // Will be replaced below.. HACK!!!
398
      $occurrenceQuery .= '&l=' . $baselayer_name . '&as=';
399

    
400
      $query_string .= "&" . $occurrenceQuery;
401
    }
402
    elseif ($distributionQuery) {
403
      $query_string .= '&l=' . $baselayer_name . "&" .$distributionQuery;
404
    }
405

    
406
    // Apply Plain Image map settings special for version >= 1.1.
407
    /*
408
    example : title=a:Naturalized++non-invasive
409
    &ad=cyprusdivs:bdcode:a:5&as=a:ff9900,,0.1,&l=tdwg4
410
    &ms=500&bbox=32,34,35,36&img=true&legend=1&mlp=3
411
    &mc_s=Georgia,15,blue&mc=&recalculate=false
412

    
413
    http://edit.br.fgov.be/edit_wp5/v1/rest_gen.php?
414
    l=background_gis:b,cyprusdivs&ad=cyprusdivs%3Abdcode%3Aa%3A8%2C4
415
    &as=a%3A339966%2C%2C0.1%2C|b:0000ff,,
416
    &bbox=32%2C34%2C35%2C36&img=true&legend=1&mc=&mc_s=Georgia%2C15%2Cblue
417
    &mlp=3&ms=500&recalculate=false&title=a%3Aindigenous
418
    */
419

    
420
    $map_service_script_name = "rest_gen.php";
421

    
422
    $bgcolor_areaStyleId = "Y";
423
    $baselayer_areaStyleId = "Z";
424
    $bgcolor_layer = '';
425
    $additional_area_styles = array();
426

    
427
    // Background color:
428
    if ($map_settings['image_map']['bg_color'] ) {
429
      $bgcolor_layer = "background_gis:" . $bgcolor_areaStyleId;
430
      $additional_area_styles[] = $bgcolor_areaStyleId . ":" . $map_settings['image_map']['bg_color'] . ",,";
431
    }
432

    
433
    // TODO HACK to replace the default base layer which currently is tdwg4 !!!
434
    // only needed for distribution maps.
435
    if (strpos($query_string, "?l=") !== FALSE) {
436
      $layer_param_token = "?l=";
437
    }
438
    else {
439
      $layer_param_token = "&l=";
440
    }
441
    if (strpos($query_string, "?as=") !== FALSE) {
442
      $areystyle_param_token = "?as=";
443
    }
444
    else {
445
      $areystyle_param_token = "&as=";
446
    }
447
    if ($map_settings['image_map']['base_layer']) {
448
      $query_string = str_replace($layer_param_token .$baselayer_name, "$layer_param_token" . $map_settings['image_map']['base_layer'] . ":" . $baselayer_areaStyleId, $query_string);
449
    }
450
    else {
451
      $query_string = str_replace($layer_param_token . $baselayer_name, $layer_param_token . $baselayer_name . ":" . $baselayer_areaStyleId . ",", $query_string);
452
    }
453

    
454
    if ($bgcolor_layer) {
455
      $query_string = str_replace($layer_param_token, $layer_param_token . $bgcolor_layer . ",", $query_string);
456
    }
457

    
458
    if ($map_settings['image_map']['layer_style']) {
459
      $additional_area_styles[] = $baselayer_areaStyleId . ":" . $map_settings['image_map']['layer_style'];
460
    }
461

    
462
    if(isset($map_settings['projection'])){
463
      $query_string .= "&srs=" . $map_settings['projection'];
464
    }
465

    
466
    if(isset($map_settings['legend']['show']) && $map_settings['legend']['show']){
467
      $query_string .= "&legend=1";
468
    }
469

    
470
    foreach ($additional_area_styles as $as) {
471
      $query_string = str_replace($areystyle_param_token, $areystyle_param_token . $as . "|", $query_string);
472
    }
473

    
474
  }
475
  else {
476
    // Pre 1.1. version of map service.
477
    if ($occurrenceQuery) {
478

    
479
      $map_service_script_name = "point.php";
480

    
481
      // Fix $occurrenceQuery.
482
      $occurrenceQuery = str_replace("&image=false", "", $occurrenceQuery);
483
      // $occurrenceQuery .= '&l=v%3Aatbi%2Ce_w_0';
484
      $occurrenceQuery .= '&l=v:e_w_0';
485
      $query_string .= "&" . $occurrenceQuery;
486
    }
487
    elseif ($distributionQuery) {
488
      $query_string .= "&" . $distributionQuery;
489
      $map_service_script_name = "areas.php";
490
    }
491
  }
492

    
493
  $mapUri = url(get_edit_map_service_full_uri() . '/' . $map_service_script_name . '?' .  $query_string);
494
  $out = '<img class="distribution_map" src="' . $mapUri . '" alt="Map" />';
495
  // Showing map caption.
496
  if ($map_caption) {
497
    // FIXME: replace <br> by according css style.
498
    $out .= '<div class="distribution_map_caption">' . $map_caption . '</div>' . '<br />';
499
    $out .= '</div>';
500
  }
501

    
502
  return $out;
503
}
504

    
505

    
(3-3/10)