EDIT

<?php

/**

 * @file

 * CDM Dataportal settings.

 */

const FEATURE_BLOCK_WEIGHT_INCREMENT = 2;

const PSEUDO_FEATURE_AGGREGATION_DESCRIPTIONS = 'AGGREGATION_DESCRIPTIONS';

const PSEUDO_FEATURE_BIBLIOGRAPHY = 'BIBLIOGRAPHY';

const PSEUDO_FEATURE_NUMBER_OF_TAXA = 'NUMBER_OF_TAXA';

const CDM_NAME_PAGE_AUTOREDIRECT = 'cdm_name_page_autoredirect';

const CDM_NAME_PAGE_SECTION_TAXA = 'cdm_name_page_section_taxa';

const CDM_NAME_PAGE_SECTION_TAXA_DEFAULT = 1;

const CDM_MEDIA_GALLERY_VIEWER = 'image_gallery_viewer';

const CDM_MEDIA_GALLERY_VIEWER_DEFAULT = 'universalviewer';

const CDM_MEDIA_GALLERY_VIEWER_SIMPLE = 'default';

const CDM_ADDITIONAL_MEDIA_COPYRIGHT = 'cdm_additional_media_copyright';

const CDM_TAXONPAGE_TAXON_NODE_SHOW_STATES = 'cdm_taxonpage_taxon_node_show_status';

define('TAXONTREE_RANKLIMIT', 'cdm_taxontree_ranklimit');

define('TAXONTREE_RANKLIMIT_DEFAULT', 0);

  define('CDM_TAXONOMICTREE_UUID', 'cdm_taxonomictree_uuid');

  define('CDM_TAXONTREE_INCLUDES', 'taxontree_includes');

  define('CDM_SUB_TREE_FILTER_UUID', 'cdm_sub_tree_filter_uuid');

  define('NO_SORT', -1);

  define('SORT_HIERARCHICAL', 9);

  const CDM_SEARCH_RESULT_PAGE_SIZE_DEFAULT = 25;

  const CDM_SEARCH_RESULT_PAGE_SIZE = 'cdm_dataportal_search_items_on_page';

  define('SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX_DEFAULT', 1);

  define('SEARCH_RESULTS_SHOW_THUMBNAIL_CHECKBOX', 'search_results_show_thumbnail_checkbox');

 const CDM_DATAPORTAL_NOMREF_IN_TITLE = 'cdm_dataportal_nomref_in_title';

 const CDM_DATAPORTAL_NOMREF_IN_TITLE_DEFAULT =  1;

 const CDM_SPECIMEN_LIST_VIEW_MODE = 'cdm_specimen_list_view_mode';

 const CDM_SPECIMEN_LIST_VIEW_MODE_DEFAULT = 'derivate_table';

 const CDM_SPECIMEN_LIST_VIEW_MODE_OPTION_DERIVATE_TABLE = 'derivate_table';

 const CDM_SPECIMEN_LIST_VIEW_MODE_OPTION_DERIVATE_TREE = 'derivate_tree';

 const CDM_SPECIMEN_LIST_VIEW_MODE_OPTION_DERIVATE_PATH = 'derivate_path';

 const CDM_SPECIMEN_DERIVATE_TREE_OPTIONS = 'cdm_specimen_derivate_tree_options';

 const CDM_SPECIMEN_DERIVATE_TREE_OPTIONS_DEFAULT = ['field_unit_short_label' => 0];

  define('CDM_DATAPORTAL_DISPLAY_IS_ACCEPTED_FOR', 0);

  define('CDM_SYNONYMY_ACCEPTED_TAXON_SEC_SEPARATE', 'cdm_synonymy_accepted_taxon_sec_separate');

  define('CDM_SYNONYMY_ACCEPTED_TAXON_SEC_SEPARATE_LABEL', 'cdm_synonymy_accepted_taxon_sec_separate_label');

  define('CDM_SYNONYMY_ACCEPTED_TAXON_SEC_SEPARATE_LABEL_DEFAULT', 'Source');

  define('CDM_DATAPORTAL_ALL_FOOTNOTES', 0);

  define('CDM_DATAPORTAL_ANNOTATIONS_FOOTNOTES', 0);

  define('CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX', 999);

  define('CDM_SEARCH_BLAST_SERVICE_URI', 'http://bgbm-import:9001/api/sequence');

  define('CDM_SEARCH_BLAST_ENABLED', 0);

  define('CDM_REGISTRATION_PRESISTENT_IDENTIFIER_AS_LINK', 'cdm_registration_presistent_identifier_as_link');

  /* annotationTypeKeys */

  $annotationTypeKeys = array_keys(cdm_vocabulary_as_option(UUID_ANNOTATION_TYPE));

  if (in_array(UUID_ANNOTATION_TYPE_TECHNICAL, $annotationTypeKeys)) {

    $annotationTypeKeys = array_flip($annotationTypeKeys);

    // Technical annotation are off by default.

    unset($annotationTypeKeys[UUID_ANNOTATION_TYPE_TECHNICAL]);

    $annotationTypeKeys = array_flip($annotationTypeKeys);

    // Additional value for the NULL case.

    $annotationTypeKeys[] = 'NULL_VALUE';

  }

  const ANNOTATION_TYPES_VISIBLE = 'annotations_types_as_footnotes';

  define('ANNOTATION_TYPES_VISIBLE_DEFAULT', serialize($annotationTypeKeys));

/* extensionTypeKeys */

$extensionTypeKeys = array_keys(cdm_vocabulary_as_option(UUID_EXTENSION_TYPE));

if (in_array(UUID_ANNOTATION_TYPE_TECHNICAL, $extensionTypeKeys)) {

  // Additional value for the NULL case.

  $extensionTypeKeys[] = 'NULL_VALUE';

}

const EXTENSION_TYPES_VISIBLE = 'extension_types_visible';

define('EXTENSION_TYPES_VISIBLE_DEFAULT', serialize([]));

  define('BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE', 'bibliography_for_original_source');

  define('BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE_DEFAULT', serialize(array(

    'enabled' => 0,

    'key_format' => 'ALPHA'

  )));

  /* taxonRelationshipTypes */

  define('CDM_TAXON_RELATIONSHIP_TYPES_DEFAULT', serialize(

    array(

      UUID_MISAPPLIED_NAME_FOR => UUID_MISAPPLIED_NAME_FOR,

      UUID_PROPARTE_MISAPPLIEDNAME_FOR => UUID_PROPARTE_MISAPPLIEDNAME_FOR,

      UUID_PARTIAL_MISAPPLIEDNAME_FOR => UUID_PARTIAL_MISAPPLIEDNAME_FOR,

      UUID_PROPARTE_SYNONYM_FOR => UUID_PROPARTE_SYNONYM_FOR,

      UUID_PARTIAL_SYNONYM_FOR => UUID_PARTIAL_SYNONYM_FOR

    )

  ));

  /* ---- MAP SETTING CONSTANTS ---- */

  /**

   * @var array of URIs eg. http://edit.africamuseum.be"

   *   An options array

   */

  define('EDIT_MAPSERVER_URI', serialize(

      array(

        'http://edit.africamuseum.be'=>'Primary (http://edit.africamuseum.be)'

      )

    )

  );

  define('EDIT_MAPSERVER_PATH', '/edit_wp5');

  /**

   * @var array of versions eg. "v1.2"

   *   An options array

   */

  define('EDIT_MAPSERVER_VERSION', serialize(

      array(

//        'v1' => 'v1' ,           // no longer recommended

//        'v1.1' => 'v1.1',        // no longer recommended

//        'v1.2_dev' => 'v1.2_dev',// no longer recommended

        'v1.2' => 'v1.2',

        'v1.3_dev' => 'v1.3_dev (not recommended)',

        'v1.4_dev' => 'v1.4_dev (latest features)'

      )

    )

  );

  define('EDIT_MAPSERVER_URI_DEFAULT', 'http://edit.africamuseum.be');

  define('EDIT_MAPSERVER_VERSION_DEFAULT', 'v1.2');

    // --- Taxon profile settings --- /

  define('DISTRIBUTION_TEXTDATA_DISPLAY_ON_TOP', 'distribution_textdata_on_top');

  define('CDM_TAXON_PROFILE_IMAGE', 'cdm_taxon_profile_image');

  define('CDM_TAXON_PROFILE_IMAGE_DEFAULT', serialize(

      array(

          'show' => 0,

          'maxextend' => 184,

          'media_uri_query' => '',

          'custom_placeholder_enabled' => 1,

          'custom_placeholder_image_on' => 0,

          'custom_placeholder_image_fid' => ''

      )

    )

  );

define('FEATURE_BLOCK_SETTINGS', 'feature_block_settings');

define('CDM_PSEUDO_FEATURE_BLOCK_WEIGHTS', 'cdm_pseudo_feature_block_weights');

define('CDM_PSEUDO_FEATURE_BLOCK_WEIGHTS_DEFAULT', serialize(

  [

    PSEUDO_FEATURE_NUMBER_OF_TAXA => 0 - FEATURE_BLOCK_WEIGHT_INCREMENT,

    PSEUDO_FEATURE_AGGREGATION_DESCRIPTIONS => 100,

    PSEUDO_FEATURE_BIBLIOGRAPHY => 102

  ]

));

define('DISTRIBUTION_CONDENSED', 'distribution_condensed');

define('DISTRIBUTION_CONDENSED_INFO_PATH', 'distribution_condensed_info_path');

define('DISTRIBUTION_CONDENSED_INFO_PATH_DEFAULT', 'cdm_dataportal/help/condensed_distribution');

define('DISTRIBUTION_CONDENSED_RECIPE', 'distribution_condensed_recipe');

define('DISTRIBUTION_CONDENSED_RECIPE_DEFAULT', 'EuroPlusMed');

define('DISTRIBUTION_STATUS_COLORS', 'distribution_status_colors');

define('DISTRIBUTION_ORDER_MODE', 'distribution_order_mode');

define('DISTRIBUTION_ORDER_MODE_DEFAULT', 'TREE');

define('DISTRIBUTION_TREE_OMIT_LEVELS', 'distribution_tree_omit_levels');

define('CDM_SYNONYMY_AS_TAB', 'cdm_synonymy_as_tab');

define('CDM_SYNONYMY_AS_TAB_DEFAULT', 1);

/**

 * Returns the array of implemented taxon page tabs.

 * The array has fixed integer keys which must not be changed.

 */

function get_taxon_tabs_list() {

  $opts = array(

    0 => 'General',

    1 => 'Synonymy',

    2 => 'Images',

    3 => 'Specimens',

    4 => 'Keys',

    5 => 'Experts',

  );

  if(variable_get(CDM_SYNONYMY_AS_TAB, CDM_SYNONYMY_AS_TAB_DEFAULT) !== 1){

    // skip the Synonymy if it is shown in  the general tab

    unset($opts[1]);

  }

  return $opts;

}

define('CDM_TAXONPAGE_TAB_WEIGHT', 'cdm_taxonpage_tab_weight');

define('CDM_TAXONPAGE_TAB_WEIGHT_DEFAULT', serialize(

  array(

    'general' => '-3',

    'synonymy' => '-2',

    'images' => '0',

    'specimens' => '1',

    'keys' => '3',

    'experts' => '5',

    )

));

// CDM_TAXONPAGE_TAB_LABELS_DEFAULT

define('CDM_TAXONPAGE_TAB_LABELS', 'cdm_taxonpage_tab_labels');

define('CDM_TAXONPAGE_TAB_LABELS_DEFAULT', serialize(

  array(

    'general' => null,

    'synonymy' => null,

    'images' => null,

    'specimens' => null,

    'keys' => null,

    'experts' => null,

  )

));

$taxon_tab_options = get_taxon_tabs_list();

$taxon_tab_options[CDM_DATAPORTAL_LAST_VISITED_TAB_ARRAY_INDEX] = 'Last visited tab';

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

/**

 * @todo document this function.

 */

function get_taxon_options_list() {

  $taxon_tab_options = array_flip(get_taxon_tabs_list());

  foreach ($taxon_tab_options as $key => $value) {

    $taxon_tab_options[$key] = t('@key', array('@key' => $key));

  }

  return $taxon_tab_options;

}

define('CDM_SEARCH_TAXA_MODE','cdm_search_taxa_mode');

define('CDM_SEARCH_TAXA_MODE_DEFAULT', serialize(

    // to unset a default entry set the value to 0

    array(

      'doTaxa'=>'doTaxa',

      'doSynonyms' => 'doSynonyms',

      'doTaxaByCommonNames' => 0,

      'doMisappliedNames' => 'doMisappliedNames'

    )

  )

);

define('CDM_SEARCH_AREA_FILTER_PRESET', 'cdm_search_area_filter_preset');

define('SIMPLE_SEARCH_USE_LUCENE_BACKEND', 'simple_search_use_lucene_backend');

define('SIMPLE_SEARCH_IGNORE_CLASSIFICATION', 'simple_search_ignore_classification');

define('SIMPLE_SEARCH_AUTO_SUGGEST', 'cdm_search_taxa_auto_suggest');

/* Gallery variables. */

$gallery_settings = array(

    "cdm_dataportal_show_taxon_thumbnails" => 1,

    "cdm_dataportal_show_synonym_thumbnails" => 0,

    "cdm_dataportal_show_thumbnail_captions" => 1,

    "cdm_dataportal_media_maxextend" => 120,

    "cdm_dataportal_media_cols" => 3,

    "cdm_dataportal_media_maxRows" => 1,

);

define('TAXONPAGE_VISIBILITY_OPTIONS_DEFAULT', serialize(get_taxon_options_list()));

define('CDM_DATAPORTAL_GALLERY_SETTINGS', serialize($gallery_settings));

define('CDM_DATAPORTAL_SPECIMEN_GALLERY_NAME', 'specimen_gallery');

define('CDM_DATAPORTAL_TYPE_SPECIMEN_GALLERY_NAME', 'type_specimen_gallery');

define('CDM_DATAPORTAL_DESCRIPTION_GALLERY_NAME', "description_gallery");

define('CDM_DATAPORTAL_TAXON_MEDIA_GALLERY_NAME_TAB', "taxon_tab_media_gallery");

define('CDM_DATAPORTAL_SEARCH_GALLERY_NAME', "search_gallery");

define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS', 'cdm_dataportal_display_taxon_relationships');

define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS', 'cdm_dataportal_display_name_relations');

// define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_2', array("default" => t('Display all')));

define('CDM_DATAPORTAL_DISPLAY_TAXON_RELATIONSHIPS_DEFAULT', 1);

define('CDM_DATAPORTAL_DISPLAY_NAME_RELATIONSHIPS_DEFAULT', 1);

define('CDM_STANDARD_IMAGE_VIEWER', "cdm_standard_image_viewer");

define('CDM_STANDARD_IMAGE_VIEWER_DEFAULT', serialize(array(

  'media_representation_details_enabled' => 0

)));

/**

 * The drupal variable key for the array containing the uuids of the taxon relationship types to display in

 * the synonymy.

 *

 * @var string

 */

define('CDM_TAXON_RELATIONSHIP_TYPES', 'cdm_taxon_relationship_types');

define('CDM_NAME_RELATIONSHIP_INLINE_TYPES', 'cdm_name_relationship_types');

define('CDM_NAME_RELATIONSHIP_INLINE_TYPES_DEFAULT', serialize(

    array(

      UUID_NAMERELATIONSHIPTYPE_LATER_HOMONYM => UUID_NAMERELATIONSHIPTYPE_LATER_HOMONYM,

      UUID_NAMERELATIONSHIPTYPE_TREATED_AS_LATER_HOMONYM => UUID_NAMERELATIONSHIPTYPE_TREATED_AS_LATER_HOMONYM,

      UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR => UUID_NAMERELATIONSHIPTYPE_BLOCKING_NAME_FOR

    )

  )

);

define('CDM_NAME_RELATIONSHIP_LIST_TYPES', 'cdm_name_relationship_list_types');

/**

 * The drupal variable for the configuration of the information aggregation along

 * the taxon relation ships. The mapped array is associative and holds two elements:

 *    - direct: the uuids of the taxon relationship types to take into account in invers

 *      direction.

 *    - invers: the uuids of the taxon relationship types to take into account in direct

 *      direction.

 *

 * @var String

 */

define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS', 'cdm_aggregate_by_taxon_relationships');

define('CDM_AGGREGATE_BY_TAXON_RELATIONSHIPS_DEFAULT', serialize(

    array(

        'direct'=>array(),

        'invers'=>array()

     )

   ));

define('CDM_PROFILE_FEATURETREE_UUID', 'cdm_dataportal_featuretree_uuid');

define('CDM_OCCURRENCE_FEATURETREE_UUID', 'cdm_occurrence_featuretree_uuid');

define('CDM_DATAPORTAL_STRUCTURED_DESCRIPTION_FEATURETREE_UUID', 'cdm_dataportal_structdesc_featuretree_uuid');

define('CDM_DISTRIBUTION_FILTER', 'cdm_distribution_filter');

define('CDM_DISTRIBUTION_FILTER_DEFAULT', serialize(

      array(

      'filter_rules' => array(

        'statusOrderPreference' => 0,

        'subAreaPreference' => 0,

      ),

      'hiddenAreaMarkerType' => array()

     )

));

define('DISTRIBUTION_HIERARCHY_STYLE', 'distribution_hierarchy_style');

define('DISTRIBUTION_HIERARCHY_STYLE_DEFAULT', serialize(array(

  "level_0" => array(

    'label_suffix' => '',

    'status_glue' => '',

    'item_suffix' => ': ',

    'item_glue' => ', ',

    'item_group_prefix' => '',

    'item_group_postfix' => ''

  ),

  "level_1" => array(

    'label_suffix' => '',

    'status_glue' => '‒ ', // '‒ '

    'item_suffix' => '',

    'item_glue' => '; ',

    'item_group_prefix' => '',

    'item_group_postfix' => ''

  ),

  "level_2" => array(

    'label_suffix' => '',

    'status_glue' => '‒ ', // '‒ '

    'item_suffix' => '',

    'item_glue' => ', ',

    'item_group_prefix' => ' (',

    'item_group_postfix' => ')'

  )

)));

/**

 * Constant for the drupal variable key distribution_map_visibility

 *

 * possible values:

 *  - never

 *  - automatic

 *  - always

 */

define('DISTRIBUTION_MAP_VISIBILITY', 'distribution_map_visibility');

define('DISTRIBUTION_MAP_VISIBILITY_DEFAULT', 'automatic');

/**

 * Constant for the drupal variable key specimen_map_visibility

 *

 * possible values:

 *  - never

 *  - automatic

 *  - always

 */

define('SPECIMEN_MAP_VISIBILITY', 'specimen_map_visibility');

define('SPECIMEN_MAP_VISIBILITY_DEFAULT', 'automatic');

define('CDM_TAXON_MEDIA_FILTER', 'cdm_taxon_media_filter');

define('CDM_TAXON_MEDIA_FILTER_DEFAULT', serialize(

    array(

        'includeTaxonDescriptions' => 'includeTaxonDescriptions',

        'includeOccurrences' => 0,

        'includeTaxonNameDescriptions' => 0

     )

  ));

define('CDM_MAP_DISTRIBUTION', 'cdm_map_distribution');

define('CDM_MAP_DISTRIBUTION_DEFAULT', serialize(array(

  // needs to be merged with user setting by drupal_array_merge_deep()

  // 'width' => 512, // optimum size for OSM layers is 512

  // 'height' => 512 / 2, // optimum size for OSM layers 256

  'aspect_ratio' => 2,

  'bbox' => '', // empty to allow automatic zooming to extend

  'maxZoom' => 13, // see https://dev.e-taxonomy.eu/redmine/issues/9458

  'show_labels' => FALSE,

  'caption' => '',

  'distribution_opacity' => '0.5',

  'map_type' => 1, //  1 = 'openlayers', 0 = 'image'

  'image_map' => array(

    'base_layer' => '', // none, formerly this was cyprusdivs

    'bg_color' => '1874CD',

    'layer_style' => 'ffffff,606060,,',

  ),

  'openlayers' => array(

    'base_layers' =>  array(

      // A layer MUST NOT BE SET in the defaults,

      // otherwise it can not be overidden by the user settings:

      // 'mapproxy_vmap0' => 'mapproxy_vmap0',

      // it is sufficient to define the preferred layer,

      // since it will automatically be enabled:

      'PREFERRED' => 'open_topomap'),

    'custom_wms_base_layer' => array(

      'name' => NULL,

      'url' => NULL,

      'params' =>  NULL,

      'projection' => NULL,

      'proj4js_def' => NULL,

      'max_extent' => NULL,

      'units' => NULL,

      'untiled' => FALSE

    ),

    'wms_overlay_layer' => array(

      'name' => NULL,

      'url' => NULL,

      'params' =>  NULL,

      'untiled' => FALSE

    ),

    'show_layer_switcher' => TRUE,

    'display_outside_max_extent' => FALSE,

    'google_maps_api_key' => NULL,

  ),

  'legend' => array(

    'show' => TRUE,

    'opacity' => '0.5',

    'font_size' => 10,

    'font_style' => FALSE,

    'icon_width' => 35,

    'icon_height' => 15

  )

)));

/**

 * Merges the named array variable with the array of defaults.

 *

 * IMPORTANT: The array keys must be strings. When the keys are integers

 * the merging will not take place for these entities. Number keyed entities

 * are just appended to the result array.

 *

 * @param string $variable_name

 *     The variable name

 * @param string | array $default

 *     The array containing the default values either as array or serialized as string.

 *     Unserialization is cared for if necessary

 * @return array

 *     The merged array as returned by drupal_array_merge_deep()

 *

 * TODO compare with mixed_variable_get() duplicate functions? => result use this function instead of mixed_variable_get()

 * TODO force $default being an array

 */

function get_array_variable_merged($variable_name, $default){

    // unserialize if nessecary

    if(!is_array($default)){

      $default = unserialize($default);

    }

    $variable = variable_get($variable_name, array());

    $result = drupal_array_merge_deep($default, $variable);

    return $result;

}

/**

 * @todo document this function.

 */

function getGallerySettings($gallery_config_form_name) {

  return get_array_variable_merged($gallery_config_form_name, CDM_DATAPORTAL_GALLERY_SETTINGS);

}

/**

 * Returns the string representation of the default tab.

 *

 * @param bool $returnTabIndex

 *   Defaults to FALSE, if set true this function will return the index number

 *   of the default tab. (used to supply default values to form elements).

 */

function get_default_taxon_tab($returnTabIndex = FALSE) {

  global $user;

  $values = unserialize(CDM_DATAPORTAL_DEFAULT_TAXON_TAB);

  $user_tab_active = 'cdm_dataportal_' . $user->uid . '_default_tab_active';

  $user_tab = 'cdm_dataportal_' . $user->uid . '_default_tab';

  // Get the user value if the used has chosen to overwrite the system settings.

  $user_tab_on = variable_get($user_tab_active, FALSE);

  if ($user_tab_on) {

    $user_value = variable_get($user_tab, 0);

    $index_value = $user_value;

    // Get the system value.

  }

  else {

    $system_value = variable_get('cdm_dataportal_default_tab', 0);

    $index_value = $system_value;

  }

  // Return the index value or the string representation.

  if ($returnTabIndex) {

    return $index_value;

  }

  else {

    return ($values[$index_value]);

  }

}

/**

 * Provides the feature block settings for a specific feature which matches the $feature_uuid parameter.

 *

 * In case specifically configured settings array, like these which are stored in the drupal variables, is missing

 * one or more fields these fields are taken from the default. That is the specific settings are always merges

 * with the default.

 *

 * Note: These settings only apply to feature blocks which do not have a special rendering

 * the specially handled features (e.g.: Distribution, CommonNames) may make use of the

 * 'special' element of the settings

 *

 * @param $feature_uuid

 *   The uuid string representation of the feature to return the settings for

 *

 * @return array

 *  an associative array of settings, with the following fields:

 *    - as_list: string

 *        this setting will be used in compose_feature_block_wrap_elements() as $enclosing_tag

 *        possible values are:

 *          div: not as list,

 *          ul: as bullet list,

 *          ol: as numbered list,

 *          dl: as definition list

 *        The tag used for the inner element, thus depends on the value of this field. The

 *        inner tag name can be retrieved by the function cdm_feature_block_element_tag_name()

 *    - link_to_reference: boolean,

 *        render the reference as link, ignored if the element is NOT a DescriptionElementSource

 *    - link_to_name_used_in_source": boolean

 *        whether to show name in source information as link which will point to the according name page

 *    - sources_as_content (boolean)

 *        TRUE (int: 1):

 *          1. If element is of the CDM type TextData and the text is not empty the source references will be

 *             appended in brackets like "text (source references)". If the original source has name in source

 *             information it will be appended to the citation string,

 *             like : "(citation, as name in source; citation, as name in source)"

 *          2. if the text of the TextData is empty, the original source citations are the only content

 *             (e.g. use case CITATION) and are not put into brackets. In this case the nameInSource is

 *             prepended to the citation string like: "name in source: citation"

 *        FALSE (int: 0):

 *          Original sources are put into the bibliography(=references) pseudo feature block. If the original source

 *          citations are the only content, the resulting feature block content would only consist of footnotes.

 *          In this case the display of the respective feature block is suppressed.

 *          TODO if the bibliography is not enabled the sources will be treated as footnotes like annotations,

 *               in future however they will in this case be shown in a separate references section for each

 *               feature block.

 *    - sources_as_content_to_bibliography  (boolean)

 *        Only valid if sources_as_content == TRUE, will cause the sources to be also shown

 *        in the bibliography.

 *    - sort_elements

 *        whether and how to sort the elements

 *        possible values are the constants SORT_ASC, SORT_DESC, NULL,

 *        some feature types (Distribution) also support: SORT_HIERARCHICAL (

 *        TODO option to exclude levels, put in special?,

 *        TODO make use of this setting in compose_feature_block_wrap_elements())

 *    - element_tag

 *        specifies the tag to be used for creating the elements, only applies if "as_list" == 'div'

 *        possible values are span | div. the proper inner tag name can be retrieved by the function

 *        cdm_feature_block_element_tag_name()

 *    - special: array()

 *        an array with further settings, this field can be used for special

 *        settings for specialized rendering like for distributions

 *  }

 *

 */

function get_feature_block_settings($feature_uuid = 'DEFAULT') {

  // the default must conform to the default parameter values of

  // compose_feature_block_wrap_elements() : $glue = '', $sort = FALSE, $enclosing_tag = 'ul'

  // compose_description_element_text_data() : asListElement = NULL

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

  // ---- DEFAULTS settings

  // only needed as final option, when the settings are not having a default

  $default = array(

    'DEFAULT' => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    ),

    // settings for pseudo feature bibliography

    // only hard coded here

    'BIBLIOGRAPHY' => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    )

  );

  // will be used as preset in the settings

  $other_themes_default = array(

    'DEFAULT' => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    ),

    UUID_CITATION => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 0,

      'sources_as_content' => 1,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => SORT_ASC,

      'glue' => '',

      'element_tag' => 'div'

    ),

    UUID_DISTRIBUTION => array(

      'as_list' => 'div', // currently ignored

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 0,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT, // will cause ...

      'glue' => '',

      'element_tag' => 'div',

      'special' => array()

    ),

    UUID_COMMON_NAME => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => 'span'

    ),

  );

  // ---- Special DEFAULTS for existing portals

  // TODO:

  // this can be removed once the feature block

  // settings have been deployed for the first time to these portals

  $cichorieae_default = array(

    'DEFAULT' => array(

      'as_list' => 'div',

      'link_to_reference' => 1,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 1,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => 'div'

    ),

    UUID_CITATION => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 0,

      'sources_as_content' => 1,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => SORT_ASC,

      'glue' => '',

      'element_tag' => 'div'

    ),

    UUID_CHROMOSOMES_NUMBERS => array(

      'as_list' => 'ul',

      'link_to_reference' => 1,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 1,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => 'div'

    ),

    UUID_CHROMOSOMES => array(

      'as_list' => 'ul',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 1,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => 'div'

    ),

    UUID_COMMON_NAME => array(

      'as_list' => 'div',

      'link_to_reference' => 0,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 0,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => 'span'

    ),

  );

  $palmweb_default = array(

    'DEFAULT' => array(

      'as_list' => 'ul',

      'link_to_reference' => 1,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 1,

      'sources_as_content_to_bibliography' => 1,

      'sort_elements' => NO_SORT,

      'glue' => '',

      'element_tag' => NULL

    ),

    UUID_CITATION => array(

      'as_list' => 'ul',

      'link_to_reference' => 1,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 0,

      'sources_as_content_to_bibliography' => 1,

      'sort_elements' => SORT_ASC,

      'glue' => '',

      'element_tag' => 'div'

    ),

    UUID_DISTRIBUTION => array(

      'as_list' => 'div', // currently ignored

      'link_to_reference' => 1,

      'link_to_name_used_in_source' => 1,

      'sources_as_content' => 1, // FIXME seems to have no effect see Acanthophoenix rousselii (palmae)

      'sources_as_content_to_bibliography' => 1,

      'sort_elements' => NO_SORT, // will cause ...

      'glue' => ', ',

      'element_tag' => 'span',

      'special' => array()

    ),

  );

  $cyprus_default = $cichorieae_default;

  $cyprus_default[UUID_DISTRIBUTION] = array(

    'as_list' => 'div', // currently ignored

    'link_to_reference' => 0,

    'link_to_name_used_in_source' => 0,

    'sources_as_content' => 0,

    'sources_as_content_to_bibliography' => 0,

    'sort_elements' => NO_SORT, // will cause ...

    'glue' => ' ',

    'element_tag' => 'div',

    'special' => array()

  );

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

  switch ($default_theme) {

    case 'garland_cichorieae':

      $settings_for_theme = $cichorieae_default;

      break;

    case 'cyprus':

      // cyprus: no longer used in production,

      // but is required for selenium tests see class eu.etaxonomy.dataportal.pages.PortalPage

      $settings_for_theme = $cyprus_default;

      break;

    case 'flore_afrique_centrale':

    case 'flora_malesiana':

    case 'flore_gabon':

      $settings_for_theme = $cichorieae_default;

      $settings_for_theme[UUID_CITATION]['as_list'] = 'ul';

      break;

    case 'palmweb_2':

      $settings_for_theme = $palmweb_default;

      break;

    default:

      $settings_for_theme = $other_themes_default;

  }

  // add pseudo feature settings

  $settings_for_theme['BIBLIOGRAPHY'] = $default['BIBLIOGRAPHY'];

  // ---- END of DEFAULTS

  $saved_settings = variable_get(FEATURE_BLOCK_SETTINGS, NULL);

  $feature_block_setting = null;

  if (isset($saved_settings[$feature_uuid])) {

    $feature_block_setting = $saved_settings[$feature_uuid];

  }

  else if (isset($settings_for_theme[$feature_uuid])) {

    $feature_block_setting = $settings_for_theme[$feature_uuid];

  }

  else if (isset($settings_for_theme['DEFAULT'])) {

    $feature_block_setting = $settings_for_theme['DEFAULT'];

  }

  // now merge the default and specific settings

  $settings_to_merge = array($default['DEFAULT']);

  if(is_array($saved_settings)){

    $settings_to_merge[] = $saved_settings['DEFAULT'];

  }

  if(isset($feature_block_setting)){

    $settings_to_merge[] = $feature_block_setting;

  }

  $feature_block_setting = drupal_array_merge_deep_array($settings_to_merge);

  return $feature_block_setting;

}

/**

 * returns the current setting for the original source bibliography

 *

 * Caches internally

 *

 * @return array

 *  the setting for the original source bibliography see BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE:

 *   - 'enabled': 1|0

 *   - 'key_format': one of 'latin', 'ROMAN', 'roman', 'ALPHA', 'alpha'

 */

function get_bibliography_settings($clear_cache = false){

  static $bibliography_settings = null;

  if(!$bibliography_settings || $clear_cache){

    $bibliography_settings = get_array_variable_merged(

      BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE,

      BIBLIOGRAPHY_FOR_ORIGINAL_SOURCE_DEFAULT

    );

  }

  return $bibliography_settings;

}

/**

 * @todo Please document this function.

 * @see http://drupal.org/node/1354

 */

function cdm_dataportal_menu_admin(&$items) {

  // Display section on admin/config page.

  $items['admin/config/cdm_dataportal'] = array(

    'title' => 'CDM Dataportal',

    'description' => 'Settings for the CDM DataPortal.',

    'position' => 'right',

    'weight' => 10,

    'page callback' => 'system_admin_menu_block_page',

    'access arguments' => array('administer cdm_dataportal'),

    'file' => 'system.admin.inc',

    'file path' => drupal_get_path('module', 'system'),

  );

  $items['admin/config/cdm_dataportal/settings'] = array(

    'title' => 'Settings',

    'description' => 'Settings for the CDM DataPortal.',

    'weight' => 0,

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_general'),

    'access arguments' => array('administer cdm_dataportal'),

    'type' => MENU_NORMAL_ITEM,

  );

  $items['admin/config/cdm_dataportal/settings/general'] = array(

    'title' => 'General',

    'description' => 'General',

    'weight' => 0,

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_general'),

    'access arguments' => array('administer cdm_dataportal'),

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/cachesite'] = array(

    'title' => 'Cache',

    'description' => 'Cache',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_cache'),

    'weight' => 10,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/geo'] = array(

    'title' => 'Geo & Map',

    'description' => 'Geo & Map',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_geo'),

    'weight' => 1,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/layout'] = array(

    'title' => 'Layout',

    'description' => 'Configure and adjust the layout of your DataPortal ',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_layout'),

    'weight' => 2,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/layout/taxon'] = array(

    'title' => 'Taxon page',

    'description' => 'Configure and adjust the layout of your DataPortal ',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_layout_taxon'),

    'weight' => 1,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/layout/name-page'] = array(

    'title' => 'Name page',

    'description' => 'Configure and adjust the layout of your DataPortal ',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_layout_name_page'),

    'weight' => 1,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/layout/search'] = array(

    'title' => 'Search',

    'description' => 'Configure and adjust the layout of your DataPortal ',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_layout_search'),

    'weight' => 2,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/cdm_dataportal/settings/layout/media'] = array(

    'title' => 'Media',

    'description' => 'Configure and adjust the layout of your DataPortal ',

    'access arguments' => array('administer cdm_dataportal'),

    'page callback' => 'drupal_get_form',

    'page arguments' => array('cdm_settings_layout_media'),

    'weight' => 3,

    'type' => MENU_LOCAL_TASK,

  );

}

/**