def get_package_group_fieldset():
if not 'new_package_group_fs' in fieldsets:
# new_package_group_fs is the packages for the WUI form
builder = FormBuilder(model.Member)
builder.add_field(PackageNameField('package_name'))
builder.set_field_option('package_name', 'with_renderer', PackagesRenderer)
builder.set_field_text('package_name', _('Package'))
builder.set_displayed_fields({_('Add packages'):['package_name']},
focus_field=False)
fieldsets['new_package_group_fs'] = builder.get_fieldset()
return fieldsets['new_package_group_fs']
def get_authorization_group_user_fieldset():
if not 'new_user_authz_group_fs' in fieldsets:
builder = FormBuilder(model.AuthorizationGroupUser)
builder.add_field(UserNameField('user_name'))
builder.set_field_option('user_name', 'with_renderer', UsersRenderer)
builder.set_displayed_fields({'Add users':['user_name']}, focus_field=False)
fieldsets['new_user_authz_group_fs'] = builder.get_fieldset()
return fieldsets['new_user_authz_group_fs']
def get_authorization_group_user_fieldset():
if not 'new_user_authz_group_fs' in fieldsets:
builder = FormBuilder(model.AuthorizationGroupUser)
builder.add_field(UserNameField('user_name'))
builder.set_field_option('user_name', 'with_renderer', UsersRenderer)
builder.set_displayed_fields({_('Add users'):['user_name']}, focus_field=False)
fieldsets['new_user_authz_group_fs'] = builder.get_fieldset()
return fieldsets['new_user_authz_group_fs']
def build_action_form(is_admin=False, user_editable_groups=None, **params):
builder = FormBuilder(lightbaseDatasetActions)
# Labels and instructions
builder.set_field_text(
'action_name',
instructions=_('Short name for the action'),
further_instructions=_(
'this is the action that will be called for rendering the data.'),
)
# Options/settings
builder.set_field_option('action_name', 'validate', action_name_validator)
# Layout
field_groups = OrderedDict([
(_('Basic information'), ['name']),
])
builder.set_displayed_fields(field_groups)
builder.set_label_prettifier(prettify)
return builder
def build_action_form(is_admin=False, user_editable_groups=None, **params):
builder = FormBuilder(lightbaseDatasetActions)
# Labels and instructions
builder.set_field_text(
"action_name",
instructions=_("Short name for the action"),
further_instructions=_("this is the action that will be called for rendering the data."),
)
# Options/settings
builder.set_field_option("action_name", "validate", action_name_validator)
# Layout
field_groups = OrderedDict([(_("Basic information"), ["name"])])
builder.set_displayed_fields(field_groups)
builder.set_label_prettifier(prettify)
return builder
def build_authorization_group_form(is_admin=False, with_users=False):
builder = FormBuilder(model.AuthorizationGroup)
builder.set_field_text('name', _('Name'), literal(
'<br/>' + _("<strong>Unique identifier</strong> for group.") +
'<br/>' + _("2+ characters, lowercase, using only 'a-z0-9' and '-_'")
))
builder.set_field_option('name', 'validate', common.group_name_validator)
builder.set_field_option('name', 'required')
displayed_fields = ['name']
if with_users:
builder.add_field(UsersField('users'))
displayed_fields.append('users')
builder.set_displayed_fields(OrderedDict([(_('Details'), displayed_fields)]))
builder.set_label_prettifier(common.prettify)
return builder
def build_authorization_group_form(is_admin=False, with_users=False):
builder = FormBuilder(model.AuthorizationGroup)
builder.set_field_text('name', 'Name', literal("<br/><strong>Unique identifier</strong> for group.<br/>2+ chars, lowercase, using only 'a-z0-9' and '-_'"))
builder.set_field_option('name', 'validate', common.group_name_validator)
builder.set_field_option('name', 'required')
displayed_fields = ['name']
if with_users:
builder.add_field(UsersField('users'))
displayed_fields.append('users')
builder.set_displayed_fields(OrderedDict([('Details', displayed_fields)]))
builder.set_label_prettifier(common.prettify)
return builder
def build_group_form(is_admin=False, with_packages=False):
builder = FormBuilder(model.Group)
builder.set_field_text('name', _('Name'), literal("<br/><strong>Unique identifier</strong> for group.<br/>2+ chars, lowercase, using only 'a-z0-9' and '-_'"))
builder.set_field_option('name', 'validate', common.group_name_validator)
builder.set_field_option('description', 'textarea', {'size':'60x15'})
builder.add_field(ExtrasField('extras', hidden_label=True))
displayed_fields = ['name', 'title', 'description']
if is_admin:
builder.set_field_option('state', 'dropdown', {'options':model.State.all})
displayed_fields.append('state')
if with_packages:
builder.add_field(PackagesField('packages'))
displayed_fields.append('packages')
builder.set_displayed_fields(OrderedDict([(_('Details'), displayed_fields),
(_('Extras'), ['extras'])]))
builder.set_label_prettifier(common.prettify)
return builder
def build_package_form(is_admin=False, user_editable_groups=None, **params):
builder = FormBuilder(model.Package)
# Extra fields
builder.add_field(
GroupSelectField('groups',
allow_empty=True,
user_editable_groups=user_editable_groups))
builder.add_field(ResourcesField('resources', hidden_label=True))
builder.add_field(TagField('tags'))
builder.add_field(ExtrasField('extras', hidden_label=True))
# Labels and instructions
builder.set_field_text(
'title',
instructions=_('A short descriptive title for the data set.'),
further_instructions=
_('It should not be a description though - save that for the Notes field. Do not give a trailing full stop.'
),
)
builder.set_field_text(
'name',
_('Name'),
instructions=_('A unique identifier for the package.'),
further_instructions=
_('It should be broadly humanly readable, in the spirit of Semantic Web URIs. Only use an acronym if it is widely recognised. Renaming is possible but discouraged.'
),
hints=_("2+ characters, lowercase, using only 'a-z0-9' and '-_'"))
builder.set_field_text(
'version',
instructions=_('A number representing the version (if applicable)'),
hints='e.g. 1.2.0',
)
builder.set_field_text(
'url',
instructions=
_('The URL for the web page describing the data (not the data itself).'
),
hints=_('e.g. http://www.example.com/growth-figures.html'),
)
builder.set_field_text(
'author',
instructions=
_('The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.'
),
)
builder.set_field_text(
'maintainer',
instructions=
_('If there is another important contact person (in addition to the person in the Author field) then provide details here.'
),
)
builder.set_field_text(
'license_id',
_('Licence'),
instructions=_('The licence under which the dataset is released.'),
)
builder.set_field_text(
'tags',
_('Tags'),
instructions=literal(
_('Terms that may link this dataset to similar ones. For more information on conventions, see <a href="%s">this wiki page</a>.'
) % 'http://wiki.okfn.org/ckan/doc/faq#TagConventions'),
hints=_('e.g. pollution rivers water-quality'))
builder.set_field_text(
'resources',
instructions=
_('The files containing the data or address of the APIs for accessing it.'
),
further_instructions=literal(
_('<br />These can be repeated as required. For example if the data is being supplied in multiple formats, or split into different areas or time periods, each file is a different \'resource\' which should be described differently. They will all appear on the dataset page on CKAN together.<br /><br /> <b>URL:</b> This is the Internet link directly to the data - by selecting this link in a web browser, the user will immediately download the full data set. Note that datasets are not hosted on this site, but by the publisher of the data. Alternatively the URL can point to an API server such as a SPARQL endpoint or JSON-P service.<br /> <b>Format:</b> This should give the file format in which the data is supplied. <br /><b>Description</b> Any information you want to add to describe the resource.<br />'
)),
hints=
_('Format choices: CSV | RDF | XML | XBRL | SDMX | HTML+RDFa | Other as appropriate'
))
builder.set_field_text(
'notes',
_('Notes'),
instructions=_('The main description of the dataset'),
further_instructions=
_('It is often displayed with the package title. In particular, it should start with a short sentence that describes the data set succinctly, because the first few words alone may be used in some views of the data sets.'
),
hints=literal(
_('You can use %sMarkdown formatting%s here.') %
('<a href="http://daringfireball.net/projects/markdown/syntax">',
'</a>')))
# Options/settings
builder.set_field_option('name', 'validate', package_name_validator)
builder.set_field_option(
'license_id', 'dropdown',
{'options': [('', None)] + model.Package.get_license_options()})
builder.set_field_option('state', 'dropdown', {'options': model.State.all})
builder.set_field_option('notes', 'textarea', {'size': '60x15'})
# Layout
field_groups = OrderedDict([
(_('Basic information'),
['title', 'name', 'url', 'notes', 'license_id', 'tags']),
(_('Resources'), ['resources']),
(_('Groups'), ['groups']),
(_('Detail'), [
'author',
'author_email',
'maintainer',
'maintainer_email',
'version',
]),
(_('Extras'), ['extras']),
])
if is_admin:
field_groups[_('Detail')].append('state')
builder.set_displayed_fields(field_groups)
builder.set_label_prettifier(prettify)
return builder
# Strings for i18n:
[
_('Title'),
_('Name'),
_('Version'),
_('URL'),
_('Notes'),
_('Resources'),
_('Author'),
_('Author email'),
_('Maintainer'),
_('Maintainer email'),
_('License'),
_('Tags'),
_('Extras'),
_('State')
]
def get_package_group_fieldset():
if not 'new_package_group_fs' in fieldsets:
# new_package_group_fs is the packages for the WUI form
builder = FormBuilder(model.Member)
builder.add_field(PackageNameField('package_name'))
builder.set_field_option('package_name', 'with_renderer', PackagesRenderer)
builder.set_field_text('package_name', _('Package'))
builder.set_displayed_fields({_('Add packages'):['package_name']},
focus_field=False)
fieldsets['new_package_group_fs'] = builder.get_fieldset()
return fieldsets['new_package_group_fs']
def build_group_form(is_admin=False, with_packages=False):
builder = FormBuilder(model.Group)
builder.set_field_text('name', _('Name'), literal("<strong>Unique identifier</strong> for group.<br/>2+ chars, lowercase, using only 'a-z0-9' and '-_'<p></p>"))
builder.set_field_option('name', 'validate', common.group_name_validator)
builder.set_field_option('description', 'textarea', {'size':'60x15'})
builder.add_field(ExtrasField('extras', hidden_label=True))
displayed_fields = ['name', 'title', 'description']
if is_admin:
builder.set_field_option('state', 'dropdown', {'options':model.State.all})
displayed_fields.append('state')
if with_packages:
builder.add_field(PackagesField('packages'))
displayed_fields.append('packages')
builder.set_displayed_fields(OrderedDict([(_('Details'), displayed_fields),
(_('Extras'), ['extras'])]))
builder.set_label_prettifier(common.prettify)
return builder
def build_harvest_source_form():
builder = FormBuilder(model.HarvestSource)
builder.set_field_text('url', 'Location (required)', literal("<br/><strong>URL</strong> for source of metadata.<br/>"))
builder.set_field_option('url', 'validate', harvest_source_url_validator)
builder.set_field_option('description', 'textarea', {'size':'60x15'})
displayed_fields = ['url', 'description']
builder.set_displayed_fields(OrderedDict([('Details', displayed_fields)]))
builder.set_label_prettifier(common.prettify)
return builder
def build_package_form(is_admin=False, user_editable_groups=None, **params):
builder = FormBuilder(model.Package)
# Extra fields
builder.add_field(GroupSelectField('groups', allow_empty=True, user_editable_groups=user_editable_groups))
builder.add_field(ResourcesField('resources', hidden_label=True))
builder.add_field(TagField('tags'))
builder.add_field(ExtrasField('extras', hidden_label=True))
# Labels and instructions
builder.set_field_text(
'title',
instructions=_('A short descriptive title for the data set.'),
further_instructions=_('It should not be a description though - save that for the Notes field. Do not give a trailing full stop.'),
)
builder.set_field_text(
'name', _('Name'),
instructions=_('A unique identifier for the package.'),
further_instructions=_('It should be broadly humanly readable, in the spirit of Semantic Web URIs. Only use an acronym if it is widely recognised. Renaming is possible but discouraged.'),
hints=_("2+ characters, lowercase, using only 'a-z0-9' and '-_'")
)
builder.set_field_text(
'version',
instructions=_('A number representing the version (if applicable)'),
hints='e.g. 1.2.0',
)
builder.set_field_text(
'url',
instructions=_('The URL for the web page describing the data (not the data itself).'),
hints=_('e.g. http://www.example.com/growth-figures.html'),
)
builder.set_field_text(
'author',
instructions=_('The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.'),
)
builder.set_field_text(
'maintainer',
instructions=_('If there is another important contact person (in addition to the person in the Author field) then provide details here.'),
)
builder.set_field_text(
'license_id',
_('Licence'),
instructions=_('The licence under which the dataset is released.'),
)
builder.set_field_text(
'tags',
_('Tags'),
instructions=literal(_('Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="%s">this wiki page</a>.') % 'http://wiki.okfn.org/ckan/doc/faq#TagConventions'),
hints=_('e.g. pollution, rivers, water quality')
)
builder.set_field_text(
'resources',
instructions=_('The files containing the data or address of the APIs for accessing it.'),
further_instructions=literal(_('<br />These can be repeated as required. For example if the data is being supplied in multiple formats, or split into different areas or time periods, each file is a different \'resource\' which should be described differently. They will all appear on the dataset page on CKAN together.<br /><br /> <b>URL:</b> This is the Internet link directly to the data - by selecting this link in a web browser, the user will immediately download the full data set. Note that datasets are not hosted on this site, but by the publisher of the data. Alternatively the URL can point to an API server such as a SPARQL endpoint or JSON-P service.<br /> <b>Format:</b> This should give the file format in which the data is supplied. <br /><b>Description</b> Any information you want to add to describe the resource.<br />')),
hints=_('Format choices: CSV | RDF | XML | XBRL | SDMX | HTML+RDFa | Other as appropriate')
)
builder.set_field_text(
'notes',
_('Notes'),
instructions=_('The main description of the dataset'),
further_instructions=_('It is often displayed with the package title. In particular, it should start with a short sentence that describes the data set succinctly, because the first few words alone may be used in some views of the data sets.'),
hints=literal(_('You can use %sMarkdown formatting%s here.') % ('<a href="http://daringfireball.net/projects/markdown/syntax">', '</a>'))
)
# Options/settings
builder.set_field_option('name', 'validate', package_name_validator)
builder.set_field_option('license_id', 'dropdown', {'options':[('', None)] + model.Package.get_license_options()})
builder.set_field_option('state', 'dropdown', {'options':model.State.all})
builder.set_field_option('notes', 'textarea', {'size':'60x15'})
# Layout
field_groups = OrderedDict([
(_('Basic information'), ['title', 'name', 'url',
'notes', 'license_id', 'tags']),
(_('Resources'), ['resources']),
(_('Groups'), ['groups']),
(_('Detail'), ['author', 'author_email',
'maintainer', 'maintainer_email',
'version',
]),
(_('Extras'), ['extras']),
])
if is_admin:
field_groups[_('Detail')].append('state')
builder.set_displayed_fields(field_groups)
builder.set_label_prettifier(prettify)
return builder
# Strings for i18n:
[ _('Title'), _('Name'), _('Version'), _('URL'),
_('Notes'), _('Resources'), _('Author'), _('Author email'), _('Maintainer'),
_('Maintainer email'), _('License'), _('Tags'), _('Extras'), _('State')]
