Project

General

Profile

Download (96.2 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://localhost:8080/cichorieae/"</em> The URL <strong>must end
508
      with a slash</strong> character!'),
509
    '#default_value' => variable_get('cdm_webservice_url', NULL),
510
  );
511

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

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

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

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

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

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

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

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

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

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

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

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

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

    
632
  );
633

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

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

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

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

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

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

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

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

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

    
720
  return system_settings_form($form);
721
}
722

    
723

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

    
731
  $form = array();
732

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

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

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

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

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

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

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

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

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

    
821
  //TODO remove after all portals are using the settings
822
  $default_part_definitions = theme('get_partDefinition', array());
823
  if(!is_array($default_part_definitions)) {
824
    $default_part_definitions = unserialize(CDM_PART_DEFINITIONS_DEFAULT);
825
  }
826

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

    
914
  //TODO remove after all portals are using the settings
915
  $default_render_templates = theme('get_nameRenderTemplate', array());
916
  if(!is_array($default_render_templates)) {
917
    $default_render_templates = unserialize(CDM_NAME_RENDER_TEMPLATES_DEFAULT);
918
  }
919

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

    
958
  // @WA: D7 form api does not support reset buttons,
959
  // so to mimic the D5 reset button we add one like this.
960
  $form['actions']['reset'] = array(
961
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
962
    '#weight' => 1000,
963
  );
964

    
965
  $form['#submit'] = array('submit_json_as_php_array');
966
  // #json_elements especially defined for submit_json_as_php_array()
967
  $form['#json_elements'] = array(CDM_NAME_RENDER_TEMPLATES, CDM_PART_DEFINITIONS);
968
  return system_settings_form($form);
969
}
970

    
971

    
972
/**
973
 * @todo Please document this function.
974
 * @see http://drupal.org/node/1354
975
 */
976
function cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description = '') {
977
  $form[$form_name] = array(
978
    '#type' => 'fieldset',
979
    '#title' => t($form_title),
980
    '#collapsible' => TRUE,
981
    '#collapsed' => $collapsed,
982
    '#tree' => TRUE,
983
    '#description' => t($form_description),
984
  );
985

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

    
1005
    $form[$form_name]['cdm_dataportal_show_synonym_thumbnails'] = array(
1006
      '#type' => 'checkbox',
1007
      '#title' => t('Show media thumbnails for synonyms'),
1008
      '#default_value' => $gallery_settings['cdm_dataportal_show_synonym_thumbnails'],
1009
      '#description' => '',
1010
    );
1011
  }
1012

    
1013
  // $showCaption = variable_get('cdm_dataportal_findtaxa_show_thumbnail_captions', 0);
1014
  $form[$form_name]['cdm_dataportal_show_thumbnail_captions'] = array(
1015
    '#type' => 'checkbox',
1016
    '#title' => t('Show captions under thumbnails'),
1017
    '#default_value' => $gallery_settings['cdm_dataportal_show_thumbnail_captions'],
1018
    '#description' => '',
1019
  );
1020

    
1021
  $form[$form_name]['cdm_dataportal_media_maxextend'] = array(
1022
    '#type' => 'textfield',
1023
    '#title' => t('Thumbnail size') . ':',
1024
    '#default_value' => $gallery_settings['cdm_dataportal_media_maxextend'],
1025
    '#description' => t('Select the size of each individual thumbnail.'),
1026
  );
1027

    
1028
  if ($form_name != CDM_DATAPORTAL_MEDIA_GALLERY_NAME) {
1029
    $form[$form_name]['cdm_dataportal_media_cols'] = array(
1030
      '#type' => 'textfield',
1031
      '#title' => t('Number of columns') . ':',
1032
      '#default_value' => $gallery_settings['cdm_dataportal_media_cols'],
1033
      '#description' => t('Group the thumbnails in columns: select how many
1034
        columns the gallery should display.'),
1035
    );
1036
  }
1037

    
1038
  if ($form_name == CDM_DATAPORTAL_SEARCH_GALLERY_NAME) {
1039
    $form[$form_name]['cdm_dataportal_media_maxRows'] = array(
1040
      '#type' => 'textfield',
1041
      '#title' => t('Maximum number of rows') . ':',
1042
      '#default_value' => $gallery_settings['cdm_dataportal_media_maxRows'],
1043
      '#description' => t('You can group the thumbnails in rows, select in how
1044
        many rows should be the thumbnails grouped.<br/><strong>Note:</strong>
1045
        If you want an unlimited number of rows please set to 0.'),
1046
    );
1047
  }
1048

    
1049
  return $form;
1050
}
1051

    
1052
/**
1053
 * @todo document this function.
1054
 */
1055
function cdm_settings_layout_taxon() {
1056
  $collapsed = FALSE;
1057
  $form = array();
1058

    
1059
  $form['#submit'][] = 'cdm_settings_layout_taxon_submit';
1060

    
1061
  $form['cdm_dataportal_show_back_to_search_results'] = array(
1062
      '#type' => 'checkbox',
1063
      '#title' => t('Show <em>Back to search results</em> link at the taxon site.'),
1064
      '#default_value' => variable_get('cdm_dataportal_show_back_to_search_results', 1),
1065
      '#description' => t('<p>If checked the link to search results is rendered at
1066
       the top of the taxon site. Clicking on the link the last search performed
1067
       is rendered again.</p>'),
1068
  );
1069

    
1070
  // --------- TABBED TAXON ------- //
1071
  $form['taxon_tabs'] = array(
1072
    '#type' => 'fieldset',
1073
    '#title' => t('Taxon tabs'),
1074
    '#collapsible' => TRUE,
1075
    '#collapsed' => FALSE,
1076
    '#description' => t('If tabbed taxon page is enabled the taxon profile will
1077
      be splitted in four diferent tabs; General, Synonymy, Images and
1078
      Specimens. If the taxon has no information for any of the tabs/sections
1079
      such tab will be not displayed.'),
1080
  );
1081

    
1082
  $form['taxon_tabs']['cdm_dataportal_taxonpage_tabs'] = array(
1083
    '#type' => 'checkbox',
1084
    '#title' => t('Tabbed taxon page'),
1085
    '#default_value' => variable_get('cdm_dataportal_taxonpage_tabs', 1),
1086
    '#description' => t('<p>If selected split the taxon page into individual
1087
      tabs for description, images, synonymy and specimens. If not the taxon
1088
      data is rendered as a long single page without tabs.</p>'),
1089
  );
1090

    
1091
  $form['taxon_tabs']['cdm_taxonpage_tabs_visibility'] = array(
1092
    '#type' => 'checkboxes',
1093
    '#title' => t('Tabs visibility options') . ':',
1094
    '#default_value' => variable_get('cdm_taxonpage_tabs_visibility', get_taxon_options_list()),
1095
    '#options' => get_taxon_options_list(),
1096
    '#description' => t('Enable or disable Tabs in the Tabbed page display'),
1097
  );
1098

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

    
1111
  /* ======  TAXON_PROFILE ====== */
1112
  $form['taxon_profile'] = array(
1113
    '#type' => 'fieldset',
1114
    '#title' => t('Taxon profile (tab)'),
1115
    '#description' => t('<p>This section covers the settings related to the taxon
1116
      profile tab, also known as the <strong>"General"</strong> tab.</p>'),
1117
    '#collapsible' => TRUE,
1118
    '#collapsed' => TRUE,
1119
  );
1120

    
1121
  // ---- PROFILE PICTURE ----//
1122

    
1123
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE] = array(
1124
    '#type' => 'fieldset',
1125
    '#tree' => TRUE,
1126
    '#title' => t('Taxon profile picture'),
1127
    '#collapsible' => TRUE,
1128
    '#collapsed' => FALSE,
1129
    '#description' => t('This sections allows configuring the display of the so called taxon profile image which is displayed in the taxon profile tab.'),
1130
  );
1131

    
1132
  //FIXME migrate variables:
1133
  //  cdm_dataportal_show_default_image ---> CDM_TAXON_PROFILE_IMAGE['show']
1134
  // FIXME
1135
  //  eanable file modul in profile and in update
1136

    
1137
  $taxon_profile_image_settings = variable_get(CDM_TAXON_PROFILE_IMAGE, unserialize(CDM_TAXON_PROFILE_IMAGE_DEFAULT));
1138
  /*
1139
   * 'show' => 1,
1140
   * 'maxextend' => 184,
1141
   * 'media_uri_query' => ''
1142
   * 'custom_placeholder_image_on' => 1,
1143
   * 'custom_placeholder_image_fid' => ''
1144
   */
1145
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['show'] = array(
1146
    '#type' => 'checkbox',
1147
    '#title' => t('Enable profil picture'),
1148
    '#description' => t('Show the profil picture.'),
1149
    '#default_value' => $taxon_profile_image_settings['show'],
1150
  );
1151

    
1152
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['maxextend'] = array(
1153
      '#type' => 'textfield',
1154
      '#tree' => TRUE,
1155
      '#title' => t('Profil picture maximum extend'),
1156
      '#default_value' =>  $taxon_profile_image_settings['maxextend'],
1157
      '#field_suffix' => 'px',
1158
      '#maxlength' => 4,
1159
      '#size' => 4,
1160
      '#description' => t('The maximum extend in either dimension, width or height, of the profil picture in pixels.')
1161
  );
1162

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

    
1176
  $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_on'] = array(
1177
      '#type' => 'checkbox',
1178
      '#title' => t('Use a custom placeholder image'),
1179
      '#description' => t("This image is shown as replacement if no image of the taxon is available."),
1180
      '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_on']
1181
  );
1182

    
1183
  if($taxon_profile_image_settings['custom_placeholder_image_on'] == 1){
1184
    $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'] = array(
1185
        '#type' => 'managed_file',
1186
        '#title' => t('Custom placeholder image file'),
1187
        '#progress_indicator' => 'bar',
1188
        '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_fid'],
1189
    //       '#name' => 'custom_placeholder_image',
1190
        '#upload_location' => 'public://' . CDM_TAXON_PROFILE_IMAGE .'/'
1191
    );
1192

    
1193
    if($taxon_profile_image_settings['custom_placeholder_image_fid']){
1194
      $profile_image_file = file_load($taxon_profile_image_settings['custom_placeholder_image_fid']);
1195
      $url = file_create_url($profile_image_file->uri);
1196
      $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['preview'] = array(
1197
                '#type' => 'item',
1198
                '#markup' => '<div class="image-preview"><img src="' . $url . '"/></div>',
1199
      );
1200
    }
1201
  } else {
1202
    $form['taxon_profile'][CDM_TAXON_PROFILE_IMAGE]['custom_placeholder_image_fid'] = array(
1203
        '#type' => 'hidden',
1204
        '#default_value' => $taxon_profile_image_settings['custom_placeholder_image_fid']
1205
    );
1206
  }
1207

    
1208

    
1209

    
1210
  $options = cdm_rankVocabulary_as_option();
1211
  array_unshift($options, '-- DISABLED --');
1212
  $form['taxon_profile']['picture']['image_hide_rank'] = array(
1213
    '#type' => 'select',
1214
    '#title' => t('Hide profile picture for higher ranks') . ':',
1215
    '#default_value' => variable_get('image_hide_rank', '0'),
1216
    '#options' => $options,
1217
    '#description' => t('The taxon profile picture will not be shown for taxa with rank higher that the selected.'),
1218
  );
1219

    
1220
  // -- MEDIA THUMBNAILS -- //
1221
  $form_name = CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME;
1222
  $form_title = 'Taxon Profile Images';
1223
  $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>';
1224
  $form['taxon_profile'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description);
1225

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

    
1271
  // ---- LAYOUT PER FEATURE ---- //
1272
  $feature_tree = get_profile_featureTree();
1273
  if (isset($feature_tree->root->children)) {
1274

    
1275
    $form_feature_list_layout = array(
1276
      '#title' => t('Taxon profile layout'),
1277
      '#collapsible' => TRUE,
1278
      '#collapsed' => FALSE,
1279
      '#type' => 'fieldset',
1280
      '#description' => t('Will be available in a future release.'),
1281
    );
1282

    
1283
    $feature_list_layout_settings_disabled = TRUE;
1284
    foreach ($feature_tree->root->children as $featureNode) {
1285

    
1286
      if (!$feature_list_layout_settings_disabled && isset($featureNode->feature)) {
1287
        // Must not exceed 45 characters !!!
1288
        $subform_id = LAYOUT_SETTING_PREFIX . $featureNode->feature->uuid;
1289

    
1290
        $settings = mixed_variable_get($subform_id, FEATURE_TREE_LAYOUT_DEFAULTS);
1291
        $systemDefaults = unserialize(FEATURE_TREE_LAYOUT_DEFAULTS);
1292

    
1293
        $form_feature_list_layout[$subform_id] = array(
1294
          '#tree' => TRUE,
1295
          '#title' => 'test' . $featureNode->feature->representation_L10n,
1296
          '#collapsible' => FALSE,
1297
          '#collapsed' => FALSE,
1298
          '#type' => 'fieldset',
1299
          '#description' => t(''),
1300
        );
1301

    
1302
        $form_feature_list_layout[$subform_id]['enabled'] = array(
1303
          '#type' => 'checkbox',
1304
          '#title' => t('Enable'),
1305
          '#default_value' => $settings['enabled'],
1306
          '#description' => t('Enable user defined layout for this feature'),
1307
        );
1308

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

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

    
1325
        $form_feature_list_layout[$subform_id]['glue'] = array(
1326
          '#type' => 'textfield',
1327
          '#title' => t('Glue'),
1328
          '#disabled' => !$settings['enabled'],
1329
          '#default_value' => $settings['glue'],
1330
          '#description' => t('Default is: ') . "'<code>" . $systemDefaults['glue'] . "</code>'",
1331
        );
1332

    
1333
      }
1334

    
1335
      $form['taxon_profile']['feature_list_layout'] = $form_feature_list_layout;
1336
    }
1337
  }
1338

    
1339
  // ---- DISTRIBUTION LAYOUT ---- //
1340
  $form['taxon_profile']['distribution_layout'] = array(
1341
    '#title' => t('Distribution'),
1342
    '#collapsible' => TRUE,
1343
    '#collapsed' => FALSE,
1344
    '#type' => 'fieldset',
1345
    '#description' => t('Select if you want to sort or not the distribution text
1346
      located below the distribution map.'),
1347
  );
1348

    
1349
  $form['taxon_profile']['distribution_layout']['distribution_sort'] = array(
1350
    '#type' => 'radios',
1351
    '#title' => t('Sort') . ':',
1352
    '#default_value' => variable_get('distribution_sort', 'NO_SORT'),
1353
    '#options' => array(
1354
      'NO_SORT' => t('Standard (No sort)'),
1355
      'HIDE_TDWG2' => t('Sorted without TDWG Level 2'),
1356
    ),
1357
  );
1358

    
1359
  $form['taxon_profile']['distribution_layout'][DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP] = array(
1360
    '#type' => 'checkbox',
1361
    '#title' => t('Show TextData elements on top of the map'),
1362
    '#default_value' => variable_get(DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP, 0),
1363
    '#description' => t('Check this if you want to appear all <code>TextData</code>
1364
      elements on top of the map. Otherwise all <code>TextData</code>
1365
      distribution elements will be listed below the other area elements.
1366
      This option is useful if you need to have descriptive texts for each
1367
      distribution map.'),
1368
  );
1369

    
1370

    
1371
  /* ====== SYNONYMY ====== */
1372
  $form['taxon_synonymy'] = array(
1373
    '#type' => 'fieldset',
1374
    '#title' => t('Taxon synonymy (tab)'),
1375
    '#collapsible' => TRUE,
1376
    '#collapsed' => TRUE,
1377
    '#description' => t('This section covers the settings related to the taxon
1378
      <strong>synonymy</strong> tab.'),
1379
  );
1380

    
1381
  $form['taxon_synonymy']['cdm_dataportal_nomref_in_title'] = array(
1382
    '#type' => 'checkbox',
1383
    '#title' => t('Show accepted taxon on top of the synonymy'),
1384
    '#default_value' => variable_get('cdm_dataportal_nomref_in_title', CDM_DATAPORTAL_NOMREF_IN_TITLE),
1385
    '#description' => t('If checked, the first homotypic taxon is a repetition
1386
      of the accepted taxon most likely with the full nomenclatural reference
1387
      (depending on the currently chosen theme).'),
1388
  );
1389

    
1390
  $form['taxon_synonymy']['cdm_dataportal_display_is_accepted_for'] = array(
1391
    '#type' => 'checkbox',
1392
    '#title' => t('Display <em>is accepted for ...</em> on taxon pages when
1393
      coming from a synonym link.'),
1394
    '#default_value' => variable_get('cdm_dataportal_display_is_accepted_for', CDM_DATAPORTAL_DISPLAY_IS_ACCEPTED_FOR),
1395
    '#description' => t('Check this if after doing a search and clicking on a
1396
      synonym you want to see the "accept of" text for the accepted synonym.'),
1397
  );
1398

    
1399
  $nameRelationshipTypeOptions = cdm_Vocabulary_as_option(UUID_NAME_RELATIONSHIP_TYPE);
1400
  $form['taxon_synonymy']['name_relationships']['name_relationships_to_show'] = array(
1401
    '#type' => 'checkboxes',
1402
    '#title' => t('Display name relationships') . ':',
1403
    '#default_value' => variable_get('name_relationships_to_show', 0),
1404
    '#options' => $nameRelationshipTypeOptions,
1405
    '#description' => t('Select the name relationships you want to show for the
1406
      accepted taxa.'),
1407
  );
1408

    
1409
  $form['taxon_synonymy'][CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS] = array(
1410
    '#type' => 'checkbox',
1411
    '#title' => t('Show taxon relations ships of accepted taxon'),
1412
    '#default_value' => variable_get(CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS, CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT),
1413
    '#description' => t('If this option is enabled the synonymy will show the
1414
      below selected taxon relationships of accepted taxa.'),
1415
  );
1416

    
1417
  $taxonRelationshipTypeOptions = cdm_Vocabulary_as_option(UUID_TAXON_RELATIONSHIP_TYPE, '_cdm_relationship_type_term_label_callback');
1418
  $form['taxon_synonymy'][CDM_TAXON_RELATIONSHIP_TYPES] = array(
1419
    '#type' => 'checkboxes',
1420
    '#title' => t('Taxon relationship types') . ':',
1421
    '#description' => t('Only taxon relationships of the selected type will be
1422
      displayed'),
1423
    '#options' => $taxonRelationshipTypeOptions,
1424
    '#default_value' => variable_get(CDM_TAXON_RELATIONSHIP_TYPES, unserialize(CDM_TAXON_RELATIONSHIP_TYPES_DEFAULT)),
1425
    '#disabled' => !variable_get(CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS, CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT),
1426
  );
1427

    
1428
  // ====== SPECIMENS ====== //
1429
  $form['taxon_specimens'] = array(
1430
    '#type' => 'fieldset',
1431
    '#title' => t('Taxon specimens (tab)'),
1432
    '#collapsible' => TRUE,
1433
    '#collapsed' => TRUE,
1434
    '#description' => t('This section covers the settings related to the taxon
1435
      <strong>specimens</strong> tab.'),
1436
  );
1437

    
1438
  $featureTrees = cdm_get_featureTrees_as_options(TRUE);
1439
  $saved_uuid = variable_get(CDM_OCCURRENCE_FEATURETREE_UUID, UUID_DEFAULT_FEATURETREE);
1440
  if(!isset($featureTrees['options'][$saved_uuid])) {
1441
    $saved_uuid = UUID_DEFAULT_FEATURETREE;
1442
  }
1443
  $form['taxon_specimens']['feature_trees'][CDM_OCCURRENCE_FEATURETREE_UUID] = array(
1444
      '#type' => 'radios',
1445
      '#title' => t('Specimen description feature tree') . ':',
1446
      '#default_value' => $saved_uuid,
1447
      '#options' =>  $featureTrees['options'],
1448
      '#pre_render' => array('form_pre_render_conditional_form_element', 'radios_prepare_options_suffix'),
1449
      '#options_suffixes' => $featureTrees['treeRepresentations'],
1450
      '#description' => t('Select the feature tree to be used for displaying specimen descriptions. Click "Show Details" to see the Feature Tree elements.'
1451
      ),
1452
  );
1453

    
1454
  $form_name = CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME;
1455
  $form_title = t('Specimen media');
1456
  $form_description = t('Specimens may have media which is displayed at the
1457
     Specimen tab/section as a gallery. It is possible to configure the
1458
     thumbnails gallery here, however for configuring how a single media should
1459
     be displayed please go to !url.</p>',
1460
     array(
1461
       '!url' => l(t('Layout -> Media'), 'admin/config/cdm_dataportal/settings/layout/media'),
1462
     ));
1463
  $form['taxon_specimens'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, FALSE, $form_description);
1464

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

    
1476
  // Comment @WA: D7 form api does not support reset buttons,
1477
  // so to mimic the D5 reset button we add one like this.
1478
  $form['actions']['reset'] = array(
1479
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1480
    '#weight' => 1000,
1481
  );
1482
  return system_settings_form($form);
1483
}
1484

    
1485
/**
1486
 * @todo document this function.
1487
 */
1488
function cdm_settings_layout_search() {
1489

    
1490
  $form = array();
1491

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

    
1503
  $form['search_settings']['simple_search_ignore_classification'] = array(
1504
      '#type' => 'checkbox',
1505
      '#title' => t('Ignore the chosen classification in simple search'),
1506
      '#default_value' => variable_get('simple_search_ignore_classification', TRUE),
1507
      '#description' => t('The simple search, which can be executed via the search block,
1508
          will by default search on all classifications. Remove the tick if you want your
1509
          portal to search on the classification selected in the classification browser
1510
          selector.'),
1511
  );
1512

    
1513
  $form['search_settings']['cdm_dataportal_search_items_on_page'] = array(
1514
    '#type' => 'textfield',
1515
    '#title' => t('Results per page') . ':',
1516
    '#default_value' => variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE),
1517
    '#description' => t('Number of results to display per page.'),
1518
  );
1519

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

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

    
1534
  $form['search_settings']['cdm_search_common_names'] = array(
1535
    '#type' => 'checkbox',
1536
    '#title' => t('Sets the default value of <em>Search for common names</em> in the advanced search form.'),
1537
    '#default_value' => variable_get('cdm_search_common_names', 0),
1538
    '#description' => t('<p>If checked the <em>Search for common names</em> option will be enabled in the advanced form.</p>'),
1539
  );
1540

    
1541
  $form['search_settings']['cdm_search_use_default_values'] = array(
1542
    '#type' => 'checkbox',
1543
    '#title' => t('Sets use of default values in the advanced search form.'),
1544
    '#default_value' => variable_get('cdm_search_use_default_values', 1),
1545
    '#description' => t('<p>If checked the defqult values set abovewill be used for the search.</p>'),
1546
  );
1547

    
1548

    
1549
  // --- SEARCH TAXA GALLERY ---- //
1550
  $items = variable_get('cdm_dataportal_search_items_on_page', CDM_DATAPORTAL_SEARCH_ITEMS_ON_PAGE);
1551
  $collapsed = FALSE;
1552
  $form_name = CDM_DATAPORTAL_SEARCH_GALLERY_NAME;
1553
  $form_title = 'Taxa Search thumbnails';
1554
  $form_description = 'Search results may show thumbnails. ';
1555
  $form[] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed, $form_description);
1556

    
1557
  // Comment @WA: D7 form api does not support reset buttons,
1558
  // so to mimic the D5 reset button we add one like this.
1559
  $form['actions']['reset'] = array(
1560
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1561
    '#weight' => 1000,
1562
  );
1563
  return system_settings_form($form);
1564
}
1565

    
1566
/**
1567
 * @todo document this function.
1568
 */
1569
function cdm_settings_layout_media() {
1570

    
1571
  $form = array();
1572

    
1573
  $form['media_settings'] = array(
1574
    '#type' => 'fieldset',
1575
    '#title' => t('Media settings'),
1576
    '#collapsible' => FALSE,
1577
    '#collapsed' => FALSE,
1578
    '#description' => 'This section covers layout settings for media pages.'
1579
      . 'Further media related settings may be found under the taxon layout settings and on the general settings.',
1580
  );
1581

    
1582
  $form['media_settings']['image_gallery_viewer'] = array(
1583
    '#type' => 'select',
1584
    '#title' => t('Image viewer') . ':',
1585
    '#default_value' => variable_get('image_gallery_viewer', 'default'),
1586
    '#options' => array(
1587
      'default' => t('Standard image viewer'),
1588
      'fsi' => t('FSI viewer (requires FSI server!)'),
1589
    ),
1590
  );
1591

    
1592
  // --- MEDIA GALLERY ---- //
1593
  $form_name = CDM_DATAPORTAL_MEDIA_GALLERY_NAME;
1594
  $form_title = 'Standard viewer';
1595
  $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>';
1596
  // $form[] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, $collapsed);
1597
  $form['media_settings'][] = cdm_dataportal_create_gallery_settings_form($form_name, $form_title, FALSE, $form_description);
1598

    
1599
  // @WA: D7 form api does not support reset buttons,
1600
  // so to mimic the D5 reset button we add one like this.
1601
  $form['actions']['reset'] = array(
1602
    '#markup' => '<input id="reset" type="reset" class="form-submit" value="' . t('Reset to defaults') . '" />',
1603
    '#weight' => 1000,
1604
  );
1605
  return system_settings_form($form);
1606
}
1607

    
1608
/**
1609
 * GEOSERVICE and Map settings.
1610
 */
1611
function cdm_settings_geo($form, &$form_state) {
1612

    
1613
  $current_geoserver_settings = get_edit_map_service_settings();
1614
  $map_distribution = get_array_variable_merged(CDM_MAP_DISTRIBUTION, CDM_MAP_DISTRIBUTION_DEFAULT);
1615

    
1616
  $form = array();
1617

    
1618
  $dummy_distribution_query = NULL;
1619
  if($map_distribution['map_type'] != 1){
1620
    // we need to apply a dummy query since the map serice requires for image maps
1621
    // at least as and ad to be defined
1622
    $dummy_distribution_query = "as=a:339966&ad=tdwg1:a:1,2,3,4,5,6,7,8,9";
1623
  }
1624
  $form['map_preview'] = array(
1625
      '#type' => 'fieldset',
1626
      '#tree' => FALSE,
1627
      '#title' => t('Map preview'),
1628
      '#collapsible' => FALSE,
1629
      '#description' => 'The preview of the map'
1630
       . ($dummy_distribution_query != null ?
1631
           ' may not be accurate in case if image maps, please check the map display in the taxon pages.':
1632
           '.<br/>Hold down Strg and drag with your mouse to select a bbox to zoom to. <br/>The bbox of the visisble area of the map is always displayed below the map.')
1633
  );
1634
  $form['map_preview']['map'] = compose_map(NULL, $dummy_distribution_query, NULL,
1635
      array(
1636
          'move' => "this.cdmOpenlayersMap.printInfo",
1637
          '#execute' => "this.cdmOpenlayersMap.printInfo"
1638
      )
1639
  );
1640

    
1641

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

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

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

    
1684

    
1685
  /*
1686
   * MAP SETTINGS
1687
   */
1688

    
1689
  $form[CDM_MAP_DISTRIBUTION] = array(
1690
    '#type' => 'fieldset',
1691
    '#tree' => TRUE,
1692
    '#title' => t('Maps settings'),
1693
    '#collapsible' => TRUE,
1694
    '#collapsed' => TRUE,
1695
    '#description' => t('General configuration for all map types.'),
1696
  );
1697

    
1698
  /*
1699
   * settings for the distribution map are used also for specimens map!!!!
1700
   */
1701

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

    
1722
  $form[CDM_MAP_DISTRIBUTION]['bbox'] = array(
1723
    '#type' => 'textfield',
1724
    '#title' => 'Bounding box',
1725
    '#default_value' => $map_distribution['bbox'],
1726
    '#description' => t('The bounding box defines the area to be initially displayed in maps.
1727
      Use "-180,-90,180,90" for the whole world. Leave <strong>empty</strong>
1728
      to let the map <strong>automatically zoom</strong> to the bounds enclosing the shown data.</p>
1729
      <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.
1730
      Hold down Strg and drag with your mouse to select a bbox to zoom to. The bbox of the visisble area of the map is always displayed
1731
      below the map from where you can copy the bbox string.</p>'),
1732
  );
1733

    
1734
  $form[CDM_MAP_DISTRIBUTION]['show_labels'] = array(
1735
    '#type' => 'checkbox',
1736
    '#title' => 'Display area labels',
1737
    '#default_value' => $map_distribution['show_labels'],
1738
    '#description' => t('The map will show name labels of the areas'),
1739
  );
1740

    
1741
  $form[CDM_MAP_DISTRIBUTION]['caption'] = array(
1742
    '#type' => 'textfield',
1743
    '#title' => 'Map caption',
1744
    '#default_value' => $map_distribution['caption'],
1745
    '#description' => t('The caption will be shown below the map.'),
1746
  );
1747

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

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

    
1773

    
1774
  // --- Plain Image Settings --- //
1775
  $form[CDM_MAP_DISTRIBUTION]['image_map'] = array(
1776
    '#type' => 'fieldset',
1777
    '#title' => 'Plain image map settings',
1778
    '#tree' => TRUE,
1779
    '#collapsible' => TRUE,
1780
    '#collapsed' => $open_layers_is_enabled,
1781
    '#description' => 'The settings in this section are still expertimental
1782
      and can only be used with the EDIT map service version 1.1 or above.',
1783
  );
1784
  $edit_mapserver_version = get_edit_map_service_version_number();
1785
  if ($edit_mapserver_version < 1.1) {
1786
    $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>'
1787
      . $form[CDM_MAP_DISTRIBUTION]['image_map']['#description'];
1788
  }
1789

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

    
1800
  $form[CDM_MAP_DISTRIBUTION]['image_map']['bg_color'] = array(
1801
    '#type' => 'textfield',
1802
    '#title' => 'Background color',
1803
    '#default_value' => $map_distribution['image_map']['bg_color'],
1804
  );
1805

    
1806
  $form[CDM_MAP_DISTRIBUTION]['image_map']['layer_style'] = array(
1807
    '#type' => 'textfield',
1808
    '#title' => 'Background layer style',
1809
     // Only line color by now.
1810
    '#default_value' => $map_distribution['image_map']['layer_style'],
1811
    '#description' => 'Syntax: {Area fill color},{Area stroke color},{Area stroke width},{Area stroke dash style}',
1812
  );
1813

    
1814

    
1815
  // --- OpenLayers Settings --- //
1816
  $form[CDM_MAP_DISTRIBUTION]['openlayers'] = array(
1817
    '#type' => 'fieldset',
1818
    '#title' => 'OpenLayers settings',
1819
    '#tree' => TRUE,
1820
    '#collapsible' => TRUE,
1821
    '#collapsed' => !$open_layers_is_enabled,
1822
    '#description' => '',
1823
  );
1824

    
1825

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

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

    
1846
  if (!$open_layers_is_enabled) {
1847
    $form[CDM_MAP_DISTRIBUTION]['openlayers']['#description'] = '<div class="messages warning">'
1848
        . 'The Openlayers viewer is currently not enabled! (see section Maps settings above )</div>'
1849
        . $form[CDM_MAP_DISTRIBUTION]['openlayers']['#description'];
1850
  }
1851

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

    
1878
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['base_layers'] = array(
1879
    '#type' => 'checkboxes_preferred',
1880
    '#title' => 'Base Layers',
1881
    '#options' => $baselayer_options,
1882
    '#default_value' =>  $map_distribution['openlayers']['base_layers'],
1883
    '#description' => 'Choose the baselayer layer you prefer to use as map background in the OpenLayers dynamic mapviewer.',
1884
  );
1885

    
1886
  $form[CDM_MAP_DISTRIBUTION]['openlayers']['custom_wms_base_layer'] = array(
1887
      '#type' => 'fieldset',
1888
      '#title' => 'Custom WMS base layer',
1889
      '#tree' => TRUE,
1890
      '#collapsible' => FALSE,
1891
      '#collapsed' => FALSE,
1892
      '#description' => 'Here you an define a custom wms layer as additional base layer.',
1893
  );
1894

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

    
1938
  /*
1939
   * Map Legend
1940
   */
1941
  $form[CDM_MAP_DISTRIBUTION]['legend'] = array(
1942
    '#type' => 'fieldset',
1943
    '#title' => 'Map legend',
1944
    '#tree' => TRUE,
1945
    '#collapsible' => TRUE,
1946
    '#collapsed' => TRUE,
1947
    '#description' => 'Configure the maps legend.',
1948
  );
1949

    
1950
  $form[CDM_MAP_DISTRIBUTION]['legend']['show'] = array(
1951
    '#type' => 'checkbox',
1952
    '#title' => 'Display a map legend',
1953
    '#default_value' => $map_distribution['legend']['show'],
1954
    '#description' => 'Check this if you like a legend to be displayed with the maps.',
1955
  );
1956

    
1957
  $form[CDM_MAP_DISTRIBUTION]['legend']['opacity'] = array(
1958
    '#type' => 'textfield',
1959
    '#title' => 'Legend opacity',
1960
    '#default_value' => $map_distribution['legend']['opacity'],
1961
    '#description' => 'Valid values range from 0.0 to 1.0. Value 1.0 means the legend will be fully visible, while a value near
1962
                         to 0.0 will be not much visible.',
1963
  );
1964

    
1965
  $form[CDM_MAP_DISTRIBUTION]['legend']['font_size'] = array(
1966
    '#type' => 'textfield',
1967
    '#title' => 'Font size',
1968
    '#default_value' => $map_distribution['legend']['font_size'],
1969
    '#description' => 'Font size in pixels.',
1970
  );
1971

    
1972
  $fontStyles = array(
1973
    0 => "plane",
1974
    1 => "italic",
1975
  );
1976
  $form[CDM_MAP_DISTRIBUTION]['legend']['font_style'] = array(
1977
    '#type' => 'select',
1978
    '#title' => 'Available font styles',
1979
    '#default_value' => $map_distribution['legend']['font_style'],
1980
    '#options' => $fontStyles,
1981
    '#description' => 'Select a font style for the map legend.',
1982
  );
1983

    
1984
  $form[CDM_MAP_DISTRIBUTION]['legend']['icon_width'] = array(
1985
    '#type' => 'textfield',
1986
    '#title' => 'Icon width',
1987
    '#default_value' => $map_distribution['legend']['icon_width'],
1988
    '#description' => 'Legend icon width in pixels.',
1989
  );
1990
  $form[CDM_MAP_DISTRIBUTION]['legend']['icon_height'] = array(
1991
    '#type' => 'textfield',
1992
    '#title' => 'Icon height',
1993
    '#default_value' => $map_distribution['legend']['icon_height'],
1994
    '#description' => 'Legend icon height in pixels.',
1995
  );
1996

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

    
2004
  return system_settings_form($form);
2005
}
2006

    
2007
/**
2008
 * @todo document this function.
2009
 */
2010
function cdm_settings_cache() {
2011

    
2012
  $form = array();
2013

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

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

    
2037
  $form['cache_settings']['cdm_run_cache'] = array(
2038
    '#markup' => cdm_view_cache_site(),
2039
  );
2040

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

    
2050
/**
2051
 * Walk and cache all taxon pages.
2052
 */
2053
function cdm_view_cache_site() {
2054

    
2055
  $out = '';
2056

    
2057
  drupal_add_js(drupal_get_path('module', 'cdm_dataportal') . '/js/cache_all_taxa.js');
2058

    
2059
  $request_params = array();
2060
  $request_params['class'] = "Taxon";
2061

    
2062
  $cdm_ws_page_taxa_url = cdm_compose_url(CDM_WS_TAXON . ".json", NULL, queryString($request_params));
2063
  $cdm_ws_page_taxa_url = uri_uriByProxy($cdm_ws_page_taxa_url);
2064
  $cdm_ws_page_taxa_url = rtrim($cdm_ws_page_taxa_url, '/');
2065

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

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

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

    
2093

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

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

    
2122
  if (!str_endsWith($form_state['values']['cdm_webservice_url'], '/')) {
2123
    // form_set_error('cdm_webservice_url', t("The URL to the CDM Web Service must end with a slash: '/'."));
2124
    $form_state['values']['cdm_webservice_url'] .= '/';
2125
  }
2126

    
2127
  if ($form_state['values']['cdm_webservice_cache'] != variable_get('cdm_webservice_cache', 1)) {
2128
    cache_clear_all(NULL, 'cache_cdm_ws');
2129
    // Better clear secref_cache since I can not be sure if the cache has not
2130
    // be used during this response.
2131
    cdm_api_secref_cache_clear();
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
}
(13-13/13)