30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188 | class AttributionPlugin(SingletonPlugin):
"""
A CKAN extension that adds support for complex attribution.
"""
implements(interfaces.IActions, inherit=True)
implements(interfaces.IAuthFunctions, inherit=True)
implements(interfaces.IBlueprint, inherit=True)
implements(interfaces.IClick)
implements(interfaces.IConfigurable)
implements(interfaces.IConfigurer)
implements(interfaces.IFacets, inherit=True)
implements(interfaces.IPackageController, inherit=True)
implements(interfaces.ITemplateHelpers)
if doi_available:
implements(IDoi, inherit=True)
# IActions
def get_actions(self):
from ckanext.attribution.logic.actions import (
create,
delete,
extra,
show,
update,
)
return create_actions(create, show, update, delete, extra)
# IAuthFunctions
def get_auth_functions(self):
from ckanext.attribution.logic.auth import create, delete, extra, show, update
return create_auth(create, show, update, delete, extra)
# IBlueprint
def get_blueprint(self):
return routes.blueprints
# IClick
def get_commands(self):
return cli.get_commands()
# IConfigurable
def configure(self, config):
contribution_activity.check_for_table()
agent.check_for_table()
agent_affiliation.check_for_table()
agent_contribution_activity.check_for_table()
package_contribution_activity.check_for_table()
relationships.setup_relationships()
# IConfigurer
def update_config(self, config):
toolkit.add_template_directory(config, 'theme/templates')
toolkit.add_resource('theme/assets', 'ckanext-attribution')
# IFacets
def dataset_facets(self, facets_dict, package_type):
enable_faceting = toolkit.asbool(
toolkit.config.get('ckanext.attribution.enable_faceting', False)
)
if enable_faceting:
facets_dict['author'] = toolkit._('Contributors')
return facets_dict
# IPackageController
def before_index(self, pkg_dict):
enable_faceting = toolkit.asbool(
toolkit.config.get('ckanext.attribution.enable_faceting', False)
)
if enable_faceting:
contributions = toolkit.get_action('package_contributions_show')(
{}, {'id': pkg_dict['id']}
)
agents = [c['agent'] for c in contributions['contributions']]
pkg_dict['author'] = [a['display_name'] for a in agents]
return pkg_dict
# ITemplateHelpers
def get_helpers(self):
return {
'get_contributions': helpers.get_contributions,
'can_edit': helpers.can_edit,
'split_caps': helpers.split_caps,
'get_cited_contributors': helpers.get_cited_contributors,
'controlled_list': helpers.controlled_list,
'doi_plugin': helpers.doi_plugin,
'agent_from_user': helpers.agent_from_user,
'user_contributions': helpers.user_contributions,
}
# IDoi
def build_metadata_dict(self, pkg_dict, metadata_dict, errors):
# Adds cited contributors as 'creators' and uncited contributors as 'contributors'.
# 'creators' do not get roles/contributor types; 'contributors' do.
all_contributors = helpers.get_cited_contributors(pkg_dict['id'])
id_schemes = helpers.controlled_list('agent_external_id_schemes')
def _make_contrib_dict(entry):
d = {
'is_org': entry['agent'].agent_type == 'org',
'affiliations': [
a['agent'].display_name
for a in entry['agent'].package_affiliations(pkg_dict['id'])
],
}
if entry['agent'].agent_type == 'person':
d['family_name'] = entry['agent'].family_name
d['given_name'] = entry['agent'].given_names
else:
d['full_name'] = entry['agent'].name
if entry['agent'].external_id and entry['agent'].external_id_scheme:
scheme = entry['agent'].external_id_scheme
scheme_label = id_schemes.get(scheme, {}).get('label', scheme)
scheme_uri = id_schemes.get(scheme, {}).get('scheme_uri')
d['identifiers'] = [
{
'identifier': entry['agent'].external_id_url,
'scheme': scheme_label,
'scheme_uri': scheme_uri,
}
]
return d
creators = []
for c in all_contributors['cited']:
creator_dict = _make_contrib_dict(c)
creators.append(creator_dict)
if len(creators) == 0:
default_author = toolkit.config.get(
'ckanext.doi.publisher',
toolkit.config.get('ckan.site_title', 'Anonymous'),
)
creators.append({'full_name': default_author, 'is_org': True})
contributors = []
for c in all_contributors['uncited']:
# Only one type can be sent to datacite, so use the datacite role/activity where the
# contributor is ranked highest, e.g. if they're 2nd Editor and 1st DataManager,
# DataManager is used. If none are ranked (or there are multiple with the same rank),
# use the first alphabetically. If there are no datacite roles/activities for this
# contributor, use 'Other' (because contributor type is a required field).
contrib_dict = _make_contrib_dict(c)
datacite_roles = sorted(
[a for a in c['contributions'] if a.scheme == 'datacite'],
key=lambda x: (x.order or len(c['contributions']), x.activity),
)
if datacite_roles:
contrib_dict['contributor_type'] = datacite_roles[0].activity
else:
contrib_dict['contributor_type'] = 'Other'
contributors.append(contrib_dict)
metadata_dict['creators'] = creators
metadata_dict['contributors'] = contributors
return metadata_dict, errors
|