def _get_validator(self):
'''
Returns the validator object using the relevant profiles
The profiles to be used are assigned in the following order:
1. 'validator_profiles' property of the harvest source config object
2. 'ckan.spatial.validator.profiles' configuration option in the ini file
3. Default value as defined in DEFAULT_VALIDATOR_PROFILES
'''
if not hasattr(self, '_validator'):
if hasattr(self, 'source_config') and self.source_config.get(
'validator_profiles', None):
profiles = self.source_config.get('validator_profiles')
elif config.get('ckan.spatial.validator.profiles', None):
profiles = [
x.strip() for x in config.get(
'ckan.spatial.validator.profiles').split(',')
]
else:
profiles = DEFAULT_VALIDATOR_PROFILES
self._validator = Validators(profiles=profiles)
# Add any custom validators from extensions
for plugin_with_validators in p.PluginImplementations(
ISpatialHarvester):
custom_validators = plugin_with_validators.get_validators()
for custom_validator in custom_validators:
if custom_validator not in all_validators:
self._validator.add_validator(custom_validator)
return self._validator
def setup_class(cls):
# TODO: Fix these tests, broken since 27c4ee81e
raise SkipTest('Validation tests not working since 27c4ee81e')
SpatialHarvester._validator = Validators(profiles=['iso19139eden', 'constraints', 'gemini2'])
HarvestFixtureBase.setup_class()
def transform_to_iso(self, original_document, original_format,
harvest_object):
if original_format != 'fgdc':
return None
transform_service = config.get('ckanext.geodatagov.fgdc2iso_service')
if not transform_service:
self._save_object_error('No FGDC to ISO transformation service',
harvest_object, 'Import')
return None
# Validate against FGDC schema
if self.source_config.get('validator_profiles'):
profiles = self.source_config.get('validator_profiles')
else:
profiles = ['fgdc_minimal']
validator = Validators(profiles=profiles)
for custom_validator in custom_validators:
validator.add_validator(custom_validator)
is_valid, profile, errors = self._validate_document(
original_document, harvest_object, validator=validator)
if not is_valid:
# TODO: Provide an option to continue anyway
return None
original_document = re.sub('<\?xml(.*)\?>', '', original_document)
tree = etree.fromstring(original_document)
comments = tree.xpath('//comment()')
for comment in comments:
p = comment.getparent()
if p:
p.remove(comment)
ptvctcnt = tree.xpath('//ptvctcnt')
for node in ptvctcnt:
p = node.getparent()
if p and not node.text:
p.remove(node)
themekt = tree.xpath('//placekt')
for num, node in enumerate(themekt):
p = node.getparent()
###remove all but first
if p and num > 0:
p.remove(node)
original_document = etree.tostring(tree)
response = requests.post(
transform_service,
data=original_document.encode('utf8'),
headers={'content-type': 'text/xml; charset=utf-8'})
if response.status_code == 200:
# XML coming from the conversion tool is already declared and encoded as utf-8
return response.content
else:
msg = 'The transformation service returned an error for object {0}'
if response.status_code and response.content:
msg += ': [{0}] {1}'.format(response.status_code,
response.content)
elif response.error:
msg += ': {0}'.format(response.error)
self._save_object_error(msg, harvest_object, 'Import')
return None
class PacGeoHarvester(CSWHarvester):
_validator = Validators(profiles=[])
def info(self):
'''
Return information about this harvester.
'''
return {
'name': 'pacgeo',
'title': 'PacGeo',
'description': 'Harvester for PacGeo'
}
def _set_source_config(self, source_config):
super(CSWHarvester, self)._set_source_config(source_config)
try:
config_json = json.loads(source_config)
self.keywords = config_json['keywords']
except (KeyError, ValueError):
self.keywords = []
def gather_stage(self, harvest_job):
logger.debug('CswHarvester gather_stage for job: %r', harvest_job)
# Get source URL
url = harvest_job.source.url
self._set_source_config(harvest_job.source.config)
parts = urlparse.urlparse(url)
params = {'keywords__slug__in': self.keywords, 'limit': 10000}
url = urlparse.urlunparse((
parts.scheme, parts.netloc, '/api/layers', None,
urllib.urlencode(params, True), None
))
query = model.Session.query(
HarvestObject.guid, HarvestObject.package_id
).filter(HarvestObject.current == True).filter(
HarvestObject.harvest_source_id == harvest_job.source.id
)
guid_to_package_id = {}
for guid, package_id in query:
guid_to_package_id[guid] = package_id
guids_in_db = set(guid_to_package_id.keys())
logger.debug('Starting gathering for %s' % url)
guids_in_harvest = set()
try:
for obj in requests.get(url).json()['objects']:
try:
uuid = obj['uuid']
logger.info('Got identifier %s from the PacGeo', uuid)
guids_in_harvest.add(uuid)
except Exception, e:
self._save_gather_error(
'Error for the identifier from <%r>: %s' % (obj, e),
harvest_job
)
continue
except Exception as e:
logger.error('Exception: %s', e)
self._save_gather_error(
'Error gathering the identifiers from the PacGeo server [%s]' %
str(e), harvest_job
)
return None
new = guids_in_harvest - guids_in_db
delete = guids_in_db - guids_in_harvest
change = guids_in_db & guids_in_harvest
ids = []
for guid in new:
obj = HarvestObject(
guid=guid,
job=harvest_job,
extras=[HOExtra(key='status', value='new')]
)
obj.save()
ids.append(obj.id)
for guid in change:
obj = HarvestObject(
guid=guid,
job=harvest_job,
package_id=guid_to_package_id[guid],
extras=[HOExtra(key='status', value='change')]
)
obj.save()
ids.append(obj.id)
for guid in delete:
obj = HarvestObject(
guid=guid,
job=harvest_job,
package_id=guid_to_package_id[guid],
extras=[HOExtra(key='status', value='delete')]
)
model.Session.query(HarvestObject).filter_by(guid=guid).update({
'current': False
}, False)
obj.save()
ids.append(obj.id)
if len(ids) == 0:
self._save_gather_error(
'No records received from the CSW server', harvest_job
)
return None
return ids
def get_package_dict(self, iso_values, harvest_object):
data = super(PacGeoHarvester,
self).get_package_dict(iso_values, harvest_object)
data['type'] = 'geographic_data'
extras = data.pop('extras', [])
for extra in extras:
key, value = extra['key'], extra['value']
if key == 'metadata-date':
data['date_stamp'] = value.split('T')[0]
elif key == 'spatial':
data[key] = value
elif key == 'responsible-party':
for party in json.loads(value):
contact = {
'individual_name': party['name'] or 'Undefined',
'role': [
{'code_list_value': role, 'code_list': 'default'}
for role in party['roles']
]
}
data.setdefault('contact', []).append(contact)
harvest_source = model.Package.get(harvest_object.source.id)
if harvest_source:
data['owner_org'] = harvest_source.owner_org
data['thematic_area_string'] = 'Geoscience'
return data
class SpatialHarvester(HarvesterBase):
_user_name = None
_site_user = None
source_config = {}
force_import = False
extent_template = Template('''
{"type": "Polygon", "coordinates": [[[$xmin, $ymin], [$xmax, $ymin], [$xmax, $ymax], [$xmin, $ymax], [$xmin, $ymin]]]}
''')
# IHarvester
def validate_config(self, source_config):
if not source_config:
return source_config
try:
source_config_obj = json.loads(source_config)
if 'validator_profiles' in source_config_obj:
if not isinstance(source_config_obj['validator_profiles'],
list):
raise ValueError('validator_profiles must be a list')
# Check if all profiles exist
existing_profiles = [v.name for v in all_validators]
unknown_profiles = set(source_config_obj['validator_profiles']
) - set(existing_profiles)
if len(unknown_profiles) > 0:
raise ValueError('Unknown validation profile(s): %s' %
','.join(unknown_profiles))
if 'default_tags' in source_config_obj:
if not isinstance(source_config_obj['default_tags'], list):
raise ValueError('default_tags must be a list')
if 'default_extras' in source_config_obj:
if not isinstance(source_config_obj['default_extras'], dict):
raise ValueError('default_extras must be a dictionary')
for key in ('override_extras', 'clean_tags'):
if key in source_config_obj:
if not isinstance(source_config_obj[key], bool):
raise ValueError('%s must be boolean' % key)
except ValueError as e:
raise e
return source_config
# SpatialHarvester
def get_package_dict(self, iso_values, harvest_object):
'''
Constructs a package_dict suitable to be passed to package_create or
package_update. See documentation on
ckan.logic.action.create.package_create for more details
Extensions willing to modify the dict should do so implementing the
ISpatialHarvester interface
import ckan.plugins as p
from ckanext.spatial.interfaces import ISpatialHarvester
class MyHarvester(p.SingletonPlugin):
p.implements(ISpatialHarvester, inherit=True)
def get_package_dict(self, context, data_dict):
package_dict = data_dict['package_dict']
package_dict['extras'].append(
{'key': 'my-custom-extra', 'value': 'my-custom-value'}
)
return package_dict
If a dict is not returned by this function, the import stage will be cancelled.
:param iso_values: Dictionary with parsed values from the ISO 19139
XML document
:type iso_values: dict
:param harvest_object: HarvestObject domain object (with access to
job and source objects)
:type harvest_object: HarvestObject
:returns: A dataset dictionary (package_dict)
:rtype: dict
'''
tags = []
if 'tags' in iso_values:
do_clean = self.source_config.get('clean_tags')
tags_val = [
munge_tag(tag) if do_clean else tag[:100]
for tag in iso_values['tags']
]
tags = [{'name': tag} for tag in tags_val]
# Add default_tags from config
default_tags = self.source_config.get('default_tags', [])
if default_tags:
for tag in default_tags:
tags.append({'name': tag})
package_dict = {
'title': iso_values['title'],
'notes': iso_values['abstract'],
'tags': tags,
'resources': [],
}
# We need to get the owner organization (if any) from the harvest
# source dataset
source_dataset = model.Package.get(harvest_object.source.id)
if source_dataset.owner_org:
package_dict['owner_org'] = source_dataset.owner_org
# Package name
package = harvest_object.package
if package is None or package.title != iso_values['title']:
name = self._gen_new_name(iso_values['title'])
if not name:
name = self._gen_new_name(six.text_type(iso_values['guid']))
if not name:
raise Exception(
'Could not generate a unique name from the title or the GUID. '
'Please choose a more unique title.')
package_dict['name'] = name
else:
package_dict['name'] = package.name
extras = {
'guid': harvest_object.guid,
'spatial_harvester': True,
}
# Just add some of the metadata as extras, not the whole lot
for name in [
# Essentials
'spatial-reference-system',
'guid',
# Usefuls
'dataset-reference-date',
'metadata-language', # Language
'metadata-date', # Released
'coupled-resource',
'contact-email',
'frequency-of-update',
'spatial-data-service-type',
]:
extras[name] = iso_values[name]
if len(iso_values.get('progress', [])):
extras['progress'] = iso_values['progress'][0]
else:
extras['progress'] = ''
if len(iso_values.get('resource-type', [])):
extras['resource-type'] = iso_values['resource-type'][0]
else:
extras['resource-type'] = ''
extras['licence'] = iso_values.get('use-constraints', '')
def _extract_first_license_url(licences):
for licence in licences:
o = urlparse(licence)
if o.scheme and o.netloc:
return licence
return None
if len(extras['licence']):
license_url_extracted = _extract_first_license_url(
extras['licence'])
if license_url_extracted:
extras['licence_url'] = license_url_extracted
# Metadata license ID check for package
use_constraints = iso_values.get('use-constraints')
if use_constraints:
context = {
'model': model,
'session': model.Session,
'user': self._get_user_name()
}
license_list = p.toolkit.get_action('license_list')(context, {})
for constraint in use_constraints:
package_license = None
for license in license_list:
if constraint.lower() == license.get(
'id') or constraint == license.get('url'):
package_license = license.get('id')
break
if package_license:
package_dict['license_id'] = package_license
break
extras['access_constraints'] = iso_values.get(
'limitations-on-public-access', '')
# Grpahic preview
browse_graphic = iso_values.get('browse-graphic')
if browse_graphic:
browse_graphic = browse_graphic[0]
extras['graphic-preview-file'] = browse_graphic.get('file')
if browse_graphic.get('description'):
extras['graphic-preview-description'] = browse_graphic.get(
'description')
if browse_graphic.get('type'):
extras['graphic-preview-type'] = browse_graphic.get('type')
for key in ['temporal-extent-begin', 'temporal-extent-end']:
if len(iso_values[key]) > 0:
extras[key] = iso_values[key][0]
# Save responsible organization roles
if iso_values['responsible-organisation']:
parties = {}
for party in iso_values['responsible-organisation']:
if party['organisation-name'] in parties:
if not party['role'] in parties[
party['organisation-name']]:
parties[party['organisation-name']].append(
party['role'])
else:
parties[party['organisation-name']] = [party['role']]
extras['responsible-party'] = [{
'name': k,
'roles': v
} for k, v in parties.items()]
if len(iso_values['bbox']) > 0:
bbox = iso_values['bbox'][0]
extras['bbox-east-long'] = bbox['east']
extras['bbox-north-lat'] = bbox['north']
extras['bbox-south-lat'] = bbox['south']
extras['bbox-west-long'] = bbox['west']
try:
xmin = float(bbox['west'])
xmax = float(bbox['east'])
ymin = float(bbox['south'])
ymax = float(bbox['north'])
except ValueError as e:
self._save_object_error(
'Error parsing bounding box value: {0}'.format(
six.text_type(e)), harvest_object, 'Import')
else:
# Construct a GeoJSON extent so ckanext-spatial can register the extent geometry
# Some publishers define the same two corners for the bbox (ie a point),
# that causes problems in the search if stored as polygon
if xmin == xmax or ymin == ymax:
extent_string = Template(
'{"type": "Point", "coordinates": [$x, $y]}'
).substitute(x=xmin, y=ymin)
self._save_object_error(
'Point extent defined instead of polygon',
harvest_object, 'Import')
else:
extent_string = self.extent_template.substitute(xmin=xmin,
ymin=ymin,
xmax=xmax,
ymax=ymax)
extras['spatial'] = extent_string.strip()
else:
log.debug('No spatial extent defined for this object')
resource_locators = iso_values.get('resource-locator', []) +\
iso_values.get('resource-locator-identification', [])
if len(resource_locators):
for resource_locator in resource_locators:
url = resource_locator.get('url', '').strip()
if url:
resource = {}
resource['format'] = guess_resource_format(url)
if resource['format'] == 'wms' and config.get(
'ckanext.spatial.harvest.validate_wms', False):
# Check if the service is a view service
test_url = url.split('?')[0] if '?' in url else url
if self._is_wms(test_url):
resource['verified'] = True
resource['verified_date'] = datetime.now(
).isoformat()
resource.update({
'url':
url,
'name':
resource_locator.get('name')
or p.toolkit._('Unnamed resource'),
'description':
resource_locator.get('description') or '',
'resource_locator_protocol':
resource_locator.get('protocol') or '',
'resource_locator_function':
resource_locator.get('function') or '',
})
package_dict['resources'].append(resource)
# Add default_extras from config
default_extras = self.source_config.get('default_extras', {})
if default_extras:
override_extras = self.source_config.get('override_extras', False)
for key, value in default_extras.items():
log.debug('Processing extra %s', key)
if not key in extras or override_extras:
# Look for replacement strings
if isinstance(value, six.string_types):
value = value.format(
harvest_source_id=harvest_object.job.source.id,
harvest_source_url=harvest_object.job.source.url.
strip('/'),
harvest_source_title=harvest_object.job.source.
title,
harvest_job_id=harvest_object.job.id,
harvest_object_id=harvest_object.id)
extras[key] = value
extras_as_dict = []
for key, value in extras.items():
if isinstance(value, (list, dict)):
extras_as_dict.append({'key': key, 'value': json.dumps(value)})
else:
extras_as_dict.append({'key': key, 'value': value})
package_dict['extras'] = extras_as_dict
return package_dict
def transform_to_iso(self, original_document, original_format,
harvest_object):
'''
DEPRECATED: Use the transform_to_iso method of the ISpatialHarvester
interface
'''
self.__base_transform_to_iso_called = True
return None
def import_stage(self, harvest_object):
context = {
'model': model,
'session': model.Session,
'user': self._get_user_name(),
}
log = logging.getLogger(__name__ + '.import')
log.debug('Import stage for harvest object: %s', harvest_object.id)
if not harvest_object:
log.error('No harvest object received')
return False
self._set_source_config(harvest_object.source.config)
if self.force_import:
status = 'change'
else:
status = self._get_object_extra(harvest_object, 'status')
# Get the last harvested object (if any)
previous_object = model.Session.query(HarvestObject) \
.filter(HarvestObject.guid == harvest_object.guid) \
.filter(HarvestObject.current == True).first() # noqa
if status == 'delete':
# Delete package
context.update({
'ignore_auth': True,
})
if harvest_object.package_id:
p.toolkit.get_action('package_delete')(
context, {
'id': harvest_object.package_id
})
log.info('Deleted package {0} with guid {1}'.format(
harvest_object.package_id, harvest_object.guid))
return True
# Check if it is a non ISO document
original_document = self._get_object_extra(harvest_object,
'original_document')
original_format = self._get_object_extra(harvest_object,
'original_format')
if original_document and original_format:
# DEPRECATED use the ISpatialHarvester interface method
self.__base_transform_to_iso_called = False
content = self.transform_to_iso(original_document, original_format,
harvest_object)
if not self.__base_transform_to_iso_called:
log.warn(
'Deprecation warning: calling transform_to_iso directly is deprecated. '
+
'Please use the ISpatialHarvester interface method instead.'
)
for harvester in p.PluginImplementations(ISpatialHarvester):
content = harvester.transform_to_iso(original_document,
original_format,
harvest_object)
if content:
harvest_object.content = content
else:
self._save_object_error('Transformation to ISO failed',
harvest_object, 'Import')
return False
else:
if harvest_object.content is None:
self._save_object_error(
'Empty content for object {0}'.format(harvest_object.id),
harvest_object, 'Import')
return False
# Validate ISO document
is_valid, profile, errors = self._validate_document(
harvest_object.content, harvest_object)
if not is_valid:
# If validation errors were found, import will stop unless
# configuration per source or per instance says otherwise
continue_import = p.toolkit.asbool(config.get('ckanext.spatial.harvest.continue_on_validation_errors',
False)) or \
self.source_config.get('continue_on_validation_errors')
if not continue_import:
return False
# Parse ISO document
try:
iso_parser = ISODocument(harvest_object.content)
iso_values = iso_parser.read_values()
except Exception as e:
self._save_object_error(
'Error parsing ISO document for object {0}: {1}'.format(
harvest_object.id, six.text_type(e)), harvest_object,
'Import')
return False
# Flag previous object as not current anymore
if previous_object and not self.force_import:
previous_object.current = False
previous_object.add()
# Update GUID with the one on the document
iso_guid = iso_values['guid']
if iso_guid and harvest_object.guid != iso_guid:
# First make sure there already aren't current objects
# with the same guid
existing_object = model.Session.query(HarvestObject.id) \
.filter(HarvestObject.guid == iso_guid) \
.filter(HarvestObject.current == True).first() # noqa
if existing_object:
self._save_object_error(
'Object {0} already has this guid {1}'.format(
existing_object.id, iso_guid), harvest_object,
'Import')
return False
harvest_object.guid = iso_guid
harvest_object.add()
# Generate GUID if not present (i.e. it's a manual import)
if not harvest_object.guid:
m = hashlib.md5()
m.update(harvest_object.content.encode('utf8', 'ignore'))
harvest_object.guid = m.hexdigest()
harvest_object.add()
# Get document modified date
try:
metadata_modified_date = dateutil.parser.parse(
iso_values['metadata-date'], ignoretz=True)
except ValueError:
self._save_object_error(
'Could not extract reference date for object {0} ({1})'.format(
harvest_object.id, iso_values['metadata-date']),
harvest_object, 'Import')
return False
harvest_object.metadata_modified_date = metadata_modified_date
harvest_object.add()
# Build the package dict
package_dict = self.get_package_dict(iso_values, harvest_object)
for harvester in p.PluginImplementations(ISpatialHarvester):
package_dict = harvester.get_package_dict(
context, {
'package_dict': package_dict,
'iso_values': iso_values,
'xml_tree': iso_parser.xml_tree,
'harvest_object': harvest_object,
})
if not package_dict:
log.error(
'No package dict returned, aborting import for object {0}'.
format(harvest_object.id))
return False
# Create / update the package
context.update({
'extras_as_string': True,
'api_version': '2',
'return_id_only': True
})
if self._site_user and context['user'] == self._site_user['name']:
context['ignore_auth'] = True
# The default package schema does not like Upper case tags
tag_schema = logic.schema.default_tags_schema()
tag_schema['name'] = [not_empty, six.text_type]
# Flag this object as the current one
harvest_object.current = True
harvest_object.add()
if status == 'new':
package_schema = logic.schema.default_create_package_schema()
package_schema['tags'] = tag_schema
context['schema'] = package_schema
# We need to explicitly provide a package ID, otherwise ckanext-spatial
# won't be be able to link the extent to the package.
package_dict['id'] = six.text_type(uuid.uuid4())
package_schema['id'] = [six.text_type]
# Save reference to the package on the object
harvest_object.package_id = package_dict['id']
harvest_object.add()
# Defer constraints and flush so the dataset can be indexed with
# the harvest object id (on the after_show hook from the harvester
# plugin)
model.Session.execute(
'SET CONSTRAINTS harvest_object_package_id_fkey DEFERRED')
model.Session.flush()
try:
package_id = p.toolkit.get_action('package_create')(
context, package_dict)
log.info('Created new package %s with guid %s', package_id,
harvest_object.guid)
except p.toolkit.ValidationError as e:
self._save_object_error(
'Validation Error: %s' % six.text_type(e.error_summary),
harvest_object, 'Import')
return False
elif status == 'change':
# Check if the modified date is more recent
if not self.force_import and previous_object \
and harvest_object.metadata_modified_date <= previous_object.metadata_modified_date:
# Assign the previous job id to the new object to
# avoid losing history
harvest_object.harvest_job_id = previous_object.job.id
harvest_object.add()
# Delete the previous object to avoid cluttering the object table
previous_object.delete()
# Reindex the corresponding package to update the reference to the
# harvest object
if ((config.get('ckanext.spatial.harvest.reindex_unchanged',
True) != 'False'
or self.source_config.get('reindex_unchanged') != 'False')
and harvest_object.package_id):
context.update({'validate': False, 'ignore_auth': True})
try:
package_dict = logic.get_action('package_show')(
context, {
'id': harvest_object.package_id
})
except p.toolkit.ObjectNotFound:
pass
else:
for extra in package_dict.get('extras', []):
if extra['key'] == 'harvest_object_id':
extra['value'] = harvest_object.id
if package_dict:
package_index = PackageSearchIndex()
package_index.index_package(package_dict)
log.info('Document with GUID %s unchanged, skipping...' %
(harvest_object.guid))
else:
package_schema = logic.schema.default_update_package_schema()
package_schema['tags'] = tag_schema
context['schema'] = package_schema
package_dict['id'] = harvest_object.package_id
try:
package_id = p.toolkit.get_action('package_update')(
context, package_dict)
log.info('Updated package %s with guid %s', package_id,
harvest_object.guid)
except p.toolkit.ValidationError as e:
self._save_object_error(
'Validation Error: %s' %
six.text_type(e.error_summary), harvest_object,
'Import')
return False
model.Session.commit()
return True
##
def _is_wms(self, url):
'''
Checks if the provided URL actually points to a Web Map Service.
Uses owslib WMS reader to parse the response.
'''
try:
capabilities_url = wms.WMSCapabilitiesReader().capabilities_url(
url)
res = urlopen(capabilities_url, None, 10)
xml = res.read()
s = wms.WebMapService(url, xml=xml)
return isinstance(s.contents, dict) and s.contents != {}
except Exception as e:
log.error('WMS check for %s failed with exception: %s' %
(url, six.text_type(e)))
return False
def _get_object_extra(self, harvest_object, key):
'''
Helper function for retrieving the value from a harvest object extra,
given the key
'''
for extra in harvest_object.extras:
if extra.key == key:
return extra.value
return None
def _set_source_config(self, config_str):
'''
Loads the source configuration JSON object into a dict for
convenient access
'''
if config_str:
self.source_config = json.loads(config_str)
log.debug('Using config: %r', self.source_config)
else:
self.source_config = {}
def _get_validator(self):
'''
Returns the validator object using the relevant profiles
The profiles to be used are assigned in the following order:
1. 'validator_profiles' property of the harvest source config object
2. 'ckan.spatial.validator.profiles' configuration option in the ini file
3. Default value as defined in DEFAULT_VALIDATOR_PROFILES
'''
if not hasattr(self, '_validator'):
if hasattr(self, 'source_config') and self.source_config.get(
'validator_profiles', None):
profiles = self.source_config.get('validator_profiles')
elif config.get('ckan.spatial.validator.profiles', None):
profiles = [
x.strip() for x in config.get(
'ckan.spatial.validator.profiles').split(',')
]
else:
profiles = DEFAULT_VALIDATOR_PROFILES
self._validator = Validators(profiles=profiles)
# Add any custom validators from extensions
for plugin_with_validators in p.PluginImplementations(
ISpatialHarvester):
custom_validators = plugin_with_validators.get_validators()
for custom_validator in custom_validators:
if custom_validator not in all_validators:
self._validator.add_validator(custom_validator)
return self._validator
def _get_user_name(self):
'''
Returns the name of the user that will perform the harvesting actions
(deleting, updating and creating datasets)
By default this will be the internal site admin user. This is the
recommended setting, but if necessary it can be overridden with the
`ckanext.spatial.harvest.user_name` config option, eg to support the
old hardcoded 'harvest' user:
ckanext.spatial.harvest.user_name = harvest
'''
if self._user_name:
return self._user_name
context = {
'model': model,
'ignore_auth': True,
'defer_commit': True, # See ckan/ckan#1714
}
self._site_user = p.toolkit.get_action('get_site_user')(context, {})
config_user_name = config.get('ckanext.spatial.harvest.user_name')
if config_user_name:
self._user_name = config_user_name
else:
self._user_name = self._site_user['name']
return self._user_name
def _get_content(self, url):
'''
DEPRECATED: Use _get_content_as_unicode instead
'''
url = url.replace(' ', '%20')
http_response = urlopen(url)
return http_response.read()
def _get_content_as_unicode(self, url):
'''
Get remote content as unicode.
We let requests handle the conversion [1] , which will use the
content-type header first or chardet if the header is missing
(requests uses its own embedded chardet version).
As we will be storing and serving the contents as unicode, we actually
replace the original XML encoding declaration with an UTF-8 one.
[1] http://github.com/kennethreitz/requests/blob/63243b1e3b435c7736acf1e51c0f6fa6666d861d/requests/models.py#L811
'''
url = url.replace(' ', '%20')
response = requests.get(url, timeout=10)
content = response.text
# Remove original XML declaration
content = re.sub(r'<\?xml(.*)\?>', '', content)
# Get rid of the BOM and other rubbish at the beginning of the file
content = re.sub('.*?<', '<', content, 1)
content = content[content.index('<'):]
return content
def _validate_document(self,
document_string,
harvest_object,
validator=None):
'''
Validates an XML document with the default, or if present, the
provided validators.
It will create a HarvestObjectError for each validation error found,
so they can be shown properly on the frontend.
Returns a tuple, with a boolean showing whether the validation passed
or not, the profile used and a list of errors (tuples with error
message and error lines if present).
'''
if not validator:
validator = self._get_validator()
document_string = re.sub(r'<\?xml(.*)\?>', '', document_string)
try:
xml = etree.fromstring(document_string)
except etree.XMLSyntaxError as e:
self._save_object_error(
'Could not parse XML file: {0}'.format(six.text_type(e)),
harvest_object, 'Import')
return False, None, []
valid, profile, errors = validator.is_valid(xml)
if not valid:
log.error(
'Validation errors found using profile {0} for object with GUID {1}'
.format(profile, harvest_object.guid))
for error in errors:
self._save_object_error(error[0].encode('utf-8'),
harvest_object,
'Validation',
line=error[1])
return valid, profile, errors
def transform_to_iso(self, original_document, original_format, harvest_object):
if original_format != 'fgdc':
return None
transform_service = config.get('ckanext.geodatagov.fgdc2iso_service')
if not transform_service:
self._save_object_error('No FGDC to ISO transformation service', harvest_object, 'Import')
return None
# Validate against FGDC schema
if self.source_config.get('validator_profiles'):
profiles = self.source_config.get('validator_profiles')
else:
profiles = ['fgdc_minimal']
validator = Validators(profiles=profiles)
for custom_validator in custom_validators:
validator.add_validator(custom_validator)
is_valid, profile, errors = self._validate_document(original_document, harvest_object,
validator=validator)
if not is_valid:
# TODO: Provide an option to continue anyway
return None
original_document = re.sub('<\?xml(.*)\?>', '', original_document)
tree = etree.fromstring(original_document)
comments = tree.xpath('//comment()')
for comment in comments:
p = comment.getparent()
if p:
p.remove(comment)
ptvctcnt = tree.xpath('//ptvctcnt')
for node in ptvctcnt:
p = node.getparent()
if p and not node.text:
p.remove(node)
themekt = tree.xpath('//placekt')
for num, node in enumerate(themekt):
p = node.getparent()
###remove all but first
if p and num > 0:
p.remove(node)
original_document = etree.tostring(tree)
response = requests.post(transform_service,
data=original_document.encode('utf8'),
headers={'content-type': 'text/xml; charset=utf-8'})
if response.status_code == 200:
# XML coming from the conversion tool is already declared and encoded as utf-8
return response.content
else:
msg = 'The transformation service returned an error for object {0}'
if response.status_code and response.content:
msg += ': [{0}] {1}'.format(response.status_code, response.content)
elif response.error:
msg += ': {0}'.format(response.error)
self._save_object_error(msg ,harvest_object,'Import')
return None
def setup_class(cls):
SpatialHarvester._validator = Validators(profiles=['gemini2'])
HarvestFixtureBase.setup_class()
def setup_class(cls):
SpatialHarvester._validator = Validators(
profiles=['iso19139eden', 'constraints', 'gemini2'])
HarvestFixtureBase.setup_class()
