Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for CKAN 2.10 #492

Merged
merged 6 commits into from
Apr 5, 2022
Merged

Add support for CKAN 2.10 #492

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fe3a557
add support for CKAN 2.10
Mar 22, 2022
f20a7a9
lint
Mar 22, 2022
3ec4947
lint
Mar 22, 2022
e8b465e
remove harvest_plugin_extended
Mar 24, 2022
0bbf8b0
update ckan hooks
Mar 24, 2022
1669302
remove unnecessary code
Mar 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 70 additions & 42 deletions ckanext/harvest/plugin/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,50 +61,76 @@ def i18n_directory(self):

# IPackageController

# CKAN < 2.10 hooks
def after_create(self, context, data_dict):
if 'type' in data_dict and data_dict['type'] == DATASET_TYPE_NAME and not self.startup:
return self.after_dataset_create(context, data_dict)

def after_update(self, context, data_dict):
return self.after_dataset_update(context, data_dict)

def after_delete(self, context, data_dict):
return self.after_dataset_delete(context, data_dict)

def before_search(self, search_params):
return self.before_dataset_search(search_params)

def before_index(self, pkg_dict):
return self.before_dataset_index(pkg_dict)

def after_show(self, context, data_dict):
return self.after_dataset_show(context, data_dict)

# CKAN >= 2.10 hooks
def after_dataset_create(self, context, data_dict):
TomeCirun marked this conversation as resolved.
Show resolved Hide resolved
if (
"type" in data_dict
and data_dict["type"] == DATASET_TYPE_NAME
and not self.startup
):
# Create an actual HarvestSource object
_create_harvest_source_object(context, data_dict)

def after_update(self, context, data_dict):
if 'type' in data_dict and data_dict['type'] == DATASET_TYPE_NAME:
def after_dataset_update(self, context, data_dict):
if "type" in data_dict and data_dict["type"] == DATASET_TYPE_NAME:
# Edit the actual HarvestSource object
_update_harvest_source_object(context, data_dict)

def after_delete(self, context, data_dict):
def after_dataset_delete(self, context, data_dict):

package_dict = p.toolkit.get_action('package_show')(context, {'id': data_dict['id']})
package_dict = p.toolkit.get_action("package_show")(
context, {"id": data_dict["id"]}
)

if 'type' in package_dict and package_dict['type'] == DATASET_TYPE_NAME:
if "type" in package_dict and package_dict["type"] == DATASET_TYPE_NAME:
# Delete the actual HarvestSource object
_delete_harvest_source_object(context, package_dict)

def before_search(self, search_params):
'''Prevents the harvesters being shown in dataset search results.'''
def before_dataset_search(self, search_params):
"""Prevents the harvesters being shown in dataset search results."""

fq = search_params.get('fq', '')
if 'dataset_type:harvest' not in fq:
fq = u"{0} -dataset_type:harvest".format(search_params.get('fq', ''))
search_params.update({'fq': fq})
fq = search_params.get("fq", "")
if "dataset_type:harvest" not in fq:
fq = "{0} -dataset_type:harvest".format(search_params.get("fq", ""))
search_params.update({"fq": fq})

return search_params

def before_index(self, pkg_dict):
def before_dataset_index(self, pkg_dict):

harvest_object = model.Session.query(HarvestObject) \
.filter(HarvestObject.package_id == pkg_dict['id']) \
.filter(HarvestObject.current == True).first() # noqa
.filter(HarvestObject.package_id == pkg_dict["id"]) \
.filter(HarvestObject.current == True).first() # noqa

if harvest_object:

data_dict = json.loads(pkg_dict['data_dict'])
data_dict = json.loads(pkg_dict["data_dict"])

validated_data_dict = json.loads(pkg_dict['validated_data_dict'])
validated_data_dict = json.loads(pkg_dict["validated_data_dict"])

harvest_extras = [
('harvest_object_id', harvest_object.id),
('harvest_source_id', harvest_object.source.id),
('harvest_source_title', harvest_object.source.title),
("harvest_object_id", harvest_object.id),
("harvest_source_id", harvest_object.source.id),
("harvest_source_title", harvest_object.source.title),
]

for key, value in harvest_extras:
Expand All @@ -114,55 +140,57 @@ def before_index(self, pkg_dict):
# which call package_show
harvest_not_found = True
harvest_not_found_validated = True
if not data_dict.get('extras'):
data_dict['extras'] = []
if not data_dict.get("extras"):
data_dict["extras"] = []

for e in data_dict.get('extras'):
if e.get('key') == key:
e.update({'value': value})
for e in data_dict.get("extras"):
if e.get("key") == key:
e.update({"value": value})
harvest_not_found = False
if(harvest_not_found):
data_dict['extras'].append({'key': key, 'value': value})
if harvest_not_found:
data_dict["extras"].append({"key": key, "value": value})

if not validated_data_dict.get('extras'):
validated_data_dict['extras'] = []
if not validated_data_dict.get("extras"):
validated_data_dict["extras"] = []

for e in validated_data_dict.get('extras'):
if e.get('key') == key:
e.update({'value': value})
for e in validated_data_dict.get("extras"):
if e.get("key") == key:
e.update({"value": value})
harvest_not_found_validated = False
if(harvest_not_found_validated):
validated_data_dict['extras'].append({'key': key, 'value': value})
if harvest_not_found_validated:
validated_data_dict["extras"].append({"key": key, "value": value})

# The commented line isn't cataloged correctly, if we pass the
# basic key the extras are prepended and the system works as
# expected.
# pkg_dict['extras_{0}'.format(key)] = value
pkg_dict[key] = value

pkg_dict['data_dict'] = json.dumps(data_dict)
pkg_dict['validated_data_dict'] = json.dumps(validated_data_dict)
pkg_dict["data_dict"] = json.dumps(data_dict)
pkg_dict["validated_data_dict"] = json.dumps(validated_data_dict)

return pkg_dict

def after_show(self, context, data_dict):
def after_dataset_show(self, context, data_dict):

if 'type' in data_dict and data_dict['type'] == DATASET_TYPE_NAME:
if "type" in data_dict and data_dict["type"] == DATASET_TYPE_NAME:
# This is a harvest source dataset, add extra info from the
# HarvestSource object
source = HarvestSource.get(data_dict['id'])
source = HarvestSource.get(data_dict["id"])
if not source:
log.error('Harvest source not found for dataset {0}'.format(data_dict['id']))
log.error(
"Harvest source not found for dataset {0}".format(data_dict["id"])
)
return data_dict

st_action_name = 'harvest_source_show_status'
st_action_name = "harvest_source_show_status"
try:
status_action = p.toolkit.get_action(st_action_name)
except KeyError:
logic.clear_actions_cache()
status_action = p.toolkit.get_action(st_action_name)

data_dict['status'] = status_action(context, {'id': source.id})
data_dict["status"] = status_action(context, {"id": source.id})

return data_dict

Expand Down