""" Widgets are small components that render form fields for inputing data in a certain format. Caution: the args argument in the widgets' render methods is a disaster in python3 -- it maps from bytes when there are errors (it's a t.w Request.args), from string otherwise (it's a formal-internal thing). And don't get me started on its values. """ # TODO: Fix this -- have a common sort of args for both cases in # some way. import itertools from pkg_resources import resource_filename from zope.interface import implementer from twisted.web import template from twisted.web.template import tags as T from . import iformal, validation, nevowc from .util import render_cssid # Marker object for args that are not supplied _UNSET = object() def getStringFromArgs(args, key, default=''): """returns args[key][0] suitably decoded. This is used to insert erroneous inputs into fields from request.args. Default must already be a string, not bytes. Unfortunately, depending on the context, formal will pass in args with either string keys or bytes keys. While we can't rebuild the thing to be halfway sane, we simply adapt key based on some key we pick from args. Yeah, madness. """ if not args: return default if isinstance(next(iter(args)), str): if isinstance(key, bytes): key = key.decode("ascii") else: if isinstance(key, str): key = key.encode("ascii") if key in args and args[key]: return args[key][0].decode("utf-8", "replace") else: return default def perhapsDecode(val): """returns val utf-8-decoded if it's bytes, unchanged otherwise. """ if isinstance(val, bytes): return val.decode("utf-8") return val @implementer( iformal.IWidget ) class TextInput(object): """ A text input field. """ inputType = 'text' showValueOnFailure = True placeholder = None def __init__(self, original): self.original = original def _renderTag(self, request, key, value, readonly): tag=T.input(type=self.inputType, name=key, id=render_cssid(key)) if value is not None: tag(value=str(value)) if readonly: tag(class_='readonly', readonly='readonly') if self.placeholder is not None: tag(placeholder=self.placeholder) return tag def render(self, request, key, args, errors): if errors: value = getStringFromArgs(args, key) else: value = iformal.IStringConvertible(self.original).fromType( args.get(key)) if not self.showValueOnFailure: value = None return self._renderTag(request, key, value, False) def renderImmutable(self, request, key, args, errors): value = iformal.IStringConvertible(self.original).fromType( args.get(key)) return self._renderTag(request, key, value, True) def processInput(self, request, key, args, default=''): value = getStringFromArgs(args, key, default) value = iformal.IStringConvertible(self.original).toType(value) return self.original.validate(value) @implementer( iformal.IWidget ) class Checkbox(object): """ A checkbox input field. """ def __init__(self, original): self.original = original def _renderTag(self, request, key, value, disabled): tag = T.input(type='checkbox', name=key, id=render_cssid(key), value='True') if value == 'True': tag(checked='checked') if disabled: tag(class_='disabled', disabled='disabled') return tag def render(self, request, key, args, errors): if errors: value = getStringFromArgs(args, key) else: value = iformal.IBooleanConvertible(self.original).fromType( args.get(key)) return self._renderTag(request, key, value, False) def renderImmutable(self, request, key, args, errors): value = iformal.IBooleanConvertible(self.original).fromType( args.get(key)) return self._renderTag(request, key, value, True) def processInput(self, request, key, args, default=''): value = getStringFromArgs(args, key, default) if not value: value = 'False' value = iformal.IBooleanConvertible(self.original).toType(value) return self.original.validate(value) class Password(TextInput): """ A text input field that hides the text. """ inputType = 'password' showValueOnFailure = False @implementer( iformal.IWidget ) class TextArea(object): """ A large text entry area that accepts newline characters. """ cols = 48 rows = 6 def __init__(self, original, cols=None, rows=None): self.original = original if cols is not None: self.cols = cols if rows is not None: self.rows = rows def _renderTag(self, request, key, value, readonly): tag=T.textarea(name=key, id=render_cssid(key), cols=str(self.cols), rows=str(self.rows))[str(value or '')] if readonly: tag(class_='readonly', readonly='readonly') return tag def render(self, request, key, args, errors): if errors: value = getStringFromArgs(args, key) else: value = iformal.IStringConvertible(self.original).fromType( args.get(key)) return self._renderTag(request, key, value or "", False) def renderImmutable(self, request, key, args, errors): value = iformal.IStringConvertible(self.original).fromType( args.get(key)) return self._renderTag(request, key, value, True) def processInput(self, request, key, args, default=''): value = getStringFromArgs(args, key, default) value = iformal.IStringConvertible(self.original).fromType(value) return self.original.validate(value) @implementer( iformal.IWidget ) class TextAreaList(object): """ A text area that allows a list of values to be entered, one per line. Any empty lines are discarded. """ cols = 48 rows = 6 def __init__(self, original, cols=None, rows=None): self.original = original if cols is not None: self.cols = cols if rows is not None: self.rows = rows def _renderTag(self, request, key, values, readonly): value = '\n'.join(values) tag=T.textarea(name=key, id=render_cssid(key), cols=str(self.cols), rows=str(self.rows))[str(value or '')] if readonly: tag(class_='readonly', readonly='readonly') return tag def render(self, request, key, args, errors): converter = iformal.IStringConvertible(self.original.type) if errors: values = args.get(key, []) else: values = args.get(key) if values is not None: values = [converter.fromType(v) for v in values] else: values = [] return self._renderTag(request, key, values, False) def renderImmutable(self, request, key, args, errors): converter = iformal.IStringConvertible(self.original.type) values = args.get(key) if values is not None: values = [converter.fromType(v) for v in values] else: values = [] return self._renderTag(request, key, values, True) def processInput(self, request, key, args, default=''): # Get the whole string value = getStringFromArgs(args, key, default) # Split into lines values = value.splitlines() # Strip each line values = [v.strip() for v in values] # Discard empty lines values = [v for v in values if v] # Convert values to correct type converter = iformal.IStringConvertible(self.original.type) values = [converter.toType(v) for v in values] # Validate and return return self.original.validate(values) @implementer( iformal.IWidget ) class CheckedPassword(object): """ Two password entry fields that must contain the same value to validate. """ def __init__(self, original): self.original = original def render(self, request, key, args, errors): if errors and not errors.getFieldError(key): values = args.get(key) else: values = ('', '') return [ T.input(type='password', name=key, id=render_cssid(key), value=str(values[0])), T.br, T.label(for_=render_cssid(key, 'confirm'))[' Confirm '], T.input(type='password', name=key, id=render_cssid(key, 'confirm'), value=str(values[1])), ] def renderImmutable(self, request, key, args, errors): values = ('', '') return [ T.input(type='password', name=key, id=render_cssid(key), value=str(values[0]), class_='readonly', readonly='readonly'), T.br, T.label(for_=render_cssid(key, 'confirm'))[' Confirm '], T.input(type='password', name=key, id=render_cssid(key, 'confirm'), value=str(values[1]), class_='readonly', readonly='readonly') ] def processInput(self, request, key, args, default=''): pwds = [perhapsDecode(pwd) for pwd in args.get(key, [])] if len(pwds) == 0: pwds = ["", ""] elif len(pwds) == 1: raise validation.FieldValidationError('Please enter the password twice for confirmation.') else: if pwds[0] != pwds[1]: raise validation.FieldValidationError('Passwords do not match.') return self.original.validate(pwds[0]) class ChoiceBase(object): """ A base class for widgets that provide the UI to select one or more items from a list. options: A sequence of objects adaptable to IKey and ILabel. IKey is used as the