/usr/share/pyshared/zc/table/fieldcolumn.py is in python-zc.table 0.9.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | ##############################################################################
#
# Copyright (c) 2006 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
import re
from xml.sax.saxutils import quoteattr
from zope import component
import zope.schema.interfaces
import zope.formlib.interfaces
import zope.formlib.form
from zope.formlib.interfaces import IInputWidget, IDisplayWidget
from zope.formlib.interfaces import WidgetInputError, WidgetsError
from zc.table import column
isSafe = re.compile(r'[\w +/]*$').match
def toSafe(string):
# We don't want to use base64 unless we have to,
# because it makes testing and reading html more difficult. We make this
# safe because all base64 strings will have a trailing '=', and our
# `isSafe` regex does not allow '=' at all. The only downside to the
# approach is that a 'safe' string generated by the `toSafe` base64 code
# will not pass the `isSafe` test, so the function is not idempotent. The
# simpler version (without the `isSafe` check) was not idempotent either,
# so no great loss.
if not isSafe(string):
string = ''.join(string.encode('base64').split())
return string
class BaseColumn(column.Column):
###### subclass helper API (not expected to be overridden) ######
def getPrefix(self, item, formatter):
prefix = self.getId(item, formatter)
if formatter.prefix:
prefix = '%s.%s' % (formatter.prefix, prefix)
return prefix
@property
def key(self):
return '%s.%s.%s' % (
self.__class__.__module__,
self.__class__.__name__,
self.name)
def setAnnotation(self, name, value, formatter):
formatter.annotations[self.key + name] = value
def getAnnotation(self, name, formatter, default=None):
return formatter.annotations.get(self.key + name, default)
###### subclass customization API ######
def getId(self, item, formatter):
return toSafe(str(item))
class FieldColumn(BaseColumn):
"""Column that supports field/widget update
"""
__slots__ = ('title', 'name', 'field') # to emphasize that this should not
# have thread-local attributes such as request
def __init__(self, field, title=None, name=''):
if zope.schema.interfaces.IField.providedBy(field):
field = zope.formlib.form.FormField(field)
else:
assert zope.formlib.interfaces.IFormField.providedBy(field)
self.field = field
if title is None:
title = self.field.field.title
if not name and self.field.__name__:
name = self.field.__name__
super(FieldColumn, self).__init__(title, name)
###### subclass helper API (not expected to be overridden) ######
def getInputWidget(self, item, formatter):
form_field = self.field
field = form_field.field
request = formatter.request
prefix = self.getPrefix(item, formatter)
context = self.getFieldContext(item, formatter)
if context is not None:
field = form_field.field.bind(context)
if form_field.custom_widget is None:
if field.readonly or form_field.for_display:
iface = IDisplayWidget
else:
iface = IInputWidget
widget = component.getMultiAdapter((field, request), iface)
else:
widget = form_field.custom_widget(field, request)
if form_field.prefix: # this should not be necessary AFAICT
prefix = '%s.%s' % (prefix, form_field.prefix)
widget.setPrefix(prefix)
return widget
def getRenderWidget(self, item, formatter, ignore_request=False):
widget = self.getInputWidget(item, formatter)
if (ignore_request or
IDisplayWidget.providedBy(widget) or
not widget.hasInput()):
widget.setRenderedValue(self.get(item, formatter))
return widget
###### subclass customization API ######
def get(self, item, formatter):
return self.field.field.get(item)
def set(self, item, value, formatter):
self.field.field.set(item, value)
def getFieldContext(self, item, formatter):
return None
###### main API: input, update, and custom renderCell ######
def input(self, items, formatter):
data = {}
errors = []
for item in items:
widget = self.getInputWidget(item, formatter)
if widget.hasInput():
try:
data[self.getId(item, formatter)] = widget.getInputValue()
except WidgetInputError, v:
errors.append(v)
if errors:
raise WidgetsError(errors)
return data
def update(self, items, data, formatter):
changed = False
for item in items:
id = self.getId(item, formatter)
v = data.get(id, self)
if v is not self and self.get(item, formatter) != v:
self.set(item, v, formatter)
changed = True
if changed:
self.setAnnotation('changed', changed, formatter)
return changed
def renderCell(self, item, formatter):
ignore_request = self.getAnnotation('changed', formatter)
return self.getRenderWidget(
item, formatter, ignore_request)()
class SubmitColumn(BaseColumn):
###### subclass helper API (not expected to be overridden) ######
def getIdentifier(self, item, formatter):
return '%s.%s' % (self.getPrefix(item, formatter), self.name)
def renderWidget(self, item, formatter, **kwargs):
res = ['%s=%s' % (k, quoteattr(v)) for k, v in kwargs.items()]
lbl = self.getLabel(item, formatter)
res[0:0] = [
'input',
'type="submit"',
'name=%s' % quoteattr(self.getIdentifier(item, formatter)),
'value=%s' % quoteattr(lbl)]
return '<%s />' % (' '.join(res))
###### customization API (expected to be overridden) ######
def getLabel(self, item, formatter):
return super(SubmitColumn, self).renderHeader(formatter) # title
###### basic API ######
def input(self, items, formatter):
for item in items:
if self.getIdentifier(item, formatter) in formatter.request.form:
return item
def update(self, items, item, formatter):
raise NotImplementedError
def renderCell(self, item, formatter):
return self.renderWidget(item, formatter)
def renderHeader(self, formatter):
return ''
|