def __call__(self):
"""Build up the schema and return the form view.
"""
# build the schema if it not exist
if self.schema is None:
if self.schema_factory is None:
self.schema_factory = SettingsSchema
self.schema = self.schema_factory()
# append csrf token if needed
if self.use_csrf_token and 'csrf_token' not in self.schema:
self.schema.children.append(CSRFSchema()['csrf_token'])
# enhance the schema with the given definitions
for setting_obj in self.settings.settings_objs:
node = colander.SchemaNode(
self.colander_type(setting_obj.type)(),
name=setting_obj.field_name,
title=setting_obj.title,
description=setting_obj.description,
default=setting_obj.default
)
self.schema.children.append(node)
# the names of the children should begin with the module name
settings = get_settings()
bind_values = self.settings.bind.copy()
for child in self.schema.children:
bind_attrs = bind_values.get(child.name, None)
if child.name == 'csrf_token':
continue
if not child.name.startswith(self.settings.module):
child.name = "%s-%s" % (self.settings.module, child.name)
child.default = settings.get(child.name)
if bind_attrs:
for k,v in bind_attrs.iteritems():
if callable(v):
v = v()
setattr(child, k, v)
# Build up the buttons dynamically, so we can check what setting form
# was saved.
save = 'save_' + self.form_id
self.buttons = (
deform.Button(save, _(u'Save')),
deform.Button('cancel', _(u'Cancel')))
setattr(self, save + '_success', self.save_success)
return super(SettingsFormView, self).__call__()
def view(self):
setting_id = self.request.params.get("setting_id")
if not setting_id:
settings_form_views = []
for settings in SETTINGS.values():
settings_form_views.append(settings)
return {
"settings": settings_form_views,
"UCP_LINKS": CONTROL_PANEL_LINKS
}
settings = SETTINGS.get(setting_id)
if not settings:
return httpexc.HTTPNotFound()
args = {
'title': settings.title,
'description': settings.description,
'name': settings.name,
'schema_factory': settings.schema_factory,
'settings': settings,
'success_message': settings.success_message,
'active': True,
}
View = type(str(setting_id), (SettingsFormView, ), args)
view = View(self.context, self.request)
form = view()
form["view"] = view
links = util.get_links(setting_id)
link1 = Link('controlpanel', title=_(u'Control Panel'))
if link1 not in links:
links.append(link1)
if self.request.has_permission("admin"):
link2 = Link("controlpanel-dump", title=_(u'All Settings'))
if link2 not in links:
links.append(link2)
template = (settings.template
or 'kotti_controlpanel:templates/settings.pt')
return render_to_response(template, {
"settings": settings,
"settings_form": form,
"cp_links": links,
"UCP_LINKS": CONTROL_PANEL_LINKS
},
request=self.request)
def __call__(self):
"""Build up the schema and return the form view.
"""
# build the schema if it not exist
if self.schema is None:
if self.schema_factory is None:
self.schema_factory = SettingsSchema
self.schema = self.schema_factory()
# append csrf token if needed
if self.use_csrf_token and 'csrf_token' not in self.schema:
self.schema.children.append(CSRFSchema()['csrf_token'])
# enhance the schema with the given definitions
for setting_obj in self.settings.settings_objs:
node = colander.SchemaNode(self.colander_type(setting_obj.type)(),
name=setting_obj.field_name,
title=setting_obj.title,
description=setting_obj.description,
default=setting_obj.default)
self.schema.children.append(node)
# the names of the children should begin with the module name
settings = get_settings()
bind_values = self.settings.bind.copy()
for child in self.schema.children:
bind_attrs = bind_values.get(child.name, None)
if child.name == 'csrf_token':
continue
if not child.name.startswith(self.settings.module):
child.name = "%s-%s" % (self.settings.module, child.name)
child.default = settings.get(child.name)
if bind_attrs:
for k, v in bind_attrs.iteritems():
if callable(v):
v = v()
setattr(child, k, v)
# Build up the buttons dynamically, so we can check what setting form
# was saved.
save = 'save_' + self.form_id
self.buttons = (deform.Button(save, _(u'Save')),
deform.Button('cancel', _(u'Cancel')))
setattr(self, save + '_success', self.save_success)
return super(SettingsFormView, self).__call__()
def cancel_success(self, appstruct):
self.request.session.flash(_(u'No changes made.'), 'info')
location = self.request.resource_url(self.context, "controlpanel")
raise HTTPFound(location=location)
class SettingsFormView(FormView):
"""The form template class for one setting tab.
"""
name = 'settings'
title = _(u"Settings")
description = u""
success_message = _(
(u"Your changes have been saved. "
u"Please reload the application for it to take effect."))
success_url = None
settings = None
schema_factory = None
use_csrf_token = True
use_ajax = False
active = False
form_options = {'counter': counter}
def __init__(self, context, request, **kwargs):
self.context = context
self.request = request
self.__dict__.update(kwargs)
def form_class(self, *args, **kwargs):
form = deform.form.Form(*args, **kwargs)
form.formid = self.form_id
return form
def __call__(self):
"""Build up the schema and return the form view.
"""
# build the schema if it not exist
if self.schema is None:
if self.schema_factory is None:
self.schema_factory = SettingsSchema
self.schema = self.schema_factory()
# append csrf token if needed
if self.use_csrf_token and 'csrf_token' not in self.schema:
self.schema.children.append(CSRFSchema()['csrf_token'])
# enhance the schema with the given definitions
for setting_obj in self.settings.settings_objs:
node = colander.SchemaNode(self.colander_type(setting_obj.type)(),
name=setting_obj.field_name,
title=setting_obj.title,
description=setting_obj.description,
default=setting_obj.default)
self.schema.children.append(node)
# the names of the children should begin with the module name
settings = get_settings()
bind_values = self.settings.bind.copy()
for child in self.schema.children:
bind_attrs = bind_values.get(child.name, None)
if child.name == 'csrf_token':
continue
if not child.name.startswith(self.settings.module):
child.name = "%s-%s" % (self.settings.module, child.name)
child.default = settings.get(child.name)
if bind_attrs:
for k, v in bind_attrs.iteritems():
if callable(v):
v = v()
setattr(child, k, v)
# Build up the buttons dynamically, so we can check what setting form
# was saved.
save = 'save_' + self.form_id
self.buttons = (deform.Button(save, _(u'Save')),
deform.Button('cancel', _(u'Cancel')))
setattr(self, save + '_success', self.save_success)
return super(SettingsFormView, self).__call__()
@reify
def form_id(self):
form_id = "{0}-{1}".format(self.settings.module, self.name)
return form_id
def colander_type(self, name):
# http://docs.pylonsproject.org/projects/colander/en/latest/api.html#types
try:
klass = getattr(sys.modules['colander'], name)
except AttributeError:
raise NameError("%s is not an sqlalchemy data type." % name)
if isinstance(klass, (ClassType, type)):
return klass
raise TypeError("%s is not a class." % name) # pragma: no cover
def save_success(self, appstruct):
formid = self.request.POST.get('__formid__', None)
self.active = False
if formid is not None and formid == self.form_id:
self.active = True
appstruct.pop('csrf_token', None)
module = None
if appstruct:
key = appstruct.keys()[0]
module = key[:key.find('-')]
self.request.registry.notify(SettingsBeforeSave(module))
for item in appstruct:
if appstruct[item] is not None:
set_setting(item, appstruct[item])
ses = self.request.session
if not '_f_success' in ses or\
not self.success_message in ses['_f_success']:
self.request.session.flash(self.success_message, 'success')
self.request.registry.notify(SettingsAfterSave(module))
def cancel_success(self, appstruct):
self.request.session.flash(_(u'No changes made.'), 'info')
location = self.request.resource_url(self.context, "controlpanel")
raise HTTPFound(location=location)
def cancel_success(self, appstruct):
self.request.session.flash(_(u'No changes made.'), 'info')
location = self.request.resource_url(self.context, "controlpanel")
raise HTTPFound(location=location)
class ShowInContextSchemaNode(colander.SchemaNode):
name = 'show_in_context'
title = _(u'Show in context')
default = u'everywhere'
widget = deform.widget.SelectWidget(values=show_in_context)
class SlotSchemaNode(colander.SchemaNode):
name = 'slot'
title = _(u'Direction')
default = u'left'
widget = deform.widget.SelectWidget(values=slot_names)
import colander
import deform
from kotti_controlpanel import _
# hold the setting objects
SETTINGS = {}
CONTROL_PANEL_LINKS = {}
# Here we define some default schemas.
slot_names = (
('left', _(u'left')),
('right', _(u'right')),
('abovecontent', _(u'abovecontent')),
('belowcontent', _(u'belowcontent')),
('beforebodyend', _(u'beforebodyend')),
)
class SlotSchemaNode(colander.SchemaNode):
name = 'slot'
title = _(u'Direction')
default = u'left'
widget = deform.widget.SelectWidget(values=slot_names)
show_in_context = (('everywhere', _(u'Everywhere')), ('only on root',
_(u'Only on root')),
('not on root', _(u'Not on root')), ('nowhere',
_(u'Nowhere')))
import colander
import deform
from kotti_controlpanel import _
# hold the setting objects
SETTINGS = {}
CONTROL_PANEL_LINKS = {}
# Here we define some default schemas.
slot_names = (('left', _(u'left')),
('right', _(u'right')),
('abovecontent', _(u'abovecontent')),
('belowcontent', _(u'belowcontent')),
('beforebodyend', _(u'beforebodyend')),)
class SlotSchemaNode(colander.SchemaNode):
name = 'slot'
title = _(u'Direction')
default = u'left'
widget = deform.widget.SelectWidget(values=slot_names)
show_in_context = (('everywhere', _(u'Everywhere')),
('only on root', _(u'Only on root')),
('not on root', _(u'Not on root')),
('nowhere', _(u'Nowhere')))
class ShowInContextSchemaNode(colander.SchemaNode):