geonode.layers.utils
====================

.. py:module:: geonode.layers.utils

.. autoapi-nested-parse::

   Utilities for managing GeoNode layers



Attributes
----------

.. autoapisummary::

   geonode.layers.utils.READ_PERMISSIONS
   geonode.layers.utils.WRITE_PERMISSIONS
   geonode.layers.utils.DOWNLOAD_PERMISSIONS
   geonode.layers.utils.OWNER_PERMISSIONS
   geonode.layers.utils.logger
   geonode.layers.utils._separator
   geonode.layers.utils.default_dataset_download_handler
   geonode.layers.utils.dataset_download_handler_list


Functions
---------

.. autoapisummary::

   geonode.layers.utils._clean_string
   geonode.layers.utils.resolve_regions
   geonode.layers.utils.get_files
   geonode.layers.utils.dataset_type
   geonode.layers.utils.get_valid_name
   geonode.layers.utils.get_valid_dataset_name
   geonode.layers.utils.get_default_user
   geonode.layers.utils.is_vector
   geonode.layers.utils.is_raster
   geonode.layers.utils.get_resolution
   geonode.layers.utils.get_bbox
   geonode.layers.utils.delete_orphaned_datasets
   geonode.layers.utils.surrogate_escape_string
   geonode.layers.utils.set_datasets_permissions
   geonode.layers.utils.get_uuid_handler
   geonode.layers.utils.validate_input_source
   geonode.layers.utils.is_xml_upload_only
   geonode.layers.utils.is_sld_upload_only
   geonode.layers.utils.mdata_search_by_type
   geonode.layers.utils.get_dataset_download_handlers
   geonode.layers.utils.get_default_dataset_download_handler
   geonode.layers.utils.set_default_dataset_download_handler
   geonode.layers.utils.clear_dataset_download_handlers


Module Contents
---------------

.. py:data:: READ_PERMISSIONS
   :value: ['view_resourcebase']


.. py:data:: WRITE_PERMISSIONS
   :value: ['change_dataset_data', 'change_dataset_style', 'change_resourcebase_metadata']


.. py:data:: DOWNLOAD_PERMISSIONS
   :value: ['download_resourcebase']


.. py:data:: OWNER_PERMISSIONS
   :value: ['change_resourcebase', 'delete_resourcebase', 'change_resourcebase_permissions', 'publish_resourcebase']


.. py:data:: logger

.. py:data:: _separator

.. py:function:: _clean_string(str, regex='(^[^a-zA-Z\\._]+)|([^a-zA-Z\\._0-9]+)', replace='_')

   Replaces a string that matches the regex with the replacement.


.. py:function:: resolve_regions(regions)

.. py:function:: get_files(filename)

   Converts the data to Shapefiles or Geotiffs and returns
   a dictionary with all the required files


.. py:function:: dataset_type(filename)

   Finds out if a filename is a Feature or a Vector
   returns a gsconfig resource_type string
   that can be either 'featureType' or 'coverage'


.. py:function:: get_valid_name(dataset_name)

   Create a brand new name


.. py:function:: get_valid_dataset_name(layer, overwrite)

   Checks if the layer is a string and fetches it from the database.


.. py:function:: get_default_user()

   Create a default user


.. py:function:: is_vector(filename)

.. py:function:: is_raster(filename)

.. py:function:: get_resolution(filename)

.. py:function:: get_bbox(filename)

   Return bbox in the format [xmin,xmax,ymin,ymax].


.. py:function:: delete_orphaned_datasets()

   Delete orphaned layer files.


.. py:function:: surrogate_escape_string(input_string, source_character_set)

   Escapes a given input string using the provided source character set,
   using the `surrogateescape` codec error handler.


.. py:function:: set_datasets_permissions(permissions_name, resources_names=None, users_usernames=None, groups_names=None, delete_flag=False, verbose=False)

.. py:function:: get_uuid_handler()

.. py:function:: validate_input_source(layer, filename, files, gtype=None, action_type='replace', storage_manager=storage_manager)

.. py:function:: is_xml_upload_only(request)

.. py:function:: is_sld_upload_only(request)

.. py:function:: mdata_search_by_type(request, filetype)

.. py:data:: default_dataset_download_handler
   :value: None


.. py:data:: dataset_download_handler_list
   :value: []


.. py:function:: get_dataset_download_handlers()

.. py:function:: get_default_dataset_download_handler()

.. py:function:: set_default_dataset_download_handler(handler)

.. py:function:: clear_dataset_download_handlers()