Project

General

Profile

Download (96 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/**
3
 * @file
4
 * CDM Dataportal settings.
5
 */
6

    
7
// TODO Genus UUID.
8
define('DEFAULT_TAXONTREE_RANKLIMIT', '1b11c34c-48a8-4efa-98d5-84f7f66ef43a');
9
define('CDM_TAXONOMICTREE_UUID', 'cdm_taxonomictree_uuid');
10

    
11
define('CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE', 25);
12
define('CDM_DATAPORTAL_NOMREF_IN_TITLE', 1);
13
define('CDM_DATAPORTAL_DISPLAY_IS_ACCEPTED_FOR', 0);
14
define('CDM_DATAPORTAL_ALL_FOOTNOTES', 0);
15
define('CDM_DATAPORTAL_ANNOTATIONS_FOOTNOTES', 0);
16
define('CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX', 999);
17

    
18
/* annotationTypeKeys */
19
$annotationTypeKeys = array_keys(cdm_Vocabulary_as_option(UUID_ANNOTATION_TYPE));
20
if (in_array(UUID_ANNOTATION_TYPE_TECHNICAL, $annotationTypeKeys)) {
21
  $annotationTypeKeys = array_flip($annotationTypeKeys);
22

    
23
  // Technical annotation are off by default.
24
  unset($annotationTypeKeys[UUID_ANNOTATION_TYPE_TECHNICAL]);
25
  $annotationTypeKeys = array_flip($annotationTypeKeys);
26
  // Additional value for the NULL case.
27
  $annotationTypeKeys[] = 'NULL_VALUE';
28
}
29
define('ANNOTATIONS_TYPES_AS_FOOTNOTES_DEFAULT', serialize($annotationTypeKeys));
30

    
31
/* taxonRelationshipTypes */
32
define('CDM_TAXON_RELATIONSHIP_TYPES_DEFAULT', serialize(array(UUID_MISAPPLIED_NAME_FOR, UUID_INVALID_DESIGNATION_FOR)));
33

    
34
/* Gallery variables. */
35
$gallery_settings = array(
36
  "cdm_dataportal_show_taxon_thumbnails" => 1,
37
  "cdm_dataportal_show_synonym_thumbnails" => 0,
38
  "cdm_dataportal_show_thumbnail_captions" => 1,
39
  "cdm_dataportal_media_maxextend" => 120,
40
  "cdm_dataportal_media_cols" => 3,
41
  "cdm_dataportal_media_maxRows" => 1,
42
);
43

    
44
/* ---- MAP SETTING CONSTANTS ---- */
45
/**
46
 * @var array of URIs eg. http://edit.africamuseum.be"
47
 *   An options array
48
 */
49
define('EDIT_MAPSERVER_URI', serialize(
50
    array(
51
      'http://edit.africamuseum.be'=>'Primary (http://edit.africamuseum.be)',
52
      'http://edit.br.fgov.be'=>'Secondary (http://edit.br.fgov.be)',
53
    )
54
  )
55
);
56
define('EDIT_MAPSERVER_PATH', '/edit_wp5');
57
/**
58
 * @var array of versions eg. "v1.2"
59
 *   An options array
60
 */
61
define('EDIT_MAPSERVER_VERSION', serialize(
62
    array(
63
      'v1' => 'v1' ,
64
      'v1.1' => 'v1.1',
65
      'v1.2_dev' => 'v1.2_dev',
66
      'v1.2' => 'v1.2',
67
      'v1.3_dev' => 'v1.3_dev'
68
    )
69
  )
70
);
71
define('EDIT_MAPSERVER_URI_DEFAULT', 'http://edit.africamuseum.be');
72
define('EDIT_MAPSERVER_VERSION_DEFAULT', 'v1.2');
73

    
74
// --- Taxon profile settings --- /
75
define('LAYOUT_SETTING_PREFIX', 'layout_');
76
define('FEATURE_TREE_LAYOUT_DEFAULTS', serialize(
77
  array(
78
    'enabled' => FALSE,
79
    'enclosingTag' => 'ul',
80
    'entryEnclosingTag' => 'li',
81
    'glue' => ' ',
82
  )));
83

    
84
define('DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP', 'distribution_textdata_on_top');
85
define('CDM_TAXON_PROFILE_IMAGE', 'cdm_taxon_profile_image');
86
define('CDM_TAXON_PROFILE_IMAGE_DEFAULT', serialize(
87
    array(
88
        'show' => 0,
89
        'maxextend' => 184,
90
        'media_uri_query' => '',
91
        'custom_placeholder_image_on' => 0,
92
        'custom_placeholder_image_fid' => ''
93
    )
94
  )
95
);
96

    
97
/**
98
 * @todo document this function
99
 */
100
function get_taxon_tabs_list() {
101
  return array(
102
    0 => 'General',
103
    1 => 'Synonymy',
104
    2 => 'Images',
105
    3 => 'Specimens',
106
    4 => 'Keys',
107
  );
108
}
109

    
110
$taxon_tab_options = get_taxon_tabs_list();
111
$taxon_tab_options[CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX] = 'Last visited tab';
112

    
113
define('CDM_DATAPORTAL_DEFAULT_TAXON_TAB', serialize($taxon_tab_options));
114

    
115
/**
116
 * @todo document this function.
117
 */
118
function get_taxon_options_list() {
119
  $taxon_tab_options = array_flip(get_taxon_tabs_list());
120
  foreach ($taxon_tab_options as $key => $value) {
121
    $taxon_tab_options[$key] = t($key);
122
  }
123
  return $taxon_tab_options;
124

    
125
}
126

    
127
define('CDM_PART_DEFINITIONS', 'cdm-part-definitions');
128
define('CDM_PART_DEFINITIONS_DEFAULT', serialize(
129
  array(
130
      'ZoologicalName' => array(
131
        'namePart' => array('name' => TRUE),
132
        'nameAuthorPart' => array('name' => TRUE),
133
        'referencePart' => array('authors' => TRUE),
134
        'microreferencePart' => array('microreference' => TRUE),
135
        'statusPart' => array('status' => TRUE),
136
        'descriptionPart' => array('description' => TRUE),
137
      ),
138
      'BotanicalName'=> array(
139
        'namePart' => array('name' => TRUE),
140
        'nameAuthorPart' => array('name' => TRUE, 'authors' => TRUE),
141
        'referencePart' => array('reference' => TRUE, 'microreference' => TRUE),
142
        'statusPart' => array('status' => TRUE),
143
        'descriptionPart' => array('description' => TRUE),
144
      ),
145
     '#DEFAULT' => array(
146
        'namePart' => array(
147
            'name' => TRUE
148
        ),
149
        'nameAuthorPart' => array(
150
            'name' => TRUE,
151
            'authors' => TRUE
152
        ),
153
        'referencePart' => array(
154
            'reference' => TRUE
155
        ),
156
        'microreferencePart' => array(
157
            'microreference' => TRUE,
158
        ),
159
        'statusPart' => array(
160
            'status' => TRUE,
161
        ),
162
        'descriptionPart' => array(
163
            'description' => TRUE,
164
        ),
165
      )
166
    )
167
  )
168
);
169
define('CDM_NAME_RENDER_TEMPLATES', 'cdm-name-render-templates');
170
define('CDM_NAME_RENDER_TEMPLATES_DEFAULT', serialize(
171
   array (
172
     'taxon_page_title,polytomousKey'=> array(
173
          'namePart' => array('#uri' => TRUE),
174
        ),
175
      'taxon_page_synonymy,related_taxon'=> array(
176
          'nameAuthorPart' => array('#uri' => TRUE),
177
          'referencePart' => TRUE,
178
          'statusPart' => TRUE,
179
          'descriptionPart' => TRUE,
180
        ),
181
      'acceptedFor,typedesignations,list_of_taxa' => array(
182
          'nameAuthorPart' => array('#uri' => TRUE),
183
          'referencePart' => TRUE,
184
        ),
185
      '#DEFAULT' => array(
186
          'nameAuthorPart' => array('#uri' => TRUE),
187
          'referencePart' => TRUE,
188
       )
189
    )
190
));
191

    
192
define('TAXONPAGE_VISIBILITY_OPTIONS_DEFAULT', serialize(get_taxon_options_list()));
193
define('CDM_DATAPORTAL_GALLERY_SETTINGS', serialize($gallery_settings));
194
define('CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME', 'specimen_gallery');
195
define('CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME', "description_gallery");
196
define('CDM_DATAPORTAL_MEDIA_GALLERY_NAME', "media_gallery");
197
define('CDM_DATAPORTAL_TAXON_MEDIA_GALLERY_NAME_TAB', "taxon_tab_media_gallery");
198
define('CDM_DATAPORTAL_SEARCH_GALLERY_NAME', "search_gallery");
199
define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS', 'cdm_dataportal_display_taxon_relationships');
200
define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS', 'cdm_dataportal_display_name_relations');
201
// define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_2', array("default" => t('Display all')));
202
define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT', 1);
203
define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_DEFAULT', 1);
204
/**
205
 * The drupal variable key for the array containing the uuids of the taxon relationship types to display in
206
 * the snonymy.
207
 *
208
 * @var string
209
 */
210
define('CDM_TAXON_RELATIONSHIP_TYPES', 'cdm_taxon_relationship_types');
211
/**
212
 * The drupal variable for the configuration of the information aggregation along
213
 * the taxon relation ships. The mapped arrayis associative and holds two elements:
214
 *    - direct: the uuids of the taxon relationship types to take into account in invers
215
 *      direction.
216
 *    - invers: the uuids of the taxon relationship types to take into account in direct
217
 *      direction.
218
 *
219
 * @var String
220
 */
221
define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS', 'cdm_aggregate_by_taxon_relationships');
222
define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS_DEFAULT', serialize(
223
    array(
224
        'direct'=>array(),
225
        'invers'=>array()
226
     )
227
   ));
228
define('CDM_PROFILE_FEATURETREE_UUID', 'cdm_dataportal_featuretree_uuid');
229
define('CDM_OCCURRENCE_FEATURETREE_UUID', 'cdm_occurrence_featuretree_uuid');
230
define('CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID', 'cdm_dataportal_structdesc_featuretree_uuid');
231

    
232
define('CDM_TAXON_MEDIA_FILTER', 'cdm_taxon_media_filter');
233
define('CDM_TAXON_MEDIA_FILTER_DEFAULT', serialize(
234
    array(
235
        'includeTaxonDescriptions' => 'includeTaxonDescriptions',
236
        'includeOccurrences' => 0,
237
        'includeTaxonNameDescriptions' => 0
238
     )
239
  ));
240

    
241
define('CDM_MAP_DISTRIBUTION', 'cdm_map_distribution');
242
define('CDM_MAP_DISTRIBUTION_DEFAULT', serialize(array(
243
  // needs to be merged with user setting by drupal_array_merge_deep()
244
  'width' => 512, // optimum size for OSM layers is 512
245
  'height' => 512 / 2, // optimum size for OSM layers 256
246
  'bbox' => '', // empty to allow automatic zooming to extend
247
  'show_labels' => FALSE,
248
  'caption' => '',
249
  'distribution_opacity' => '0.5',
250
  'map_type' => 1, //  1 = 'openlayers', 0 = 'image'
251
  'image_map' => array(
252
    'base_layer' => '', // none, formerly this was cyprusdivs
253
    'bg_color' => '1874CD',
254
    'layer_style' => 'ffffff,606060,,',
255
  ),
256
  'openlayers' => array(
257
    'base_layers' =>  array(
258
      // A layer MUST NOT BE SET in the defaults,
259
      // otherwise it can not be overidden by the user settings:
260
      // 'osgeo_vmap0' => 'osgeo_vmap0',
261
      // it is sufficient to define the preferred layer,
262
      // since it will automatically be enabled:
263
      'PREFERRED' => 'osgeo_vmap0'),
264
     'custom_wms_base_layer' => array(
265
            'name' => NULL,
266
            'url' => NULL,
267
            'params' =>  NULL,
268
            'projection' => NULL,
269
            'max_extent' => NULL,
270
            'units' => NULL
271
     ),
272
    'show_layer_switcher' => TRUE,
273
    'display_outside_max_extent' => FALSE
274
  ),
275
  'legend' => array(
276
    'show' => TRUE,
277
    'opacity' => '0.5',
278
    'font_size' => 10,
279
    'font_style' => FALSE,
280
    'icon_width' => 35,
281
    'icon_height' => 15
282
  )
283
)));
284

    
285
/**
286
 * Merges the named array variable with the array of defaults.
287
 *
288
 * @param string $variable_name
289
 *     The variable name
290
 * @param string | array $default
291
 *     The array containing the default values either as array or serialized as string.
292
 *     Unserialization is cared for if nessecary
293
 * @return array
294
 *     The merged array as returnd by drupal_array_merge_deep()
295
 */
296
function get_array_variable_merged($variable_name, $default){
297

    
298
    // unserialize if nessecary
299
    if(!is_array($default)){
300
      $default = unserialize($default);
301
    }
302
    $variable = variable_get($variable_name, array());
303
    return drupal_array_merge_deep($default, $variable);
304
}
305

    
306
/**
307
 * @todo document this function.
308
 */
309
function getGallerySettings($gallery_config_form_name) {
310
  return get_array_variable_merged($gallery_config_form_name, CDM_DATAPORTAL_GALLERY_SETTINGS);
311
}
312

    
313
/**
314
 * Returns the string representation of the default tab.
315
 *
316
 * @param bool $returnTabIndex
317
 *   Defaults to FALSE, if set true this function will return the index number
318
 *   of the default tab. (used to supply default values to form elements).
319
 */
320
function get_default_taxon_tab($returnTabIndex = FALSE) {
321

    
322
  global $user;
323
  $values = unserialize(CDM_DATAPORTAL_DEFAULT_TAXON_TAB);
324
  $user_tab_active = 'cdm_dataportal_' . $user->uid . '_default_tab_active';
325
  $user_tab = 'cdm_dataportal_' . $user->uid . '_default_tab';
326
  // Get the user value if the used has chosen to overwrite the system settings.
327
  $user_tab_on = variable_get($user_tab_active, FALSE);
328
  if ($user_tab_on) {
329
    $user_value = variable_get($user_tab, 0);
330
    $index_value = $user_value;
331
    // Get the system value.
332
  }
333
  else {
334
    $system_value = variable_get('cdm_dataportal_default_tab', 0);
335
    $index_value = $system_value;
336
  }
337

    
338
  // Return the index value or the string representation.
339
  if ($returnTabIndex) {
340
    return $index_value;
341
  }
342
  else {
343
    return ($values[$index_value]);
344
  }
345

    
346
}
347

    
348
/**
349
 * @todo Please document this function.
350
 * @see http://drupal.org/node/1354
351
 */
352
function cdm_dataportal_menu_admin(&$items) {
353
  // Display section on admin/config page.
354
  $items['admin/config/cdm_dataportal'] = array(
355
    'title' => 'CDM Dataportal',
356
    'description' => 'Settings for the CDM DataPortal.',
357
    'position' => 'right',
358
    'weight' => 10,
359
    'page callback' => 'system_admin_menu_block_page',
360
    'access arguments' => array('administer cdm_dataportal'),
361
    'file' => 'system.admin.inc',
362
    'file path' => drupal_get_path('module', 'system'),
363
  );
364
  $items['admin/config/cdm_dataportal/settings'] = array(
365
    'title' => 'Settings',
366
    'description' => 'Settings for the CDM DataPortal.',
367
    'weight' => 0,
368
    'page callback' => 'drupal_get_form',
369
    'page arguments' => array('cdm_settings_general'),
370
    'access arguments' => array('administer cdm_dataportal'),
371
    'type' => MENU_NORMAL_ITEM,
372
  );
373
  $items['admin/config/cdm_dataportal/settings/general'] = array(
374
    'title' => 'General',
375
    'description' => 'General',
376
    'weight' => 0,
377
    'page callback' => 'drupal_get_form',
378
    'page arguments' => array('cdm_settings_general'),
379
    'access arguments' => array('administer cdm_dataportal'),
380
    'type' => MENU_DEFAULT_LOCAL_TASK,
381
  );
382

    
383
  $items['admin/config/cdm_dataportal/settings/cachesite'] = array(
384
    'title' => 'Cache',
385
    'description' => 'Cache',
386
    'access arguments' => array('administer cdm_dataportal'),
387
    'page callback' => 'drupal_get_form',
388
    'page arguments' => array('cdm_settings_cache'),
389
    'weight' => 10,
390
    'type' => MENU_LOCAL_TASK,
391
  );
392

    
393
  $items['admin/config/cdm_dataportal/settings/geo'] = array(
394
    'title' => 'Geo & Map',
395
    'description' => 'Geo & Map',
396
    'access arguments' => array('administer cdm_dataportal'),
397
    'page callback' => 'drupal_get_form',
398
    'page arguments' => array('cdm_settings_geo'),
399
    'weight' => 1,
400
    'type' => MENU_LOCAL_TASK,
401
  );
402

    
403
  $items['admin/config/cdm_dataportal/settings/layout'] = array(
404
    'title' => 'Layout',
405
    'description' => 'Configure and adjust the layout of your DataPortal ',
406
    'access arguments' => array('administer cdm_dataportal'),
407
    'page callback' => 'drupal_get_form',
408
    'page arguments' => array('cdm_settings_layout'),
409
    'weight' => 2,
410
    'type' => MENU_LOCAL_TASK,
411
  );
412

    
413
  $items['admin/config/cdm_dataportal/settings/layout/taxon'] = array(
414
    'title' => 'Taxon',
415
    'description' => 'Configure and adjust the layout of your DataPortal ',
416
    'access arguments' => array('administer cdm_dataportal'),
417
    'page callback' => 'drupal_get_form',
418
    'page arguments' => array('cdm_settings_layout_taxon'),
419
    'weight' => 1,
420
    'type' => MENU_LOCAL_TASK,
421
  );
422
  /*
423
  $items[] = array(
424
  'path' => 'admin/config/cdm_dataportal/layout/synonymy',
425
  'title' => t('Synonymy'),
426
  'description' => t('Configure and adjust the layout of your DataPortal '),
427
  'access' => user_access('administer cdm_dataportal'),
428
  'callback' => 'drupal_get_form',
429
  'callback arguments' => array('cdm_settings_layout_synonymy'),
430
  'weight' => 1,
431
  'type' => MENU_LOCAL_TASK,
432
  );
433

    
434
  $items[] = array(
435
  'path' => 'admin/config/cdm_dataportal/layout/specimens',
436
  'title' => t('Specimens'),
437
  'description' => t('Configure and adjust the layout of your DataPortal '),
438
  'access' => user_access('administer cdm_dataportal'),
439
  'callback' => 'drupal_get_form',
440
  'callback arguments' => array('cdm_settings_layout_specimens'),
441
  'weight' => 1,
442
  'type' => MENU_LOCAL_TASK,
443
  );
444
  */
445
  $items['admin/config/cdm_dataportal/settings/layout/search'] = array(
446
    'title' => 'Search',
447
    'description' => 'Configure and adjust the layout of your DataPortal ',
448
    'access arguments' => array('administer cdm_dataportal'),
449
    'page callback' => 'drupal_get_form',
450
    'page arguments' => array('cdm_settings_layout_search'),
451
    'weight' => 2,
452
    'type' => MENU_LOCAL_TASK,
453
  );
454

    
455
  $items['admin/config/cdm_dataportal/settings/layout/media'] = array(
456
    'title' => 'Media',
457
    'description' => 'Configure and adjust the layout of your DataPortal ',
458
    'access arguments' => array('administer cdm_dataportal'),
459
    'page callback' => 'drupal_get_form',
460
    'page arguments' => array('cdm_settings_layout_media'),
461
    'weight' => 3,
462
    'type' => MENU_LOCAL_TASK,
463
  );
464

    
465
}
466

    
467
/**
468
 * @todo document this function.
469
 */
470
function cdm_help_general_cache() {
471
  $form = array();
472
  $form['cache_help'] = array(
473
    '#type' => 'fieldset',
474
    '#title' => t('Help'),
475
    '#collapsible' => TRUE,
476
    '#collapsed' => TRUE,
477
  );
478
  $form['cache_help']['test'] = array('#value' => t('probando'));
479
  return drupal_render($form);
480
  $res = array();
481
  $res['default'] = drupal_render($help);
482
  return $res;
483
}
484

    
485
/**
486
 * Configures the settings form for the CDM-API module.
487
 *
488
 * @return array
489
 *   Drupal settings form.
490
 */
491
function cdm_settings_general() {
492

    
493
  $form['cdm_webservice'] = array(
494
    '#type' => 'fieldset',
495
    '#title' => t('CDM Server'),
496
    '#collapsible' => FALSE,
497
    '#collapsed' => FALSE,
498
    '#description' => t('The <em>CDM Server</em> exposes data stored in a
499
        CDM data base to the web via RESTful web services and thus is the source of the data
500
        to be displayed by a CDM DataPotal.'),
501
  );
502

    
503
  $form['cdm_webservice']['cdm_webservice_url'] = array(
504
    '#type' => 'textfield',
505
    '#title' => t('CDM web service URL') . ':',
506
    '#description' => t('This is the URL to the CDM-Server exposing your data
507
      e.g. <em>"http://myserver.net/cdmserver/myproject"</em>'),
508
    '#default_value' => variable_get('cdm_webservice_url', NULL),
509
  );
510

    
511
  $form['cdm_webservice']['cdm_webservice_debug'] = array(
512
    '#type' => 'markup',
513
    '#markup' => '<b>Debug CDM Web Service:</b> The web service debug box has completely been replaced '
514
      . 'by  the ' . l('CDM web service debug block', 'admin/structure/block/manage/cdm_api/cdm_ws_debug/configure')
515
      . '. It is usually only visible for administrative roles like <i>administrator</i> and <i>CDM admin</i>'
516
  );
517

    
518
  $form['cdm_webservice']['freetext_index'] = array(
519
    '#type' => 'fieldset',
520
    '#title' => t('Freetext index'),
521
    '#collapsible' => FALSE,
522
    '#collapsed' => FALSE,
523
  );
524

    
525
  // Check the cdmserver port number and display a waring if it is not port 80
526
  preg_match("#http[s]?://[0-9\p{L}\.]*:([0-9]*)/.*#u", variable_get('cdm_webservice_url', ''), $portNumberMatch, PREG_OFFSET_CAPTURE);
527
  if (isset($portNumberMatch[1]) && $portNumberMatch[1] != '80') {
528
    $form['cdm_webservice']['freetext_index']['message'] = array(
529
      '#markup' => "<div class=\"description\">"
530
      . t("The CDM web service URL contains a portnumber other than standart HTTP port 80: '!port'."
531
      . " Due to this the reindex and purge fuctions may not be working if there is a firewall in between you and the CDM Server."
532
      . " You may want to contact the maintainer of the according CDM Server in order to solve this problem.", array('!port' => $portNumberMatch[1][0]))
533
      . "</div>",
534
    );
535
  };
536

    
537
  $frontentURL = urlencode(variable_get('cdm_webservice_url', ''));
538
  $trigger_link_options = array(
539
    'attributes' => array(
540
      'class' => 'index-trigger',
541
    ),
542
  );
543
  $form['cdm_webservice']['freetext_index']['operations'] = array(
544
    '#markup' => "<div>" . t('Operations: !url1 !url2', array(
545
        '!url1' => l(t("Purge"), cdm_compose_url(CDM_WS_MANAGE_PURGE, NULL, 'frontendBaseUrl=' . $frontentURL), $trigger_link_options),
546
        '!url2' => l(t("Reindex"), cdm_compose_url(CDM_WS_MANAGE_REINDEX, NULL, 'frontendBaseUrl=' . $frontentURL), $trigger_link_options),
547
      ))
548
    . '<div id="index-progress"></div></div>',
549
  );
550
  _add_js_cdm_ws_progressbar(".index-trigger", "#index-progress");
551

    
552
  $form['cdm_webservice']['proxy'] = array(
553
    '#type' => 'fieldset',
554
    '#title' => t('Proxy'),
555
    '#collapsible' => TRUE,
556
    '#collapsed' => TRUE,
557
  );
558

    
559
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_url'] = array(
560
    '#type' => 'textfield',
561
    '#title' => t('Proxy URL') . ':',
562
    '#description' => t('If this proxy url is set the cdm api tries
563
    to connect the web service over the given proxy server.
564
    Otherwise proxy usage is deactivated.'),
565
    '#default_value' => variable_get('cdm_webservice_proxy_url', FALSE),
566
  );
567

    
568
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_port'] = array(
569
    '#type' => 'textfield',
570
    '#title' => t('Proxy port') . ':',
571
    '#default_value' => variable_get('cdm_webservice_proxy_port', '80'),
572
  );
573

    
574
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_usr'] = array(
575
    '#type' => 'textfield',
576
    '#title' => t('Login') . ':',
577
    '#default_value' => variable_get('cdm_webservice_proxy_usr', FALSE),
578
  );
579

    
580
  $form['cdm_webservice']['proxy']['cdm_webservice_proxy_pwd'] = array(
581
    '#type' => 'textfield',
582
    '#title' => t('Password') . ':',
583
    '#default_value' => variable_get('cdm_webservice_proxy_pwd', FALSE),
584
  );
585

    
586
  // TODO: settings are still incomplete, compare with
587
  // trunk/dataportal/inc/config_default.php.inc.
588
  $form['taxon_tree'] = array(
589
    '#type' => 'fieldset',
590
    '#title' => t('Taxon Tree'),
591
    '#collapsible' => FALSE,
592
    '#collapsed' => TRUE,
593
    '#description' => t('<p>When you explore your collection, you can navigate
594
      it through a tree structure also called <em>Taxon Tree</em>.</p><p>To be
595
      able to navigate through your collection the
596
      <a href="http://drupal.org/handbook/blocks">drupal block</a>
597
      <em>CDM Taxon Tree</em> should be visible for users. Enable the block at
598
      <a href="./?q=admin/build/block">Administer&#45&#62Site building&#45&#62Blocks
599
      </a></p>'),
600
  );
601

    
602
  $form['taxon_tree'][CDM_TAXONOMICTREE_UUID] = array(
603
    '#type' => 'select',
604
    '#title' => t('Available classifications') . ':',
605
    '#default_value' => variable_get(CDM_TAXONOMICTREE_UUID, FALSE),
606
    '#options' => cdm_get_taxontrees_as_options(),
607
    '#description' => t('Select the default taxa classification for your
608
      <em>taxon tree</em>, the other classifications will be also available but
609
      with a manual user change.'),
610
  );
611

    
612
  $form['taxon_tree']['taxontree_ranklimit'] = array(
613
    '#type' => 'select',
614
    '#title' => t('Rank of highest displayed taxon') . ':',
615
     // Before DEFAULT_TAXONTREE_RANKLIMIT_UUID.
616
    '#default_value' => variable_get('taxontree_ranklimit', DEFAULT_TAXONTREE_RANKLIMIT),
617
    '#options' => cdm_rankVocabulary_as_option(),
618
    '#description' => t('This is the rank of the highest displayed taxon in the
619
      <em>taxon tree</em>. You can select here which rank should be at the top
620
      level of the tree structure.'),
621
  );
622

    
623
  $form['aggregation'] = array(
624
      '#type' => 'fieldset',
625
      '#title' => t('Aggregation of data'),
626
      '#collapsible' => FALSE,
627
      '#description' => t("This section covers the different aspects of aggregating information.
628
          <p>
629
          </p>"),
630

    
631
  );
632

    
633
  $form['aggregation'][CDM_TAXON_MEDIA_FILTER] = array(
634
      '#type' => 'checkboxes',
635
      '#title' => 'Taxon media filter',
636
      '#default_value' => variable_get(CDM_TAXON_MEDIA_FILTER, unserialize(CDM_TAXON_MEDIA_FILTER_DEFAULT)),
637
      '#options' => array(
638
          'includeTaxonDescriptions' => 'Media in taxon descriptions',
639
          'includeTaxonNameDescriptions' => 'Media in name descriptions',
640
          'includeOccurrences' => 'Media related to specimens and occurrences',
641
      ),
642
      '#description' => 'This filter configures which images should be taken into account.',
643
  );
644

    
645
  $form['aggregation']['notice'] = array(
646
      '#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
647
          want to make use of the caching capabilities of the dataportal.',
648
  );
649

    
650
  $form['aggregation']['media_aggregation'] = array(
651
      '#type' => 'fieldset',
652
      '#title' => t('Media aggregation'),
653
      '#collapsible' => FALSE,
654
      '#collapsed' => TRUE,
655
      '#description' => t("The media aggregation is also affected by the settigs in \"<strong>Aggregation via taxon relationsships</strong>\" below."),
656

    
657
  );
658
  $form['aggregation']['media_aggregation']['cdm_images_include_children'] = array(
659
      '#type' => 'select',
660
      '#title' => t('Aggregation of taxon pictures') . ':',
661
      '#default_value' => variable_get('cdm_images_include_children', FALSE),
662
      '#options' => array(
663
          0 => "Show only pictures of the current taxon",
664
          1 => "Include pictures of taxonomic children",
665
      ),
666
      '#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."),
667
  );
668

    
669
  $form['aggregation']['aggregate_by_taxon_relationships'][CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS] = array(
670
      '#type' => 'fieldset',
671
      '#attributes' => array('class'=>array('clearfix')),
672
      '#title' => t('Aggregation via taxon relationsships'),
673
      '#collapsible' => TRUE,
674
      '#collapsed' => TRUE,
675
      '#tree' => TRUE,
676
      '#description' => t('Information on taxa will be aggregated along the below chosen
677
          taxon relation ships. This will affect images and occurrences (specimens).
678
          Taxon relation ships are directed and point form one taxon to another. The taxon
679
          relationships to be taken into accunt can therefore configured for the direct direction
680
          and for the inverse.'),
681
  );
682

    
683
  $taxonRelationshipTypeOptions = cdm_Vocabulary_as_option(UUID_TAXON_RELATIONSHIP_TYPE, '_cdm_relationship_type_term_label_callback');
684
  $aggregate_by_taxon_relationships = variable_get(CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS, unserialize(CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS_DEFAULT));
685

    
686
  $form['aggregation']['aggregate_by_taxon_relationships'][CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS]['direct'] = array(
687
      '#type' => 'checkboxes',
688
      '#title' => t('Direct'),
689
      '#options' => $taxonRelationshipTypeOptions,
690
      '#default_value' => $aggregate_by_taxon_relationships['direct'],
691
  );
692
  $form['aggregation']['aggregate_by_taxon_relationships'][CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS]['invers'] = array(
693
      '#type' => 'checkboxes',
694
      '#title' => t('Invers'),
695
      '#options' => $taxonRelationshipTypeOptions,
696
      '#default_value' => $aggregate_by_taxon_relationships['invers'],
697
  );
698

    
699
  // ----------------------
700
  $form['cdm_js_devel_mode'] = array(
701
      '#type' => 'checkbox',
702
      '#title' => 'Java-script developer mode',
703
      '#default_value' => variable_get('cdm_js_devel_mode', FALSE),
704
      '#description' => 'In production envirionments the java script libraries
705
      the cdm_dataportal is making use of are compressed and optimized. This
706
      is good for performance but a caveat if you need to debug java-script. When the
707
      java-script developer mode is enabled the uncompressed and commented developer
708
      versions of java-script libraries will be used where possible.
709
      <br/><strong>Do not use this option in production!</strong>'
710
  );
711

    
712
  // Comment @WA: D7 form api does not support reset buttons,
713
  // so to mimic the D5 reset button we add one like this.
714
  $form['actions']['reset'] = array(
715
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
716
    '#weight' => 1000,
717
  );
718

    
719
  return system_settings_form($form);
720
}
721

    
722

    
723
/**
724
 * LAYOUT settings
725
 * @return unknown_type
726
 *   todo
727
 */
728
function cdm_settings_layout() {
729

    
730
  $form = array();
731

    
732
  $form['about'] = array(
733
    '#markup' => '<h4>' . t('Portal Layout') . '</h4><p>' . t('This settings contains the general configurations
734
      layout. If you want to configure the specific sites layout visit the
735
      respective configuration site for taxon, search or media.') . '</p>',
736
  );
737

    
738
  // ---- footnotes --- //
739
  $form['footnotes'] = array(
740
    '#type' => 'fieldset',
741
    '#title' => t('Footnotes'),
742
    '#collapsible' => FALSE,
743
    '#collapsed' => FALSE,
744
    '#description' => t('Taxa data such authors, synonyms names, descriptions,
745
      media or distribution areas may have annotations or footnotes. When the
746
      footnotes are enabled they will be visible (if they exist).'),
747
  );
748

    
749
  $form['footnotes']['cdm_dataportal_all_footnotes'] = array(
750
    '#type' => 'checkbox',
751
    '#title' => t('Do not show footnotes'),
752
    '#default_value' => variable_get('cdm_dataportal_all_footnotes', CDM_DATAPORTAL_ALL_FOOTNOTES),
753
    '#description' => t('Check this if you do not want to show any footnotes'),
754
  );
755

    
756
  $form['footnotes']['cdm_dataportal_annotations_footnotes'] = array(
757
    '#type' => 'checkbox',
758
    '#title' => t('Do not show annotations footnotes'),
759
    '#default_value' => variable_get('cdm_dataportal_annotations_footnotes', CDM_DATAPORTAL_ANNOTATIONS_FOOTNOTES),
760
    '#description' => t('Check this if you do not want to show annotation footnotes'),
761
  );
762

    
763
  $annotationTypeOptions = cdm_Vocabulary_as_option(UUID_ANNOTATION_TYPE);
764
  // Additional option for the NULL case.
765
  $annotationTypeOptions['NULL_VALUE'] = t('untyped');
766
  $form['footnotes']['annotations_types_as_footnotes'] = array(
767
    '#type' => 'checkboxes',
768
    '#title' => t('Annotation types as footnotes'),
769
    '#description' => t("Only annotations of the selected type will be displayed
770
       as footnotes. You may want to turn 'technical annotations' off."),
771
    '#options' => $annotationTypeOptions,
772
  );
773
  $annotationsTypesAsFootnotes = variable_get('annotations_types_as_footnotes', unserialize(ANNOTATIONS_TYPES_AS_FOOTNOTES_DEFAULT));
774
  if (!empty($annotationsTypesAsFootnotes)) {
775
    $form['footnotes']['annotations_types_as_footnotes']['#default_value'] = $annotationsTypesAsFootnotes;
776
  }
777

    
778
  // --- Advanced Search --- //
779
  $form['asearch'] = array(
780
      '#type' => 'fieldset',
781
      '#title' => t('Advanced search'),
782
      '#collapsible' => FALSE,
783
      '#collapsed' => FALSE,
784
  );
785
  $form['asearch']['cdm_dataportal_show_advanced_search'] = array(
786
      '#type' => 'checkbox',
787
      '#title' => t('Show advanced search link'),
788
      '#default_value' => variable_get('cdm_dataportal_show_advanced_search', 1),
789
      '#description' => t('Check this box if the link to advanced search should be show below the search box.'),
790
  );
791

    
792
  // ---- Taxon Name Rendering --- //
793
  $form['taxon_name'] = array(
794
      '#type' => 'fieldset',
795
      '#title' => t('Taxon name display'),
796
      '#collapsible' => TRUE,
797
      '#collapsed' => TRUE,
798
      '#description' => t('The display of taxon names is configured by two parts.'
799
          . 'The <srong>name render templates</strong> define the parts of the name to be displayed in the different areas of the data portal pages.'
800
          . 'The name parts are defined in the <stong>part definitions</strong>'),
801
  );
802

    
803
  drupal_add_js(
804
      'jQuery(document).ready( function( ) {
805
         // pretty print json
806
         var json_text = jQuery(\'#edit-' . CDM_PART_DEFINITIONS . '\').val();
807
         var obj = JSON.parse(json_text);
808
         jQuery(\'#edit-' . CDM_PART_DEFINITIONS . '\').val(JSON.stringify(obj, undefined, 2));
809

    
810
         json_text = jQuery(\'#edit-' . CDM_NAME_RENDER_TEMPLATES . '\').val();
811
         obj = JSON.parse(json_text);
812
         jQuery(\'#edit-' . CDM_NAME_RENDER_TEMPLATES . '\').val(JSON.stringify(obj, undefined, 2));
813
       });'
814
      ,array(
815
          'type' => 'inline',
816
          'scope' => 'footer'
817
      )
818
  );
819

    
820
  $default_part_definitions = unserialize(CDM_PART_DEFINITIONS_DEFAULT);
821

    
822
  $form['taxon_name'][CDM_PART_DEFINITIONS] = array(
823
      '#type' => 'textarea',
824
      '#title' => t('Part definitions'),
825
      '#element_validate' => array('form_element_validate_json'),
826
      '#default_value' =>  json_encode(variable_get(CDM_PART_DEFINITIONS, $default_part_definitions)),
827
      '#description' => '
828
          <p>
829
          (Clearing the text area will reset it to the default)
830
          </p>
831
          <p>
832
           The part definitions define the specific parts of which a rendered taxon name plus additional information will consist.
833
          </p>
834
          <p>
835
           A full taxon name plus additional information can consist of the following elements:
836
          <ul>
837
             <li>name: the taxon name inclugin rank nbut without author</li>
838
             <li>authors:  The authors of a reference, also used in taxon names</li>
839
             <li>reference: the nomenclatural reference,</li>
840
             <li>microreference:  Volume, page number etc.</li>
841
             <li>status:  The nomenclatural status of a name</li>
842
             <li>description: name descriptions like protologues etc ...</li>
843
          </ul>
844
          </p>
845
          <p>
846
           These elements are combined in the part definitions array to from the specific parts to be rendered.
847
           (The taxon name "Lapsana communis L., Sp. Pl.: 811. 1753" shall be an example in the following)
848
           Usually the following parts are formed:
849
          <ul>
850
            <li>namePart: the name and rank (in example: "Lapsana communis")</li>
851
            <li>authorshipPart: the author (in example: "L.")</li>
852
            <li>nameAuthorPart: the combination of name and author part (in example: "Lapsana communis L.").</li>
853
               This is useful for zoological names where the authorshipPart belongs to the name and both should</li>
854
               be combined when a link to the taxon is rendered.</li>
855
            <li>referencePart: the nomencaltural reference (in example: "Sp. Pl. 1753")</li>
856
            <li>microreferencePart: usually the page number (in example ": 811.")</li>
857
            <li>statusPart: the nomenclatorical status</li>
858
            <li>descriptionPart: name descriptions like protologues etc ...</li>
859
          </ul>
860
          </p>
861
          <p>
862
           Each set of parts is dedicated to render a specific TaxonName type, the type names are used as keys for the
863
           specific parts part definitions:
864
          <ul>
865
            <li>BotanicalName</li>
866
            <li>ZoologicalName</li>
867
            <li>#DEFAULT: covers ViralNames and other NonViralNames
868
          </ul>
869
           An example:
870
          <pre>
871
           {
872
            "ZoologicalName": {
873
              "namePart": {
874
                "name": true
875
              },
876
              "referencePart": {
877
                "authors": true
878
              },
879
              "microreferencePart": {
880
                "microreference": true
881
              },
882
              "statusPart": {
883
                "status": true
884
              },
885
              "descriptionPart": {
886
                "description": true
887
              }
888
            },
889
            "BotanicalName": {
890
              "namePart": {
891
                "name": true,
892
                "authors": true
893
              },
894
              "referencePart": {
895
                "reference": true,
896
                "microreference": true
897
              },
898
              "statusPart": {
899
                "status": true
900
              },
901
              "descriptionPart": {
902
                "description": true
903
              }
904
            }
905
          }
906
           </pre>',
907
  );
908

    
909
  $default_render_templates = unserialize(CDM_NAME_RENDER_TEMPLATES_DEFAULT);
910

    
911
  $form['taxon_name'][CDM_NAME_RENDER_TEMPLATES] = array(
912
      '#type' => 'textarea',
913
      '#title' => t('Name render templates'),
914
      '#element_validate' => array('form_element_validate_json'),
915
      '#default_value' =>  json_encode(variable_get(CDM_NAME_RENDER_TEMPLATES, $default_render_templates)),
916
      '#description' => '
917
          <p>
918
          (Clearing the text area will reset it to the default)
919
          </p>
920
          <p>
921
          The render templates array contains one or more name render templates to be used within the page areas identified by the
922
          render path. The render path is used as key of the array sub subelements whereas the name render template array is set as value.
923
          The following render Path keys are curretly recognized:
924
          <ul>
925
            <li>list_of_taxa:</li>
926
            <li>acceptedFor:</li>
927
            <li>taxon_page_synonymy</li>
928
            <li>typedesignations</li>
929
            <li>taxon_page_title</li>
930
            <li>polytomousKey</li>
931
            <li>na: name + authorship</li>
932
            <li>nar:name + authorship + reference</li>
933
            <li>#DEFAULT</li>
934
          </ul>
935
          A single render template can be used for multiple render paths. In this case the according key of the render templates
936
          array element should be a comma separated list of render paths, without any whitespace!.
937
          </p>
938
          <p>
939
          A render template is an associative array. The keys of this array are referring to the keys as defined in the part
940
          definitions array. See <a href="#edit-cdm-part-definitions">Part definitions</a> above for more information.
941
          <p>
942
          The value of the render template element must be set to TRUE in order to let this part being rendered.
943
          The namePart, nameAuthorPart and referencePart can also hold an associative array with a single
944
          element: array(\'#uri\' => TRUE). The value of the #uri element will be replaced by the according
945
          links if the paramters $nameLink or $refenceLink are given to the name render function
946
          (this is hard coded and cannot be configured here).',
947
  );
948

    
949
  // @WA: D7 form api does not support reset buttons,
950
  // so to mimic the D5 reset button we add one like this.
951
  $form['actions']['reset'] = array(
952
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
953
    '#weight' => 1000,
954
  );
955

    
956
  $form['#submit'] = array('submit_json_as_php_array');
957
  // #json_elements especially defined for submit_json_as_php_array()
958
  $form['#json_elements'] = array(CDM_NAME_RENDER_TEMPLATES, CDM_PART_DEFINITIONS);
959
  return system_settings_form($form);
960
}
961

    
962

    
963
/**
964
 * @todo Please document this function.
965
 * @see http://drupal.org/node/1354
966
 */
967
function cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description = '') {
968
  $form[$form_name] = array(
969
    '#type' => 'fieldset',
970
    '#title' => t($form_title),
971
    '#collapsible' => TRUE,
972
    '#collapsed' => $collapsed,
973
    '#tree' => TRUE,
974
    '#description' => t($form_description),
975
  );
976

    
977
  $default_values = unserialize(CDM_DATAPORTAL_GALLERY_SETTINGS);
978
  $gallery_settings = variable_get($form_name, $default_values);
979
  // $test = variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE);
980
  if ($form_name == CDM_DATAPORTAL_SEARCH_GALLERY_NAME) {
981
    /*
982
    TODO: why cdm_dataportal_search_items_on_page does not save the value on $test???
983
    $form[$form_name]['cdm_dataportal_search_items_on_page'] = array(
984
    '#type' => 'textfield',
985
    '#title' => t('Search Page Size'),
986
    '#default_value' => $test,
987
    '#description' => t('Number of Names to display per page in search results.')
988
    );
989
    */
990
    $form[$form_name]['cdm_dataportal_show_taxon_thumbnails'] = array(
991
      '#type' => 'checkbox',
992
      '#title' => t('Show media thumbnails for accepted taxa'),
993
      '#default_value' => $gallery_settings['cdm_dataportal_show_taxon_thumbnails'],
994
    );
995

    
996
    $form[$form_name]['cdm_dataportal_show_synonym_thumbnails'] = array(
997
      '#type' => 'checkbox',
998
      '#title' => t('Show media thumbnails for synonyms'),
999
      '#default_value' => $gallery_settings['cdm_dataportal_show_synonym_thumbnails'],
1000
      '#description' => '',
1001
    );
1002
  }
1003

    
1004
  // $showCaption = variable_get('cdm_dataportal_findtaxa_show_thumbnail_captions', 0);
1005
  $form[$form_name]['cdm_dataportal_show_thumbnail_captions'] = array(
1006
    '#type' => 'checkbox',
1007
    '#title' => t('Show captions under thumbnails'),
1008
    '#default_value' => $gallery_settings['cdm_dataportal_show_thumbnail_captions'],
1009
    '#description' => '',
1010
  );
1011

    
1012
  $form[$form_name]['cdm_dataportal_media_maxextend'] = array(
1013
    '#type' => 'textfield',
1014
    '#title' => t('Thumbnail size') . ':',
1015
    '#default_value' => $gallery_settings['cdm_dataportal_media_maxextend'],
1016
    '#description' => t('Select the size of each individual thumbnail.'),
1017
  );
1018

    
1019
  if ($form_name != CDM_DATAPORTAL_MEDIA_GALLERY_NAME) {
1020
    $form[$form_name]['cdm_dataportal_media_cols'] = array(
1021
      '#type' => 'textfield',
1022
      '#title' => t('Number of columns') . ':',
1023
      '#default_value' => $gallery_settings['cdm_dataportal_media_cols'],
1024
      '#description' => t('Group the thumbnails in columns: select how many
1025
        columns the gallery should display.'),
1026
    );
1027
  }
1028

    
1029
  if ($form_name == CDM_DATAPORTAL_SEARCH_GALLERY_NAME) {
1030
    $form[$form_name]['cdm_dataportal_media_maxRows'] = array(
1031
      '#type' => 'textfield',
1032
      '#title' => t('Maximum number of rows') . ':',
1033
      '#default_value' => $gallery_settings['cdm_dataportal_media_maxRows'],
1034
      '#description' => t('You can group the thumbnails in rows, select in how
1035
        many rows should be the thumbnails grouped.<br/><strong>Note:</strong>
1036
        If you want an unlimited number of rows please set to 0.'),
1037
    );
1038
  }
1039

    
1040
  return $form;
1041
}
1042

    
1043
/**
1044
 * @todo document this function.
1045
 */
1046
function cdm_settings_layout_taxon() {
1047
  $collapsed = FALSE;
1048
  $form = array();
1049

    
1050
  $form['#submit'][] = 'cdm_settings_layout_taxon_submit';
1051

    
1052
  $form['cdm_dataportal_show_back_to_search_results'] = array(
1053
      '#type' => 'checkbox',
1054
      '#title' => t('Show <em>Back to search results</em> link at the taxon site.'),
1055
      '#default_value' => variable_get('cdm_dataportal_show_back_to_search_results', 1),
1056
      '#description' => t('<p>If checked the link to search results is rendered at
1057
       the top of the taxon site. Clicking on the link the last search performed
1058
       is rendered again.</p>'),
1059
  );
1060

    
1061
  // --------- TABBED TAXON ------- //
1062
  $form['taxon_tabs'] = array(
1063
    '#type' => 'fieldset',
1064
    '#title' => t('Taxon tabs'),
1065
    '#collapsible' => TRUE,
1066
    '#collapsed' => FALSE,
1067
    '#description' => t('If tabbed taxon page is enabled the taxon profile will
1068
      be splitted in four diferent tabs; General, Synonymy, Images and
1069
      Specimens. If the taxon has no information for any of the tabs/sections
1070
      such tab will be not displayed.'),
1071
  );
1072

    
1073
  $form['taxon_tabs']['cdm_dataportal_taxonpage_tabs'] = array(
1074
    '#type' => 'checkbox',
1075
    '#title' => t('Tabbed taxon page'),
1076
    '#default_value' => variable_get('cdm_dataportal_taxonpage_tabs', 1),
1077
    '#description' => t('<p>If selected split the taxon page into individual
1078
      tabs for description, images, synonymy and specimens. If not the taxon
1079
      data is rendered as a long single page without tabs.</p>'),
1080
  );
1081

    
1082
  $form['taxon_tabs']['cdm_taxonpage_tabs_visibility'] = array(
1083
    '#type' => 'checkboxes',
1084
    '#title' => t('Tabs visibility options') . ':',
1085
    '#default_value' => variable_get('cdm_taxonpage_tabs_visibility', get_taxon_options_list()),
1086
    '#options' => get_taxon_options_list(),
1087
    '#description' => t('Enable or disable Tabs in the Tabbed page display'),
1088
  );
1089

    
1090
  $form['taxon_tabs']['cdm_dataportal_default_tab'] = array(
1091
    '#type' => 'select',
1092
    '#title' => t('Default tab to display') . ':',
1093
    '#default_value' => variable_get('cdm_dataportal_default_tab', 0),
1094
    '#options' => unserialize(CDM_DATAPORTAL_DEFAULT_TAXON_TAB),
1095
    '#description' => t('<p>Select the default tab to display when visiting a
1096
      taxon page. Only available if Tabbed Taxon Page is enable.</p>
1097
      <strong>Note:</strong> After performing a search and clicking in any
1098
      synonym, the taxon tab to be rendered will be the synonymy of the accepted
1099
      taxon and not the above selected tab.'),
1100
  );
1101

    
1102
  /* ======  TAXON_PROFILE ====== */
1103
  $form['taxon_profile'] = array(
1104
    '#type' => 'fieldset',
1105
    '#title' => t('Taxon profile (tab)'),
1106
    '#description' => t('<p>This section covers the settings related to the taxon
1107
      profile tab, also known as the <strong>"General"</strong> tab.</p>'),
1108
    '#collapsible' => TRUE,
1109
    '#collapsed' => TRUE,
1110
  );
1111

    
1112
  // ---- PROFILE PICTURE ----//
1113

    
1114
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE] = array(
1115
    '#type' => 'fieldset',
1116
    '#tree' => TRUE,
1117
    '#title' => t('Taxon profile picture'),
1118
    '#collapsible' => TRUE,
1119
    '#collapsed' => FALSE,
1120
    '#description' => t('This sections allows configuring the display of the so called taxon profile image which is displayed in the taxon profile tab.'),
1121
  );
1122

    
1123
  //FIXME migrate variables:
1124
  //  cdm_dataportal_show_default_image ---> CDM_TAXON_PROFILE_IMAGE['show']
1125
  // FIXME
1126
  //  eanable file modul in profile and in update
1127

    
1128
  $taxon_profile_image_settings = variable_get(CDM_TAXON_PROFILE_IMAGE, unserialize(CDM_TAXON_PROFILE_IMAGE_DEFAULT));
1129
  /*
1130
   * 'show' => 1,
1131
   * 'maxextend' => 184,
1132
   * 'media_uri_query' => ''
1133
   * 'custom_placeholder_image_on' => 1,
1134
   * 'custom_placeholder_image_fid' => ''
1135
   */
1136
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['show'] = array(
1137
    '#type' => 'checkbox',
1138
    '#title' => t('Enable profil picture'),
1139
    '#description' => t('Show the profil picture.'),
1140
    '#default_value' => $taxon_profile_image_settings['show'],
1141
  );
1142

    
1143
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['maxextend'] = array(
1144
      '#type' => 'textfield',
1145
      '#tree' => TRUE,
1146
      '#title' => t('Profil picture maximum extend'),
1147
      '#default_value' =>  $taxon_profile_image_settings['maxextend'],
1148
      '#field_suffix' => 'px',
1149
      '#maxlength' => 4,
1150
      '#size' => 4,
1151
      '#description' => t('The maximum extend in either dimension, width or height, of the profil picture in pixels.')
1152
  );
1153

    
1154
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['media_uri_query'] = array(
1155
      '#type' => 'textfield',
1156
      '#tree' => TRUE,
1157
      '#title' => t('Additional URI query parameter'),
1158
      '#default_value' =>  $taxon_profile_image_settings['media_uri_query'],
1159
      '#maxlength' => 1024,
1160
      '#size' => 60,
1161
      '#description' => t('Additional query parameters to be used when requesting for the '
1162
          . 'profile image. E.g.: <code>width=400&height=300&quality=95&format=jpeg</code>.'
1163
          . 'The query parameters will be appendend to the uri of the media representation part'
1164
          . ' as stored in the cdm. The query parameter string must not start with a \'&\' or  \'?\'')
1165
  );
1166

    
1167
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_on'] = array(
1168
      '#type' => 'checkbox',
1169
      '#title' => t('Use a custom placeholder image'),
1170
      '#description' => t("This image is shown as replacement if no image of the taxon is available."),
1171
      '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_on']
1172
  );
1173

    
1174
  if($taxon_profile_image_settings['custom_placeholder_image_on'] == 1){
1175
    $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'] = array(
1176
        '#type' => 'managed_file',
1177
        '#title' => t('Custom placeholder image file'),
1178
        '#progress_indicator' => 'bar',
1179
        '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_fid'],
1180
    //       '#name' => 'custom_placeholder_image',
1181
        '#upload_location' => 'public://' . CDM_TAXON_PROFILE_IMAGE .'/'
1182
    );
1183

    
1184
    if($taxon_profile_image_settings['custom_placeholder_image_fid']){
1185
      $profile_image_file = file_load($taxon_profile_image_settings['custom_placeholder_image_fid']);
1186
      $url = file_create_url($profile_image_file->uri);
1187
      $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['preview'] = array(
1188
                '#type' => 'item',
1189
                '#markup' => '<div class="image-preview"><img src="' . $url . '"/></div>',
1190
      );
1191
    }
1192
  } else {
1193
    $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'] = array(
1194
        '#type' => 'hidden',
1195
        '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_fid']
1196
    );
1197
  }
1198

    
1199

    
1200

    
1201
  $options = cdm_rankVocabulary_as_option();
1202
  array_unshift($options, '-- DISABLED --');
1203
  $form['taxon_profile']['picture']['image_hide_rank'] = array(
1204
    '#type' => 'select',
1205
    '#title' => t('Hide profile picture for higher ranks') . ':',
1206
    '#default_value' => variable_get('image_hide_rank', '0'),
1207
    '#options' => $options,
1208
    '#description' => t('The taxon profile picture will not be shown for taxa with rank higher that the selected.'),
1209
  );
1210

    
1211
  // -- MEDIA THUMBNAILS -- //
1212
  $form_name = CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME;
1213
  $form_title = 'Taxon Profile Images';
1214
  $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>';
1215
  $form['taxon_profile'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description);
1216

    
1217
  // ---- FEATURE TREE ---- //
1218
  $form['taxon_profile']['feature_trees'] = array(
1219
    '#type' => 'fieldset',
1220
    '#title' => t('Features'),
1221
    '#collapsible' => TRUE,
1222
    '#collapsed' => FALSE,
1223
    '#description' => t("This section covers settings related to the taxon's
1224
      <em>Feature Tree</em>. The <em>feature tree</em> are the taxon's
1225
      features such as description, distribution, common names, etc. that Drupal
1226
      will render at the taxon profile page."),
1227
  );
1228
  $featureTrees = cdm_get_featureTrees_as_options(TRUE);
1229
  $saved_uuid = variable_get(CDM_PROFILE_FEATURETREE_UUID, UUID_DEFAULT_FEATURETREE);
1230
  if(!isset($featureTrees['options'][$saved_uuid])) {
1231
    $saved_uuid = UUID_DEFAULT_FEATURETREE;
1232
  }
1233
  $form['taxon_profile']['feature_trees'][CDM_PROFILE_FEATURETREE_UUID] = array(
1234
    '#type' => 'radios',
1235
    '#title' => t('Taxon profile sections') . ':',
1236
    '#default_value' => $saved_uuid,
1237
    '#options' =>  $featureTrees['options'],
1238
    '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
1239
    '#options_suffixes' => $featureTrees['treeRepresentations'],
1240
    '#description' => t('Select the Feature Tree to be displayed at the taxon
1241
      profile. Click "Show Details" to see the Feature Tree elements.'
1242
    ),
1243
  );
1244
  $featureTrees = cdm_get_featureTrees_as_options();
1245
  $saved_uuid = variable_get(CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID, UUID_DEFAULT_FEATURETREE);
1246
  if(!isset($featureTrees['options'][$saved_uuid])) {
1247
    $saved_uuid = NULL;
1248
  }
1249
  $form['taxon_profile']['feature_trees'][CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID] = array(
1250
    '#type' => 'radios',
1251
    '#title' => t('Natural language representation of structured descriptions') . ':',
1252
    '#default_value' => $saved_uuid,
1253
    '#options' => $featureTrees['options'],
1254
    '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
1255
    '#options_suffixes' => $featureTrees['treeRepresentations'],
1256
    '#description' => t('Taxon descriptions can be stored in a highly structured
1257
      form. The feature tree selected here will be used to generate textual
1258
      representation in natural language.'
1259
    ),
1260
  );
1261

    
1262
  // ---- LAYOUT PER FEATURE ---- //
1263
  $feature_tree = get_profile_featureTree();
1264
  if (isset($feature_tree->root->children)) {
1265

    
1266
    $form_feature_list_layout = array(
1267
      '#title' => t('Taxon profile layout'),
1268
      '#collapsible' => TRUE,
1269
      '#collapsed' => FALSE,
1270
      '#type' => 'fieldset',
1271
      '#description' => t('Will be available in a future release.'),
1272
    );
1273

    
1274
    $feature_list_layout_settings_disabled = TRUE;
1275
    foreach ($feature_tree->root->children as $featureNode) {
1276

    
1277
      if (!$feature_list_layout_settings_disabled && isset($featureNode->feature)) {
1278
        // Must not exceed 45 characters !!!
1279
        $subform_id = LAYOUT_SETTING_PREFIX . $featureNode->feature->uuid;
1280

    
1281
        $settings = mixed_variable_get($subform_id, FEATURE_TREE_LAYOUT_DEFAULTS);
1282
        $systemDefaults = unserialize(FEATURE_TREE_LAYOUT_DEFAULTS);
1283

    
1284
        $form_feature_list_layout[$subform_id] = array(
1285
          '#tree' => TRUE,
1286
          '#title' => 'test' . $featureNode->feature->representation_L10n,
1287
          '#collapsible' => FALSE,
1288
          '#collapsed' => FALSE,
1289
          '#type' => 'fieldset',
1290
          '#description' => t(''),
1291
        );
1292

    
1293
        $form_feature_list_layout[$subform_id]['enabled'] = array(
1294
          '#type' => 'checkbox',
1295
          '#title' => t('Enable'),
1296
          '#default_value' => $settings['enabled'],
1297
          '#description' => t('Enable user defined layout for this feature'),
1298
        );
1299

    
1300
        $form_feature_list_layout[$subform_id]['enclosingTag'] = array(
1301
          '#type' => 'textfield',
1302
          '#title' => t('Enclosing tag'),
1303
          '#disabled' => !$settings['enabled'],
1304
          '#default_value' => $settings['enclosingTag'],
1305
          '#description' => t('Default is: ') . "'<code>" . $systemDefaults['enclosingTag'] . "</code>'",
1306
        );
1307

    
1308
        $form_feature_list_layout[$subform_id]['entryEnclosingTag'] = array(
1309
          '#type' => 'textfield',
1310
          '#title' => t('Entry enclosing tag'),
1311
          '#disabled' => !$settings['enabled'],
1312
          '#default_value' => $settings['entryEnclosingTag'],
1313
          '#description' => t('Default is: ') . "'<code>" . $systemDefaults['entryEnclosingTag'] . "</code>'",
1314
        );
1315

    
1316
        $form_feature_list_layout[$subform_id]['glue'] = array(
1317
          '#type' => 'textfield',
1318
          '#title' => t('Glue'),
1319
          '#disabled' => !$settings['enabled'],
1320
          '#default_value' => $settings['glue'],
1321
          '#description' => t('Default is: ') . "'<code>" . $systemDefaults['glue'] . "</code>'",
1322
        );
1323

    
1324
      }
1325

    
1326
      $form['taxon_profile']['feature_list_layout'] = $form_feature_list_layout;
1327
    }
1328
  }
1329

    
1330
  // ---- DISTRIBUTION LAYOUT ---- //
1331
  $form['taxon_profile']['distribution_layout'] = array(
1332
    '#title' => t('Distribution'),
1333
    '#collapsible' => TRUE,
1334
    '#collapsed' => FALSE,
1335
    '#type' => 'fieldset',
1336
    '#description' => t('Select if you want to sort or not the distribution text
1337
      located below the distribution map.'),
1338
  );
1339

    
1340
  $form['taxon_profile']['distribution_layout']['distribution_sort'] = array(
1341
    '#type' => 'radios',
1342
    '#title' => t('Sort') . ':',
1343
    '#default_value' => variable_get('distribution_sort', 'NO_SORT'),
1344
    '#options' => array(
1345
      'NO_SORT' => t('Standard (No sort)'),
1346
      'HIDE_TDWG2' => t('Sorted without TDWG Level 2'),
1347
    ),
1348
  );
1349

    
1350
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP] = array(
1351
    '#type' => 'checkbox',
1352
    '#title' => t('Show TextData elements on top of the map'),
1353
    '#default_value' => variable_get(DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP, 0),
1354
    '#description' => t('Check this if you want to appear all <code>TextData</code>
1355
      elements on top of the map. Otherwise all <code>TextData</code>
1356
      distribution elements will be listed below the other area elements.
1357
      This option is useful if you need to have descriptive texts for each
1358
      distribution map.'),
1359
  );
1360

    
1361

    
1362
  /* ====== SYNONYMY ====== */
1363
  $form['taxon_synonymy'] = array(
1364
    '#type' => 'fieldset',
1365
    '#title' => t('Taxon synonymy (tab)'),
1366
    '#collapsible' => TRUE,
1367
    '#collapsed' => TRUE,
1368
    '#description' => t('This section covers the settings related to the taxon
1369
      <strong>synonymy</strong> tab.'),
1370
  );
1371

    
1372
  $form['taxon_synonymy']['cdm_dataportal_nomref_in_title'] = array(
1373
    '#type' => 'checkbox',
1374
    '#title' => t('Show accepted taxon on top of the synonymy'),
1375
    '#default_value' => variable_get('cdm_dataportal_nomref_in_title', CDM_DATAPORTAL_NOMREF_IN_TITLE),
1376
    '#description' => t('If checked, the first homotypic taxon is a repetition
1377
      of the accepted taxon most likely with the full nomenclatural reference
1378
      (depending on the currently chosen theme).'),
1379
  );
1380

    
1381
  $form['taxon_synonymy']['cdm_dataportal_display_is_accepted_for'] = array(
1382
    '#type' => 'checkbox',
1383
    '#title' => t('Display <em>is accepted for ...</em> on taxon pages when
1384
      coming from a synonym link.'),
1385
    '#default_value' => variable_get('cdm_dataportal_display_is_accepted_for', CDM_DATAPORTAL_DISPLAY_IS_ACCEPTED_FOR),
1386
    '#description' => t('Check this if after doing a search and clicking on a
1387
      synonym you want to see the "accept of" text for the accepted synonym.'),
1388
  );
1389

    
1390
  $nameRelationshipTypeOptions = cdm_Vocabulary_as_option(UUID_NAME_RELATIONSHIP_TYPE);
1391
  $form['taxon_synonymy']['name_relationships']['name_relationships_to_show'] = array(
1392
    '#type' => 'checkboxes',
1393
    '#title' => t('Display name relationships') . ':',
1394
    '#default_value' => variable_get('name_relationships_to_show', 0),
1395
    '#options' => $nameRelationshipTypeOptions,
1396
    '#description' => t('Select the name relationships you want to show for the
1397
      accepted taxa.'),
1398
  );
1399

    
1400
  $form['taxon_synonymy'][CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS] = array(
1401
    '#type' => 'checkbox',
1402
    '#title' => t('Show taxon relations ships of accepted taxon'),
1403
    '#default_value' => variable_get(CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS, CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT),
1404
    '#description' => t('If this option is enabled the synonymy will show the
1405
      below selected taxon relationships of accepted taxa.'),
1406
  );
1407

    
1408
  $taxonRelationshipTypeOptions = cdm_Vocabulary_as_option(UUID_TAXON_RELATIONSHIP_TYPE, '_cdm_relationship_type_term_label_callback');
1409
  $form['taxon_synonymy'][CDM_TAXON_RELATIONSHIP_TYPES] = array(
1410
    '#type' => 'checkboxes',
1411
    '#title' => t('Taxon relationship types') . ':',
1412
    '#description' => t('Only taxon relationships of the selected type will be
1413
      displayed'),
1414
    '#options' => $taxonRelationshipTypeOptions,
1415
    '#default_value' => variable_get(CDM_TAXON_RELATIONSHIP_TYPES, unserialize(CDM_TAXON_RELATIONSHIP_TYPES_DEFAULT)),
1416
    '#disabled' => !variable_get(CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS, CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT),
1417
  );
1418

    
1419
  // ====== SPECIMENS ====== //
1420
  $form['taxon_specimens'] = array(
1421
    '#type' => 'fieldset',
1422
    '#title' => t('Taxon specimens (tab)'),
1423
    '#collapsible' => TRUE,
1424
    '#collapsed' => TRUE,
1425
    '#description' => t('This section covers the settings related to the taxon
1426
      <strong>specimens</strong> tab.'),
1427
  );
1428

    
1429
  $featureTrees = cdm_get_featureTrees_as_options(TRUE);
1430
  $saved_uuid = variable_get(CDM_OCCURRENCE_FEATURETREE_UUID, UUID_DEFAULT_FEATURETREE);
1431
  if(!isset($featureTrees['options'][$saved_uuid])) {
1432
    $saved_uuid = UUID_DEFAULT_FEATURETREE;
1433
  }
1434
  $form['taxon_specimens']['feature_trees'][CDM_OCCURRENCE_FEATURETREE_UUID] = array(
1435
      '#type' => 'radios',
1436
      '#title' => t('Specimen description feature tree') . ':',
1437
      '#default_value' => $saved_uuid,
1438
      '#options' =>  $featureTrees['options'],
1439
      '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
1440
      '#options_suffixes' => $featureTrees['treeRepresentations'],
1441
      '#description' => t('Select the feature tree to be used for displaying specimen descriptions. Click "Show Details" to see the Feature Tree elements.'
1442
      ),
1443
  );
1444

    
1445
  $form_name = CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME;
1446
  $form_title = t('Specimen media');
1447
  $form_description = t('Specimens may have media which is displayed at the
1448
     Specimen tab/section as a gallery. It is possible to configure the
1449
     thumbnails gallery here, however for configuring how a single media should
1450
     be displayed please go to !url.</p>',
1451
     array(
1452
       '!url' => l(t('Layout -> Media'), 'admin/config/cdm_dataportal/settings/layout/media'),
1453
     ));
1454
  $form['taxon_specimens'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, FALSE, $form_description);
1455

    
1456
  // --- MEDIA GALLERY ---- //
1457
  $form_name = CDM_DATAPORTAL_TAXON_MEDIA_GALLERY_NAME_TAB;
1458
  $form_title = 'Media gallery (tab)';
1459
  $form_description = '<p>This section covers the settings related to the taxon <strong>media</strong> tab.
1460
   Taxa may have media (usually images) and they are as thumbnails displayed. It is possible to configure
1461
   the thumbnails gallery here, however for configuring how a single media should be displayed please go to
1462
   <a href="./?q=admin/settings/cdm_dataportal/layout/media">Layout -&gt; Media</a></p>
1463
   <p><strong>Note:</strong> These settings are only taken into account when the standard
1464
   gallery viewer is selected at <a href="./?q=admin/settings/cdm_dataportal/layout/media">Layout -&gt; Media</a>.</p>';
1465
  $form['taxon_media'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, TRUE, $form_description);
1466

    
1467
  // Comment @WA: D7 form api does not support reset buttons,
1468
  // so to mimic the D5 reset button we add one like this.
1469
  $form['actions']['reset'] = array(
1470
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1471
    '#weight' => 1000,
1472
  );
1473
  return system_settings_form($form);
1474
}
1475

    
1476
/**
1477
 * @todo document this function.
1478
 */
1479
function cdm_settings_layout_search() {
1480

    
1481
  $form = array();
1482

    
1483
  $form['search_settings'] = array(
1484
    '#type' => 'fieldset',
1485
    '#title' => t('Taxa Search'),
1486
    '#collapsible' => FALSE,
1487
    '#collapsed' => FALSE,
1488
    '#description' => t('<p>The data portal allows the users to perform searchs.</p><p>To perform searchs
1489
         the block <em>CDM Taxon Search</em> should be enabled and visible for users
1490
         where they can write the text to be searched. You can find Drupal block configuration
1491
         site at <a href="./?q=admin/build/block">Administer&#45&#62Site building&#45&#62Blocks</a></p> '),
1492
  );
1493

    
1494
  $form['search_settings']['simple_search_ignore_classification'] = array(
1495
      '#type' => 'checkbox',
1496
      '#title' => t('Ignore the chosen classification in simple search'),
1497
      '#default_value' => variable_get('simple_search_ignore_classification', TRUE),
1498
      '#description' => t('The simple search, which can be executed via the search block,
1499
          will by default search on all classifications. Remove the tick if you want your
1500
          portal to search on the classification selected in the classification browser
1501
          selector.'),
1502
  );
1503

    
1504
  $form['search_settings']['cdm_dataportal_search_items_on_page'] = array(
1505
    '#type' => 'textfield',
1506
    '#title' => t('Results per page') . ':',
1507
    '#default_value' => variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE),
1508
    '#description' => t('Number of results to display per page.'),
1509
  );
1510

    
1511
  $form['search_settings']['cdm_search_taxa'] = array(
1512
    '#type' => 'checkbox',
1513
    '#title' => t('Sets the default value of <em>Search for accepted taxa</em> in the advanced search form.'),
1514
    '#default_value' => variable_get('cdm_search_taxa', 1),
1515
    '#description' => t('<p>If checked the <em>Search for accepted taxa </em> option will be enabled in the advanced form.</p>'),
1516
  );
1517

    
1518
  $form['search_settings']['cdm_search_synonyms'] = array(
1519
    '#type' => 'checkbox',
1520
    '#title' => t('Sets the default value of <em>Search for synonyms</em> in the advanced search form.'),
1521
    '#default_value' => variable_get('cdm_search_synonyms', 1),
1522
    '#description' => t('<p>If checked the <em>Search for synonyms</em> option will be enabled in the advanced form.</p>'),
1523
  );
1524

    
1525
  $form['search_settings']['cdm_search_common_names'] = array(
1526
    '#type' => 'checkbox',
1527
    '#title' => t('Sets the default value of <em>Search for common names</em> in the advanced search form.'),
1528
    '#default_value' => variable_get('cdm_search_common_names', 0),
1529
    '#description' => t('<p>If checked the <em>Search for common names</em> option will be enabled in the advanced form.</p>'),
1530
  );
1531

    
1532
  $form['search_settings']['cdm_search_use_default_values'] = array(
1533
    '#type' => 'checkbox',
1534
    '#title' => t('Sets use of default values in the advanced search form.'),
1535
    '#default_value' => variable_get('cdm_search_use_default_values', 1),
1536
    '#description' => t('<p>If checked the defqult values set abovewill be used for the search.</p>'),
1537
  );
1538

    
1539

    
1540
  // --- SEARCH TAXA GALLERY ---- //
1541
  $items = variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE);
1542
  $collapsed = FALSE;
1543
  $form_name = CDM_DATAPORTAL_SEARCH_GALLERY_NAME;
1544
  $form_title = 'Taxa Search thumbnails';
1545
  $form_description = 'Search results may show thumbnails. ';
1546
  $form[] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description);
1547

    
1548
  // Comment @WA: D7 form api does not support reset buttons,
1549
  // so to mimic the D5 reset button we add one like this.
1550
  $form['actions']['reset'] = array(
1551
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1552
    '#weight' => 1000,
1553
  );
1554
  return system_settings_form($form);
1555
}
1556

    
1557
/**
1558
 * @todo document this function.
1559
 */
1560
function cdm_settings_layout_media() {
1561

    
1562
  $form = array();
1563

    
1564
  $form['media_settings'] = array(
1565
    '#type' => 'fieldset',
1566
    '#title' => t('Media settings'),
1567
    '#collapsible' => FALSE,
1568
    '#collapsed' => FALSE,
1569
    '#description' => 'This section covers layout settings for media pages.'
1570
      . 'Further media related settings may be found under the taxon layout settings and on the general settings.',
1571
  );
1572

    
1573
  $form['media_settings']['image_gallery_viewer'] = array(
1574
    '#type' => 'select',
1575
    '#title' => t('Image viewer') . ':',
1576
    '#default_value' => variable_get('image_gallery_viewer', 'default'),
1577
    '#options' => array(
1578
      'default' => t('Standard image viewer'),
1579
      'fsi' => t('FSI viewer (requires FSI server!)'),
1580
    ),
1581
  );
1582

    
1583
  // --- MEDIA GALLERY ---- //
1584
  $form_name = CDM_DATAPORTAL_MEDIA_GALLERY_NAME;
1585
  $form_title = 'Standard viewer';
1586
  $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>';
1587
  // $form[] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed);
1588
  $form['media_settings'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, FALSE, $form_description);
1589

    
1590
  // @WA: D7 form api does not support reset buttons,
1591
  // so to mimic the D5 reset button we add one like this.
1592
  $form['actions']['reset'] = array(
1593
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1594
    '#weight' => 1000,
1595
  );
1596
  return system_settings_form($form);
1597
}
1598

    
1599
/**
1600
 * GEOSERVICE and Map settings.
1601
 */
1602
function cdm_settings_geo($form, &$form_state) {
1603

    
1604
  $current_geoserver_settings = get_edit_map_service_settings();
1605
  $map_distribution = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
1606
  // The default layer must always be enabled
1607
  $preferred_layer = $map_distribution['openlayers']['base_layers']['PREFERRED'];
1608
  $map_distribution['openlayers']['base_layers'][$preferred_layer] = $preferred_layer;
1609

    
1610
  $form = array();
1611

    
1612
  $dummy_distribution_query = NULL;
1613
  if($map_distribution['map_type'] != 1){
1614
    // we need to apply a dummy query since the map serice requires for image maps
1615
    // at least as and ad to be defined
1616
    $dummy_distribution_query = "as=a:339966&ad=tdwg1:a:1,2,3,4,5,6,7,8,9";
1617
  }
1618
  $form['map_preview'] = array(
1619
      '#type' => 'fieldset',
1620
      '#tree' => FALSE,
1621
      '#title' => t('Map preview'),
1622
      '#collapsible' => FALSE,
1623
      '#description' => 'The preview of the map'
1624
       . ($dummy_distribution_query != null ?
1625
           ' may not be accurate in case if image maps, please check the map display in the taxon pages.':
1626
           '.<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.')
1627
  );
1628
  $form['map_preview']['map'] = compose_map(NULL, $dummy_distribution_query, NULL,
1629
      array(
1630
          'move' => "this.cdmOpenlayersMap.printInfo",
1631
          '#execute' => "this.cdmOpenlayersMap.printInfo"
1632
      )
1633
  );
1634

    
1635

    
1636
  /*
1637
   * GEO SERVER
1638
   */
1639
  $form['edit_map_server'] = array(
1640
    '#type' => 'fieldset',
1641
    '#tree' => true,
1642
    '#title' => t('EDIT map service'),
1643
    '#collapsible' => TRUE,
1644
    '#collapsed' => TRUE,
1645
    '#description' => t('Configuration and selection of your geo server.
1646
      The Geo Server is responsible for generating the maps.'),
1647
  );
1648

    
1649
  $form['edit_map_server']['base_uri'] = array(
1650
    '#type' => 'select',
1651
    '#title' => t('EDIT map service') . ':',
1652
    '#default_value' => $current_geoserver_settings['base_uri'],
1653
    '#options' => unserialize(EDIT_MAPSERVER_URI),
1654
    '#description' => t('Select the EDIT map server you want to use within your data portal.'),
1655
  );
1656
  $form['edit_map_server']['version'] = array(
1657
      '#type' => 'select',
1658
      '#title' => t('Version') . ':',
1659
      '#default_value' => $current_geoserver_settings['version'],
1660
      '#options' => unserialize(EDIT_MAPSERVER_VERSION),
1661
      '#description' => t('The version of the EDIT map services'),
1662
  );
1663

    
1664
  $localhostkey = 'ABQIAAAAFho6eHAcUOTHLmH9IYHAeBRi_j0U6kJrkFvY4-OX2XYmEAa76BTsyMmEq-tn6nFNtD2UdEGvfhvoCQ';
1665
  $gmap_api_key = variable_get('gmap_api_key', 'ABQIAAAAFho6eHAcUOTHLmH9IYHAeBRi_j0U6kJrkFvY4-OX2XYmEAa76BTsyMmEq-tn6nFNtD2UdEGvfhvoCQ');
1666
  $form['gmap_api_key'] = array(
1667
      '#type' => 'textfield',
1668
      '#title' => t('Google maps API key') . ':',
1669
      '#default_value' => variable_get('gmap_api_key', $gmap_api_key),
1670
      '#description' => t('If you want to use the Google Maps Layer, a key is
1671
      needed. If you need a key, visit
1672
      <a href="http://code.google.com/intl/en/apis/maps/signup.html">google maps api key</a>.
1673
      <br/><strong>Note:</strong> The following key: <code>!localhostkey</code>
1674
      is the default key for the localhost (127.0.0.1).',
1675
      array('!localhostkey' => $localhostkey)),
1676
  );
1677

    
1678

    
1679
  /*
1680
   * MAP SETTINGS
1681
   */
1682

    
1683
  $form[CDM_MAP_DISTRIBUTION] = array(
1684
    '#type' => 'fieldset',
1685
    '#tree' => TRUE,
1686
    '#title' => t('Maps settings'),
1687
    '#collapsible' => TRUE,
1688
    '#collapsed' => TRUE,
1689
    '#description' => t('General configuration for all map types.'),
1690
  );
1691

    
1692
  /*
1693
   * settings for the distribution map are used also for specimens map!!!!
1694
   */
1695

    
1696
  $form[CDM_MAP_DISTRIBUTION]['width'] = array(
1697
    '#type' => 'textfield',
1698
    '#title' => 'Width',
1699
    '#default_value' => $map_distribution['width'],
1700
    '#maxlength' => 4,
1701
    '#size' => 4,
1702
    '#description' => 'Width of the map. To allow OSM baselayers to zoom out to the full extend of the world the map width must be
1703
      a multiple of 256px since the osm tiles from tile.openstreetmap.org have a size of 256px x 256px and frational zoom
1704
      levels are not possible in this case.',
1705
  );
1706
  $form[CDM_MAP_DISTRIBUTION]['height'] = array(
1707
      '#type' => 'textfield',
1708
      '#title' => 'Height',
1709
      '#default_value' => $map_distribution['height'],
1710
      '#maxlength' => 4,
1711
      '#size' => 4,
1712
      '#description' => 'Height of the map. Depending on the chosen base layer you may want to choose the height equal
1713
      to the width or half of the width. Any other aspect ratio is also possible if desired.',
1714
  );
1715

    
1716
  $form[CDM_MAP_DISTRIBUTION]['bbox'] = array(
1717
    '#type' => 'textfield',
1718
    '#title' => 'Bounding box',
1719
    '#default_value' => $map_distribution['bbox'],
1720
    '#description' => t('The bounding box defines the area to be initially displayed in maps.
1721
      Use "-180,-90,180,90" for the whole world. Leave <strong>empty</strong>
1722
      to let the map <strong>automatically zoom</strong> to the bounds enclosing the shown data.</p>
1723
      <strong>TIP: </strong>You can use the map preview above to choose a bbox from the map. Maybe you need to change the map type to OpeLayers.
1724
      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
1725
      below the map from where you can copy the bbox string.</p>'),
1726
  );
1727

    
1728
  $form[CDM_MAP_DISTRIBUTION]['show_labels'] = array(
1729
    '#type' => 'checkbox',
1730
    '#title' => 'Display area labels',
1731
    '#default_value' => $map_distribution['show_labels'],
1732
    '#description' => t('The map will show name labels of the areas'),
1733
  );
1734

    
1735
  $form[CDM_MAP_DISTRIBUTION]['caption'] = array(
1736
    '#type' => 'textfield',
1737
    '#title' => 'Map caption',
1738
    '#default_value' => $map_distribution['caption'],
1739
    '#description' => t('The caption will be shown below the map.'),
1740
  );
1741

    
1742
  $form[CDM_MAP_DISTRIBUTION]['distribution_opacity'] = array(
1743
    '#type' => 'textfield',
1744
    '#title' => 'Distribution layer opacity',
1745
    '#default_value' => $map_distribution['distribution_opacity'],
1746
    '#description' => t('Valid values range from 0.0 to 1.0. Value 1.0 means the distributions (the countries or regions) will
1747
                           fully visible, while a value near to 0.0 will be not much visible.'),
1748
  );
1749

    
1750
  $form[CDM_MAP_DISTRIBUTION]['map_type'] = array(
1751
    '#type' => 'radios',
1752
    '#title' => 'Map types',
1753
    '#options' => array(
1754
      1 => "OpenLayers dynamic map viewer",
1755
      0 => "Plain image",
1756
    ),
1757
    '#default_value' => $map_distribution['map_type'],
1758
    '#description' => 'Two different map types are available :
1759
      <ul><li><em>OpenLayers</em>: Display the maps in an interactive viewer
1760
      which allows zooming and panning. If enabled you can configure the default layer
1761
      (background of your maps) below.</li>
1762
      <li><em>Plain image</em>: The map will be static non interactive
1763
      image.</li></ul>',
1764
  );
1765
  $open_layers_is_enabled = $map_distribution['map_type'] == 1;
1766

    
1767

    
1768
  // --- Plain Image Settings --- //
1769
  $form[CDM_MAP_DISTRIBUTION]['image_map'] = array(
1770
    '#type' => 'fieldset',
1771
    '#title' => 'Plain image map settings',
1772
    '#tree' => TRUE,
1773
    '#collapsible' => TRUE,
1774
    '#collapsed' => $open_layers_is_enabled,
1775
    '#description' => 'The settings in this section are still expertimental
1776
      and can only be used with the EDIT map service version 1.1 or above.',
1777
  );
1778
  $edit_mapserver_version = get_edit_map_service_version_number();
1779
  if ($edit_mapserver_version < 1.1) {
1780
    $form[CDM_MAP_DISTRIBUTION]['image_map']['#description'] = '<div class="messages warning">' . t("The chosen EDIT map service version ($edit_mapserver_version) is too low, it must be at least 1.1") . '</div>'
1781
      . $form[CDM_MAP_DISTRIBUTION]['image_map']['#description'];
1782
  }
1783

    
1784
  $form[CDM_MAP_DISTRIBUTION]['image_map']['base_layer'] = array(
1785
    '#type' => 'textfield',
1786
    '#title' => 'Background layer',
1787
    '#default_value' => $map_distribution['image_map']['base_layer'],
1788
    '#description' => t('Background layer. For available layers inspect !url1 or !url2.', array(
1789
      '!url1' => l('deegree-csw', 'http://edit.africamuseum.be:8080/deegree-csw/md_search.jsp'),
1790
      '!url2' => l('geoserver layers', 'http://edit.africamuseum.be/geoserver/web/'),
1791
    )),
1792
  );
1793

    
1794
  $form[CDM_MAP_DISTRIBUTION]['image_map']['bg_color'] = array(
1795
    '#type' => 'textfield',
1796
    '#title' => 'Background color',
1797
    '#default_value' => $map_distribution['image_map']['bg_color'],
1798
  );
1799

    
1800
  $form[CDM_MAP_DISTRIBUTION]['image_map']['layer_style'] = array(
1801
    '#type' => 'textfield',
1802
    '#title' => 'Background layer style',
1803
     // Only line color by now.
1804
    '#default_value' => $map_distribution['image_map']['layer_style'],
1805
    '#description' => 'Syntax: {Area fill color},{Area stroke color},{Area stroke width},{Area stroke dash style}',
1806
  );
1807

    
1808

    
1809
  // --- OpenLayers Settings --- //
1810
  $form[CDM_MAP_DISTRIBUTION]['openlayers'] = array(
1811
    '#type' => 'fieldset',
1812
    '#title' => 'OpenLayers settings',
1813
    '#tree' => TRUE,
1814
    '#collapsible' => TRUE,
1815
    '#collapsed' => !$open_layers_is_enabled,
1816
    '#description' => '',
1817
  );
1818

    
1819

    
1820
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['display_outside_max_extent'] = array(
1821
      '#type' => 'checkbox',
1822
      '#title' => 'Display outside max extent',
1823
      '#default_value' => $map_distribution['openlayers']['display_outside_max_extent'],
1824
      '#description' => t('Allows the map to display parts of the layers which are outside
1825
         the max extent if the aspect ratio of the map and of the baselayer
1826
         are not equal.'),
1827
  );
1828

    
1829
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['show_layer_switcher'] = array(
1830
      '#type' => 'checkbox',
1831
      '#title' => 'Show Layer Switcher',
1832
      '#default_value' => $map_distribution['openlayers']['show_layer_switcher'],
1833
      '#description' => 'The Layer Switcher control displays a table of contents
1834
      for the map.  This allows the user interface to switch between
1835
      base layers and to show or hide overlays.  By default the switcher is
1836
      shown minimized on the right edge of the map, the user may expand it
1837
      by clicking on the handle.',
1838
  );
1839

    
1840
  if (!$open_layers_is_enabled) {
1841
    $form[CDM_MAP_DISTRIBUTION]['openlayers']['#description'] = '<div class="messages warning">'
1842
        . 'The Openlayers viewer is currently not enabled! (see section Maps settings above )</div>'
1843
        . $form[CDM_MAP_DISTRIBUTION]['openlayers']['#description'];
1844
  }
1845

    
1846
  $baselayer_options = array(
1847
    /*
1848
   NOTICE: must correspond to the layers defined in
1849
   js/openlayers_,ap.js#getLayersByName()
1850
   */
1851
    'osgeo_vmap0' => "Metacarta Vmap0 (OSGeo server)", // EPSG:4326: EPSG:900913
1852
    'metacarta_vmap0' => "Metacarta Vmap0 (MetaCarta Labs server)", // EPSG:4326, EPSG:900913
1853
    // all others EPSG:900913
1854
    // 'edit-vmap0_world_basic' => 'EDIT Vmap0',
1855
    'edit-etopo1' => "ETOPO1 Global Relief Model",
1856
    'mapnik' => 'OpenStreetMap',
1857
    'mapquest_open' => "MapQuest",
1858
    'mapquest_sat' => "MapQuest Sattelite",
1859
//     'osmarender' => 'OpenStreetMap (Tiles@home)',
1860
    'gmap' => 'Google Streets',
1861
    'gsat' => 'Google Satellite',
1862
    'ghyb' => 'Google Hybrid',
1863
//     'veroad' => 'Virtual Earth Roads',
1864
//     'veaer' => 'Virtual Earth Aerial',
1865
//     'vehyb' => 'Virtual Earth Hybrid',
1866
    // 'yahoo' => 'Yahoo Street',
1867
    // 'yahoosat' => 'Yahoo Satellite',
1868
    // 'yahoohyb' => 'Yahoo Hybrid',
1869
     'custom_wms_base_layer_1' => 'Custom WMS base layer (needs to be manually configured below!)',
1870
  );
1871

    
1872
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['base_layers'] = array(
1873
    '#type' => 'checkboxes_preferred',
1874
    '#title' => 'Base Layers',
1875
    '#options' => $baselayer_options,
1876
    '#default_value' =>  $map_distribution['openlayers']['base_layers'],
1877
    '#description' => 'Choose the baselayer layer you prefer to use as map background in the OpenLayers dynamic mapviewer.',
1878
  );
1879

    
1880
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer'] = array(
1881
      '#type' => 'fieldset',
1882
      '#title' => 'Custom WMS base layer',
1883
      '#tree' => TRUE,
1884
      '#collapsible' => FALSE,
1885
      '#collapsed' => FALSE,
1886
      '#description' => 'Here you an define a custom wms layer as additional base layer.',
1887
  );
1888

    
1889
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['name'] = array(
1890
      '#type' => 'textfield',
1891
      '#title' => 'Layer name',
1892
      // Only line color by now.
1893
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['name'],
1894
      '#description' => 'A arbitrary name for the layer.',
1895
  );
1896
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['url'] = array(
1897
      '#type' => 'textfield',
1898
      '#title' => 'WMS url',
1899
      // Only line color by now.
1900
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['url'],
1901
      '#description' => 'Base url for the WMS (e.g.  http://wms.jpl.nasa.gov/wms.cgi)'
1902
  );
1903
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['params'] = array(
1904
      '#type' => 'textarea',
1905
      '#title' => 'WMS parameters',
1906
      '#element_validate' => array('form_element_validate_json'),
1907
      // Only line color by now.
1908
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['params'],
1909
      '#description' => 'An javasript object with key/value pairs representing the GetMap query string parameters and parameter values, entered in valid JSON.'
1910
  );
1911
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['projection'] = array(
1912
      '#type' => 'textfield',
1913
      '#title' => 'Projection',
1914
      // Only line color by now.
1915
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['projection'],
1916
      '#description' => 'The desired projection for the layer (e.g. EPSG:4326, EPSG:900913, EPSG:3857)'
1917
  );
1918
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['max_extent'] = array(
1919
      '#type' => 'textfield',
1920
      '#title' => 'Maximum extent',
1921
      // Only line color by now.
1922
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['max_extent'],
1923
      '#description' => 'The maximum extent of the map as boundin box in the units of the map.'
1924
  );
1925
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer']['units'] = array(
1926
      '#type' => 'textfield',
1927
      '#title' => 'Units',
1928
      '#default_value' => $map_distribution['openlayers']['custom_wms_base_layer']['units'],
1929
      '#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.'
1930
  );
1931

    
1932
  /*
1933
   * Map Legend
1934
   */
1935
  $form[CDM_MAP_DISTRIBUTION]['legend'] = array(
1936
    '#type' => 'fieldset',
1937
    '#title' => 'Map legend',
1938
    '#tree' => TRUE,
1939
    '#collapsible' => TRUE,
1940
    '#collapsed' => TRUE,
1941
    '#description' => 'Configure the maps legend.',
1942
  );
1943

    
1944
  $form[CDM_MAP_DISTRIBUTION]['legend']['show'] = array(
1945
    '#type' => 'checkbox',
1946
    '#title' => 'Display a map legend',
1947
    '#default_value' => $map_distribution['legend']['show'],
1948
    '#description' => 'Check this if you like a legend to be displayed with the maps.',
1949
  );
1950

    
1951
  $form[CDM_MAP_DISTRIBUTION]['legend']['opacity'] = array(
1952
    '#type' => 'textfield',
1953
    '#title' => 'Legend opacity',
1954
    '#default_value' => $map_distribution['legend']['opacity'],
1955
    '#description' => 'Valid values range from 0.0 to 1.0. Value 1.0 means the legend will be fully visible, while a value near
1956
                         to 0.0 will be not much visible.',
1957
  );
1958

    
1959
  $form[CDM_MAP_DISTRIBUTION]['legend']['font_size'] = array(
1960
    '#type' => 'textfield',
1961
    '#title' => 'Font size',
1962
    '#default_value' => $map_distribution['legend']['font_size'],
1963
    '#description' => 'Font size in pixels.',
1964
  );
1965

    
1966
  $fontStyles = array(
1967
    0 => "plane",
1968
    1 => "italic",
1969
  );
1970
  $form[CDM_MAP_DISTRIBUTION]['legend']['font_style'] = array(
1971
    '#type' => 'select',
1972
    '#title' => 'Available font styles',
1973
    '#default_value' => $map_distribution['legend']['font_style'],
1974
    '#options' => $fontStyles,
1975
    '#description' => 'Select a font style for the map legend.',
1976
  );
1977

    
1978
  $form[CDM_MAP_DISTRIBUTION]['legend']['icon_width'] = array(
1979
    '#type' => 'textfield',
1980
    '#title' => 'Icon width',
1981
    '#default_value' => $map_distribution['legend']['icon_width'],
1982
    '#description' => 'Legend icon width in pixels.',
1983
  );
1984
  $form[CDM_MAP_DISTRIBUTION]['legend']['icon_height'] = array(
1985
    '#type' => 'textfield',
1986
    '#title' => 'Icon height',
1987
    '#default_value' => $map_distribution['legend']['icon_height'],
1988
    '#description' => 'Legend icon height in pixels.',
1989
  );
1990

    
1991
  // @WA: D7 form api does not support reset buttons,
1992
  // so to mimic the D5 reset button we add one like this.
1993
  $form['actions']['reset'] = array(
1994
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1995
    '#weight' => 1000,
1996
  );
1997

    
1998
  return system_settings_form($form);
1999
}
2000

    
2001
/**
2002
 * @todo document this function.
2003
 */
2004
function cdm_settings_cache() {
2005

    
2006
  $form = array();
2007

    
2008
  $form['cache_settings'] = array(
2009
    '#type' => 'fieldset',
2010
    '#title' => t('Cache Settings'),
2011
    '#collapsible' => FALSE,
2012
    '#collapsed' => FALSE,
2013
    '#description' => t('<p>When caching is enabled all single taxon sites are
2014
      stored in an internal drupal cache doing the portal response of taxa pages
2015
      faster. This is possible because the sites are loaded from the cache and
2016
      are not created from scratch.</p>'),
2017
  );
2018

    
2019
  $form['cache_settings']['cdm_webservice_cache'] = array(
2020
    '#type' => 'checkbox',
2021
    '#title' => t('<strong>Enable caching</strong>'),
2022
    '#options' => cdm_help_general_cache(),
2023
    '#default_value' => variable_get('cdm_webservice_cache', 1),
2024
    '#description' => t('<p>Enable drupal to load taxa pages from the cache.</p>
2025
       <p><strong>Note:</strong> If taxa are modified by the editor or any other
2026
       application the changes will be not visible till the cache is erased.
2027
       Therefore developers should deactived this feature when they are working
2028
       on the CDM Dataportal Module.</p>'),
2029
  );
2030

    
2031
  $form['cache_settings']['cdm_run_cache'] = array(
2032
    '#markup' => cdm_view_cache_site(),
2033
  );
2034

    
2035
  // @WA: D7 form api does not support reset buttons,
2036
  // so to mimic the D5 reset button we add one like this.
2037
  $form['actions']['reset'] = array(
2038
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
2039
    '#weight' => 1000,
2040
  );
2041
  return system_settings_form($form);
2042
}
2043

    
2044
/**
2045
 * Walk and cache all taxon pages.
2046
 */
2047
function cdm_view_cache_site() {
2048

    
2049
  $out = '';
2050

    
2051
  drupal_add_js(drupal_get_path('module', 'cdm_dataportal') . '/js/cache_all_taxa.js');
2052

    
2053
  $request_params = array();
2054
  $request_params['class'] = "Taxon";
2055

    
2056
  $cdm_ws_page_taxa_url = cdm_compose_url(CDM_WS_TAXON . ".json", NULL, queryString($request_params));
2057
  $cdm_ws_page_taxa_url = uri_uriByProxy($cdm_ws_page_taxa_url);
2058
  $cdm_ws_page_taxa_url = rtrim($cdm_ws_page_taxa_url, '/');
2059

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

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

    
2069
  // Comment @WA: A form within a form is not valid html and not needed here.
2070
  // Also, it would be recommended just to include this part of the form in the
2071
  // rest of the form array in cdm_settings_cache().
2072
  // $out .= '<form id="cache_site">';
2073
  $out .= '<input type="hidden" name="pageTaxaUrl" value="' . $cdm_ws_page_taxa_url . '"/>';
2074
  $out .= '<input type="hidden" name="taxonPageUrl" value="' . url('cdm_dataportal/taxon/') . '"/>';
2075
  $out .= '<input type="button" name="start" value="' . t('Start') . '"/>';
2076
  $out .= '<input type="button" name="stop" value="' . t('Stop') . '"/>';
2077
  // $out .= '</form>';
2078
  $out .= '</div>';
2079
  /*
2080
  foreach($taxonPager->records as $taxon){
2081
    cdm_dataportal_taxon_view($uuid);
2082
  }
2083
  */
2084
  return $out;
2085
}
2086

    
2087

    
2088
function cdm_settings_layout_taxon_submit($form, &$form_state){
2089
  if (isset($form_state['values'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'])) {
2090
    $file = file_load($form_state['values'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid']);
2091
    if(is_object($file)){
2092
      $file->status = FILE_STATUS_PERMANENT;
2093
      file_save($file);
2094
      file_usage_add($file, 'cdm_dataportal', CDM_TAXON_PROFILE_IMAGE, 0);
2095
    }
2096
  }
2097
  // rebuild the menu if the show tabs setting has changed, otherwise the change will not have a consistent effect
2098
  if(variable_get('cdm_dataportal_taxonpage_tabs', 1) != $form_state['values']['cdm_dataportal_taxonpage_tabs']){
2099
    // we first need to set the variable to persist the changes setting
2100
    variable_set('cdm_dataportal_taxonpage_tabs', $form_state['values']['cdm_dataportal_taxonpage_tabs']);
2101
    menu_rebuild();
2102
  }
2103
}
2104

    
2105
/**
2106
 * Form validation handler for cdm_settings_general
2107
 *
2108
 * Comment @WA: currently this handler is not used.
2109
 * It seems partly for cdm_settings_general en partly for cdm_settings_cache?
2110
 * Then you can change the name into cdm_settings_general_validate() or
2111
 * cdm_settings_cache_validate().
2112
 * But cdm_api_secref_cache_clear is not doing anything (yet)?
2113
 */
2114
function cdm_settings_general_validate($form, &$form_state) {
2115

    
2116
  if (!str_endsWith($form_state['values']['cdm_webservice_url'], '/')) {
2117
    $form_state['values']['cdm_webservice_url'] .= '/';
2118
  }
2119

    
2120
}
2121

    
2122
/**
2123
 * Form validation handler for cdm_settings_cache
2124
 */
2125
function cdm_settings_cache_validate() {
2126
  if ($form_state['values']['cdm_webservice_cache'] != variable_get('cdm_webservice_cache', 1)) {
2127
    cache_clear_all(NULL, 'cache_cdm_ws');
2128
    // Better clear secref_cache since I can not be sure if the cache has not
2129
    // be used during this response.
2130
    cdm_api_secref_cache_clear();
2131
  }
2132

    
2133
}
2134

    
2135
/**
2136
 * Returns an associative array of the currently chosen settings for the EDIT map service or the defaults as
2137
 * specified in EDIT_MAPSERVER_URI_DEFAULT and EDIT_MAPSERVER_VERSION_DEFAULT:
2138
 *  - base_uri: the protocol and host part , e.g.: http://edit.africamuseum.be
2139
 *  - version: the version, e.g.: v1.1
2140
 *
2141
 * @return array
2142
 *    An associative array of the currently chosen settings for the EDIT map service or the defaults.
2143
 */
2144
function get_edit_map_service_settings() {
2145

    
2146
  $settings = variable_get('edit_map_server', array(
2147
      'base_uri' => EDIT_MAPSERVER_URI_DEFAULT,
2148
      'version' => EDIT_MAPSERVER_VERSION_DEFAULT
2149
      )
2150
  );
2151
  // replace old non tree like settings by default
2152
  // TODO to be removed after release 3.1.5
2153
  if(!is_array($settings)){
2154
    variable_del('edit_map_server');
2155
    return get_edit_map_service_settings();
2156
  }
2157

    
2158
  return $settings;
2159
}
2160

    
2161
/**
2162
 * Returns the full edit map service URI e.g.: http://edit.africamuseum.be/edit_wp5/v1.1
2163
 *
2164
 * @return string
2165
 *   The full edit map service URI e.g.: http://edit.africamuseum.be/edit_wp5/v1.1
2166
 */
2167
function get_edit_map_service_full_uri() {
2168
  $settings = get_edit_map_service_settings();
2169
  return $settings['base_uri'] . EDIT_MAPSERVER_PATH .  '/' . $settings['version'];
2170
}
2171

    
2172

    
2173
/**
2174
 * Returns the version number of the currently selected edit mapserver as a float
2175
 *
2176
 * @return float
2177
 *   The version number of the currently selected edit mapserver as a float.
2178
 *   Returns 0 on error.
2179
 */
2180
function get_edit_map_service_version_number() {
2181

    
2182
  $pattern = '/v([\d\.]+).*$/';
2183

    
2184
  $settings = get_edit_map_service_settings();
2185
  preg_match($pattern, $settings['version'], $matches, PREG_OFFSET_CAPTURE);
2186
  if (isset($matches[1])) {
2187
    // Convert string to float.
2188
    $version = 1 + $matches[1][0] - 1;
2189
    return $version;
2190
  }
2191
  else {
2192
    // Report error.
2193
    drupal_set_message(t(" Invalid EDIT map service version number: '!version'",
2194
        array(
2195
          '!version' => $settings['version'],
2196
          'warning')
2197
        )
2198
      );
2199
    return 0;
2200
  }
2201
}
2202

    
2203
/**
2204
 * Returns the array of selected items in a options array
2205
 *
2206
 * @param array $options
2207
 *   An options array as generated by a form element like checkoxes, select ...,
2208
 */
2209
function get_selection($options) {
2210
  $selection = array();
2211
  foreach ($options as $key=>$val) {
2212
    if (!empty($val)) {
2213
      $selection[] = $val;
2214
    }
2215
  }
2216
  return $selection;
2217
}
2218

    
2219

    
2220
/**
2221
 * Implements hook_element_info().
2222
 *
2223
 * Allows modules to declare their own Form API element types and specify their default values.
2224
 *
2225
 * @see http://api.drupal.org/api/drupal/modules!system!system.api.php/function/hook_element_info/7
2226
 */
2227
function cdm_dataportal_element_info() {
2228
  $type['checkboxes_preferred'] = array(
2229
    '#input' => TRUE,
2230
    '#process' => array('checkboxes_preferred_expand'),
2231
    '#after_build' => array('checkboxes_preferred_after_build'),
2232
    '#theme' => array('checkboxes_preferred'),
2233
    // '#theme_wrapper' => array('form_element'),
2234
  );
2235
  return $type;
2236
}
2237

    
2238
/**
2239
 * #process callback function for the custom form element type 'checkbox_preferred'
2240
 *
2241
 *
2242
 */
2243
function checkboxes_preferred_expand($element, &$form_state, $form) {
2244

    
2245
  // First of all create checkboxes for each of the elements
2246
  $element = form_process_checkboxes($element);
2247

    
2248
  // compose the element name
2249
  $parents = array();
2250
  array_deep_copy($element['#parents'], $parents);
2251
  $parents[count($parents) -1 ] .= '_preferred';
2252
  $element_name = $parents[0];
2253
  for ($i=1; $i < count($parents); $i++){
2254
    $element_name .= '[' . $parents[$i] . ']';
2255
  }
2256

    
2257
  $children = element_children($element);
2258

    
2259
  $element['table_start'] = array(
2260
    '#markup' => '<table class="checkboxes_preferred"><tr><th></th><th>' . t('Enabled') . '</th><th>' . t('Default') . '</th></tr>',
2261
    '#weight' => -1,
2262
  );
2263

    
2264
  // prepare first part each of the table rows which contains the row label
2265
  $weight = 0;
2266
  foreach ($children as $key) {
2267
    $odd_even = $weight % 4 == 0 ? 'odd' : 'even';
2268
    $element[$key]['#weight'] = $weight;
2269
    $element[$key]['#prefix'] = '<tr class="' . $odd_even . '"><td>' . t($element['#options'][$key]) . '</td><td>';
2270
    $element[$key]['#suffix'] = '</td>';
2271
    unset($element[$key]['#title']);
2272
    $weight += 2;
2273
  }
2274
  $weight = 0;
2275

    
2276
  // add a radio button to each of the checkboxes, the
2277
  // check boxes have already been created at the beginning
2278
  // of this function
2279
  if (count($element['#options']) > 0) {
2280
    foreach ($element['#options'] as $key => $choice) {
2281
      if (!isset($element[$key . '_preferred'])) {
2282
        $element[$key . '_preferred'] = array(
2283
          '#type' => 'radio',
2284
          '#name' => $element_name,
2285
          '#return_value' => check_plain($key),
2286
          '#default_value' => empty($element['#default_value_2']) ? NULL : $element['#default_value_2'],
2287
          '#attributes' => $element['#attributes'],
2288
          '#parents' => $element['#parents'],
2289
          // '#spawned' => TRUE,
2290
          '#weight' => $weight + 1,
2291
          '#prefix' => '<td>',        // add a prefix to start a new table cell
2292
          '#suffix' => '</td></tr>',  // add a prefix to close the tabel row
2293
        );
2294
      }
2295
      $weight += 2;
2296
    }
2297
  }
2298

    
2299
  // end the table
2300
  $element['table_end'] = array(
2301
    '#markup' => '</table>',
2302
    '#weight' => $weight++,
2303
  );
2304

    
2305
  return $element;
2306
}
2307

    
2308
/**
2309
 * Theme function for the custom form field 'checkboxes_preferred'.
2310
 */
2311
function theme_checkboxes_preferred($variables) {
2312
  $element = $variables['element'];
2313
  $out = '<div id="edit-baselayers-wrapper" class="form-item">';
2314
  $out .= '<label for="edit-baselayers">' . $element['#title'] . '</label>';
2315
  $out .= drupal_render_children($element);
2316
  $out .= '<div class="description">' . $element['#description'] . '</div>';
2317
  $out .= '</div>';
2318
  return $out;
2319
}
2320

    
2321
/**
2322
 * Callback for checkboxes preferred for widget which will
2323
 * be called after the form or element is built. The call
2324
 * back is configured in the form element by setting it as
2325
 * #after_build parameter.
2326
 *
2327
 * @see http://api.drupal.org/api/drupal/developer!topics!forms_api_reference.html/7#after_build
2328
 *
2329
 * @param $element
2330
 *   Nested array of form elements that comprise the form.
2331
 * @param $form_state
2332
 *   A keyed array containing the current state of the form.
2333
 *   This includes the current persistent storage data for the form.
2334
 *   Additional information, like the sanitized $_POST data,
2335
 *   is also accumulated here in $form_state['input']
2336
 *
2337
 * @return the modified form array
2338
 */
2339
function checkboxes_preferred_after_build($element, &$form_state) {
2340

    
2341
  $parent_id = $element['#parents'][count($element['#parents']) - 1];
2342

    
2343
  if ($_POST && count($_POST) > 0) {
2344
    // TODO use  $form_state['input'] instead of POST !!!
2345
    // First pass of form processing.
2346
    $parents = array();
2347
    array_deep_copy($element['#parents'], $parents);
2348
    $parents[count($parents) - 1] .= '_preferred';
2349
    $preferred_layer = drupal_array_get_nested_value($_POST, $parents);
2350
    $element['#value']['PREFERRED'] = $preferred_layer;
2351
//     $form_state[$parent_id] = $element['#value'];
2352
//     $form_state['values']['baselayers'] = $element['#value'];
2353
    $form_state_element_values = &drupal_array_get_nested_value($form_state['values'], $element['#parents']);
2354
    $form_state_element_values = $element['#value'];
2355
  }
2356
  else {
2357
    // Second pass of form processing.
2358
    $preferred_layer = $element['#value']['PREFERRED'];
2359
  }
2360

    
2361
  // Also set the chosen value (not sure if this is good Drupal style ....).
2362
  foreach ($children = element_children($element) as $key) {
2363
    if (!empty($element[$key]['#type']) && $element[$key]['#type'] == 'radio') {
2364
      $element[$key]['#value'] = $preferred_layer;
2365
    }
2366
  }
2367
  // The default layer must always be enabled.
2368
  $element[$preferred_layer]['#value'] = $preferred_layer;
2369

    
2370
  return $element;
2371
}
2372

    
2373
function radios_prepare_options_suffix(&$elements){
2374

    
2375
  $childrenKeys = element_children($elements);
2376
  foreach($childrenKeys as $key){
2377
    if(!is_array($elements[$key]['#theme_wrappers'])){
2378
      $elements[$key]['#theme_wrappers'] = array();
2379
    }
2380
    if(isset($elements['#options_suffixes'][$key])){
2381
      $elements[$key]['#theme_wrappers'][] = 'radio_options_suffix';
2382
      $elements[$key]['#options_suffix'] = $elements['#options_suffixes'][$key];
2383
    }
2384
  }
2385
  return $elements;
2386

    
2387
}
2388

    
2389
/**
2390
 * TODO
2391
 * @param unknown $variables
2392
 */
2393
function theme_radio_options_suffix($variables) {
2394
  $element = $variables['element'];
2395
  if(isset($element['#options_suffix'])) {
2396
    $element['#children'] .= $element['#options_suffix'];
2397
  }
2398
  return $element['#children'];
2399
}
2400

    
2401

    
2402
/**
2403
 * Element validate callback for text field and arrays containing json.
2404
 *
2405
 * @param $element
2406
 *   The form element to validate
2407
 * @param $form_state
2408
 *   A keyed array containing the current state of the form.
2409
 * @param $form
2410
 *   Nested array of form elements that comprise the form.
2411
 */
2412
function form_element_validate_json($element, &$form_state, $form) {
2413
   if (!empty($element['#value'])) {
2414
     json_decode($element['#value']);
2415
     if(json_last_error() != JSON_ERROR_NONE){
2416
       form_error($element, t('The form element %title contains invalid JSON. You can check the syntax with ', array('%title' => $element['#title'])) . l('JSONLint', 'http://jsonlint.com/'));
2417
     }
2418
   }
2419
}
2420

    
2421
/**
2422
 * Form submission handler for textareas and textfields containing JSON.
2423
 *
2424
 * The contained JSON will be converted into an php array
2425
 * or object and will be stored in the variables as such.
2426
 *
2427
 * @see http://api.drupal.org/api/drupal/developer!topics!forms_api_reference.html/7#submit
2428
 *
2429
 * @param $form
2430
 *   Nested array of form elements that comprise the form.
2431
 * @param $form_state
2432
 *   A keyed array containing the current state of the form.
2433
 *
2434
 */
2435
function submit_json_as_php_array($form, &$form_state) {
2436
  if (is_array($form['#json_elements'])) {
2437
    foreach ($form['#json_elements'] as $element){
2438
      if (trim($form_state['values'][$element])) {
2439
        $form_state['values'][$element] = (array) json_decode($form_state['values'][$element]);
2440
      } else {
2441
        $form_state['values'][$element] = NULL;
2442
      }
2443
    }
2444
  }
2445
}
(14-14/14)