Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

cdm-dataportal / modules / cdm_dataportal / settings.php @ 4feeabc7

History | View | Annotate | Download (146 KB)

1
<?php
2
/**
3
 * @file
4
 * CDM Dataportal settings.
5
 */
6

    
7

    
8
  // TODO Genus UUID.
9

    
10
  define('TAXONTREE_RANKLIMIT', 'cdm_taxontree_ranklimit');
11
  define('TAXONTREE_RANKLIMIT_DEFAULT', 0);
12
  define('CDM_TAXONOMICTREE_UUID', 'cdm_taxonomictree_uuid');
13
  define('CDM_TAXONTREE_INCLUDES', 'taxontree_includes');
14

    
15
  define('NO_SORT', -1);
16
  define('SORT_HIERARCHICAL', 9);
17

    
18
  define('CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE', 25);
19

    
20
  define('SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX_DEFAULT', 1);
21
  define('SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX', 'search_results_show_thumbnail_checkbox');
22

    
23
  define('CDM_DATAPORTAL_NOMREF_IN_TITLE', 1);
24
  define('CDM_DATAPORTAL_COMPRESSED_SPECIMEN_DERIVATE_TABLE', 0);
25
  define('CDM_DATAPORTAL_TAXON_AUTO_SUGGEST', 0);
26
  define('CDM_DATAPORTAL_COMPRESSED_SPECIMEN_DERIVATE_TABLE_SHOW_DETERMINED_AS', 1);
27
  define('CDM_DATAPORTAL_DISPLAY_IS_ACCEPTED_FOR', 0);
28
  define('CDM_DATAPORTAL_ALL_FOOTNOTES', 0);
29
  define('CDM_DATAPORTAL_ANNOTATIONS_FOOTNOTES', 0);
30
  define('CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX', 999);
31

    
32
  /* annotationTypeKeys */
33
  $annotationTypeKeys = array_keys(cdm_vocabulary_as_option(UUID_ANNOTATION_TYPE));
34
  if (in_array(UUID_ANNOTATION_TYPE_TECHNICAL, $annotationTypeKeys)) {
35
    $annotationTypeKeys = array_flip($annotationTypeKeys);
36

    
37
    // Technical annotation are off by default.
38
    unset($annotationTypeKeys[UUID_ANNOTATION_TYPE_TECHNICAL]);
39
    $annotationTypeKeys = array_flip($annotationTypeKeys);
40
    // Additional value for the NULL case.
41
    $annotationTypeKeys[] = 'NULL_VALUE';
42
  }
43
  define('ANNOTATIONS_TYPES_AS_FOOTNOTES_DEFAULT', serialize($annotationTypeKeys));
44

    
45
  define('BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE', 'bibliography_for_original_source');
46
  define('BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE_DEFAULT', serialize(array(
47
    'enabled' => 0,
48
    'key_format' => 'ALPHA'
49
  )));
50

    
51
  /* taxonRelationshipTypes */
52
  define('CDM_TAXON_RELATIONSHIP_TYPES_DEFAULT', serialize(array(UUID_MISAPPLIED_NAME_FOR, UUID_INVALID_DESIGNATION_FOR)));
53

    
54

    
55

    
56
    /* ---- MAP SETTING CONSTANTS ---- */
57
  /**
58
   * @var array of URIs eg. http://edit.africamuseum.be"
59
   *   An options array
60
   */
61
  define('EDIT_MAPSERVER_URI', serialize(
62
      array(
63
        'http://edit.africamuseum.be'=>'Primary (http://edit.africamuseum.be)',
64
        'http://edit.br.fgov.be'=>'Secondary (http://edit.br.fgov.be)',
65
      )
66
    )
67
  );
68
  define('EDIT_MAPSERVER_PATH', '/edit_wp5');
69
  /**
70
   * @var array of versions eg. "v1.2"
71
   *   An options array
72
   */
73
  define('EDIT_MAPSERVER_VERSION', serialize(
74
      array(
75
//        'v1' => 'v1' ,           // no longer recommended
76
//        'v1.1' => 'v1.1',        // no longer recommended
77
//        'v1.2_dev' => 'v1.2_dev',// no longer recommended
78
        'v1.2' => 'v1.2',
79
        'v1.3_dev' => 'v1.3_dev (not recommended)',
80
        'v1.4_dev' => 'v1.4_dev (experimental features)'
81
      )
82
    )
83
  );
84
  define('EDIT_MAPSERVER_URI_DEFAULT', 'http://edit.africamuseum.be');
85
  define('EDIT_MAPSERVER_VERSION_DEFAULT', 'v1.2');
86

    
87
    // --- Taxon profile settings --- /
88
  define('DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP', 'distribution_textdata_on_top');
89
  define('CDM_TAXON_PROFILE_IMAGE', 'cdm_taxon_profile_image');
90
  define('CDM_TAXON_PROFILE_IMAGE_DEFAULT', serialize(
91
      array(
92
          'show' => 0,
93
          'maxextend' => 184,
94
          'media_uri_query' => '',
95
          'custom_placeholder_enabled' => 1,
96
          'custom_placeholder_image_on' => 0,
97
          'custom_placeholder_image_fid' => ''
98
      )
99
    )
100
  );
101

    
102

    
103
define('FEATURE_BLOCK_SETTINGS', 'feature_block_settings');
104

    
105
define('DISTRIBUTION_CONDENSED', 'distribution_condensed');
106
define('DISTRIBUTION_CONDENSED_INFO_PATH', 'distribution_condensed_info_path');
107
define('DISTRIBUTION_CONDENSED_INFO_PATH_DEFAULT', 'cdm_dataportal/help/condensed_distribution');
108
define('DISTRIBUTION_CONDENSED_RECIPE', 'distribution_condensed_recipe');
109
define('DISTRIBUTION_CONDENSED_RECIPE_DEFAULT', 'EuroPlusMed');
110

    
111
define('DISTRIBUTION_STATUS_COLORS', 'distribution_status_colors');
112
define('DISTRIBUTION_ORDER_MODE', 'distribution_order_mode');
113
define('DISTRIBUTION_ORDER_MODE_DEFAULT', 'TREE');
114
define('DISTRIBUTION_TREE_OMIT_LEVELS', 'distribution_tree_omit_levels');
115

    
116
/**
117
 * Returns the array of implemented taxon page tabs.
118
 * The array has fixed integer keys which must not be changed.
119
 */
120
function get_taxon_tabs_list() {
121
  return array(
122
    0 => 'General',
123
    1 => 'Synonymy',
124
    2 => 'Images',
125
    3 => 'Specimens',
126
    4 => 'Keys',
127
    5 => 'Experts',
128
  );
129
}
130

    
131
define('CDM_TAXONPAGE_TAB_WEIGHT', 'cdm_taxonpage_tab_weight');
132
define('CDM_TAXONPAGE_TAB_WEIGHT_DEFAULT', serialize(
133
  array(
134
    'general' => '-3',
135
    'synonymy' => '-2',
136
    'images' => '0',
137
    'specimens' => '1',
138
    'keys' => '3',
139
    'experts' => '5',
140
    )
141
));
142

    
143

    
144
// CDM_TAXONPAGE_TAB_LABELS_DEFAULT
145
define('CDM_TAXONPAGE_TAB_LABELS', 'cdm_taxonpage_tab_labels');
146
define('CDM_TAXONPAGE_TAB_LABELS_DEFAULT', serialize(
147
  array(
148
    'general' => null,
149
    'synonymy' => null,
150
    'images' => null,
151
    'specimens' => null,
152
    'keys' => null,
153
    'experts' => null,
154
  )
155
));
156

    
157
$taxon_tab_options = get_taxon_tabs_list();
158
$taxon_tab_options[CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX] = 'Last visited tab';
159

    
160
define('CDM_DATAPORTAL_DEFAULT_TAXON_TAB', serialize($taxon_tab_options));
161

    
162
/**
163
 * @todo document this function.
164
 */
165
function get_taxon_options_list() {
166
  $taxon_tab_options = array_flip(get_taxon_tabs_list());
167
  foreach ($taxon_tab_options as $key => $value) {
168
    $taxon_tab_options[$key] = t('@key', array('@key' => $key));
169
  }
170
  return $taxon_tab_options;
171

    
172
}
173

    
174
define('CDM_PART_DEFINITIONS', 'cdm-part-definitions');
175
define('CDM_PART_DEFINITIONS_DEFAULT', serialize(
176
  array(
177
      'ZoologicalName' => array(
178
        'namePart' => array('name' => TRUE),
179
        'nameAuthorPart' => array('name' => TRUE),
180
        'referencePart' => array('authors' => TRUE),
181
        'microreferencePart' => array('microreference' => TRUE),
182
        'secReferencePart' => array('secReference' => TRUE,),
183
        'statusPart' => array('status' => TRUE),
184
        'descriptionPart' => array('description' => TRUE),
185
      ),
186
      'BotanicalName'=> array(
187
        'namePart' => array('name' => TRUE),
188
        'nameAuthorPart' => array('name' => TRUE, 'authors' => TRUE),
189
        'referencePart' => array('reference' => TRUE, 'microreference' => TRUE),
190
        'secReferencePart' => array('secReference' => TRUE,),
191
        'referenceYearPart' => array('reference.year' => TRUE),
192
        'statusPart' => array('status' => TRUE),
193
        'descriptionPart' => array('description' => TRUE),
194
      ),
195
     '#DEFAULT' => array(
196
        'namePart' => array(
197
            'name' => TRUE
198
        ),
199
        'nameAuthorPart' => array(
200
            'name' => TRUE,
201
            'authors' => TRUE
202
        ),
203
       'referencePart' => array(
204
         'reference' => TRUE
205
        ),
206
       'secReferencePart' => array(
207
         'secReference' => TRUE,
208
       ),
209
       'microreferencePart' => array(
210
          'microreference' => TRUE,
211
        ),
212
       'statusPart' => array(
213
          'status' => TRUE,
214
        ),
215
       'descriptionPart' => array(
216
          'description' => TRUE,
217
        ),
218
      )
219
    )
220
  )
221
);
222
  define('CDM_PART_DEFINITIONS_DEFAULT_PRE_380', serialize(
223
    array(
224
      'ZoologicalName' => array(
225
        'namePart' => array('name' => TRUE),
226
        'nameAuthorPart' => array('name' => TRUE),
227
        'referencePart' => array('authors' => TRUE),
228
        'microreferencePart' => array('microreference' => TRUE),
229
        'statusPart' => array('status' => TRUE),
230
        'descriptionPart' => array('description' => TRUE),
231
      ),
232
      'BotanicalName'=> array(
233
        'namePart' => array('name' => TRUE),
234
        'nameAuthorPart' => array('name' => TRUE, 'authors' => TRUE),
235
        'referencePart' => array('reference' => TRUE, 'microreference' => TRUE),
236
        'referenceYearPart' => array('reference.year' => TRUE),
237
        'statusPart' => array('status' => TRUE),
238
        'descriptionPart' => array('description' => TRUE),
239
      ),
240
      '#DEFAULT' => array(
241
        'namePart' => array(
242
          'name' => TRUE
243
        ),
244
        'nameAuthorPart' => array(
245
          'name' => TRUE,
246
          'authors' => TRUE
247
        ),
248
        'referencePart' => array(
249
          'reference' => TRUE
250
        ),
251
        'microreferencePart' => array(
252
          'microreference' => TRUE,
253
        ),
254
        'statusPart' => array(
255
          'status' => TRUE,
256
        ),
257
        'descriptionPart' => array(
258
          'description' => TRUE,
259
        ),
260
      )
261
    )
262
  )
263
  );
264

    
265
define('CDM_NAME_RENDER_TEMPLATES', 'cdm-name-render-templates');
266
define('CDM_NAME_RENDER_TEMPLATES_DEFAULT', serialize(
267
  array (
268
    'taxon_page_title,polytomousKey'=> array(
269
        'namePart' => array('#uri' => TRUE),
270
      ),
271
    'not_in_current_classification' => array(
272
     'nameAuthorPart' => TRUE,
273
     'referencePart' => TRUE,
274
     'statusPart' => TRUE,
275
     'secReferencePart' => TRUE,
276
    ),
277
    'taxon_page_synonymy,accepted_taxon.taxon_page_synonymy'=> array(
278
      'nameAuthorPart' => array('#uri' => TRUE),
279
      'referencePart' => TRUE,
280
      'statusPart' => TRUE,
281
      'descriptionPart' => TRUE,
282
    ),
283
    'related_taxon.other_taxon_relationship.taxon_relationships.taxon_page_synonymy'=> array(
284
      'nameAuthorPart' => array('#uri' => TRUE),
285
      'referencePart' => TRUE,
286
      'statusPart' => TRUE,
287
      'secReferencePart' => TRUE,
288
      'descriptionPart' => TRUE,
289
    ),
290
    'related_taxon.misapplied_name_for.taxon_relationships.taxon_page_synonymy' => array(
291
      'nameAuthorPart' => array('#uri' => TRUE),
292
      'referencePart' => TRUE,
293
      'statusPart' => TRUE,
294
      /* no sec ref in this case, misapplied names are
295
       * de-duplicated and the sec ref is shown as footnote */
296
      'descriptionPart' => TRUE,
297
    ),
298
    'homonym'=> array(
299
        'nameAuthorPart' => array('#uri' => TRUE),
300
        'referenceYearPart' => TRUE,
301
        'statusPart' => TRUE,
302
    ),
303
    'acceptedFor,typedesignations,list_of_taxa' => array(
304
        'nameAuthorPart' => array('#uri' => TRUE),
305
        'referencePart' => TRUE,
306
      ),
307
    '#DEFAULT' => array(
308
        'nameAuthorPart' => array('#uri' => TRUE),
309
        'referencePart' => TRUE,
310
     )
311
  )
312
));
313
define('CDM_NAME_RENDER_TEMPLATES_DEFAULT_PRE_380', serialize(
314
  array (
315
    'taxon_page_title,polytomousKey'=> array(
316
      'namePart' => array('#uri' => TRUE),
317
    ),
318
    'taxon_page_synonymy,related_taxon'=> array(
319
      'nameAuthorPart' => array('#uri' => TRUE),
320
      'referencePart' => TRUE,
321
      'statusPart' => TRUE,
322
      'descriptionPart' => TRUE,
323
    ),
324
    'homonym'=> array(
325
      'nameAuthorPart' => array('#uri' => TRUE),
326
      'referenceYearPart' => TRUE,
327
    ),
328
    'acceptedFor,typedesignations,list_of_taxa' => array(
329
      'nameAuthorPart' => array('#uri' => TRUE),
330
      'referencePart' => TRUE,
331
    ),
332
    '#DEFAULT' => array(
333
      'nameAuthorPart' => array('#uri' => TRUE),
334
      'referencePart' => TRUE,
335
    )
336
  )
337
));
338

    
339
define('CDM_SEARCH_TAXA_MODE','cdm_search_taxa_mode');
340
define('CDM_SEARCH_TAXA_MODE_DEFAULT', serialize(
341
    // to unset a default enntry set the value to 0
342
    array(
343
      'doTaxa'=>'doTaxa',
344
      'doSynonyms' => 'doSynonyms',
345
      'doTaxaByCommonNames' => 'doTaxaByCommonNames',
346
      'doMisappliedNames' => 'doMisappliedNames'
347
    )
348
  )
349
);
350

    
351
define('CDM_SEARCH_AREA_FILTER_PRESET', 'cdm_search_area_filter_preset');
352

    
353
define('SIMPLE_SEARCH_USE_LUCENE_BACKEND', 'simple_search_use_lucene_backend');
354
define('SIMPLE_SEARCH_IGNORE_CLASSIFICATION', 'simple_search_ignore_classification');
355

    
356
/* Gallery variables. */
357
$gallery_settings = array(
358
    "cdm_dataportal_show_taxon_thumbnails" => 1,
359
    "cdm_dataportal_show_synonym_thumbnails" => 0,
360
    "cdm_dataportal_show_thumbnail_captions" => 1,
361
    "cdm_dataportal_media_maxextend" => 120,
362
    "cdm_dataportal_media_cols" => 3,
363
    "cdm_dataportal_media_maxRows" => 1,
364
);
365

    
366
define('TAXONPAGE_VISIBILITY_OPTIONS_DEFAULT', serialize(get_taxon_options_list()));
367
define('CDM_DATAPORTAL_GALLERY_SETTINGS', serialize($gallery_settings));
368
define('CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME', 'specimen_gallery');
369
define('CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME', "description_gallery");
370
define('CDM_DATAPORTAL_MEDIA_GALLERY_NAME', "media_gallery");
371
define('CDM_DATAPORTAL_TAXON_MEDIA_GALLERY_NAME_TAB', "taxon_tab_media_gallery");
372
define('CDM_DATAPORTAL_SEARCH_GALLERY_NAME', "search_gallery");
373
define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS', 'cdm_dataportal_display_taxon_relationships');
374
define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS', 'cdm_dataportal_display_name_relations');
375
// define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_2', array("default" => t('Display all')));
376
define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT', 1);
377
define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_DEFAULT', 1);
378

    
379
/**
380
 * The drupal variable key for the array containing the uuids of the taxon relationship types to display in
381
 * the snonymy.
382
 *
383
 * @var string
384
 */
385
define('CDM_TAXON_RELATIONSHIP_TYPES', 'cdm_taxon_relationship_types');
386

    
387
define('CDM_NAME_RELATIONSHIP_TYPES', 'cdm_name_relationship_types');
388
define('CDM_NAME_RELATIONSHIP_TYPES_DEFAULT', serialize(
389
    array(
390
      UUID_NAMERELATIONSHIPTYPE_LATER_HOMONYM => UUID_NAMERELATIONSHIPTYPE_LATER_HOMONYM,
391
      UUID_NAMERELATIONSHIPTYPE_TREATED_AS_LATER_HOMONYM => UUID_NAMERELATIONSHIPTYPE_TREATED_AS_LATER_HOMONYM,
392
      UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR => UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR
393
    )
394
  )
395
);
396

    
397
/**
398
 * The drupal variable for the configuration of the information aggregation along
399
 * the taxon relation ships. The mapped arrayis associative and holds two elements:
400
 *    - direct: the uuids of the taxon relationship types to take into account in invers
401
 *      direction.
402
 *    - invers: the uuids of the taxon relationship types to take into account in direct
403
 *      direction.
404
 *
405
 * @var String
406
 */
407
define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS', 'cdm_aggregate_by_taxon_relationships');
408
define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS_DEFAULT', serialize(
409
    array(
410
        'direct'=>array(),
411
        'invers'=>array()
412
     )
413
   ));
414
define('CDM_PROFILE_FEATURETREE_UUID', 'cdm_dataportal_featuretree_uuid');
415
define('CDM_OCCURRENCE_FEATURETREE_UUID', 'cdm_occurrence_featuretree_uuid');
416
define('CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID', 'cdm_dataportal_structdesc_featuretree_uuid');
417

    
418
define('CDM_DISTRIBUTION_FILTER', 'cdm_distribution_filter');
419
define('CDM_DISTRIBUTION_FILTER_DEFAULT', serialize(
420
      array(
421
      'filter_rules' => array(
422
        'statusOrderPreference' => 0,
423
        'subAreaPreference' => 0,
424
      ),
425
      'hiddenAreaMarkerType' => array()
426
     )
427
));
428

    
429
define('DISTRIBUTION_HIERARCHY_STYLE', 'distribution_hierarchy_style');
430
define('DISTRIBUTION_HIERARCHY_STYLE_DEFAULT', serialize(array(
431
  "level_0" => array(
432
    'label_suffix' => ':',
433
    'status_glue' => '',
434
    'item_glue' => ' ',
435
    'item_group_prefix' => '',
436
    'item_group_postfix' => ''
437
  ),
438
  "level_1" => array(
439
    'label_suffix' => '',
440
    'status_glue' => '', // '&#8210; '
441
    'item_glue' => '; ',
442
    'item_group_prefix' => ', ',
443
    'item_group_postfix' => ''
444
  ),
445
  "level_2" => array(
446
    'label_suffix' => '',
447
    'status_glue' => '', // '&#8210; '
448
    'item_glue' => ', ',
449
    'item_group_prefix' => ' (',
450
    'item_group_postfix' => ')'
451
  )
452
)));
453

    
454
/**
455
 * Constant for the drupal variable key distribution_map_visibility
456
 *
457
 * possible values:
458
 *  - never
459
 *  - automatic
460
 *  - always
461
 */
462
define('DISTRIBUTION_MAP_VISIBILITY', 'distribution_map_visibility');
463
define('DISTRIBUTION_MAP_VISIBILITY_DEFAULT', 'automatic');
464

    
465
/**
466
 * Constant for the drupal variable key specimen_map_visibility
467
 *
468
 * possible values:
469
 *  - never
470
 *  - automatic
471
 *  - always
472
 */
473
define('SPECIMEN_MAP_VISIBILITY', 'specimen_map_visibility');
474
define('SPECIMEN_MAP_VISIBILITY_DEFAULT', 'automatic');
475

    
476
define('CDM_TAXON_MEDIA_FILTER', 'cdm_taxon_media_filter');
477
define('CDM_TAXON_MEDIA_FILTER_DEFAULT', serialize(
478
    array(
479
        'includeTaxonDescriptions' => 'includeTaxonDescriptions',
480
        'includeOccurrences' => 0,
481
        'includeTaxonNameDescriptions' => 0
482
     )
483
  ));
484

    
485
define('CDM_MAP_DISTRIBUTION', 'cdm_map_distribution');
486
define('CDM_MAP_DISTRIBUTION_DEFAULT', serialize(array(
487
  // needs to be merged with user setting by drupal_array_merge_deep()
488
  // 'width' => 512, // optimum size for OSM layers is 512
489
  // 'height' => 512 / 2, // optimum size for OSM layers 256
490
  'aspect_ratio' => 2,
491
  'bbox' => '', // empty to allow automatic zooming to extend
492
  'show_labels' => FALSE,
493
  'caption' => '',
494
  'distribution_opacity' => '0.5',
495
  'map_type' => 1, //  1 = 'openlayers', 0 = 'image'
496
  'image_map' => array(
497
    'base_layer' => '', // none, formerly this was cyprusdivs
498
    'bg_color' => '1874CD',
499
    'layer_style' => 'ffffff,606060,,',
500
  ),
501
  'openlayers' => array(
502
    'base_layers' =>  array(
503
      // A layer MUST NOT BE SET in the defaults,
504
      // otherwise it can not be overidden by the user settings:
505
      // 'mapproxy_vmap0' => 'mapproxy_vmap0',
506
      // it is sufficient to define the preferred layer,
507
      // since it will automatically be enabled:
508
      'PREFERRED' => 'mapproxy_vmap0'),
509
    'custom_wms_base_layer' => array(
510
      'name' => NULL,
511
      'url' => NULL,
512
      'params' =>  NULL,
513
      'projection' => NULL,
514
      'proj4js_def' => NULL,
515
      'max_extent' => NULL,
516
      'units' => NULL
517
    ),
518
    'show_layer_switcher' => TRUE,
519
    'display_outside_max_extent' => FALSE,
520
    'google_maps_api_key' => NULL,
521
  ),
522
  'legend' => array(
523
    'show' => TRUE,
524
    'opacity' => '0.5',
525
    'font_size' => 10,
526
    'font_style' => FALSE,
527
    'icon_width' => 35,
528
    'icon_height' => 15
529
  )
530
)));
531

    
532
/**
533
 * Merges the named array variable with the array of defaults.
534
 *
535
 * IMPORTANT: The array keys must be strings. When the keys are integers
536
 * the merging will not take place for these entities. Number keyed entities
537
 * are just appended to the result array.
538
 *
539
 * @param string $variable_name
540
 *     The variable name
541
 * @param string | array $default
542
 *     The array containing the default values either as array or serialized as string.
543
 *     Unserialization is cared for if necessary
544
 * @return array
545
 *     The merged array as returned by drupal_array_merge_deep()
546
 *
547
 * TODO compare with mixed_variable_get() duplicate functions? => result use this function instead of mixed_variable_get()
548
 * TODO force $default being an array
549
 */
550
function get_array_variable_merged($variable_name, $default){
551

    
552
    // unserialize if nessecary
553
    if(!is_array($default)){
554
      $default = unserialize($default);
555
    }
556
    $variable = variable_get($variable_name, array());
557
    $result = drupal_array_merge_deep($default, $variable);
558
    return $result;
559
}
560

    
561
/**
562
 * @todo document this function.
563
 */
564
function getGallerySettings($gallery_config_form_name) {
565
  return get_array_variable_merged($gallery_config_form_name, CDM_DATAPORTAL_GALLERY_SETTINGS);
566
}
567

    
568
/**
569
 * Returns the string representation of the default tab.
570
 *
571
 * @param bool $returnTabIndex
572
 *   Defaults to FALSE, if set true this function will return the index number
573
 *   of the default tab. (used to supply default values to form elements).
574
 */
575
function get_default_taxon_tab($returnTabIndex = FALSE) {
576

    
577
  global $user;
578
  $values = unserialize(CDM_DATAPORTAL_DEFAULT_TAXON_TAB);
579
  $user_tab_active = 'cdm_dataportal_' . $user->uid . '_default_tab_active';
580
  $user_tab = 'cdm_dataportal_' . $user->uid . '_default_tab';
581
  // Get the user value if the used has chosen to overwrite the system settings.
582
  $user_tab_on = variable_get($user_tab_active, FALSE);
583
  if ($user_tab_on) {
584
    $user_value = variable_get($user_tab, 0);
585
    $index_value = $user_value;
586
    // Get the system value.
587
  }
588
  else {
589
    $system_value = variable_get('cdm_dataportal_default_tab', 0);
590
    $index_value = $system_value;
591
  }
592

    
593
  // Return the index value or the string representation.
594
  if ($returnTabIndex) {
595
    return $index_value;
596
  }
597
  else {
598
    return ($values[$index_value]);
599
  }
600
}
601

    
602

    
603
  /**
604
   * Provides the feature block settings for a specific feature which matches the $feature_uuid parameter.
605
   *
606
   * In case specifically configured settings array, like these which are stored in the drupal variables, is missing
607
   * one or more fields these fields are taken from the default. That is the specific settings are always merges
608
   * with the default.
609
   *
610
   * Note: These settings only apply to feature blocks which do not have a special rendering
611
   * the specially handled features (e.g.: Distribution, CommonNames) may make use of the
612
   * 'special' element of the settings
613
   *
614
   * @param $feature_uuid
615
   *   The uuid string representation of the feature to return the settings for
616
   *
617
   * @return array
618
   *  an associative array of settings, with the following fields:
619
   *    - as_list: string
620
   *        this setting will be used in compose_feature_block_wrap_elements() as $enclosing_tag
621
   *        possible values are:
622
   *          div: not as list,
623
   *          ul: as bullet list,
624
   *          ol: as numbered list,
625
   *          dl: as definition list
626
   *        The tag used for the inner element, thus depends on the value of this field. The
627
   *        inner tag name can be retrieved by the function cdm_feature_block_element_tag_name()
628
   *    - link_to_reference: boolean,
629
   *        render the reference as link, ignored if the element is NOT a DescriptionElementSource
630
   *    - link_to_name_used_in_source": boolean
631
   *        whether to show name is source information as link which will point to the according name page
632
   *    - sources_as_content (boolean)
633
   *        TRUE (int: 1):
634
   *          1. If element is of the CDM type TextData and the text is not empty the source references will be
635
   *             appended in brackets like "text (source references)". If the original source has name in source
636
   *             information it will be appended to the citation string,
637
   *             like : "(citation, as name in source; citation, as name in source)"
638
   *          2. if the text of the TextData is empty, the original source citations are the only content
639
   *             (e.g. use case CITATION) and are not put into brackets. In this case the nameInSource is
640
   *             prepended to the citation string like: "name in source: citation"
641
   *        FALSE (int: 0):
642
   *          Original sources are put into the bibliography(=references) pseudo feature block. If the original source
643
   *          citations are the only content, the resulting feature block content would only consist of footnotes.
644
   *          In this case the display of the respective feature block is suppressed.
645
   *          TODO if the bibliography is not enabled the sources will be treated as footnotes like annotations,
646
   *               in future however they will in this case be shown in a separate references section for each
647
   *               feature block.
648
   *    - sources_as_content_to_bibliography  (boolean)
649
   *        Only valid if sources_as_content == TRUE, will cause the sources to be also shown
650
   *        in the bibliography.
651
   *    - sort_elements
652
   *        whether and how to sort the elements
653
   *        possible values are the constants SORT_ASC, SORT_DESC, NULL,
654
   *        some feature types (Distribution) also support: SORT_HIERARCHICAL (
655
   *        TODO option to exclude levels, put in special?,
656
   *        TODO make use of this setting in compose_feature_block_wrap_elements())
657
   *    - element_tag
658
   *        specifies the tag to be used for creating the elements, only applies if "as_list" == 'div'
659
   *        possible values are span | div. the proper inner tag name can be retrieved by the function
660
   *        cdm_feature_block_element_tag_name()
661
   *    - special: array()
662
   *        an array with further settings, this field can be used for special
663
   *        settings for specialized rendering like for distributions
664
   *  }
665
   *
666
   */
667
  function get_feature_block_settings($feature_uuid = 'DEFAULT') {
668
    // the default must conform to the default parameter values of
669
    // compose_feature_block_wrap_elements() : $glue = '', $sort = FALSE, $enclosing_tag = 'ul'
670
    // compose_description_element_text_data() : asListElement = NULL
671

    
672
    // see #3257 (implement means to define the features to show up in the taxonprofile and in the specimen descriptions)
673

    
674
    // ---- DEFAULTS settings
675

    
676
    // only needed as final option, when the settings are not having a default
677
    $default = array(
678
      'DEFAULT' => array(
679
        'as_list' => 'div',
680
        'link_to_reference' => 0,
681
        'link_to_name_used_in_source' => 1,
682
        'sources_as_content' => 0,
683
        'sources_as_content_to_bibliography' => 0,
684
        'sort_elements' => NO_SORT,
685
        'glue' => '',
686
        'element_tag' => NULL
687
      )
688
    );
689

    
690
    // will be used as preset in the settings
691
    $other_themes_default = array(
692
      'DEFAULT' => array(
693
        'as_list' => 'div',
694
        'link_to_reference' => 0,
695
        'link_to_name_used_in_source' => 1,
696
        'sources_as_content' => 0,
697
        'sources_as_content_to_bibliography' => 0,
698
        'sort_elements' => NO_SORT,
699
        'glue' => '',
700
        'element_tag' => NULL
701
      ),
702
      UUID_CITATION => array(
703
        'as_list' => 'div',
704
        'link_to_reference' => 0,
705
        'link_to_name_used_in_source' => 0,
706
        'sources_as_content' => 1,
707
        'sources_as_content_to_bibliography' => 0,
708
        'sort_elements' => SORT_ASC,
709
        'glue' => '',
710
        'element_tag' => 'div'
711
      ),
712
      UUID_DISTRIBUTION => array(
713
        'as_list' => 'div', // currently ignored
714
        'link_to_reference' => 0,
715
        'link_to_name_used_in_source' => 0,
716
        'sources_as_content' => 0,
717
        'sources_as_content_to_bibliography' => 0,
718
        'sort_elements' => NO_SORT, // will cause ...
719
        'glue' => '',
720
        'element_tag' => 'div',
721
        'special' => array()
722
      ),
723
      UUID_COMMON_NAME => array(
724
        'as_list' => 'div',
725
        'link_to_reference' => 0,
726
        'link_to_name_used_in_source' => 1,
727
        'sources_as_content' => 0,
728
        'sources_as_content_to_bibliography' => 0,
729
        'sort_elements' => NO_SORT,
730
        'glue' => '',
731
        'element_tag' => 'span'
732
      ),
733
    );
734

    
735
    // ---- Special DEFAULTS for existing portals
736
    // TODO:
737
    // this can be removed once the feature block
738
    // settings have been deployed for the first time to these portals
739

    
740
    $cichorieae_default = array(
741
      'DEFAULT' => array(
742
        'as_list' => 'div',
743
        'link_to_reference' => 1,
744
        'link_to_name_used_in_source' => 1,
745
        'sources_as_content' => 1,
746
        'sources_as_content_to_bibliography' => 0,
747
        'sort_elements' => NO_SORT,
748
        'glue' => '',
749
        'element_tag' => 'div'
750
      ),
751
      UUID_CITATION => array(
752
        'as_list' => 'div',
753
        'link_to_reference' => 0,
754
        'link_to_name_used_in_source' => 0,
755
        'sources_as_content' => 1,
756
        'sources_as_content_to_bibliography' => 0,
757
        'sort_elements' => SORT_ASC,
758
        'glue' => '',
759
        'element_tag' => 'div'
760
      ),
761
      UUID_CHROMOSOMES_NUMBERS => array(
762
        'as_list' => 'ul',
763
        'link_to_reference' => 1,
764
        'link_to_name_used_in_source' => 1,
765
        'sources_as_content' => 1,
766
        'sources_as_content_to_bibliography' => 0,
767
        'sort_elements' => NO_SORT,
768
        'glue' => '',
769
        'element_tag' => 'div'
770
      ),
771
      UUID_CHROMOSOMES => array(
772
        'as_list' => 'ul',
773
        'link_to_reference' => 0,
774
        'link_to_name_used_in_source' => 1,
775
        'sources_as_content' => 1,
776
        'sources_as_content_to_bibliography' => 0,
777
        'sort_elements' => NO_SORT,
778
        'glue' => '',
779
        'element_tag' => 'div'
780
      ),
781
      UUID_COMMON_NAME => array(
782
        'as_list' => 'div',
783
        'link_to_reference' => 0,
784
        'link_to_name_used_in_source' => 1,
785
        'sources_as_content' => 0,
786
        'sources_as_content_to_bibliography' => 0,
787
        'sort_elements' => NO_SORT,
788
        'glue' => '',
789
        'element_tag' => 'span'
790
      ),
791
    );
792

    
793
    $palmweb_default = array(
794
      'DEFAULT' => array(
795
        'as_list' => 'ul',
796
        'link_to_reference' => 1,
797
        'link_to_name_used_in_source' => 1,
798
        'sources_as_content' => 1,
799
        'sources_as_content_to_bibliography' => 1,
800
        'sort_elements' => NO_SORT,
801
        'glue' => '',
802
        'element_tag' => NULL
803
      ),
804
      UUID_CITATION => array(
805
        'as_list' => 'ul',
806
        'link_to_reference' => 1,
807
        'link_to_name_used_in_source' => 1,
808
        'sources_as_content' => 0,
809
        'sources_as_content_to_bibliography' => 1,
810
        'sort_elements' => SORT_ASC,
811
        'glue' => '',
812
        'element_tag' => 'div'
813
      ),
814
      UUID_DISTRIBUTION => array(
815
        'as_list' => 'div', // currently ignored
816
        'link_to_reference' => 1,
817
        'link_to_name_used_in_source' => 1,
818
        'sources_as_content' => 1, // FIXME seems to have no effect see Acanthophoenix rousselii (palmae)
819
        'sources_as_content_to_bibliography' => 1,
820
        'sort_elements' => NO_SORT, // will cause ...
821
        'glue' => '',
822
        'element_tag' => 'div',
823
        'special' => array()
824
      ),
825
    );
826

    
827
    $cyprus_default = $cichorieae_default;
828
    $cyprus_default[UUID_DISTRIBUTION] = array(
829
      'as_list' => 'div', // currently ignored
830
      'link_to_reference' => 0,
831
      'link_to_name_used_in_source' => 0,
832
      'sources_as_content' => 0,
833
      'sources_as_content_to_bibliography' => 0,
834
      'sort_elements' => NO_SORT, // will cause ...
835
      'glue' => '',
836
      'element_tag' => 'div',
837
      'special' => array()
838
    );
839

    
840
    $default_theme = variable_get('theme_default', NULL);
841

    
842
    switch ($default_theme) {
843
      case 'garland_cichorieae':
844
        $settings_for_theme = $cichorieae_default;
845
        break;
846
      case 'cyprus':
847
        // cyprus: no longer used in production,
848
        // but is required for selenium tests see class eu.etaxonomy.dataportal.pages.PortalPage
849
        $settings_for_theme = $cyprus_default;
850
        break;
851
      case 'flore_afrique_centrale':
852
      case 'flora_malesiana':
853
      case 'flore_gabon':
854
        $settings_for_theme = $cichorieae_default;
855
        $settings_for_theme[UUID_CITATION]['as_list'] = 'ul';
856
        break;
857
      case 'palmweb_2':
858
        $settings_for_theme = $palmweb_default;
859
        break;
860
      default:
861
        $settings_for_theme = $other_themes_default;
862
    }
863
    // ---- END of DEFAULTS
864

    
865
    $saved_settings = variable_get(FEATURE_BLOCK_SETTINGS, NULL);
866

    
867
    $feature_block_setting = null;
868

    
869
    if (isset($saved_settings[$feature_uuid])) {
870
      $feature_block_setting = $saved_settings[$feature_uuid];
871
    }
872
    else if (isset($settings_for_theme[$feature_uuid])) {
873
      $feature_block_setting = $settings_for_theme[$feature_uuid];
874
    }
875
    else if (isset($settings_for_theme['DEFAULT'])) {
876
      $feature_block_setting = $settings_for_theme['DEFAULT'];
877
    }
878

    
879
    // now merge the default and specific settings
880
    $settings_to_merge = array($default['DEFAULT']);
881
    if(is_array($saved_settings)){
882
      $settings_to_merge[] = $saved_settings['DEFAULT'];
883
    }
884
    if(isset($feature_block_setting)){
885
      $settings_to_merge[] = $feature_block_setting;
886
    }
887
    $feature_block_setting = drupal_array_merge_deep_array($settings_to_merge);
888

    
889
    return $feature_block_setting;
890
}
891
  /**
892
 * returns the current setting for the original source bibliography
893
 *
894
 * Caches internally
895
 *
896
 * @return array
897
 *  the setting for the original source bibliography see BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE:
898
 *   - 'enabled': 1|0
899
 *   - 'key_format': one of 'latin', 'ROMAN', 'roman', 'ALPHA', 'alpha'
900
 */
901
function get_bibliography_settings($clear_cache = false){
902
  static $bibliography_settings = null;
903
  if(!$bibliography_settings || $clear_cache){
904
    $bibliography_settings = get_array_variable_merged(
905
      BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE,
906
      BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE_DEFAULT
907
    );
908
  }
909
  return $bibliography_settings;
910
}
911

    
912
/**
913
 * @todo Please document this function.
914
 * @see http://drupal.org/node/1354
915
 */
916
function cdm_dataportal_menu_admin(&$items) {
917
  // Display section on admin/config page.
918
  $items['admin/config/cdm_dataportal'] = array(
919
    'title' => 'CDM Dataportal',
920
    'description' => 'Settings for the CDM DataPortal.',
921
    'position' => 'right',
922
    'weight' => 10,
923
    'page callback' => 'system_admin_menu_block_page',
924
    'access arguments' => array('administer cdm_dataportal'),
925
    'file' => 'system.admin.inc',
926
    'file path' => drupal_get_path('module', 'system'),
927
  );
928
  $items['admin/config/cdm_dataportal/settings'] = array(
929
    'title' => 'Settings',
930
    'description' => 'Settings for the CDM DataPortal.',
931
    'weight' => 0,
932
    'page callback' => 'drupal_get_form',
933
    'page arguments' => array('cdm_settings_general'),
934
    'access arguments' => array('administer cdm_dataportal'),
935
    'type' => MENU_NORMAL_ITEM,
936
  );
937
  $items['admin/config/cdm_dataportal/settings/general'] = array(
938
    'title' => 'General',
939
    'description' => 'General',
940
    'weight' => 0,
941
    'page callback' => 'drupal_get_form',
942
    'page arguments' => array('cdm_settings_general'),
943
    'access arguments' => array('administer cdm_dataportal'),
944
    'type' => MENU_DEFAULT_LOCAL_TASK,
945
  );
946

    
947
  $items['admin/config/cdm_dataportal/settings/cachesite'] = array(
948
    'title' => 'Cache',
949
    'description' => 'Cache',
950
    'access arguments' => array('administer cdm_dataportal'),
951
    'page callback' => 'drupal_get_form',
952
    'page arguments' => array('cdm_settings_cache'),
953
    'weight' => 10,
954
    'type' => MENU_LOCAL_TASK,
955
  );
956

    
957
  $items['admin/config/cdm_dataportal/settings/geo'] = array(
958
    'title' => 'Geo & Map',
959
    'description' => 'Geo & Map',
960
    'access arguments' => array('administer cdm_dataportal'),
961
    'page callback' => 'drupal_get_form',
962
    'page arguments' => array('cdm_settings_geo'),
963
    'weight' => 1,
964
    'type' => MENU_LOCAL_TASK,
965
  );
966

    
967
  $items['admin/config/cdm_dataportal/settings/layout'] = array(
968
    'title' => 'Layout',
969
    'description' => 'Configure and adjust the layout of your DataPortal ',
970
    'access arguments' => array('administer cdm_dataportal'),
971
    'page callback' => 'drupal_get_form',
972
    'page arguments' => array('cdm_settings_layout'),
973
    'weight' => 2,
974
    'type' => MENU_LOCAL_TASK,
975
  );
976

    
977
  $items['admin/config/cdm_dataportal/settings/layout/taxon'] = array(
978
    'title' => 'Taxon',
979
    'description' => 'Configure and adjust the layout of your DataPortal ',
980
    'access arguments' => array('administer cdm_dataportal'),
981
    'page callback' => 'drupal_get_form',
982
    'page arguments' => array('cdm_settings_layout_taxon'),
983
    'weight' => 1,
984
    'type' => MENU_LOCAL_TASK,
985
  );
986
  /*
987
  $items[] = array(
988
  'path' => 'admin/config/cdm_dataportal/layout/synonymy',
989
  'title' => t('Synonymy'),
990
  'description' => t('Configure and adjust the layout of your DataPortal '),
991
  'access' => user_access('administer cdm_dataportal'),
992
  'callback' => 'drupal_get_form',
993
  'callback arguments' => array('cdm_settings_layout_synonymy'),
994
  'weight' => 1,
995
  'type' => MENU_LOCAL_TASK,
996
  );
997

998
  $items[] = array(
999
  'path' => 'admin/config/cdm_dataportal/layout/specimens',
1000
  'title' => t('Specimens'),
1001
  'description' => t('Configure and adjust the layout of your DataPortal '),
1002
  'access' => user_access('administer cdm_dataportal'),
1003
  'callback' => 'drupal_get_form',
1004
  'callback arguments' => array('cdm_settings_layout_specimens'),
1005
  'weight' => 1,
1006
  'type' => MENU_LOCAL_TASK,
1007
  );
1008
  */
1009
  $items['admin/config/cdm_dataportal/settings/layout/search'] = array(
1010
    'title' => 'Search',
1011
    'description' => 'Configure and adjust the layout of your DataPortal ',
1012
    'access arguments' => array('administer cdm_dataportal'),
1013
    'page callback' => 'drupal_get_form',
1014
    'page arguments' => array('cdm_settings_layout_search'),
1015
    'weight' => 2,
1016
    'type' => MENU_LOCAL_TASK,
1017
  );
1018

    
1019
  $items['admin/config/cdm_dataportal/settings/layout/media'] = array(
1020
    'title' => 'Media',
1021
    'description' => 'Configure and adjust the layout of your DataPortal ',
1022
    'access arguments' => array('administer cdm_dataportal'),
1023
    'page callback' => 'drupal_get_form',
1024
    'page arguments' => array('cdm_settings_layout_media'),
1025
    'weight' => 3,
1026
    'type' => MENU_LOCAL_TASK,
1027
  );
1028

    
1029
}
1030

    
1031
/**
1032
 * @todo document this function.
1033
 */
1034
function cdm_help_general_cache() {
1035
  $form = array();
1036
  $form['cache_help'] = array(
1037
    '#type' => 'fieldset',
1038
    '#title' => t('Help'),
1039
    '#collapsible' => TRUE,
1040
    '#collapsed' => TRUE,
1041
  );
1042
  $form['cache_help']['test'] = array('#value' => t('probando'));
1043
  return drupal_render($form);
1044
  $res = array();
1045
  $res['default'] = drupal_render($help);
1046
  return $res;
1047
}
1048

    
1049
/**
1050
 * Configures the settings form for the CDM-API module.
1051
 *
1052
 * @return array
1053
 *   Drupal settings form.
1054
 */
1055
function cdm_settings_general() {
1056

    
1057
  $form['cdm_webservice'] = array(
1058
    '#type' => 'fieldset',
1059
    '#title' => t('CDM Server'),
1060
    '#collapsible' => FALSE,
1061
    '#collapsed' => FALSE,
1062
    '#description' => t('The <em>CDM Server</em> exposes data stored in a
1063
        CDM data base to the web via RESTful web services and thus is the source of the data
1064
        to be displayed by a CDM DataPotal.'),
1065
  );
1066

    
1067
  $form['cdm_webservice']['cdm_webservice_url'] = array(
1068
    '#type' => 'textfield',
1069
    '#title' => t('CDM web service URL') . ':',
1070
    '#description' => t('This is the URL to the CDM-Server exposing your data
1071
      e.g. <em>"http://myserver.net/cdmserver/myproject"</em>'),
1072
    '#default_value' => variable_get('cdm_webservice_url', NULL),
1073
  );
1074

    
1075
  $form['cdm_webservice']['cdm_webservice_debug'] = array(
1076
    '#type' => 'markup',
1077
    '#markup' => '<b>Debug CDM Web Service:</b> Debugging web services is possible via the ' . l('CDM web service debug block', 'admin/structure/block/manage/cdm_api/cdm_ws_debug/configure')
1078
      . ' visible only for administrators',
1079
  );
1080

    
1081
  $form['cdm_webservice']['freetext_index'] = array(
1082
    '#type' => 'fieldset',
1083
    '#title' => t('Freetext index'),
1084
    '#collapsible' => FALSE,
1085
    '#collapsed' => FALSE,
1086
  );
1087

    
1088
  // Check the cdmserver port number and display a waring if it is not port 80
1089
  preg_match("#http[s]?://[0-9\p{L}\.]*:([0-9]*)/.*#u", variable_get('cdm_webservice_url', ''), $portNumberMatch, PREG_OFFSET_CAPTURE);
1090
  if (isset($portNumberMatch[1]) && $portNumberMatch[1] != '80') {
1091
    $form['cdm_webservice']['freetext_index']['message'] = array(
1092
      '#markup' => "<div class=\"description\">"
1093
      . t("The CDM web service URL contains a portnumber other than standart HTTP port 80: '!port'
1094
           Due to this the reindex and purge fuctions may not be working if there is a firewall in between you and the CDM Server.
1095
           You may want to contact the maintainer of the according CDM Server in order to solve this problem.",
1096
          array('!port' => $portNumberMatch[1][0])
1097
        )
1098
      . "</div>",
1099
    );
1100
  };
1101

    
1102
  $frontentURL = urlencode(variable_get('cdm_webservice_url', ''));
1103
  $trigger_link_options = array(
1104
    'attributes' => array(
1105
      'class' => 'index-trigger',
1106
    ),
1107
  );
1108
  $form['cdm_webservice']['freetext_index']['operations'] = array(
1109
    '#markup' => "<div>" . t('Operations: !url1 !url2', array(
1110
        '!url1' => l(t("Purge"), cdm_compose_url(CDM_WS_MANAGE_PURGE, NULL, 'frontendBaseUrl=' . $frontentURL), $trigger_link_options),
1111
        '!url2' => l(t("Reindex"), cdm_compose_url(CDM_WS_MANAGE_REINDEX, NULL, 'frontendBaseUrl=' . $frontentURL), $trigger_link_options),
1112
      ))
1113
    . '<div id="index-progress"></div></div>',
1114
  );
1115
  _add_js_cdm_ws_progressbar(".index-trigger", "#index-progress");
1116

    
1117
    $form['cdm_webservice']['freetext_index']['cdm_dataportal_taxon_auto_suggest'] = array(
1118
        '#type' => 'checkbox',
1119
        '#title' => t('(EXPERIMENTAL) Enable auto-suggest for taxon search'),
1120
        '#default_value' => variable_get('cdm_dataportal_taxon_auto_suggest', CDM_DATAPORTAL_TAXON_AUTO_SUGGEST),
1121
        '#description' => t('If enabled, the taxon search field will suggest taxon names while typing in a search query.
1122
        This function works on indexed taxon names. If you experience any delay maybe you have to reindex (see above).'),
1123
    );
1124

    
1125
  $form['cdm_webservice']['proxy'] = array(
1126
    '#type' => 'fieldset',
1127
    '#title' => t('Proxy'),
1128
    '#collapsible' => TRUE,
1129
    '#collapsed' => TRUE,
1130
  );
1131

    
1132
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_url'] = array(
1133
    '#type' => 'textfield',
1134
    '#title' => t('Proxy URL') . ':',
1135
    '#description' => t('If this proxy url is set the cdm api tries
1136
    to connect the web service over the given proxy server.
1137
    Otherwise proxy usage is deactivated.'),
1138
    '#default_value' => variable_get('cdm_webservice_proxy_url', FALSE),
1139
  );
1140

    
1141
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_port'] = array(
1142
    '#type' => 'textfield',
1143
    '#title' => t('Proxy port') . ':',
1144
    '#default_value' => variable_get('cdm_webservice_proxy_port', '80'),
1145
  );
1146

    
1147
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_usr'] = array(
1148
    '#type' => 'textfield',
1149
    '#title' => t('Login') . ':',
1150
    '#default_value' => variable_get('cdm_webservice_proxy_usr', FALSE),
1151
  );
1152

    
1153
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_pwd'] = array(
1154
    '#type' => 'textfield',
1155
    '#title' => t('Password') . ':',
1156
    '#default_value' => variable_get('cdm_webservice_proxy_pwd', FALSE),
1157
  );
1158

    
1159
  // TODO: settings are still incomplete, compare with
1160
  // trunk/dataportal/inc/config_default.php.inc.
1161
  $form['taxon_tree'] = array(
1162
    '#type' => 'fieldset',
1163
    '#title' => t('Taxon Tree'),
1164
    '#collapsible' => FALSE,
1165
    '#collapsed' => TRUE,
1166
    '#description' => t('<p>When you explore your collection, you can navigate
1167
      it through a tree structure also called <em>Taxon Tree</em>.</p><p>To be
1168
      able to navigate through your collection the
1169
      <a href="http://drupal.org/handbook/blocks">drupal block</a>
1170
      <em>CDM Taxon Tree</em> should be visible for users. Enable the block at
1171
      <a href="./?q=admin/build/block">Administer&#45&#62Site building&#45&#62Blocks
1172
      </a></p>'),
1173
  );
1174

    
1175
  $form['taxon_tree'][CDM_TAXONOMICTREE_UUID] = array(
1176
    '#type' => 'select',
1177
    '#title' => t('Available classifications') . ':',
1178
    '#default_value' => variable_get(CDM_TAXONOMICTREE_UUID, FALSE),
1179
    '#options' => cdm_get_taxontrees_as_options(),
1180
    '#description' => t('Select the default taxa classification for your
1181
      <em>taxon tree</em>, the other classifications will be also available but
1182
      with a manual user change.'),
1183
  );
1184

    
1185
  $form['taxon_tree'][TAXONTREE_RANKLIMIT] = array(
1186
    '#type' => 'select',
1187
    '#title' => t('Rank of highest displayed taxon') . ':',
1188
     // Before DEFAULT_TAXONTREE_RANKLIMIT_UUID.
1189
    '#default_value' => variable_get(TAXONTREE_RANKLIMIT, TAXONTREE_RANKLIMIT_DEFAULT),
1190
    '#options' => cdm_rankVocabulary_as_option(),
1191
    '#description' => t('This is the rank of the highest displayed taxon in the
1192
      <em>taxon tree</em>. You can select here which rank should be at the top
1193
      level of the tree structure.'),
1194
  );
1195

    
1196
  $classification_uuids = array_keys(cdm_get_taxontrees_as_options());
1197
  $taxontree_includes_default = array_combine($classification_uuids, $classification_uuids);
1198
  $form['taxon_tree'][CDM_TAXONTREE_INCLUDES] = array(
1199
      '#type' => 'checkboxes',
1200
      '#title' => t('Included Classifications') . ':',
1201
      '#default_value' => variable_get(CDM_TAXONTREE_INCLUDES, $taxontree_includes_default),
1202
      '#options' => cdm_get_taxontrees_as_options(),
1203
      '#description' => t('Only the checked classifications will be avaliable in the classification chooser.'),
1204
  );
1205

    
1206
  $form['distribution'] = array(
1207
      '#type' => 'fieldset',
1208
      '#title' => t('Distributions'),
1209
      '#collapsible' => FALSE,
1210
      '#description' => 'This section covers general settings regarding distributions, map related settings are found in the '
1211
          . l('geo & map tab', 'admin/config/cdm_dataportal/settings/geo') .
1212
          '. Further settings regarding the Distribution feature block can be found in the Layout/Taxon tab at two distinct places: '
1213
          . l('Distribution appearance', 'admin/config/cdm_dataportal/settings/layout/taxon', array('fragment' => 'edit-distribution-layout')) .', '
1214
          . l('Taxon profile feature block settings', 'admin/config/cdm_dataportal/settings/layout/taxon', array('fragment' => 'edit-feature-block-settings')) .
1215
          '<p>
1216
          </p>',
1217
  );
1218

    
1219
  $form['distribution'][CDM_DISTRIBUTION_FILTER] = array(
1220
      '#type' => 'fieldset',
1221
      '#title' => 'Distribution filter',
1222
      '#collapsible' => FALSE,
1223
      '#collapsed' => FALSE,
1224
      '#tree' => TRUE,
1225
      '#description' => 'The Distribution filter offers the following options
1226
      <ul>
1227
      <li><strong>Status order preference rule:</strong> In case of multiple distribution status (PresenceAbsenceTermBase) for
1228
        the same area the status with the highest order is preferred, see OrderedTermBase.compareTo(OrderedTermBase).</li>
1229
      <li><strong>Sub area preference rule:</strong>If there is an area with a direct sub area and both areas have the same
1230
        computed status only the information on the sub area should be reported, whereas the super area should be ignored.</li>
1231
      <li><strong>Marked area filter:</strong>Skip distributions for areas having a TRUE Marker with one of the specified MarkerTypes.
1232
        Existing sub-areas of a marked area must also be marked with the same marker type, otherwise the marked
1233
        area acts as a fallback area for the sub areas. An area is a <em>fallback area</em> if it is marked to
1234
        be hidden and if it has at least one of sub area which is not marked to be hidden. The <em>fallback area</em>
1235
        will be show if there is no Distribution for any of the non hidden sub-areas. For more detailed discussion on
1236
        <em>fallback area</em> see https://dev.e-taxonomy.eu/trac/ticket/4408.</li>
1237
      </ul>'
1238
  );
1239

    
1240
  $cdm_distribution_filter = get_array_variable_merged(CDM_DISTRIBUTION_FILTER, CDM_DISTRIBUTION_FILTER_DEFAULT);
1241
  $form['distribution'][CDM_DISTRIBUTION_FILTER]['filter_rules'] = array(
1242
      '#type' => 'checkboxes',
1243
      '#title' => 'Filter rules',
1244
      '#default_value' => $cdm_distribution_filter['filter_rules'],
1245
      '#options' => array(
1246
          'statusOrderPreference' => 'Status order preference rule',
1247
          'subAreaPreference' => 'Sub area preference rule'
1248
      ),
1249
  );
1250

    
1251
  $marker_type_options = cdm_terms_by_type_as_option('MarkerType');
1252
  $form['distribution'][CDM_DISTRIBUTION_FILTER]['hiddenAreaMarkerType'] = array(
1253
      '#type' => 'checkboxes',
1254
      '#title' => 'Hide marked area filter',
1255
      '#default_value' => $cdm_distribution_filter['hiddenAreaMarkerType'],
1256
      '#options' => $marker_type_options,
1257
      '#description' => 'Check one or more MarkerTypes to define the "hide marked area" filter .',
1258
  );
1259

    
1260
  $form['aggregation'] = array(
1261
      '#type' => 'fieldset',
1262
      '#title' => t('Aggregation of data'),
1263
      '#collapsible' => FALSE,
1264
      '#description' => 'This section covers the different aspects of aggregating information.
1265
          <p>
1266
          </p>',
1267
  );
1268

    
1269
  $form['aggregation'][CDM_TAXON_MEDIA_FILTER] = array(
1270
      '#type' => 'checkboxes',
1271
      '#title' => 'Taxon media filter',
1272
      '#default_value' => variable_get(CDM_TAXON_MEDIA_FILTER, unserialize(CDM_TAXON_MEDIA_FILTER_DEFAULT)),
1273
      '#options' => array(
1274
          'includeTaxonDescriptions' => 'Media in taxon descriptions',
1275
          'includeTaxonNameDescriptions' => 'Media in name descriptions',
1276
          'includeOccurrences' => 'Media related to specimens and occurrences',
1277
      ),
1278
      '#description' => 'This filter configures which images should be taken into account.',
1279
  );
1280

    
1281
  $form['aggregation']['notice'] = array(
1282
      '#markup' => '<strong>NOTICE:</strong> The below aggregation settings can slow down the data portal, so you may want to sensibly apply these setting and you may also
1283
          want to make use of the caching capabilities of the dataportal.',
1284
  );
1285

    
1286
  $form['aggregation']['media_aggregation'] = array(
1287
      '#type' => 'fieldset',
1288
      '#title' => t('Media aggregation'),
1289
      '#collapsible' => FALSE,
1290
      '#collapsed' => TRUE,
1291
      '#description' => t("The media aggregation is also affected by the settigs in \"<strong>Aggregation via taxon relationsships</strong>\" below."),
1292

    
1293
  );
1294
  $form['aggregation']['media_aggregation']['cdm_images_include_children'] = array(
1295
      '#type' => 'select',
1296
      '#title' => t('Aggregation of taxon pictures') . ':',
1297
      '#default_value' => variable_get('cdm_images_include_children', FALSE),
1298
      '#options' => array(
1299
          0 => "Show only pictures of the current taxon",
1300
          1 => "Include pictures of taxonomic children",
1301
      ),
1302
      '#description' => t("Choose whether to include the images of the taxonomic children. This will affect the <em>Images</em> tab and image tumbnails like in the search results."),
1303
  );
1304

    
1305
  $form['aggregation']['aggregate_by_taxon_relationships'][CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS] = array(
1306
      '#type' => 'fieldset',
1307
      '#attributes' => array('class' => array('clearfix')),
1308
      '#title' => t('Aggregation via taxon relationsships'),
1309
      '#collapsible' => TRUE,
1310
      '#collapsed' => TRUE,
1311
      '#tree' => TRUE,
1312
      '#description' => t('Information on taxa will be aggregated along the below chosen
1313
          taxon relation ships. This will affect images and occurrences (specimens).
1314
          Taxon relation ships are directed and point form one taxon to another. The taxon
1315
          relationships to be taken into accunt can therefore configured for the direct direction
1316
          and for the inverse.'),
1317
  );
1318

    
1319
  $taxonRelationshipTypeOptions = cdm_vocabulary_as_option(UUID_TAXON_RELATIONSHIP_TYPE, '_cdm_relationship_type_term_label_callback');
1320
  $aggregate_by_taxon_relationships = variable_get(CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS, unserialize(CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS_DEFAULT));
1321

    
1322
  $form['aggregation']['aggregate_by_taxon_relationships'][CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS]['direct'] = array(
1323
      '#type' => 'checkboxes',
1324
      '#title' => t('Direct'),
1325
      '#options' => $taxonRelationshipTypeOptions,
1326
      '#default_value' => $aggregate_by_taxon_relationships['direct'],
1327
  );
1328
  $form['aggregation']['aggregate_by_taxon_relationships'][CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS]['invers'] = array(
1329
      '#type' => 'checkboxes',
1330
      '#title' => t('Invers'),
1331
      '#options' => $taxonRelationshipTypeOptions,
1332
      '#default_value' => $aggregate_by_taxon_relationships['invers'],
1333
  );
1334

    
1335
  $form['drupal_integration'] = array(
1336
    '#type' => 'fieldset',
1337
    '#attributes' => array('class'=> array('clearfix')),
1338
    '#title' => t('Drupal integration'),
1339
    '#collapsible' => FALSE,
1340
    '#collapsed' => FALSE,
1341
    '#tree' => FALSE
1342
  );
1343

    
1344
  $form['drupal_integration'][CDM_DRUPAL_NODE_CREATION] = array(
1345
    '#type' => 'checkbox',
1346
    '#title' => 'Create drupal nodes',
1347
    '#default_value' => variable_get(CDM_DRUPAL_NODE_CREATION, FALSE),
1348
    '#description' => 'Content für cdm_dataportal pages is directly retrieved from the 
1349
    CDM webservice configured above. In order to use other drupal modules like the "Comments" module together with the 
1350
    cdm pages it is required that drupal nodes are created and stored in the database.'
1351
  );
1352

    
1353

    
1354

    
1355
  $form['drupal_integration']['drop_all_cdm_nodes_warning_pre'] = array(
1356
    '#markup' => '<h6 style="color:red;">WARNING:</h6>
1357
    <div class="description">Using this button, you will lose all content associated with the cdm drupal nodes which is stored in the drupal data base.</div>',
1358
  );
1359
  $form['drupal_integration']['drop_all_cdm_nodes'] = array(
1360
    '#type' => 'submit',
1361
    '#value' => t('Drop all cdm nodes'),
1362
    '#submit' => array('drop_all_cdm_nodes_submit')
1363
  );
1364

    
1365
  $form['drupal_integration']['drop_all_cdm_nodes_warning_post'] = array(
1366
    '#markup' => '<div class="description">All Drupal nodes created for cdm content can be deleted at once using this button.</div>',
1367
  );
1368

    
1369
    // ----------------------
1370
  $form['cdm_js_devel_mode'] = array(
1371
      '#type' => 'checkbox',
1372
      '#title' => 'Java-script developer mode',
1373
      '#default_value' => variable_get('cdm_js_devel_mode', FALSE),
1374
      '#description' => 'In production envirionments the java script libraries
1375
      the cdm_dataportal is making use of are compressed and optimized. This
1376
      is good for performance but a caveat if you need to debug java-script. When the
1377
      java-script developer mode is enabled the uncompressed and commented developer
1378
      versions of java-script libraries will be used where possible.
1379
      <br/><strong>Do not use this option in production!</strong>'
1380
  );
1381
  // ----------------------
1382
  $form['cdm_debug_mode'] = array(
1383
      '#type' => 'checkbox',
1384
      '#title' => 'CDM page debug mode',
1385
      '#default_value' => variable_get('cdm_debug_mode', FALSE),
1386
      '#description' => 'When CDM page debug mode enabled the start and end of cdm entity page
1387
      creation is logged as well as any http request send via the cdm_api. The log is written to a file in the temporary
1388
      folder configured in the' . l('File system settings', 'admin/config/media/file-system') .
1389
       '. For this site the file is <code> ' . file_directory_temp() . '/drupal_debug.txt</code>
1390
      The log is written by the drupal devel module function <code>dd()</code>.
1391
      <br/><strong>Note:</strong> The start and end of the page creation is currently only logged for taxon pages only.'
1392
  );
1393

    
1394
  // Comment @WA: D7 form api does not support reset buttons,
1395
  // so to mimic the D5 reset button we add one like this.
1396
  $form['actions']['reset'] = array(
1397
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1398
    '#weight' => 1000,
1399
  );
1400

    
1401
  $form['#submit'][] = 'cdm_settings_general_submit';
1402

    
1403
  return system_settings_form($form);
1404
}
1405

    
1406
/**
1407
 * Submit callback; drops all cdm nodes.
1408
 *
1409
 * @ingroup forms
1410
 */
1411
function drop_all_cdm_nodes_submit($form, &$form_state) {
1412
  cdm_delete_all_cdm_nodes();
1413
  drupal_set_message(t('All cdm nodes dropped.'));
1414
}
1415

    
1416

    
1417
/**
1418
 * LAYOUT settings
1419
 * @return
1420
 *   todo
1421
 */
1422
function cdm_settings_layout() {
1423

    
1424
  $form = array();
1425

    
1426
  $form['about'] = array(
1427
    '#markup' => '<h4>' . t('Portal Layout') . '</h4><p>' . t('This settings contains the general configurations
1428
      layout. If you want to configure the specific sites layout visit the
1429
      respective configuration site for taxon, search or media.') . '</p>',
1430
  );
1431

    
1432
  // ---- footnotes --- //
1433
  $form['footnotes'] = array(
1434
    '#type' => 'fieldset',
1435
    '#title' => t('Footnotes'),
1436
    '#collapsible' => FALSE,
1437
    '#collapsed' => FALSE,
1438
    '#description' => t('Taxa data such authors, synonyms names, descriptions,
1439
      media or distribution areas may have annotations or footnotes. When the
1440
      footnotes are enabled they will be visible (if they exist).'),
1441
  );
1442

    
1443
  $form['footnotes']['cdm_dataportal_all_footnotes'] = array(
1444
    '#type' => 'checkbox',
1445
    '#title' => t('Do not show footnotes'),
1446
    '#default_value' => variable_get('cdm_dataportal_all_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES),
1447
    '#description' => t('Check this if you do not want to show any footnotes'),
1448
  );
1449

    
1450
  $form['footnotes']['cdm_dataportal_annotations_footnotes'] = array(
1451
    '#type' => 'checkbox',
1452
    '#title' => t('Do not show annotation footnotes'),
1453
    '#default_value' => variable_get('cdm_dataportal_annotations_footnotes', CDM_DATAPORTAL_ANNOTATIONS_FOOTNOTES),
1454
    '#description' => t('Check this if you do not want to show annotation footnotes'),
1455
  );
1456

    
1457
  $annotationTypeOptions = cdm_terms_by_type_as_option('AnnotationType');
1458
  // Additional option for the NULL case.
1459
  $annotationTypeOptions['NULL_VALUE'] = t('untyped');
1460
  $form['footnotes']['annotations_types_as_footnotes'] = array(
1461
    '#type' => 'checkboxes',
1462
    '#title' => t('Annotation types as footnotes'),
1463
    '#description' => t("Only annotations of the selected type will be displayed
1464
       as footnotes. You may want to turn 'technical annotations' off."),
1465
    '#options' => $annotationTypeOptions,
1466
  );
1467
  $annotationsTypesAsFootnotes = variable_get('annotations_types_as_footnotes', unserialize(ANNOTATIONS_TYPES_AS_FOOTNOTES_DEFAULT));
1468
  if (!empty($annotationsTypesAsFootnotes)) {
1469
    $form['footnotes']['annotations_types_as_footnotes']['#default_value'] = $annotationsTypesAsFootnotes;
1470
  }
1471

    
1472
  // ---- original source --- //
1473
  $form[BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE] = array(
1474
      '#type' => 'fieldset',
1475
      '#tree' => TRUE,
1476
      '#title' => t('Source Citations'),
1477
      '#collapsible' => FALSE,
1478
      '#collapsed' => FALSE,
1479
  );
1480

    
1481
  $bibliography_settings = get_bibliography_settings(true);
1482

    
1483
  $form[BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE]['enabled'] = array(
1484
      '#type' => 'checkbox',
1485
      '#title' => t('Original Source in bibliography'),
1486
      '#default_value' => $bibliography_settings['enabled'],
1487
      '#description' => t('Show original source citations in bibliography block, instead of rendering them with other
1488
       annotations in each feature block.'),
1489
  );
1490

    
1491
  $form[BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE]['key_format'] = array(
1492
    '#type' => 'select',
1493
    '#title' => t('The format of the key numerals'),
1494
    '#default_value' => $bibliography_settings['key_format'],
1495
    '#options' => array('latin' => 'Latin',
1496
      'ROMAN' => 'Roman (upper case)',
1497
      'roman' => 'Roman (lower case)',
1498
      'ALPHA'=> 'Alphabet (upper case)',
1499
      'alpha' => 'Alphabet (lower case)')
1500
  );
1501

    
1502
  // --- Advanced Search --- //
1503
  $form['asearch'] = array(
1504
      '#type' => 'fieldset',
1505
      '#title' => t('Advanced search'),
1506
      '#collapsible' => FALSE,
1507
      '#collapsed' => FALSE,
1508
  );
1509
  $form['asearch']['cdm_dataportal_show_advanced_search'] = array(
1510
      '#type' => 'checkbox',
1511
      '#title' => t('Show advanced search link'),
1512
      '#default_value' => variable_get('cdm_dataportal_show_advanced_search', 1),
1513
      '#description' => t('Check this box if the link to advanced search should be show below the search box.'),
1514
  );
1515

    
1516
  // ---- Taxon Name Rendering --- //
1517
  $form['taxon_name'] = array(
1518
      '#type' => 'fieldset',
1519
      '#title' => t('Taxon name display'),
1520
      '#collapsible' => TRUE,
1521
      '#collapsed' => TRUE,
1522
      '#description' => t('The display of taxon names is configured by two parts.
1523
          The <srong>name render templates</strong> define the parts of the name to be displayed in the different areas of the data portal pages.
1524
          The name parts are defined in the <stong>part definitions</strong>'),
1525
  );
1526

    
1527
  $default_part_definitions = unserialize(CDM_PART_DEFINITIONS_DEFAULT);
1528
  $default_part_definitions_pre_380_json = json_encode(unserialize(CDM_PART_DEFINITIONS_DEFAULT_PRE_380), JSON_PRETTY_PRINT);
1529
  $default_part_definition_json = json_encode($default_part_definitions, JSON_PRETTY_PRINT);
1530
  $current_part_definition_json = json_encode(variable_get(CDM_PART_DEFINITIONS, $default_part_definitions), JSON_PRETTY_PRINT);
1531

    
1532
  $is_custom_part_definition = $default_part_definition_json != $current_part_definition_json;
1533
  if($default_part_definitions_pre_380_json == $current_part_definition_json){
1534
    $which_version_message = '(These are the old default part definition from before EDIT platform release 3.8.0, you may want to reset these by clearing the text area and and submitting the form.)';
1535
  } else if($is_custom_part_definition){
1536
    $which_version_message = '(This are custom part definitions, clearing the text area and and submitting the form will reset it to the default)';
1537
  } else  {
1538
    $which_version_message = '(These are the default part definition.)';
1539
  }
1540

    
1541
  $diff_viewer_markup = '';
1542
  if($is_custom_part_definition){
1543
    $diff_viewer_markup = diff_viewer($default_part_definition_json, $current_part_definition_json);
1544
  }
1545

    
1546
  $which_version_message = '<div style="color:#ff0000; font-weight: bold;">'
1547
    . $which_version_message
1548
    . '</div>'
1549
    . $diff_viewer_markup;
1550

    
1551
  $form['taxon_name'][CDM_PART_DEFINITIONS] = array(
1552
      '#type' => 'textarea',
1553
      '#title' => t('Part definitions'),
1554
      '#element_validate' => array('form_element_validate_json'),
1555
      '#default_value' =>  $current_part_definition_json,
1556
      '#description' => '
1557
          <p>' . $which_version_message . '</p>
1558
          <p>
1559
           The part definitions define the specific parts of which a rendered taxon name plus additional information will consist.
1560
          </p>
1561
          <p>
1562
           A full taxon name plus additional information can consist of the following elements:
1563
          <ul>
1564
             <li>name: the taxon name inclugin rank nbut without author</li>
1565
             <li>authors:  The authors of a reference, also used in taxon names</li>
1566
             <li>reference: the nomenclatural reference,</li>
1567
             <li>microreference:  Volume, page number etc.</li>
1568
             <li>status:  The nomenclatural status of a name</li>
1569
             <li>description: name descriptions like protologues etc ...</li>
1570
          </ul>
1571
          </p>
1572
          <p>
1573
           These elements are combined in the part definitions array to from the specific parts to be rendered.
1574
           (The taxon name "Lapsana communis L., Sp. Pl.: 811. 1753" shall be an example in the following)
1575
           The following parts can be formed and are recognized by the system:
1576
          <ul>
1577
            <li>namePart: the name and rank (for example: "Lapsana communis")</li>
1578
            <li>authorshipPart: the author (for example: "L.")</li>
1579
            <li>nameAuthorPart: the combination of name and author part (for example: "Lapsana communis L.").</li>
1580
               This is useful for zoological names where the authorshipPart belongs to the name and both should</li>
1581
               be combined when a link to the taxon is rendered.</li>
1582
            <li>referencePart: the nomencaltural reference (for example: "Sp. Pl. 1753")</li>
1583
          <li>referenceYearPart: the publication year of the nomencaltural reference (for example: "1753")</li>
1584
            <li>microreferencePart: usually the page number (for example ": 811.")</li>
1585
            <li>statusPart: the nomenclatorical status</li>
1586
            <li>descriptionPart: name descriptions like protologues etc ...</li>
1587
          </ul>
1588
          </p>
1589
          <p>
1590
           Each set of parts is dedicated to render a specific TaxonName type, the type names are used as keys for the
1591
           specific parts part definitions:
1592
          <ul>
1593
            <li>BotanicalName</li>
1594
            <li>ZoologicalName</li>
1595
            <li>#DEFAULT: covers ViralNames and other NonViralNames
1596
          </ul>
1597
           An example:
1598
          <pre>
1599
           {
1600
            "ZoologicalName": {
1601
              "namePart": {
1602
                "name": true
1603
              },
1604
              "referencePart": {
1605
                "authors": true
1606
              },
1607
              "microreferencePart": {
1608
                "microreference": true
1609
              },
1610
              "statusPart": {
1611
                "status": true
1612
              },
1613
              "descriptionPart": {
1614
                "description": true
1615
              }
1616
            },
1617
            "BotanicalName": {
1618
              "namePart": {
1619
                "name": true,
1620
                "authors": true
1621
              },
1622
              "referencePart": {
1623
                "reference": true,
1624
                "microreference": true
1625
              },
1626
              "secReferencePart": {
1627
                "secReference": true
1628
              },
1629
              "statusPart": {
1630
                "status": true
1631
              },
1632
              "descriptionPart": {
1633
                "description": true
1634
              }
1635
            }
1636
          }
1637
           </pre>',
1638
  );
1639

    
1640
  $default_render_templates = unserialize(CDM_NAME_RENDER_TEMPLATES_DEFAULT);
1641
  $default_render_templates_pre_380_json = json_encode(unserialize(CDM_NAME_RENDER_TEMPLATES_DEFAULT_PRE_380), JSON_PRETTY_PRINT);
1642
  $default_render_templates_json = json_encode($default_render_templates, JSON_PRETTY_PRINT);
1643
  $current_render_templates_json = json_encode(variable_get(CDM_NAME_RENDER_TEMPLATES, $default_render_templates), JSON_PRETTY_PRINT);
1644
  $is_custom_render_template = $default_render_templates_json != $current_render_templates_json;
1645

    
1646
  if($default_render_templates_pre_380_json == $current_render_templates_json){
1647
    $which_version_message = '(These are the old default render templates from before EDIT platform release 3.8.0, you may want to reset these by clearing the text area and and submitting the form.)';
1648
  } else if($is_custom_render_template){
1649
    $which_version_message = '(These are custom render templates, clearing the text area and and submitting the form will reset it to the default)';
1650
  } else {
1651
    $which_version_message = '(These are the default render templates.)';
1652
  }
1653

    
1654
  $diff_viewer_markup = '';
1655
  if($is_custom_render_template){
1656
    $diff_viewer_markup = diff_viewer($default_render_templates_json, $current_render_templates_json);
1657
  }
1658

    
1659
  $which_version_message = '<div style="color:#ff0000; font-weight: bold;">'
1660
    . $which_version_message
1661
    . '</div>'
1662
    . $diff_viewer_markup;
1663

    
1664
  $form['taxon_name'][CDM_NAME_RENDER_TEMPLATES] = array(
1665
      '#type' => 'textarea',
1666
      '#title' => t('Name render templates'),
1667
      '#element_validate' => array('form_element_validate_json'),
1668
      '#default_value' =>  $current_render_templates_json,
1669
      '#description' => '
1670
          <p>' . $which_version_message . '</p>
1671
          <p>
1672
          The render templates array contains one or more name render templates to be used within the page areas identified by the
1673
          render path. The render path of taxon names can be made visible by adding the URI query parameter 
1674
          <strong><code>RENDER_PATH=1</code></strong> to the page request.<br />
1675
          The render path is used as key of the array sub subelements whereas the name render template array is set as value.
1676
          The following render Path keys are currently recognized:
1677
          <ul>
1678
            <li>list_of_taxa</li>
1679
            <li>acceptedFor</li>
1680
            <li>homonym</li>
1681
            <li>taxon_page_synonymy</li>
1682
            <li>typedesignations</li>
1683
            <li>taxon_page_title</li>
1684
            <li>polytomousKey</li>
1685
            <li>na: name + authorship</li>
1686
            <li>nar:name + authorship + reference</li>
1687
            <li>#DEFAULT</li>
1688
          </ul>
1689
          A single render template can be used for multiple render paths. In this case the according key of the render templates
1690
          array element should be a comma separated list of render paths, without any whitespace!.
1691
          </p>
1692
          <p>
1693
          A render template is an associative array. The keys of this array are referring to the keys as defined in the part
1694
          definitions array. See <a href="#edit-cdm-part-definitions">Part definitions</a> above for more information.
1695
          <p>
1696
          The value of the render template element must be set to TRUE in order to let this part being rendered.
1697
          For some parts can <strong>links</strong> can be created which lead to the accoring intity page:</br>
1698
          The <strong>namePart</strong>, <strong>nameAuthorPart</strong>, <strong>referencePart</strong> and <strong>secReferencePart</strong> can also hold an associative array with a single
1699
          element: array(\'#uri\' => TRUE). The value of the #uri element will be replaced by the according
1700
          links if the paramters $nameLink or $refenceLink are given to the name render function
1701
          (this is hard coded and cannot be configured here).',
1702
  );
1703

    
1704
  // @WA: D7 form api does not support reset buttons,
1705
  // so to mimic the D5 reset button we add one like this.
1706
  $form['actions']['reset'] = array(
1707
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1708
    '#weight' => 1000,
1709
  );
1710

    
1711
  $form['#submit'] = array('submit_json_as_php_array');
1712
  // #json_elements especially defined for submit_json_as_php_array()
1713
  $form['#json_elements'] = array(CDM_NAME_RENDER_TEMPLATES, CDM_PART_DEFINITIONS);
1714
  return system_settings_form($form);
1715
}
1716

    
1717

    
1718

    
1719
  /**
1720
 * @todo Please document this function.
1721
 * @see http://drupal.org/node/1354
1722
 */
1723
function cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description = '') {
1724
  $form[$form_name] = array(
1725
    '#type' => 'fieldset',
1726
    '#title' => t('@form-title', array('@form-title' => $form_title)),
1727
    '#collapsible' => TRUE,
1728
    '#collapsed' => $collapsed,
1729
    '#tree' => TRUE,
1730
    '#description' => t('@$form-description', array('@$form-description' => $form_description)),
1731
  );
1732

    
1733
  $default_values = unserialize(CDM_DATAPORTAL_GALLERY_SETTINGS);
1734
  $gallery_settings = variable_get($form_name, $default_values);
1735
  // $test = variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE);
1736
  if ($form_name == CDM_DATAPORTAL_SEARCH_GALLERY_NAME) {
1737
    /*
1738
    TODO: why cdm_dataportal_search_items_on_page does not save the value on $test???
1739
    $form[$form_name]['cdm_dataportal_search_items_on_page'] = array(
1740
    '#type' => 'textfield',
1741
    '#title' => t('Search Page Size'),
1742
    '#default_value' => $test,
1743
    '#description' => t('Number of Names to display per page in search results.')
1744
    );
1745
    */
1746
    $form[$form_name]['cdm_dataportal_show_taxon_thumbnails'] = array(
1747
      '#type' => 'checkbox',
1748
      '#title' => t('Show media thumbnails for accepted taxa'),
1749
      '#default_value' => $gallery_settings['cdm_dataportal_show_taxon_thumbnails'],
1750
    );
1751

    
1752
    $form[$form_name]['cdm_dataportal_show_synonym_thumbnails'] = array(
1753
      '#type' => 'checkbox',
1754
      '#title' => t('Show media thumbnails for synonyms'),
1755
      '#default_value' => $gallery_settings['cdm_dataportal_show_synonym_thumbnails'],
1756
      '#description' => '',
1757
    );
1758
  }
1759

    
1760
  // $showCaption = variable_get('cdm_dataportal_findtaxa_show_thumbnail_captions', 0);
1761
  $form[$form_name]['cdm_dataportal_show_thumbnail_captions'] = array(
1762
    '#type' => 'checkbox',
1763
    '#title' => t('Show captions under thumbnails'),
1764
    '#default_value' => $gallery_settings['cdm_dataportal_show_thumbnail_captions'],
1765
    '#description' => '',
1766
  );
1767

    
1768
  $form[$form_name]['cdm_dataportal_media_maxextend'] = array(
1769
    '#type' => 'textfield',
1770
    '#title' => t('Thumbnail size') . ':',
1771
    '#default_value' => $gallery_settings['cdm_dataportal_media_maxextend'],
1772
    '#description' => t('Select the size of each individual thumbnail.'),
1773
  );
1774

    
1775
  if ($form_name != CDM_DATAPORTAL_MEDIA_GALLERY_NAME) {
1776
    $form[$form_name]['cdm_dataportal_media_cols'] = array(
1777
      '#type' => 'textfield',
1778
      '#title' => t('Number of columns') . ':',
1779
      '#default_value' => $gallery_settings['cdm_dataportal_media_cols'],
1780
      '#description' => t('Group the thumbnails in columns: select how many
1781
        columns the gallery should display.'),
1782
    );
1783
  }
1784

    
1785
  if ($form_name == CDM_DATAPORTAL_SEARCH_GALLERY_NAME) {
1786
    $form[$form_name]['cdm_dataportal_media_maxRows'] = array(
1787
      '#type' => 'textfield',
1788
      '#title' => t('Maximum number of rows') . ':',
1789
      '#default_value' => $gallery_settings['cdm_dataportal_media_maxRows'],
1790
      '#description' => t('You can group the thumbnails in rows, select in how
1791
        many rows should be the thumbnails grouped.<br/><strong>Note:</strong>
1792
        If you want an unlimited number of rows please set to 0.'),
1793
    );
1794
  }
1795

    
1796
  return $form;
1797
}
1798

    
1799
/**
1800
 * @todo document this function.
1801
 */
1802
function cdm_settings_layout_taxon() {
1803
  $collapsed = FALSE;
1804
  $form = array();
1805

    
1806
  $form['#submit'][] = 'cdm_settings_layout_taxon_submit';
1807

    
1808
  // --------- TABBED TAXON ------- //
1809
  $form['taxon_tabs'] = array(
1810
    '#type' => 'fieldset',
1811
    '#title' => t('Taxon tabs'),
1812
    '#collapsible' => TRUE,
1813
    '#collapsed' => TRUE,
1814
    '#description' => t('If tabbed taxon page is enabled the taxon profile will
1815
      be splitted in four diferent tabs; General, Synonymy, Images and
1816
      Specimens. If the taxon has no information for any of the tabs/sections
1817
      such tab will be not displayed.'),
1818
  );
1819

    
1820
  $form['taxon_tabs']['cdm_dataportal_taxonpage_tabs'] = array(
1821
    '#type' => 'checkbox',
1822
    '#title' => t('Tabbed taxon page'),
1823
    '#default_value' => variable_get('cdm_dataportal_taxonpage_tabs', 1),
1824
    '#description' => t('<p>If selected split the taxon page into individual
1825
      tabs for description, images, synonymy and specimens. If not the taxon
1826
      data is rendered as a long single page without tabs.</p>'),
1827
  );
1828

    
1829
  $form['taxon_tabs']['cdm_taxonpage_tabs_visibility'] = array(
1830
    '#type' => 'checkboxes',
1831
    '#title' => t('Tabs visibility options') . ':',
1832
    '#default_value' => variable_get('cdm_taxonpage_tabs_visibility', get_taxon_options_list()),
1833
    '#options' => get_taxon_options_list(),
1834
    '#description' => t('Enable or disable Tabs in the Tabbed page display'),
1835
  );
1836

    
1837
  // WEIGHT
1838
  $taxon_tabs_weights = get_array_variable_merged(CDM_TAXONPAGE_TAB_WEIGHT, CDM_TAXONPAGE_TAB_WEIGHT_DEFAULT);
1839
  $form['taxon_tabs'][CDM_TAXONPAGE_TAB_WEIGHT] = array(
1840
    '#title'  => 'Tabs order',
1841
    '#tree' => true,
1842
    '#description' => 'The weight value defines the order of the tabs or of the respective content block on the 
1843
        taxon page when it is the tabless mode.'
1844
  );
1845
  // Weights range from -delta to +delta, so delta should be at least half
1846
  // of the amount of tabs present.
1847
  $tab_weight_delta = round(count(get_taxon_tabs_list()) / 2) + 1;
1848
  foreach (get_taxon_tabs_list() as $label) {
1849
    $key = strtolower($label); // turn in to string, since we need to use strings as keys
1850
    $form['taxon_tabs'][CDM_TAXONPAGE_TAB_WEIGHT][$key] = array(
1851
        '#title' => $label,
1852
        '#type'  => 'weight',
1853
        '#default_value' => $taxon_tabs_weights[$key],
1854
        '#delta' => $tab_weight_delta
1855
    );
1856
  }
1857

    
1858
  $taxon_tabs_labels = get_array_variable_merged(CDM_TAXONPAGE_TAB_LABELS, CDM_TAXONPAGE_TAB_LABELS_DEFAULT);
1859
  $form['taxon_tabs'][CDM_TAXONPAGE_TAB_LABELS] = array(
1860
    '#title'  => 'Tab label override',
1861
    '#tree' => true,
1862
    '#description' => 'Setting a label for a tab will override the default label.'
1863
  );
1864
  foreach (get_taxon_tabs_list() as $label) {
1865
    $key = strtolower($label); // turn in to string, since we need to use strings as keys
1866
    $form['taxon_tabs'][CDM_TAXONPAGE_TAB_LABELS][$key] = array(
1867
      '#title' => $label,
1868
      '#type'  => 'textfield',
1869
      '#default_value' => $taxon_tabs_labels[$key]
1870
    );
1871
  }
1872

    
1873
  $form['taxon_tabs']['cdm_dataportal_default_tab'] = array(
1874
    '#type' => 'select',
1875
    '#title' => t('Default tab to display') . ':',
1876
    '#default_value' => variable_get('cdm_dataportal_default_tab', 0),
1877
    '#options' => unserialize(CDM_DATAPORTAL_DEFAULT_TAXON_TAB),
1878
    '#description' => t('<p>Select the default tab to display when visiting a
1879
      taxon page. Only available if Tabbed Taxon Page is enable.</p>
1880
      <strong>Note:</strong> After performing a search and clicking in any
1881
      synonym, the taxon tab to be rendered will be the synonymy of the accepted
1882
      taxon and not the above selected tab.'),
1883
  );
1884

    
1885
  /* ======  TAXON_PROFILE ====== */
1886
  $form['taxon_profile'] = array(
1887
    '#type' => 'fieldset',
1888
    '#title' => t('Taxon profile (tab)'),
1889
    '#description' => t('<p>This section covers the settings related to the taxon
1890
      profile tab, also known as the <strong>"General"</strong> tab.</p>'),
1891
    '#collapsible' => TRUE,
1892
    '#collapsed' => TRUE,
1893
  );
1894

    
1895
  // ---- PROFILE PICTURE ----//
1896

    
1897
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE] = array(
1898
    '#type' => 'fieldset',
1899
    '#tree' => TRUE,
1900
    '#title' => t('Taxon profile picture'),
1901
    '#collapsible' => TRUE,
1902
    '#collapsed' => FALSE,
1903
    '#description' => t('This sections allows configuring the display of the so called taxon profile image which is displayed in the taxon profile tab.'),
1904
  );
1905

    
1906
  //FIXME migrate variables:
1907
  //  cdm_dataportal_show_default_image ---> CDM_TAXON_PROFILE_IMAGE['show']
1908
  // FIXME
1909
  //  enable file module in profile and in update,(a.kohlbecker, 4.9.2014: is this still an open issue?)
1910

    
1911
  $taxon_profile_image_settings = variable_get(CDM_TAXON_PROFILE_IMAGE, unserialize(CDM_TAXON_PROFILE_IMAGE_DEFAULT));
1912

    
1913
  /*
1914
   * 'show' => 1,
1915
   * 'maxextend' => 184,
1916
   * 'media_uri_query' => ''
1917
   * 'custom_placeholder_image_on' => 1,
1918
   * 'custom_placeholder_image_fid' => ''
1919
   */
1920
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['show'] = array(
1921
    '#type' => 'checkbox',
1922
    '#title' => t('Enable profile picture'),
1923
    '#description' => t('Show the profile picture.'),
1924
    '#default_value' => $taxon_profile_image_settings['show'],
1925
  );
1926

    
1927
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['maxextend'] = array(
1928
      '#type' => 'textfield',
1929
      '#tree' => TRUE,
1930
      '#title' => t('Profile picture maximum extend'),
1931
      '#default_value' =>  $taxon_profile_image_settings['maxextend'],
1932
      '#field_suffix' => 'px',
1933
      '#maxlength' => 4,
1934
      '#size' => 4,
1935
      '#description' => t('The maximum extend in either dimension, width or height, of the profile picture in pixels.')
1936
  );
1937

    
1938
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['media_uri_query'] = array(
1939
      '#type' => 'textfield',
1940
      '#tree' => TRUE,
1941
      '#title' => t('Additional URI query parameter'),
1942
      '#default_value' =>  $taxon_profile_image_settings['media_uri_query'],
1943
      '#maxlength' => 1024,
1944
      '#size' => 60,
1945
      '#description' => t('Additional query parameters to be used when requesting for the  
1946
            profile image. E.g.: <code>width=400&height=300&quality=95&format=jpeg</code>.
1947
            The query parameters will be appended to the uri of the media representation part
1948
            as stored in the cdm. The query parameter string must not start with a \'&\' or  \'?\'')
1949
  );
1950

    
1951
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_enabled'] = array(
1952
    '#type' => 'checkbox',
1953
    '#title' => t('Show the placeholder image'),
1954
    '#description' => t("If not taxon profile picture is available a placeholder image is shown instead."),
1955
    '#default_value' => $taxon_profile_image_settings['custom_placeholder_enabled']
1956
  );
1957

    
1958
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_on'] = array(
1959
      '#type' => 'checkbox',
1960
      '#title' => t('Use a custom placeholder image'),
1961
      '#description' => t("This image is shown as replacement if no image of the taxon is available."),
1962
      '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_on']
1963
  );
1964

    
1965
  if($taxon_profile_image_settings['custom_placeholder_image_on'] == 1){
1966
    $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'] = array(
1967
        '#type' => 'managed_file',
1968
        '#title' => t('Custom placeholder image file'),
1969
        '#progress_indicator' => 'bar',
1970
        '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_fid'],
1971
    //       '#name' => 'custom_placeholder_image',
1972
        '#upload_location' => 'public://' . CDM_TAXON_PROFILE_IMAGE .'/'
1973
    );
1974

    
1975
    if($taxon_profile_image_settings['custom_placeholder_image_fid']){
1976
      $profile_image_file = file_load($taxon_profile_image_settings['custom_placeholder_image_fid']);
1977
      $url = file_create_url($profile_image_file->uri);
1978
      $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['preview'] = array(
1979
                '#type' => 'item',
1980
                '#markup' => '<div class="image-preview"><img src="' . $url . '"/></div>',
1981
      );
1982
    }
1983
  } else {
1984
    $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'] = array(
1985
      '#type' => 'hidden',
1986
      '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_fid']
1987
    );
1988
  }
1989

    
1990
  $options = cdm_rankVocabulary_as_option();
1991
  array_unshift($options, '-- DISABLED --');
1992
  $form['taxon_profile']['picture']['image_hide_rank'] = array(
1993
    '#type' => 'select',
1994
    '#title' => t('Hide profile picture for higher ranks') . ':',
1995
    '#default_value' => variable_get('image_hide_rank', '0'),
1996
    '#options' => $options,
1997
    '#description' => t('The taxon profile picture will not be shown for taxa with rank higher that the selected.'),
1998
  );
1999

    
2000
  // -- MEDIA THUMBNAILS -- //
2001
  $form_name = CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME;
2002
  $form_title = 'Taxon Profile Images';
2003
  $form_description = '<p>The different section in the taxon  profile can have images associated with them. These images are displayed in a gallery of thumbnails wich can be configuered here:</p>';
2004
  $form['taxon_profile'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description);
2005

    
2006
  // ---- FEATURE TREE BLOCKS ---- //
2007
  $form['taxon_profile']['feature_blocks'] = array(
2008
    '#type' => 'fieldset',
2009
    '#title' => t('Feature Blocks'),
2010
    '#collapsible' => TRUE,
2011
    '#collapsed' => FALSE,
2012
    '#description' => t("This section covers settings related to the taxon's
2013
      <em>Feature Tree</em>. The <em>feature tree</em> are the taxon's
2014
      features such as description, distribution, common names"),
2015
  );
2016
  $featureTrees = cdm_get_featureTrees_as_options(TRUE);
2017
  $profile_feature_tree = get_profile_feature_tree();
2018
  $profile_feature_tree_uuid = $profile_feature_tree->uuid;
2019
  if(!isset($featureTrees['options'][$profile_feature_tree_uuid])) {
2020
    $profile_feature_tree_uuid = UUID_DEFAULT_FEATURETREE;
2021
  }
2022
  $form['taxon_profile']['feature_blocks'][CDM_PROFILE_FEATURETREE_UUID] = array(
2023
    '#type' => 'radios',
2024
    '#title' => t('Taxon profile feature tree') . ':',
2025
    '#default_value' => $profile_feature_tree_uuid,
2026
    '#options' =>  $featureTrees['options'],
2027
    '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
2028
    '#options_suffixes' => $featureTrees['treeRepresentations'],
2029
    '#description' => t('The Feature Tree selected here define the feature blocks which are visible in the taxon
2030
      profile page.'
2031
    ),
2032
  );
2033

    
2034
  // ---- FEATURE TREE BLOCKS > LAYOUT PER FEATURE BLOCK ---- //
2035
  $profile_feature_tree = get_profile_feature_tree();
2036

    
2037
  if (isset($profile_feature_tree->root->childNodes)) {
2038

    
2039
    $form_feature_block_layout = array(
2040
      '#type' => 'fieldset',
2041
      '#tree' => true,
2042
      '#title' => t('Taxon profile feature block settings'),
2043
      '#collapsible' => TRUE,
2044
      '#collapsed' => FALSE,
2045
      '#description' => 'This section let\'s you define how each of the feature blocks is displayed.
2046
      A sub form is for each of the features of currently selected feature tree allows to configre each feature block individually.
2047
      The subforms have the following settings in common:<br />
2048
      <h6>List type:</h6><div>Whether the description elements are displayed as list or not. Three different list types are available</div>
2049
      <h6>Link to reference:</h6><div>Render the reference as link, ignored if the element is NOT a DescriptionElementSource</div>
2050
      <h6>Link to name used in source:</h6><div>Whether to show name is source information as link which will point to the according name page</div>
2051
      <h6>Sources as content:</h6><div><strong>If enabled:</strong><br />
2052
            <ol>
2053
            <li>If element is of the CDM type TextData and the text is not empty the source references will be
2054
                appended in brackets like "text (source references)". If the original source has name in source
2055
                information it will be appended to the citation string,
2056
                like : "(citation, as name in source; citation, as name in source)"</li>
2057
             <li>if the text of the TextData is empty, the original source citations are the only content
2058
                (e.g. use case CITATION) and are not put into brackets. In this case the nameInSource is
2059
                prepended to the citation string like: "name in source: citation"</li>
2060
            </ol>
2061
            <strong>If disabled:</strong><br />
2062
             Original sources are put into the bibliography(=references) pseudo feature block. If the original source
2063
             citations are the only content, the resulting feature block content would only consist of footnotes.
2064
             In this case the display of the respective feature block is suppressed.</div>
2065
      </dl>
2066
      <h6>Sources as content to bibliography:</h6><div>Only valid if <em>Sources as content</em> is enabled, will cause the sources to be also shown
2067
           in the bibliography. For this to work the bibliography must be enabled the <em>' .l(
2068
            'Layout Settings', 'admin/config/cdm_dataportal/settings/layout', array('fragment'=>'edit-bibliography-for-original-source'))
2069
        . '</em></div>
2070
      <h6>Sort elements:</h6><div>Whether and how to sort the elements
2071
           possible values are the constants SORT_ASC, SORT_DESC, NULL,
2072
           some feature types (Distribution) also support: SORT_HIERARCHICAL</div>
2073
      <h6>Element tag:</h6><div>The tag to be used for creating the elements, only applies if "List type" is set to <em>No list</em>
2074
           possible values are span or div. Developers: The proper inner tag name can be retrieved by the function
2075
           cdm_feature_block_element_tag_name()</div>',
2076
    );
2077

    
2078

    
2079
    $feature_list_layout_settings_disabled = FALSE;
2080

    
2081
    // creating helper object to retrieve the default settings
2082
    $featureNode = new stdClass();
2083
    $featureNode->feature = new stdClass();
2084
    $featureNode->feature->uuid="DEFAULT";
2085
    $featureNode->feature->representation_L10n = "Default";
2086
    array_unshift($profile_feature_tree->root->childNodes, $featureNode);
2087

    
2088
    foreach ($profile_feature_tree->root->childNodes as $featureNode) {
2089

    
2090
      if (!$feature_list_layout_settings_disabled && isset($featureNode->feature)) {
2091

    
2092
        // $subform_id must not exceed 45 characters, a uuid has 36 characters
2093
        $subform_id = $featureNode->feature->uuid;
2094
        $feature_block_setting = get_feature_block_settings($featureNode->feature->uuid);
2095

    
2096
//        $settings = mixed_variable_get($subform_id, FEATURE_TREE_LAYOUT_DEFAULTS);
2097

    
2098
        $form_feature_block_layout[$subform_id] = array(
2099
          '#type' => 'fieldset',
2100
          '#tree' => TRUE,
2101
          '#title' => $featureNode->feature->representation_L10n,
2102
          '#collapsible' => FALSE,
2103
          '#collapsed' => FALSE,
2104
        );
2105
        if($featureNode->feature->uuid == "DEFAULT"){
2106
          $form_feature_block_layout[$subform_id]['#description']='These are the defaults which apply to
2107
          all feature blocks for which no specific settings have been defined. for consistency enabling links for <em>source
2108
          references</em> and <em>names in source</em> is only possible in the defaults';
2109
        }
2110

    
2111
        $form_feature_block_layout[$subform_id]['as_list'] = array(
2112
          '#type' => 'select',
2113
          '#title' => 'List type',
2114
          '#default_value' => $feature_block_setting['as_list'],
2115
          '#options' => array(
2116
            'div' => 'not as list',
2117
            'ul' => 'bullet list',
2118
            'ol' => 'numbered list',
2119
            'dl' => 'definition list'
2120
          ),
2121
        );
2122

    
2123
        if($featureNode->feature->uuid == "DEFAULT"){
2124
          $form_feature_block_layout[$subform_id]['link_to_reference'] = array(
2125
            '#type' => 'checkbox',
2126
            '#title' => t('Link to reference'),
2127
            '#default_value' => $feature_block_setting['link_to_reference'],
2128
          );
2129

    
2130
          $form_feature_block_layout[$subform_id]['link_to_name_used_in_source'] = array(
2131
            '#type' => 'checkbox',
2132
            '#title' => 'Link to name used in source',
2133
            '#default_value' => $feature_block_setting['link_to_name_used_in_source'],
2134
          );
2135
        }
2136

    
2137
        $form_feature_block_layout[$subform_id]['sources_as_content'] = array(
2138
          '#type' => 'checkbox',
2139
          '#title' => 'Sources as content',
2140
          '#default_value' => $feature_block_setting['sources_as_content'],
2141
        );
2142

    
2143
        $form_feature_block_layout[$subform_id]['sources_as_content_to_bibliography'] = array(
2144
          '#type' => 'checkbox',
2145
          '#title' => 'Put sources also as content to bibliography',
2146
          '#default_value' => $feature_block_setting['sources_as_content_to_bibliography'],
2147
        );
2148

    
2149
        $form_feature_block_layout[$subform_id]['sort_elements'] = array(
2150
          '#type' => 'select',
2151
          '#title' => t('Sort elements'),
2152
          '#default_value' => $feature_block_setting['sort_elements'],
2153
          '#options' => array(
2154
            NO_SORT => 'No sorting',
2155
            SORT_ASC => 'Ascending',
2156
            SORT_DESC => 'Descending',
2157
            SORT_HIERARCHICAL => 'Hierarchical'
2158
          ),
2159
          '#description' => 'NOT YET FULLY USED! only in preparation (works partially for distributions)
2160
          <dl>
2161
          <dr><dt>No sorting</dt><dd>Sorting undefined</dd></dr>
2162
          <dr><dt>Ascending</dt><dd>Alphabetically in ascending order</dd></dr>
2163
          <dr><dt>Descending</dt><dd>Alphabetically in descending order</dd></dr>
2164
          <dr><dt>Hierarchical</dt><dd>Use the order of items and their hierarchy. This is not possible for all feature and item types.</dd></dr>
2165
          </dl>',
2166
        );
2167

    
2168
        $form_feature_block_layout[$subform_id]['element_tag'] = array(
2169
          '#type' => 'select',
2170
          '#title' => t('Element tag'),
2171
          '#options' => array(
2172
            'span' => 'span',
2173
            'div' => 'div'
2174
          ),
2175
          '#default_value' => $feature_block_setting['element_tag'],
2176
        );
2177
      }
2178
      $form['taxon_profile']['feature_blocks'][FEATURE_BLOCK_SETTINGS] = $form_feature_block_layout;
2179
    }
2180
  }
2181

    
2182
  // ---- STRUCTURED DESCRIPTION FEATURE TREE ---- //
2183
  $form['taxon_profile']['structured_description_featuretree'] = array(
2184
    '#type' => 'fieldset',
2185
    '#title' => t('Structured Description Feature Tree'),
2186
    '#collapsible' => TRUE,
2187
    '#collapsed' => FALSE,
2188
  );
2189
  $featureTrees = cdm_get_featureTrees_as_options();
2190
  $profile_feature_tree_uuid = variable_get(CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID, UUID_DEFAULT_FEATURETREE);
2191
  if(!isset($featureTrees['options'][$profile_feature_tree_uuid])) {
2192
    $profile_feature_tree_uuid = NULL;
2193
  }
2194
  $form['taxon_profile']['structured_description_featuretree'][CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID] = array(
2195
    '#type' => 'radios',
2196
    '#title' => t('Natural language representation of structured descriptions') . ':',
2197
    '#default_value' => $profile_feature_tree_uuid,
2198
    '#options' => $featureTrees['options'],
2199
    '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
2200
    '#options_suffixes' => $featureTrees['treeRepresentations'],
2201
    '#description' => t('Taxon descriptions can be stored in a highly structured
2202
      form. The feature tree selected here will be used to generate textual
2203
      representation in natural language.'
2204
    ),
2205
  );
2206

    
2207

    
2208

    
2209
  // ---- DISTRIBUTION LAYOUT ---- //
2210
  $form['taxon_profile']['distribution_layout'] = array(
2211
    '#title' => t('Distribution'),
2212
    '#collapsible' => TRUE,
2213
    '#collapsed' => FALSE,
2214
    '#type' => 'fieldset',
2215
    '#description' => 'This section covers general settings regarding the textual representation of distributions and the visibility of the map.
2216
        Map settings regarding the geometry, layers, etc are found in the '
2217
      . l('geo & map tab', 'admin/config/cdm_dataportal/settings/geo') .
2218
      '. Further settings regarding the distribution feature block can be found in above in this tab at '
2219
      . l(
2220
        'Taxon profile feature block settings', 'admin/config/cdm_dataportal/settings/layout/taxon',
2221
        array('fragment' => 'edit-feature-block-settings')
2222
      )
2223
      . ' More general settings regrading the filtering of Distributions are found at '
2224
      . l('Distribution appearance', 'admin/config/cdm_dataportal/settings', array('fragment' => 'edit-distribution'))
2225
      . '. (These settings here will be merged in future releases into the feature block settings)',
2226

    
2227
  );
2228

    
2229
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_MAP_VISIBILITY] = _cdm_map_visibility_setting('distribution');
2230

    
2231
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_CONDENSED] = array(
2232
    '#type' => 'checkbox',
2233
    '#title' => t('Condensed distribution'),
2234
    '#default_value' => variable_get(DISTRIBUTION_CONDENSED, 0),
2235
    '#description' => 'This option enables the display of a very compact representation
2236
    of the distribution which includes also information on the status.',
2237
  );
2238

    
2239
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_CONDENSED_RECIPE] = array(
2240
    '#type' => 'select',
2241
    '#title' => t('Condensed distribution recipe'),
2242
    '#default_value' => variable_get(DISTRIBUTION_CONDENSED_RECIPE, DISTRIBUTION_CONDENSED_RECIPE_DEFAULT),
2243
    '#options' => array('EuroPlusMed' => 'Euro+Med', 'FloraCuba' => 'Flora of Cuba'),
2244
    '#description' => 'Recipe for creating the condensed distribution.',
2245
  );
2246

    
2247
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_CONDENSED_INFO_PATH] = array(
2248
    '#type' => 'textfield',
2249
    '#title' => t('Condensed distribution info path'),
2250
    '#default_value' => variable_get(DISTRIBUTION_CONDENSED_INFO_PATH, DISTRIBUTION_CONDENSED_INFO_PATH_DEFAULT),
2251
    '#description' => 'By default the help page ' .l(DISTRIBUTION_CONDENSED_INFO_PATH_DEFAULT, DISTRIBUTION_CONDENSED_INFO_PATH_DEFAULT)
2252
      . ' is used as target for the info link which is shown at the end of the condensed distribution string.',
2253
  );
2254

    
2255

    
2256
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_ORDER_MODE] = array(
2257
    '#type' => 'radios',
2258
    '#title' => t('Display mode') . ':',
2259
    '#default_value' => variable_get(DISTRIBUTION_ORDER_MODE, DISTRIBUTION_ORDER_MODE_DEFAULT),
2260
    '#options' => array(
2261
      'FLAT_ALPHA' => t('Flat list'),
2262
      'TREE' => t('Hierarchically ordered'),
2263
    ),
2264
    '#description' => 'Taxon distribution information is displayed with
2265
    focus on the area of the distribution. The list of areas can either be shown
2266
    as flat list ordered alphabetically or in the hierarchical of the parent
2267
    area and subarea relationship. Fall back areas areas with no Distribution data
2268
    are hidden from the area hierarchy so that their sub areas will move one level up.
2269
    See ' . l('Distribution appearance', 'admin/config/cdm_dataportal/settings', array('fragment' => 'edit-distribution')) .
2270
    ' for details on the <em>Marked area filter</em>.',
2271
  );
2272

    
2273
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_HIERARCHY_STYLE] = array(
2274
    '#type' => 'fieldset',
2275
    '#tree' => true,
2276
    '#title' => t('Distribution hierarchy style')
2277
  );
2278

    
2279
  $hierarchy_styles = get_array_variable_merged(DISTRIBUTION_HIERARCHY_STYLE, DISTRIBUTION_HIERARCHY_STYLE_DEFAULT);
2280
  foreach(array_keys($hierarchy_styles) as $level) {
2281
    $form['taxon_profile']['distribution_layout'][DISTRIBUTION_HIERARCHY_STYLE][$level] = array(
2282
      '#type' => 'fieldset',
2283
      '#tree' => true,
2284
      '#title' => t('@area-level', array('@area-level' => drupal_ucfirst((str_replace('_', ' ', $level))))),
2285
      '#attributes' => array('class' => array('fieldset-float'))
2286
    );
2287
    foreach ($hierarchy_styles[$level] as $key => $value) {
2288
      $form['taxon_profile']['distribution_layout'][DISTRIBUTION_HIERARCHY_STYLE][$level][$key] = array(
2289
        '#type' => 'textfield',
2290
        '#title' => t('@area-level-style', array('@area-level-style' => drupal_ucfirst((str_replace('_', ' ', $key))))),
2291
        '#default_value' => $hierarchy_styles[$level][$key],
2292
        '#maxlength' => 4,
2293
        '#size' => 4
2294
      );
2295
    }
2296
  }
2297

    
2298
  $level_options = cdm_vocabulary_as_option(UUID_NAMED_AREA_LEVEL, NULL, FALSE, NULL, CDM_ORDER_BY_ORDER_INDEX_ASC);
2299
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_TREE_OMIT_LEVELS] = array(
2300
    '#type' => 'checkboxes',
2301
    '#title' => 'Omit area levels',
2302
    '#options' => $level_options,
2303
    '#default_value' => variable_get(DISTRIBUTION_TREE_OMIT_LEVELS, array()),
2304
    '#description' => 'This option ins only applicable when distributions are hierachically orderd (see option above)!
2305
    Areas which belong to the selected area levels will be hidden in the portal.',
2306
  );
2307

    
2308
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP] = array(
2309
    '#type' => 'checkbox',
2310
    '#title' => t('Show TextData elements on top of the map'),
2311
    '#default_value' => variable_get(DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP, 0),
2312
    '#description' => t('Check this if you want to appear all <code>TextData</code>
2313
      elements on top of the map. Otherwise all <code>TextData</code>
2314
      distribution elements will be listed below the other area elements.
2315
      This option is useful if you need to have descriptive texts for each
2316
      distribution map.'),
2317
  );
2318

    
2319
  $form['taxon_profile'][DISTRIBUTION_STATUS_COLORS] = array(
2320
      '#type' => 'textarea',
2321
      '#title' => t('Custom status colors'),
2322
      '#element_validate' => array('form_element_validate_json'),
2323
      '#default_value' => variable_get(DISTRIBUTION_STATUS_COLORS, ''),
2324
      '#description' => t('<strong>EXPERIMENTAL!</strong><br/>This may be changed in the next release without notification.
2325
          A json map object with StatusTerm.idInVocabulary as key and a hex color as value. e.g: <code>{"n":"#ff0000","p":"#00ff00"}</code>.
2326
          reference list of the idInVocabulary values of absence and presence terms:
2327
<pre>
2328
Presence Term
2329
p        present
2330
pd        present: doubtfully present
2331
n        native
2332
nq        native: presence questionable
2333
nd        native: doubtfully native
2334
c        cultivated
2335
i        introduced
2336
iq        introduced: presence questionable
2337
id        introduced: doubtfully introduced (perhaps cultivated only)
2338
ip        introduced: uncertain degree of naturalisation
2339
ia        introduced: adventitious (casual)
2340
in        introduced: naturalized
2341
ic        introduced: cultivated
2342
e        endemic for the relevant area
2343
na        naturalised
2344
iv        invasive
2345

2346
AbsenceTerm
2347
a        absent
2348
f        reported in error
2349
nf        native: reported in error
2350
if        introduced: reported in error
2351
cf        cultivated: reported in error
2352
ne        native: formerly native
2353
ie        introduced: formerly introduced
2354

2355
</pre>'),
2356
  );
2357

    
2358

    
2359
  /* ====== SYNONYMY ====== */
2360
  $form['taxon_synonymy'] = array(
2361
    '#type' => 'fieldset',
2362
    '#title' => t('Taxon synonymy (tab)'),
2363
    '#collapsible' => TRUE,
2364
    '#collapsed' => TRUE,
2365
    '#description' => t('This section covers the settings related to the taxon
2366
      <strong>synonymy</strong> tab.'),
2367
  );
2368

    
2369
  $form['taxon_synonymy']['cdm_dataportal_nomref_in_title'] = array(
2370
    '#type' => 'checkbox',
2371
    '#title' => t('Show accepted taxon on top of the synonymy'),
2372
    '#default_value' => variable_get('cdm_dataportal_nomref_in_title', CDM_DATAPORTAL_NOMREF_IN_TITLE),
2373
    '#description' => t('If checked, the first homotypic taxon is a repetition
2374
      of the accepted taxon most likely with the full nomenclatural reference
2375
      (depending on the currently chosen theme).'),
2376
  );
2377

    
2378
  $form['taxon_synonymy']['cdm_dataportal_display_is_accepted_for'] = array(
2379
    '#type' => 'checkbox',
2380
    '#title' => t('Display <em>is accepted for ...</em> on taxon pages when
2381
      coming from a synonym link.'),
2382
    '#default_value' => variable_get('cdm_dataportal_display_is_accepted_for', CDM_DATAPORTAL_DISPLAY_IS_ACCEPTED_FOR),
2383
    '#description' => t('Check this if after doing a search and clicking on a
2384
      synonym you want to see the "accept of" text for the accepted synonym.'),
2385
  );
2386

    
2387
  /* === currently unused ===
2388
  $nameRelationshipTypeOptions = cdm_vocabulary_as_option(UUID_NAME_RELATIONSHIP_TYPE);
2389
  $form['taxon_synonymy']['name_relationships']['name_relationships_to_show'] = array(
2390
    '#type' => 'checkboxes',
2391
    '#title' => t('Display name relationships') . ':',
2392
    '#default_value' => variable_get('name_relationships_to_show', 0),
2393
    '#options' => $nameRelationshipTypeOptions,
2394
    '#description' => t('Select the name relationships you want to show for the
2395
      accepted taxa.'),
2396
  );
2397
 */
2398

    
2399
  $form['taxon_synonymy']['taxon_relations'] = array(
2400
    '#type' => 'fieldset',
2401
    '#title' => t('Taxon relationships'),
2402
    '#collapsible' => FALSE,
2403
    '#collapsed' => FALSE
2404
  );
2405

    
2406
  $form['taxon_synonymy']['taxon_relations'][CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS] = array(
2407
    '#type' => 'checkbox',
2408
    '#title' => t('Show taxon relations ships of accepted taxon'),
2409
    '#default_value' => variable_get(CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS, CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT),
2410
    '#description' => t('If this option is enabled the synonymy will show the
2411
      below selected taxon relationships of accepted taxa.'),
2412
  );
2413

    
2414
  $taxonRelationshipTypeOptions = cdm_vocabulary_as_option(UUID_TAXON_RELATIONSHIP_TYPE, '_cdm_relationship_type_term_label_callback');
2415
  $form['taxon_synonymy']['taxon_relations'][CDM_TAXON_RELATIONSHIP_TYPES] = array(
2416
    '#type' => 'checkboxes',
2417
    '#title' => t('Taxon relationship types') . ':',
2418
    '#description' => t('Only taxon relationships of the selected type will be
2419
      displayed'),
2420
    '#options' => $taxonRelationshipTypeOptions,
2421
    '#default_value' => variable_get(CDM_TAXON_RELATIONSHIP_TYPES, unserialize(CDM_TAXON_RELATIONSHIP_TYPES_DEFAULT)),
2422
    '#disabled' => !variable_get(CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS, CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT),
2423
  );
2424

    
2425
  $form['taxon_synonymy']['name_relations'] = array(
2426
    '#type' => 'fieldset',
2427
    '#title' => t('Name relationships'),
2428
    '#collapsible' => FALSE,
2429
    '#collapsed' => FALSE
2430
  );
2431

    
2432
  $taxonRelationshipTypeOptions = cdm_vocabulary_as_option(UUID_NAME_RELATIONSHIP_TYPE, '_cdm_relationship_type_term_label_callback');
2433
  $form['taxon_synonymy']['name_relations'][CDM_NAME_RELATIONSHIP_TYPES] = array(
2434
    '#type' => 'checkboxes',
2435
    '#title' => t('Name relationship types') . ':',
2436
    '#description' => t('Only name relationships of the selected type will be
2437
      displayed'),
2438
    '#options' => $taxonRelationshipTypeOptions,
2439
    '#default_value' => variable_get(CDM_NAME_RELATIONSHIP_TYPES, unserialize(CDM_NAME_RELATIONSHIP_TYPES_DEFAULT)),
2440
  );
2441

    
2442
  // ====== SPECIMENS ====== //
2443
  $form['taxon_specimens'] = array(
2444
    '#type' => 'fieldset',
2445
    '#title' => t('Taxon specimens (tab)'),
2446
    '#collapsible' => TRUE,
2447
    '#collapsed' => TRUE,
2448
    '#description' => t('This section covers the settings related to the taxon
2449
      <strong>specimens</strong> tab.'),
2450
  );
2451

    
2452
  $form['taxon_specimens'][SPECIMEN_MAP_VISIBILITY]  = _cdm_map_visibility_setting('specimen');
2453

    
2454
  $form['taxon_specimens']['cdm_dataportal_compressed_specimen_derivate_table'] = array(
2455
    '#type' => 'checkbox',
2456
    '#title' => t('Show specimen derivatives in a compressed table'),
2457
    '#default_value' => variable_get('cdm_dataportal_compressed_specimen_derivate_table', CDM_DATAPORTAL_COMPRESSED_SPECIMEN_DERIVATE_TABLE),
2458
    '#description' => t('If checked, the specimen will be listed in a table. Every row represents
2459
    a collection and it can be expanded to get an overview of the specimens and their derivates.'),
2460
  );
2461

    
2462
  $form['taxon_specimens']['cdm_dataportal_compressed_specimen_derivate_table_show_determined_as'] = array(
2463
    '#type' => 'checkbox',
2464
    '#title' => t('Show "Associated with" in specimen table.'),
2465
    '#default_value' => variable_get('cdm_dataportal_compressed_specimen_derivate_table_show_determined_as', CDM_DATAPORTAL_COMPRESSED_SPECIMEN_DERIVATE_TABLE_SHOW_DETERMINED_AS)
2466
  );
2467

    
2468
  $featureTrees = cdm_get_featureTrees_as_options(TRUE);
2469
  $profile_feature_tree_uuid = variable_get(CDM_OCCURRENCE_FEATURETREE_UUID, UUID_DEFAULT_FEATURETREE);
2470
  if(!isset($featureTrees['options'][$profile_feature_tree_uuid])) {
2471
    $profile_feature_tree_uuid = UUID_DEFAULT_FEATURETREE;
2472
  }
2473
  $form['taxon_specimens']['feature_trees'][CDM_OCCURRENCE_FEATURETREE_UUID] = array(
2474
    '#type' => 'radios',
2475
    '#title' => t('Specimen description feature tree') . ':',
2476
    '#default_value' => $profile_feature_tree_uuid,
2477
    '#options' =>  $featureTrees['options'],
2478
    '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
2479
    '#options_suffixes' => $featureTrees['treeRepresentations'],
2480
    '#description' => t('Select the feature tree to be used for displaying specimen descriptions. Click "Show Details" to see the Feature Tree elements.'
2481
    ),
2482
  );
2483

    
2484
  $form_name = CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME;
2485
  $form_title = t('Specimen media');
2486
  $form_description = t('Specimens may have media which is displayed at the
2487
     Specimen tab/section as a gallery. It is possible to configure the
2488
     thumbnails gallery here, however for configuring how a single media should
2489
     be displayed please go to !url.</p>',
2490
     array(
2491
       '!url' => l(t('Layout -> Media'), 'admin/config/cdm_dataportal/settings/layout/media'),
2492
     ));
2493
  $form['taxon_specimens'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, FALSE, $form_description);
2494

    
2495
  // --- MEDIA GALLERY ---- //
2496
  $form_name = CDM_DATAPORTAL_TAXON_MEDIA_GALLERY_NAME_TAB;
2497
  $form_title = 'Media gallery (tab)';
2498
  $form_description = '<p>This section covers the settings related to the taxon <strong>images</strong> tab.
2499
   Taxa may have media (usually images) and they are displayed as thumbnails. It is possible to configure
2500
   the thumbnails gallery here, however for configuring how a single media should be displayed please go to
2501
   <a href="./?q=admin/settings/cdm_dataportal/layout/media">Layout -&gt; Media</a></p>
2502
   <p><strong>Note:</strong> These settings are only taken into account when the standard
2503
   gallery viewer is selected at <a href="./?q=admin/settings/cdm_dataportal/layout/media">Layout -&gt; Media</a>.</p>';
2504
  $form['taxon_media'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, TRUE, $form_description);
2505

    
2506
  // Comment @WA: D7 form api does not support reset buttons,
2507
  // so to mimic the D5 reset button we add one like this.
2508
  $form['actions']['reset'] = array(
2509
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
2510
    '#weight' => 1000,
2511
  );
2512
  return system_settings_form($form);
2513
}
2514

    
2515
/**
2516
 * Creates a form element for the constants DISTRIBUTION_MAP_VISIBILITY, SPECIMEN_MAP_VISIBILITY.
2517
 *
2518
 * @param $map_id
2519
 * @param $form
2520
 * @return mixed
2521
 */
2522
function _cdm_map_visibility_setting($map_id)
2523
{
2524
  return array(
2525
    '#type' => 'select',
2526
    '#title' => t(ucfirst($map_id) . ' map visibility'),
2527
    '#default_value' => variable_get(constant(strtoupper($map_id) . '_MAP_VISIBILITY'), constant(strtoupper($map_id) . '_MAP_VISIBILITY_DEFAULT')),
2528
    '#options' => array('always' => 'always', 'automatic' => 'automatic', 'never' => 'never'),
2529
    '#description' => "The visibility of the map can managed <b>automatically</b> depending on whether there is data to show or not. 
2530
        The map also can forced to show up <b>always</b> or <b>never</b>."
2531
  );
2532
}
2533

    
2534
/**
2535
 * @todo document this function.
2536
 */
2537
function cdm_settings_layout_search() {
2538

    
2539
  $form = array();
2540

    
2541
  $form['#submit'][] = 'cdm_settings_layout_search_submit';
2542

    
2543
  $form['search_settings'] = array(
2544
    '#type' => 'fieldset',
2545
    '#title' => t('Taxa Search'),
2546
    '#collapsible' => FALSE,
2547
    '#collapsed' => FALSE,
2548
    '#description' => t('<p>The data portal allows the users to perform searchs.</p><p>To perform searchs
2549
         the block <em>CDM Taxon Search</em> should be enabled and visible for users
2550
         where they can write the text to be searched. You can find Drupal block configuration
2551
         site at <a href="./?q=admin/build/block">Administer&#45&#62Site building&#45&#62Blocks</a></p> '),
2552
  );
2553

    
2554
  $form['search_settings'][SIMPLE_SEARCH_IGNORE_CLASSIFICATION] = array(
2555
      '#type' => 'checkbox',
2556
      '#title' => t('Ignore the chosen classification in simple search'),
2557
      '#default_value' => variable_get(SIMPLE_SEARCH_IGNORE_CLASSIFICATION, 0),
2558
      '#description' => t('The simple search, which can be executed via the search block,
2559
          will by default search on the classification selected in the classification browser
2560
          selector. Set the tick if you want your portal to search on all classifications.'),
2561
  );
2562

    
2563
  $form['search_settings'][SIMPLE_SEARCH_USE_LUCENE_BACKEND] = array(
2564
    '#type' => 'checkbox',
2565
    '#title' => t('Run simple search with free-text search backend.'),
2566
    '#default_value' => variable_get(SIMPLE_SEARCH_USE_LUCENE_BACKEND, 0),
2567
    '#description' => t('The simple search uses by default another search
2568
      backend as the advances search. By checking this option the simple search can be
2569
      configured to also use the free-text search backend.'),
2570
  );
2571

    
2572
  $form['search_settings']['cdm_dataportal_search_items_on_page'] = array(
2573
    '#type' => 'textfield',
2574
    '#title' => t('Results per page') . ':',
2575
    '#default_value' => variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE),
2576
    '#description' => t('Number of results to display per page.'),
2577
  );
2578

    
2579
  $form['search_settings'][SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX] = array(
2580
    '#type' => 'checkbox',
2581
    '#title' => t('Show the <i>Show Image Thumbnails</i> button') . ':',
2582
    '#default_value' => variable_get(SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX, SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX_DEFAULT),
2583
    '#description' => t('The search results page will offer a button to toggle the display of image thumbnails.'),
2584
  );
2585

    
2586
  $search_mode_default = get_array_variable_merged(CDM_SEARCH_TAXA_MODE, CDM_SEARCH_TAXA_MODE_DEFAULT);
2587
  $form['search_settings']['cdm_search_taxa_mode'] = array(
2588
      '#type' => 'checkboxes',
2589
      '#title' => 'Search mode',
2590
      '#description' => 'The taxon search can operate in different modes in order to find only taxa, synonyms,
2591
          taxa by its common name and even taxa which have been used as misappied names. The settings made here will affect the default
2592
          for the advance search form and the behaviour of the simple search form which always will behave according to the
2593
          defaults set here.',
2594
      '#options' => drupal_map_assoc(array_keys(unserialize(CDM_SEARCH_TAXA_MODE_DEFAULT))),
2595
      '#default_value' => $search_mode_default
2596
      );
2597

    
2598
  $form['search_settings'][CDM_SEARCH_AREA_FILTER_PRESET] = array(
2599
    '#type' => 'textarea',
2600
    '#title' => t('area_filter_preset') . ':',
2601
    '#default_value' => variable_get(CDM_SEARCH_AREA_FILTER_PRESET, ''), // '05b0dd06-30f8-477d-bf4c-30d9def56320' =>  Caucasia (Ab + Ar + Gg + Rf(CS)) (Cc)
2602

    
2603
    '#description' => t('Area uuids, comma separated, no whitespace. EXPERIMENTAL!!!!'),
2604
  );
2605

    
2606
  // --- SEARCH TAXA GALLERY ---- //
2607
  $items = variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE);
2608
  $collapsed = FALSE;
2609
  $form_name = CDM_DATAPORTAL_SEARCH_GALLERY_NAME;
2610
  $form_title = 'Taxa Search thumbnails';
2611
  $form_description = 'Search results may show thumbnails. ';
2612
  $form[] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description);
2613

    
2614
  // Comment @WA: D7 form api does not support reset buttons,
2615
  // so to mimic the D5 reset button we add one like this.
2616
  $form['actions']['reset'] = array(
2617
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
2618
    '#weight' => 1000,
2619
  );
2620
  return system_settings_form($form);
2621
}
2622

    
2623
/**
2624
 * @todo document this function.
2625
 */
2626
function cdm_settings_layout_media() {
2627

    
2628
  $form = array();
2629

    
2630
  $form['media_settings'] = array(
2631
    '#type' => 'fieldset',
2632
    '#title' => t('Media settings'),
2633
    '#collapsible' => FALSE,
2634
    '#collapsed' => FALSE,
2635
    '#description' => 'This section covers layout settings for media pages.'
2636
      . 'Further media related settings may be found under the taxon layout settings and on the general settings.',
2637
  );
2638

    
2639
  $form['media_settings']['image_gallery_viewer'] = array(
2640
    '#type' => 'select',
2641
    '#title' => t('Image viewer') . ':',
2642
    '#default_value' => variable_get('image_gallery_viewer', 'default'),
2643
    '#options' => array(
2644
      'default' => t('Standard image viewer'),
2645
      'fsi' => t('FSI viewer (requires FSI server!)'),
2646
    ),
2647
  );
2648

    
2649
  // --- MEDIA GALLERY ---- //
2650
  $form_name = CDM_DATAPORTAL_MEDIA_GALLERY_NAME;
2651
  $form_title = 'Standard viewer';
2652
  $form_description = '<p>Configure the standard image viewer.</p><p><strong>Note:</strong> the image viewer should selected otherwise settings are not taking into account.</p>';
2653
  // $form[] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed);
2654
  $form['media_settings'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, FALSE, $form_description);
2655

    
2656
  // @WA: D7 form api does not support reset buttons,
2657
  // so to mimic the D5 reset button we add one like this.
2658
  $form['actions']['reset'] = array(
2659
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
2660
    '#weight' => 1000,
2661
  );
2662
  return system_settings_form($form);
2663
}
2664

    
2665
/**
2666
 * GEOSERVICE and Map settings.
2667
 */
2668
function cdm_settings_geo($form, &$form_state) {
2669

    
2670
  $current_geoserver_settings = get_edit_map_service_settings();
2671
  $map_distribution = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
2672

    
2673

    
2674
  $form = array();
2675

    
2676
  $dummy_distribution_query = NULL;
2677
  if($map_distribution['map_type'] != 1){
2678
    // we need to apply a dummy query since the map service requires for image maps
2679
    // at least as and ad to be defined
2680
    $dummy_distribution_query = "as=a:339966&ad=tdwg1:a:1,2,3,4,5,6,7,8,9";
2681
  }
2682

    
2683
  $form['map_preview'] = array(
2684
      '#type' => 'fieldset',
2685
      '#tree' => FALSE,
2686
      '#title' => t('Map preview'),
2687
      '#collapsible' => FALSE,
2688
      '#description' => 'The preview of the map'
2689
       . ($dummy_distribution_query != null ?
2690
           ' may not be accurate in case of image maps, please check the map display in the taxon pages.':
2691
           '.<br/>Hold down Strg and drag with your mouse to select a bbox to zoom to. <br/>The bbox of the visible area of the map is always displayed below the map.')
2692
  );
2693
  $form['map_preview']['openlayers_map'] = compose_map('settings-preview', NULL, $dummy_distribution_query, NULL, array(
2694
    'move' => "this.cdmOpenlayersMap.printInfo",
2695
    '#execute' => "this.cdmOpenlayersMap.printInfo"
2696
  ), true // resizable
2697
  );
2698

    
2699
  /*
2700
  $form['map_preview']['map'] = compose_map(NULL, $dummy_distribution_query, NULL, array(), 0 // force image map
2701
  );
2702
  */
2703

    
2704
  /*
2705
   * GEO SERVER
2706
   */
2707
  $form['edit_map_server'] = array(
2708
    '#type' => 'fieldset',
2709
    '#tree' => true,
2710
    '#title' => t('EDIT map service'),
2711
    '#collapsible' => TRUE,
2712
    '#collapsed' => TRUE,
2713
    '#description' => t('Configuration and selection of your geo server.
2714
      The Geo Server is responsible for generating the maps.'),
2715
  );
2716

    
2717
  $form['edit_map_server']['base_uri'] = array(
2718
    '#type' => 'select',
2719
    '#title' => t('EDIT map service') . ':',
2720
    '#default_value' => $current_geoserver_settings['base_uri'],
2721
    '#options' => unserialize(EDIT_MAPSERVER_URI),
2722
    '#description' => t('Select the EDIT map server you want to use within your data portal.'),
2723
  );
2724
  $form['edit_map_server']['version'] = array(
2725
      '#type' => 'select',
2726
      '#title' => t('Version') . ':',
2727
      '#default_value' => $current_geoserver_settings['version'],
2728
      '#options' => unserialize(EDIT_MAPSERVER_VERSION),
2729
      '#description' => t('The version of the EDIT map services'),
2730
  );
2731

    
2732
  /*
2733
   * MAP SETTINGS
2734
   */
2735

    
2736
  $form[CDM_MAP_DISTRIBUTION] = array(
2737
    '#type' => 'fieldset',
2738
    '#tree' => TRUE,
2739
    '#title' => t('Maps settings'),
2740
    '#collapsible' => TRUE,
2741
    '#collapsed' => TRUE,
2742
    '#description' => t('General configuration for all map types.'),
2743
  );
2744

    
2745
  $form[CDM_MAP_DISTRIBUTION]['map_type'] = array(
2746
    '#type' => 'radios',
2747
    '#title' => 'Map types',
2748
    '#options' => array(
2749
      1 => "OpenLayers dynamic map viewer",
2750
      0 => "Plain image",
2751
    ),
2752
    '#default_value' => $map_distribution['map_type'],
2753
    '#description' => 'Two different map types are available :
2754
      <ul><li><em>OpenLayers</em>: Display the maps in an interactive viewer
2755
      which allows zooming and panning. If enabled you can configure the default layer
2756
      (background of your maps) below.</li>
2757
      <li><em>Plain image</em>: The map will be static non interactive
2758
      image.</li></ul>',
2759
  );
2760
  $open_layers_is_enabled = $map_distribution['map_type'] == 1;
2761

    
2762
  /*
2763
   * settings for the distribution map are used also for specimens map!!!!
2764
   */
2765

    
2766
  $form[CDM_MAP_DISTRIBUTION]['aspect_ratio'] = array(
2767
      '#type' => 'textfield',
2768
      '#title' => 'Aspect ratio',
2769
      '#default_value' => $map_distribution['aspect_ratio'],
2770
      '#maxlength' => 4,
2771
      '#size' => 4,
2772
      '#element_validate' => array('element_validate_number'),
2773
      '#description' => 'The ratio of width to height of the map. Instead of expressing the aspect ratio as usually as
2774
      two numbers separated by a colon (x:y), this field requires a the value which is the result of the division of the
2775
      width by the height:</br>
2776
      <pre>aspect ratio = w / h</pre>
2777
      For a landscape oriented map with an aspect ratio of 2:1 use <strong>2</strong> as value,</br>
2778
      for a square map use <strong>1</strong>.',
2779
  );
2780

    
2781
  $form[CDM_MAP_DISTRIBUTION]['bbox'] = array(
2782
    '#type' => 'textfield',
2783
    '#title' => 'Bounding box',
2784
    '#default_value' => $map_distribution['bbox'],
2785
    '#description' => t('The bounding box (left, bottom, right, top) in degree defines the area to be initially displayed in maps.
2786
      Use "-180,-90,180,90" for the whole world. Leave <strong>empty</strong>
2787
      to let the map <strong>automatically zoom</strong> to the bounds enclosing the shown data.</p>
2788
      <strong>TIP:</strong> You can use the map preview above to choose the <span class="map-extent-bbox"><strong>map extent bbox</strong> in <strong class="degree-value"">degree</strong></span> from the map.
2789
      (Maybe you need to change the map base layer to OpeLayers.)
2790
      Hold down Strg and drag with your mouse to select a bbox to zoom to. The bbox of the visible area of the map is always displayed
2791
      below the map from where you can copy the bbox string.</p>'),
2792
  );
2793

    
2794
  $form[CDM_MAP_DISTRIBUTION]['show_labels'] = array(
2795
    '#type' => 'checkbox',
2796
    '#title' => 'Display area labels',
2797
    '#default_value' => $map_distribution['show_labels'],
2798
    '#description' => t('The map will show name labels of the areas'),
2799
  );
2800

    
2801
  $form[CDM_MAP_DISTRIBUTION]['caption'] = array(
2802
    '#type' => 'textfield',
2803
    '#title' => 'Map caption',
2804
    '#default_value' => $map_distribution['caption'],
2805
    '#description' => t('The caption will be shown below the map.'),
2806
  );
2807

    
2808
  $form[CDM_MAP_DISTRIBUTION]['distribution_opacity'] = array(
2809
    '#type' => 'textfield',
2810
    '#title' => 'Distribution layer opacity',
2811
    '#default_value' => $map_distribution['distribution_opacity'],
2812
    '#description' => t('Valid values range from 0.0 to 1.0. Value 1.0 means the distributions
2813
    (the countries or regions) will fully visible, while a value near to 0.0 will be not much visible.'),
2814
  );
2815

    
2816
  // --- Plain Image Settings --- //
2817
  $form[CDM_MAP_DISTRIBUTION]['image_map'] = array(
2818
    '#type' => 'fieldset',
2819
    '#title' => 'Plain image map settings',
2820
    '#tree' => TRUE,
2821
    '#collapsible' => TRUE,
2822
    '#collapsed' => $open_layers_is_enabled,
2823
    '#description' => 'The settings in this section are still expertimental
2824
      and can only be used with the EDIT map service version 1.1 or above.',
2825
  );
2826
  $edit_mapserver_version = get_edit_map_service_version_number();
2827
  if ($edit_mapserver_version < 1.1) {
2828
    $form[CDM_MAP_DISTRIBUTION]['image_map']['#description'] = '<div class="messages warning">'
2829
      . t("The chosen EDIT map service version (@edit-mapserver-version) is too low, it must be at least 1.1",
2830
        array('@edit_mapserver_version' => '$edit_mapserver_version')) . '</div>'
2831
      . $form[CDM_MAP_DISTRIBUTION]['image_map']['#description'];
2832
  }
2833

    
2834
  $form[CDM_MAP_DISTRIBUTION]['image_map']['width'] = array(
2835
    '#type' => 'textfield',
2836
    '#title' => 'Width',
2837
    '#default_value' => $map_distribution['image_map']['width'],
2838
    '#maxlength' => 4,
2839
    '#size' => 4,
2840
    '#description' => 'Width of the map. The height is calculated from the <strong>Aspect ratio</strong> set in the section above. ',
2841
  );
2842

    
2843
  $form[CDM_MAP_DISTRIBUTION]['image_map']['base_layer'] = array(
2844
    '#type' => 'textfield',
2845
    '#title' => 'Background layer',
2846
    '#default_value' => $map_distribution['image_map']['base_layer'],
2847
    '#description' => t('Background layer. For available layers inspect !url1 or !url2.', array(
2848
      '!url1' => l('deegree-csw', 'http://edit.africamuseum.be:8080/deegree-csw/md_search.jsp'),
2849
      '!url2' => l('geoserver layers', 'http://edit.africamuseum.be/geoserver/web/'),
2850
    )),
2851
  );
2852

    
2853
  $form[CDM_MAP_DISTRIBUTION]['image_map']['bg_color'] = array(
2854
    '#type' => 'textfield',
2855
    '#title' => 'Background color',
2856
    '#default_value' => $map_distribution['image_map']['bg_color'],
2857
  );
2858

    
2859
  $form[CDM_MAP_DISTRIBUTION]['image_map']['layer_style'] = array(
2860
    '#type' => 'textfield',
2861
    '#title' => 'Background layer style',
2862
     // Only line color by now.
2863
    '#default_value' => $map_distribution['image_map']['layer_style'],
2864
    '#description' => 'Syntax: {Area fill color},{Area stroke color},{Area stroke width},{Area stroke dash style}',
2865
  );
2866

    
2867
  $form[CDM_MAP_DISTRIBUTION]['image_map']['projection'] = array(
2868
      '#type' => 'textfield',
2869
      '#title' => 'Projection',
2870
      '#default_value' => drupal_array_get_nested_value($map_distribution, array('image_map', 'projection')),
2871
      '#description' => 'Spatial Reference System (SRS) identifier ) optional ( Defines projections in WMS GetMap request.
2872
        Using EPSG:4326 (WGS84 lat/long) is the default but can be changed
2873
        on-the-fly to different UTM and much more zone specific. Examples: EPSG:4326, EPSG:900913, EPSG:3857, EPSG:7777777',
2874
  );
2875

    
2876

    
2877
  // --- OpenLayers Settings --- //
2878
  $form[CDM_MAP_DISTRIBUTION]['openlayers'] = array(
2879
    '#type' => 'fieldset',
2880
    '#title' => 'OpenLayers settings',
2881
    '#tree' => TRUE,
2882
    '#collapsible' => TRUE,
2883
    '#collapsed' => !$open_layers_is_enabled,
2884
    '#description' => '',
2885
  );
2886

    
2887

    
2888
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['display_outside_max_extent'] = array(
2889
      '#type' => 'checkbox',
2890
      '#title' => 'Display outside max extent',
2891
      '#default_value' => $map_distribution['openlayers']['display_outside_max_extent'],
2892
      '#description' => t('Allows the map to display parts of the layers which are outside
2893
         the max extent if the aspect ratio of the map and of the baselayer
2894
         are not equal.'),
2895
  );
2896

    
2897

    
2898
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['show_layer_switcher'] = array(
2899
      '#type' => 'checkbox',
2900
      '#title' => 'Show Layer Switcher',
2901
      '#default_value' => $map_distribution['openlayers']['show_layer_switcher'],
2902
      '#description' => 'The Layer Switcher control displays a table of contents
2903
      for the map.  This allows the user interface to switch between
2904
      base layers and to show or hide overlays.  By default the switcher is
2905
      shown minimized on the right edge of the map, the user may expand it
2906
      by clicking on the handle.',
2907
  );
2908

    
2909
  if (!$open_layers_is_enabled) {
2910
    $form[CDM_MAP_DISTRIBUTION]['openlayers']['#description'] = '<div class="messages warning">'
2911
        . 'The Openlayers viewer is currently not enabled! (see section Maps settings above )</div>'
2912
        . $form[CDM_MAP_DISTRIBUTION]['openlayers']['#description'];
2913
  }
2914

    
2915
  // The default layer must always be enabled
2916
  $preferred_layer = $map_distribution['openlayers']['base_layers']['PREFERRED'];
2917
  $map_distribution['openlayers']['base_layers'][$preferred_layer] = $preferred_layer;
2918

    
2919
  $baselayer_options = array(
2920
    /*
2921
   NOTICE: must correspond to the layers defined in
2922
   js/openlayers_,ap.js#getLayersByName()
2923
   */
2924
    'osgeo_vmap0' => "Metacarta Vmap0 (OSGeo server) - instable!", // EPSG:4326: EPSG:900913
2925
    'metacarta_vmap0' => "Metacarta Vmap0 (MetaCarta Labs server)  - instable!", // EPSG:4326, EPSG:900913
2926
    'mapproxy_vmap0' => "Metacarta Vmap0 (OSGeo server) - via fast EDIT MapProxy",
2927
    'mapproxy_etopo1' => "ETOPO1 Global Relief Model - via fast EDIT MapProxy",
2928
    'edit-etopo1' => "ETOPO1 Global Relief Model",
2929
    // all others EPSG:900913
2930
    'mapnik' => 'OpenStreetMap',
2931
    'mapquest_open' => "MapQuest",
2932
    'mapquest_sat' => "MapQuest Sattelite",
2933
    'groadmap' => 'Google Roadmap',
2934
    'gsatellite' => 'Google Satellite',
2935
    'ghybrid' => 'Google Hybrid',
2936
    'gterrain' => 'Google Terrain',
2937
//     'veroad' => 'Virtual Earth Roads',
2938
//     'veaer' => 'Virtual Earth Aerial',
2939
//     'vehyb' => 'Virtual Earth Hybrid',
2940
    // 'yahoo' => 'Yahoo Street',
2941
    // 'yahoosat' => 'Yahoo Satellite',
2942
    // 'yahoohyb' => 'Yahoo Hybrid',
2943
     'custom_wms_base_layer_1' => 'Custom WMS base layer (needs to be manually configured below!)',
2944
  );
2945

    
2946
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['base_layers'] = array(
2947
    '#type' => 'checkboxes_preferred',
2948
    '#title' => 'Base Layers',
2949
    '#options' => $baselayer_options,
2950
    '#default_value' =>  $map_distribution['openlayers']['base_layers'],
2951
    '#description' => 'Choose the baselayer layer you prefer to use as map background in the OpenLayers dynamic mapviewer.',
2952
  );
2953

    
2954
  $google_maps_api_key = null;
2955
  if(isset($map_distribution['openlayers']['google_maps_api_key'])){
2956
    $google_maps_api_key = $map_distribution['openlayers']['google_maps_api_key'];
2957
  }
2958
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['google_maps_api_key'] = array(
2959
    '#type' => 'textfield',
2960
    '#title' => 'Google Maps API Key',
2961
    '#default_value' => $google_maps_api_key,
2962
    '#description' => 'In order to use any of the Google map layers you need to provide 
2963
        your <a href="https://developers.google.com/maps/documentation/javascript/get-api-key">Google Maps API Key</a>. ',
2964
  );
2965

    
2966
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer'] = array(
2967
      '#type' => 'fieldset',
2968
      '#title' => 'Custom WMS base layer',
2969
      '#tree' => TRUE,
2970
      '#collapsible' => FALSE,
2971
      '#collapsed' => FALSE,
2972
      '#description' => 'Here you an define a custom wms layer as additional base layer.',
2973
  );
2974

    
2975
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['name'] = array(
2976
      '#type' => 'textfield',
2977
      '#title' => 'Layer name',
2978
      // Only line color by now.
2979
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['name'],
2980
      '#description' => 'A arbitrary name for the layer.',
2981
  );
2982
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['url'] = array(
2983
      '#type' => 'textfield',
2984
      '#title' => 'WMS url',
2985
      // Only line color by now.
2986
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['url'],
2987
      '#description' => 'Base url for the WMS (e.g.  http://edit.africamuseum.be/geoserver/topp/wms, http://wms.jpl.nasa.gov/wms.cgi)'
2988
  );
2989
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['params'] = array(
2990
      '#type' => 'textarea',
2991
      '#title' => 'WMS parameters',
2992
      '#element_validate' => array('form_element_validate_json'),
2993
      // Only line color by now.
2994
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['params'],
2995
      '#description' => 'An javasript object with key/value pairs representing the GetMap query string parameters and parameter values, entered in valid JSON. For example:
2996
<pre> {
2997
  "Layers": "topp:em_tiny_jan2003",
2998
  "Format": "image/png",
2999
  "BGCOLOR": "0xe0faff"
3000
}
3001
</pre>'
3002
  );
3003
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['projection'] = array(
3004
      '#type' => 'textfield',
3005
      '#title' => 'Projection',
3006
      // Only line color by now.
3007
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['projection'],
3008
      '#description' => 'The desired projection for the layer (e.g. EPSG:4326, EPSG:900913, EPSG:3857)'
3009
  );
3010
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['proj4js_def'] = array(
3011
      '#type' => 'textfield',
3012
      '#maxlength' => 256,
3013
      '#title' => 'proj4js definition',
3014
      // Only line color by now.
3015
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['proj4js_def'],
3016
      '#description' => 'The <a href="http://trac.osgeo.org/openlayers/wiki/Documentation/Dev/proj4js">proj4js definition</a> for the projection named above.
3017
            The definitions for
3018
            EPSG:102067, EPSG:102757, EPSG:102758, EPSG:21781, EPSG:26591, EPSG:26912, EPSG:27200, EPSG:27563, EPSG:3857,
3019
            EPSG:41001, EPSG:4139, EPSG:4181, EPSG:42304, EPSG:4272, EPSG:4302, EPSG:900913
3020
            are already predefined and must be added here again.  If your dont know the defintion of your desired projection,
3021
            go to  <a href="http://spatialreference.org/">http://spatialreference.org/</a>, search for your projection and
3022
            choose to display the proj4js definition string.
3023
            <h5>Quick Reference on the commion proj4js definition parameters:</h5>
3024
            <pre>
3025
+a         Semimajor radius of the ellipsoid axis
3026
+alpha     ? Used with Oblique Mercator and possibly a few others
3027
+axis      Axis orientation (new in 4.8.0)
3028
+b         Semiminor radius of the ellipsoid axis
3029
+datum     Datum name (see `proj -ld`)
3030
+ellps     Ellipsoid name (see `proj -le`)
3031
+k         Scaling factor (old name)
3032
+k_0       Scaling factor (new name)
3033
+lat_0     Latitude of origin
3034
+lat_1     Latitude of first standard parallel
3035
+lat_2     Latitude of second standard parallel
3036
+lat_ts    Latitude of true scale
3037
+lon_0     Central meridian
3038
+lonc      ? Longitude used with Oblique Mercator and possibly a few others
3039
+lon_wrap  Center longitude to use for wrapping (see below)
3040
+nadgrids  Filename of NTv2 grid file to use for datum transforms (see below)
3041
+no_defs   Don\'t use the /usr/share/proj/proj_def.dat defaults file
3042
+over      Allow longitude output outside -180 to 180 range, disables wrapping (see below)
3043
+pm        Alternate prime meridian (typically a city name, see below)
3044
+proj      Projection name (see `proj -l`)
3045
+south     Denotes southern hemisphere UTM zone
3046
+to_meter  Multiplier to convert map units to 1.0m
3047
+towgs84   3 or 7 term datum transform parameters (see below)
3048
+units     meters, US survey feet, etc.
3049
+vto_meter vertical conversion to meters.
3050
+vunits    vertical units.
3051
+x_0       False easting
3052
+y_0       False northing
3053
+zone      UTM zone
3054
            </pre>
3055
          For the full reference please refer to <a href="http://trac.osgeo.org/proj/wiki/GenParms">http://trac.osgeo.org/proj/wiki/GenParms</a>.'
3056
  );
3057
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['max_extent'] = array(
3058
      '#type' => 'textfield',
3059
      '#title' => 'Maximum extent',
3060
      // Only line color by now.
3061
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['max_extent'],
3062
      '#description' => 'The maximum extent of the map as bounding box (left, bottom, right, top) in the units of the map.'
3063
  );
3064
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['units'] = array(
3065
      '#type' => 'textfield',
3066
      '#title' => 'Units',
3067
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['units'],
3068
      '#description' => 'The layer map units.  Defaults to null.  Possible values are ‘degrees’ (or ‘dd’), ‘m’, ‘ft’, ‘km’, ‘mi’, ‘inches’.  Normally taken from the projection.  Only required if both map and layers do not define a projection, or if they define a projection which does not define units.'
3069
  );
3070

    
3071
  /*
3072
   * Map Legend
3073
   */
3074
  $form[CDM_MAP_DISTRIBUTION]['legend'] = array(
3075
    '#type' => 'fieldset',
3076
    '#title' => 'Map legend',
3077
    '#tree' => TRUE,
3078
    '#collapsible' => TRUE,
3079
    '#collapsed' => TRUE,
3080
    '#description' => 'Configure the maps legend.',
3081
  );
3082

    
3083
  $form[CDM_MAP_DISTRIBUTION]['legend']['show'] = array(
3084
    '#type' => 'checkbox',
3085
    '#title' => 'Display a map legend',
3086
    '#default_value' => $map_distribution['legend']['show'],
3087
    '#description' => 'Check this if you like a legend to be displayed with the maps.',
3088
  );
3089

    
3090
  $form[CDM_MAP_DISTRIBUTION]['legend']['opacity'] = array(
3091
    '#type' => 'textfield',
3092
    '#title' => 'Legend opacity',
3093
    '#default_value' => $map_distribution['legend']['opacity'],
3094
    '#description' => 'Valid values range from 0.0 to 1.0. Value 1.0 means the legend will be fully visible, while a value near
3095
                         to 0.0 will be not much visible.',
3096
  );
3097

    
3098
  $form[CDM_MAP_DISTRIBUTION]['legend']['font_size'] = array(
3099
    '#type' => 'textfield',
3100
    '#title' => 'Font size',
3101
    '#default_value' => $map_distribution['legend']['font_size'],
3102
    '#description' => 'Font size in pixels.',
3103
  );
3104

    
3105
  $fontStyles = array(
3106
    0 => "plane",
3107
    1 => "italic",
3108
  );
3109
  $form[CDM_MAP_DISTRIBUTION]['legend']['font_style'] = array(
3110
    '#type' => 'select',
3111
    '#title' => 'Available font styles',
3112
    '#default_value' => $map_distribution['legend']['font_style'],
3113
    '#options' => $fontStyles,
3114
    '#description' => 'Select a font style for the map legend.',
3115
  );
3116

    
3117
  $form[CDM_MAP_DISTRIBUTION]['legend']['icon_width'] = array(
3118
    '#type' => 'textfield',
3119
    '#title' => 'Icon width',
3120
    '#default_value' => $map_distribution['legend']['icon_width'],
3121
    '#description' => 'Legend icon width in pixels.',
3122
  );
3123
  $form[CDM_MAP_DISTRIBUTION]['legend']['icon_height'] = array(
3124
    '#type' => 'textfield',
3125
    '#title' => 'Icon height',
3126
    '#default_value' => $map_distribution['legend']['icon_height'],
3127
    '#description' => 'Legend icon height in pixels.',
3128
  );
3129

    
3130
  // @WA: D7 form api does not support reset buttons,
3131
  // so to mimic the D5 reset button we add one like this.
3132
  $form['actions']['reset'] = array(
3133
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
3134
    '#weight' => 1000,
3135
  );
3136

    
3137
  return system_settings_form($form);
3138
}
3139

    
3140

    
3141
/**
3142
 * @todo document this function.
3143
 */
3144
function cdm_settings_cache() {
3145

    
3146
  $form = array();
3147

    
3148
  $form['cache_settings'] = array(
3149
    '#type' => 'fieldset',
3150
    '#title' => t('Cache Settings'),
3151
    '#collapsible' => FALSE,
3152
    '#collapsed' => FALSE,
3153
    '#description' => t('<p>When caching is enabled all single taxon sites are
3154
      stored in an internal drupal cache doing the portal response of taxa pages
3155
      faster. This is possible because the sites are loaded from the cache and
3156
      are not created from scratch.</p>'),
3157
  );
3158

    
3159
  $form['cache_settings']['cdm_webservice_cache'] = array(
3160
    '#type' => 'checkbox',
3161
    '#title' => t('<strong>Enable caching</strong>'),
3162
    '#options' => cdm_help_general_cache(),
3163
    '#default_value' => variable_get('cdm_webservice_cache', 1),
3164
    '#description' => t('<p>Enable drupal to load taxa pages from the cache.</p>
3165
       <p><strong>Note:</strong> If taxa are modified by the editor or any other
3166
       application the changes will be not visible till the cache is erased.
3167
       Therefore developers should deactived this feature when they are working
3168
       on the CDM Dataportal Module.</p>'),
3169
  );
3170

    
3171
  $form['cache_settings']['cdm_run_cache'] = array(
3172
    '#markup' => cdm_view_cache_site(),
3173
  );
3174

    
3175
  // @WA: D7 form api does not support reset buttons,
3176
  // so to mimic the D5 reset button we add one like this.
3177
  $form['actions']['reset'] = array(
3178
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
3179
    '#weight' => 1000,
3180
  );
3181
  return system_settings_form($form);
3182
}
3183

    
3184
/**
3185
 * Walk and cache all taxon pages.
3186
 */
3187
function cdm_view_cache_site() {
3188

    
3189
  $out = '';
3190

    
3191
  drupal_add_js(drupal_get_path('module', 'cdm_dataportal') . '/js/cache_all_taxa.js');
3192

    
3193
  $request_params = array();
3194
  $request_params['class'] = "Taxon";
3195

    
3196
  $cdm_ws_page_taxa_url = cdm_compose_url(CDM_WS_TAXON . ".json", NULL, queryString($request_params));
3197
  $cdm_ws_page_taxa_url = uri_uriByProxy($cdm_ws_page_taxa_url);
3198
  $cdm_ws_page_taxa_url = rtrim($cdm_ws_page_taxa_url, '/');
3199

    
3200
  $out .= t('<p><strong>Cache all taxon pages</strong></p>');
3201
  $out .= '<p>When you launch the cache process the cache is filled and ready to be enabled.<br/>
3202
  Remember that when you load the taxa from the cache last changes on taxa will be not visible till you erase
3203
  the cache and fill it again.</p>';
3204
  $out .= '<p>Before  running the cache bot you have to empty the cache manually.</p>';
3205

    
3206
  $out .= '<div>' . t('This caching process may take long time and could cause heavy load on your server') . '</div>';
3207
  $out .= '<div id="progress"></div>';
3208

    
3209
  // Comment @WA: A form within a form is not valid html and not needed here.
3210
  // Also, it would be recommended just to include this part of the form in the
3211