""" Module that control the behaviour of shape files and containers """ import os import tempfile import shutil # Fix gdal 2.40 and 3.3 integration problems try: import ogr except ModuleNotFoundError: from osgeo import ogr from tools import const from MG.tools.postgis_api import PostGis from .masterDriver import MasterDriver class SHAPE(MasterDriver): """ Class that control de shape files """ format = 'shp' gdal_driver = 'ESRI Shapefile' driver_type = const.VECTOR_KEY name = const.SHAPE_KEY _shp_extensions = ['shp', 'shx', 'dbf', 'prj', 'xml', 'sbn', 'sbx', 'cpg'] def to_local(self, layer, *_, **__): """ Get remote source to out local environment Parameters ---------- layer: :obj:`Layer` Layer from remote source _: optional Arguments __: optional Arguments Returns ------- success: dict New parameters of the layer """ url = layer.gdal_layer(with_vsi=False) shp = layer['source'].split('/')[-1][:-4] user = layer.user postgis_obj = PostGis('Public') server_name = "{}_SHP_{}_{}".format(user, shp, layer['layer_name']).\ replace(' ', '_') foreign_table_name = "SHP_{}_{}_ft".format(shp, layer['layer_name']).\ replace(' ', '_') status_wrapper_shp = postgis_obj.wrapper_shp_pg(user, server_name, url, user, shp, foreign_table_name) new_parameters = {'ip': postgis_obj.ip, 'port': postgis_obj.port, 'protocol': const.POSTGRESQL_KEY, 'driver_type': const.POSTGRESQL_KEY, 'user': postgis_obj.user, 'password': postgis_obj.passw, 'database_name': postgis_obj.dbname, 'layer_name': shp, 'table_view_name': status_wrapper_shp['layer'], 'schema': user} return new_parameters def download(self, layer, dst, *_, **__): """ Method to download the source from remote to local file. Parameters ---------- layer: :obj:`Layer` Layer from remote source dst: str Path to save the file _: list Arguments __: dict Arguments Returns ------- success: str Path where the file has been saved """ dst = self.check_source(dst) for extension in self._shp_extensions: src_path = "{}.{}".format(layer['source'].split('.')[0], extension) if layer.protocol.exists(src_path): layer.protocol.download(src_path, dst) # Removing, if exists, table in user's schema. # The method "to_local" has been executed earlier. postgis_obj = PostGis(layer.user) postgis_obj.get_foreign_server_from_ft( layer.user, layer.local_parameters['table_view_name']) return "{}.{}".format(layer['source'].split('.')[0], 'shp') def upload(self, layer, src, dst, *_, **__): """ Method to upload file from out local system to remote Parameters ---------- layer: :obj:`Layer` Layer from remote source src: str Path in local system dst: str Path in remote system _: list Arguments __: dict Arguments Returns ------- success: None """ root_dir = os.path.join(*src.split('/')[:-1]) filename = src.split('/')[-1].split('.')[0] dst_path = os.path.join(*dst.split('/')[:-1]) dst_name = dst.split('/')[-1].split('.')[0] for extension in self._shp_extensions: src_path = os.path.join(root_dir, '{}.{}'.format(filename, extension)) if os.path.exists(src_path): dst_file = layer.protocol.join(dst_path, '{}.{}'.format( dst_name, extension)) layer.protocol.upload(src_path, dst_file) def remove(self, source, *_): """ Remove sources Parameters ---------- source: str Path to remove _: list Arguments Returns ------- success: None """ # Everything on this driver are going to be files or folder if os.path.isdir(source): shutil.rmtree(source) elif os.path.isfile(source): filename = source.split('.')[0] for extension in self._shp_extensions: src_path = '{}.{}'.format(filename, extension) if os.path.exists(src_path): os.remove(src_path) def translate(self, src_layer, dst_driver): """ Translate layer from one driver to another Parameters ---------- src_layer: :obj:`Layer` Origin layer dst_driver: :obj:`Layer` Destiny layer Returns ------- success: list Resulting files """ tmp_dir = tempfile.mkdtemp(dir=const.TMP_DIRECTORY) result_files = [] for source in src_layer.attached_sources: gdal_layer_source = src_layer.gdal_url(source) file_name = source.split(os.sep)[-1].split('.')[0] file_result = os.path.join(tmp_dir, file_name) file_result = dst_driver.check_source(file_result) command = 'ogr2ogr -overwrite -f "{output_format}" ' \ '"{output_connection}" "{input_connection}"'.\ format(output_format=dst_driver.gdal_driver, output_connection=file_result, input_connection=gdal_layer_source) result_files.append(file_result) os.system(command) zipped = len(result_files) > 1 if zipped: output_result = src_layer['source'].split('/')[-1].split('.')[0] zip_output = os.path.join(tmp_dir, '{}.zip'.format(output_result)) result_names = [name.split(os.sep)[-1].split('.')[0] + "*" for name in result_files] command = "cd {} && zip -q {} {}".format(tmp_dir, zip_output. split(os.sep)[-1], ' '.join(result_names)) os.system(command) # Update layer new_cloud_parameters = { 'driver_type': const.ZIP_KEY, 'source': "{}/{}.zip".format('/'.join(src_layer['source']. split('/')[:-1]), output_result) } src_layer.cloud_parameters.update(new_cloud_parameters) result_files = [zip_output] src_layer.residual_sources.append(tmp_dir) return result_files def publish(self, *_, **__): """ Publish on Geoserver Parameters ---------- _ __ Returns ------- """ return None def check_source(self, source): """ Check that source follow the naming rules of the driver Parameters ---------- source: str Path to the source Returns ------- success: str Formatted path to the source """ # Checking dst path has_extension = len(source.split('.')) >= 2 if not has_extension: # Adding extension source = "{}.{}".format(source, self.format) return source def get_source(self, layer, *_, only_name=False, **__): """ Get source path with the format of the driver Parameters ---------- layer: :obj: `Layer` only_name: bool Get only the name or full path _: list Arguments __: dict Arguments Returns ------- success: str Formatted source """ if only_name: return layer['source'].split('/')[-1].split('.')[0] return layer['source'] def check(self, layer): """ Check that source Parameters ---------- layer: :obj: `Layer` Returns ------- bool True if successful, False otherwise. """ data_source = ogr.Open(layer.gdal_layer(), 0) if not data_source: return False return True def create(self, *_): """ With the execution of the wrapper, the foreign table is obtained from which the attributes that the user indicates will be extracted, for subsequent preview. Parameters ---------- _: Notes ----- This method will return None for all layers except Postgres, since once the wrapper is done, all layers are foreign tables. Returns ------- success: None """ return None def list(self, layer): """ Get the list of attributes and layer name of the source Parameters ---------- layer: :obj: `Layer` Returns ------- dict dict containing layer and attributes. {"layers": [{"name": 'layer1', 'attributes': [attr1, attr2, ...]}]} """ data_source = ogr.Open(layer.gdal_layer(), 0) data = {'layers': []} for layer_ogr in data_source: layer_data = dict() layer_data['name'] = layer_ogr.GetName() layer_data['attributes'] = [] layer_definition = layer_ogr.GetLayerDefn() for meta in range(layer_definition.GetFieldCount()): field_definition = layer_definition.GetFieldDefn(meta) attribute_layer = field_definition.name layer_data['attributes'].append(attribute_layer) if layer_definition.GetGeomFieldCount() >= 1: layer_data['attributes'].append('geom') data['layers'].append(layer_data) return data def preview(self, _): """ Get the info to preview Parameters ---------- _: :obj: `Layer` Returns ------- bool True if successful. """ return True def prelist(self, layer): """ list the layers of sources to preview Parameters ---------- layer: :obj: `Layer` Returns ------- list List that contain the layer name """ data_source = ogr.Open(layer.gdal_layer(), 0) head = ["layers"] layers = [] output_list = [] for lay in data_source: layers.append([lay.GetName()]) output_list.append(head) output_list.append(layers) return output_list class ContainerSHP(SHAPE): """ Class that control de shape files containers, like folders. """ def to_local(self, layer, *args, **kwargs): layer_new = layer.copy() file = layer_new.parameters['layer_name'] layer_new.parameters["source"] = "{}/{}.shp".format( layer_new.parameters['source'], file) layer_new.update_driver_and_protocol(layer_new.parameters) return SHAPE.to_local(self, layer_new, *args, **kwargs)