-
Notifications
You must be signed in to change notification settings - Fork 2k
/
forms.py
221 lines (186 loc) · 7.99 KB
/
forms.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
import os, logging
from ckan.authz import Authorizer
from ckan.logic import check_access
import ckan.logic.action.create as create
import ckan.logic.action.update as update
import ckan.logic.action.get as get
from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras
from ckan.logic import NotFound, NotAuthorized, ValidationError
from ckan.logic import tuplize_dict, clean_dict, parse_params
import ckan.logic.schema as default_schema
from ckan.logic.schema import group_form_schema
from ckan.logic.schema import package_form_schema
import ckan.logic.validators as val
from ckan.lib.base import BaseController, render, c, model, abort, request
from ckan.lib.base import redirect, _, config, h
from ckan.lib.package_saver import PackageSaver
from ckan.lib.field_types import DateType, DateConvertError
from ckan.lib.navl.dictization_functions import Invalid
from ckan.lib.navl.dictization_functions import validate, missing
from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten
from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer
from ckan.plugins import implements, SingletonPlugin
from ckan.lib.navl.validators import (ignore_missing,
not_empty,
empty,
ignore,
keep_extras,
)
log = logging.getLogger(__name__)
class PublisherForm(SingletonPlugin):
"""
This plugin implements an IGroupForm for form associated with a
publisher group. ``IConfigurer`` is used to add the local template
path and the IGroupForm supplies the custom form.
"""
implements(IGroupForm, inherit=True)
implements(IConfigurer, inherit=True)
def update_config(self, config):
"""
This IConfigurer implementation causes CKAN to look in the
```templates``` directory when looking for the group_form()
"""
here = os.path.dirname(__file__)
rootdir = os.path.dirname(os.path.dirname(here))
template_dir = os.path.join(rootdir, 'ckanext',
'publisher_form', 'templates')
config['extra_template_paths'] = ','.join([template_dir,
config.get('extra_template_paths', '')])
def group_form(self):
"""
Returns a string representing the location of the template to be
rendered. e.g. "forms/group_form.html".
"""
return 'publisher_form.html'
def group_types(self):
"""
Returns an iterable of group type strings.
If a request involving a group of one of those types is made, then
this plugin instance will be delegated to.
There must only be one plugin registered to each group type. Any
attempts to register more than one plugin instance to a given group
type will raise an exception at startup.
"""
return ["publisher"]
def is_fallback(self):
"""
Returns true iff this provides the fallback behaviour, when no other
plugin instance matches a group's type.
As this is not the fallback controller we should return False. If
we were wanting to act as the fallback, we'd return True
"""
return False
def form_to_db_schema(self):
"""
Returns the schema for mapping group data from a form to a format
suitable for the database.
"""
return group_form_schema()
def db_to_form_schema(self):
"""
Returns the schema for mapping group data from the database into a
format suitable for the form (optional)
"""
return {}
def check_data_dict(self, data_dict):
"""
Check if the return data is correct.
raise a DataError if not.
"""
def setup_template_variables(self, context, data_dict):
"""
Add variables to c just prior to the template being rendered. We should
use the available groups for the current user, but should be optional
in case this is a top level group
"""
c.user_groups = c.userobj.get_groups('publisher')
local_ctx = {'model': model, 'session': model.Session,
'user': c.user or c.author}
try:
check_access('group_create', local_ctx)
c.is_superuser_or_groupadmin = True
except NotAuthorized:
c.is_superuser_or_groupadmin = False
if 'group' in context:
group = context['group']
# Only show possible groups where the current user is a member
c.possible_parents = c.userobj.get_groups('publisher', 'admin')
c.parent = None
grps = group.get_groups('publisher')
if grps:
c.parent = grps[0]
c.users = group.members_of_type(model.User)
class PublisherDatasetForm(SingletonPlugin):
"""
This plugin implements a new publisher form for cases where we
want to enforce group (type=publisher) membership on a dataset.
"""
implements(IDatasetForm, inherit=True)
implements(IConfigurer, inherit=True)
def update_config(self, config):
"""
This IConfigurer implementation causes CKAN to look in the
```templates``` directory when looking for the package_form()
"""
here = os.path.dirname(__file__)
rootdir = os.path.dirname(os.path.dirname(here))
template_dir = os.path.join(rootdir, 'ckanext',
'publisher_form', 'templates')
config['extra_template_paths'] = ','.join([template_dir,
config.get('extra_template_paths', '')])
def package_form(self):
"""
Returns a string representing the location of the template to be
rendered. e.g. "package/new_package_form.html".
"""
return 'dataset_form.html'
def is_fallback(self):
"""
Returns true iff this provides the fallback behaviour, when no other
plugin instance matches a package's type.
As this is not the fallback controller we should return False. If
we were wanting to act as the fallback, we'd return True
"""
return True
def package_types(self):
"""
Returns an iterable of package type strings.
If a request involving a package of one of those types is made, then
this plugin instance will be delegated to.
There must only be one plugin registered to each package type. Any
attempts to register more than one plugin instance to a given package
type will raise an exception at startup.
"""
return ["dataset"]
def setup_template_variables(self, context, data_dict=None):
"""
Adds variables to c just prior to the template being rendered that can
then be used within the form
"""
c.licences = [('', '')] + model.Package.get_license_options()
c.publishers = [('Example publisher', 'Example publisher 2')]
c.is_sysadmin = Authorizer().is_sysadmin(c.user)
c.resource_columns = model.Resource.get_columns()
c.groups_available = c.userobj.get_groups('publisher') if c.userobj else []
## This is messy as auths take domain object not data_dict
pkg = context.get('package') or c.pkg
if pkg:
c.auth_for_change_state = Authorizer().am_authorized(
c, model.Action.CHANGE_STATE, pkg)
def form_to_db_schema(self):
"""
Returns the schema for mapping package data from a form to a format
suitable for the database.
"""
return package_form_schema()
def db_to_form_schema(data):
"""
Returns the schema for mapping package data from the database into a
format suitable for the form (optional)
"""
return {}
def check_data_dict(self, data_dict):
"""
Check if the return data is correct and raises a DataError if not.
"""
pass