FormulatorPatch.py 43.3 KB
Newer Older
Sebastien Robin's avatar
Sebastien Robin committed
1 2 3 4 5
##############################################################################
#
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
# Copyright (c) 2003 Nexedi SARL and Contributors. All Rights Reserved.
#          Sebastien Robin <seb@nexedi.com>
6
#          Jean-Paul Smets-Solanes <jp@nexedi.com>
Sebastien Robin's avatar
Sebastien Robin committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (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
#
##############################################################################

from Products.Formulator.Field import Field
25
from Products.Formulator.Widget import Widget
Sebastien Robin's avatar
Sebastien Robin committed
26
from AccessControl import ClassSecurityInfo
Sebastien Robin's avatar
Sebastien Robin committed
27
from zLOG import LOG
Sebastien Robin's avatar
Sebastien Robin committed
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
def Field_generate_field_key(self, validation=0, key=None):
    """Generate the key Silva uses to render the field in the form.
    """
    # Patched by JPS for ERP5 in order to
    # dynamically change the name
    if key is not None:
      return 'field_%s' % key
    if self.field_record is None:
        return 'field_%s' % self.id
    elif validation:
        return self.id
    elif isinstance(self.widget, MultiItemsWidget):
        return "%s.%s:record:list" % (self.field_record, self.id)
    else:
        return '%s.%s:record' % (self.field_record, self.id)

def Field_render(self, value=None, REQUEST=None, key=None):
    """Render the field widget.
    value -- the value the field should have (for instance
              from validation).
    REQUEST -- REQUEST can contain raw (unvalidated) field
              information. If value is None, REQUEST is searched
              for this value.
    if value and REQUEST are both None, the 'default' property of
    the field will be used for the value.
    """
    return self._render_helper(self.generate_field_key(key=key), value, REQUEST)

def Field_render_sub_field(self, id, value=None, REQUEST=None, key=None):
    """Render a sub field, as part of complete rendering of widget in
    a form. Works like render() but for sub field.
        Added key parameter for ERP5 in order to be compatible with listbox/matrixbox
    """
    return self.sub_form.get_field(id)._render_helper(
        self.generate_subfield_key(id, key=key), value, REQUEST)

def Field_generate_subfield_key(self, id, validation=0, key=None):
    """Generate the key Silva uses to render a sub field.
        Added key parameter for ERP5
        Added key parameter for ERP5 in order to be compatible with listbox/matrixbox
    """
    if key is None: key = self.id
    if self.field_record is None or validation:
        return 'subfield_%s_%s'%(key, id)
73
    return '%s.subfield_%s_%s:record' % (self.field_record, key, id)
74 75 76 77 78 79 80

def Field_validate_sub_field(self, id, REQUEST, key=None):
    """Validates a subfield (as part of field validation).
    """
    return self.sub_form.get_field(id)._validate_helper(
        self.generate_subfield_key(id, validation=1, key=key), REQUEST)

81 82
def Field_render_helper(self, key, value, REQUEST):
    value = self._get_default(key, value, REQUEST)
83
    __traceback_info__ = ('key=%s value=%r' % (key, value))
84 85 86 87 88 89 90
    if self.get_value('hidden'):
        return self.widget.render_hidden(self, key, value, REQUEST)
    elif (not self.get_value('editable',REQUEST=REQUEST)):
        return self.widget.render_view(self, value)
    else:
        return self.widget.render(self, key, value, REQUEST)

91 92 93 94 95
Field.generate_field_key = Field_generate_field_key
Field.render = Field_render
Field.render_sub_field = Field_render_sub_field
Field.generate_subfield_key = Field_generate_subfield_key
Field.validate_sub_field = Field_validate_sub_field
96
Field._render_helper = Field_render_helper
Sebastien Robin's avatar
Sebastien Robin committed
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

from Products.Formulator.Validator import SelectionValidator
from Products.Formulator.Validator import StringBaseValidator

def SelectionValidator_validate(self, field, key, REQUEST):
    value = StringBaseValidator.validate(self, field, key, REQUEST)

    if value == "" and not field.get_value('required'):
        return value

    # get the text and the value from the list of items
    # Patch by JPS for Listbox cell
    for item in field.get_value('items', cell=getattr(REQUEST,'cell',None)):
        try:
            item_text, item_value = item
        except ValueError:
            item_text = item
            item_value = item

        # check if the value is equal to the string/unicode version of
        # item_value; if that's the case, we can return the *original*
        # value in the list (not the submitted value). This way, integers
        # will remain integers.
        # XXX it is impossible with the UI currently to fill in unicode
        # items, but it's possible to do it with the TALES tab
        if field.get_value('unicode') and type(item_value) == type(u''):
            str_value = item_value.encode(field.get_form_encoding())
        else:
            str_value = str(item_value)

        if str_value == value:
            return item_value

    # if we didn't find the value, return error
    self.raise_error('unknown_selection', field)

SelectionValidator.validate = SelectionValidator_validate

135 136 137 138 139 140 141 142 143 144 145
# The required field should have a default value to 0
from Products.Formulator.DummyField import fields

StringBaseValidator_required = fields.CheckBoxField('required',
                                title='Required',
                                description=(
    "Checked if the field is required; the user has to fill in some "
    "data."),
                                default=0)
StringBaseValidator.required = StringBaseValidator_required

146 147 148 149 150 151 152 153 154
from Products.Formulator.Validator import SelectionValidator

def SelectionValidator_validate(self, field, key, REQUEST):
    value = StringBaseValidator.validate(self, field, key, REQUEST)

    if value == "" and not field.get_value('required'):
        return value

    # get the text and the value from the list of items
155
    for item in list(field.get_value('items', cell=getattr(REQUEST,'cell',None))) + [field.get_value('default', cell=getattr(REQUEST,'cell',None))]:
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
        try:
            item_text, item_value = item
        except ValueError:
            item_text = item
            item_value = item

        # check if the value is equal to the string/unicode version of
        # item_value; if that's the case, we can return the *original*
        # value in the list (not the submitted value). This way, integers
        # will remain integers.
        # XXX it is impossible with the UI currently to fill in unicode
        # items, but it's possible to do it with the TALES tab
        if field.get_value('unicode') and type(item_value) == type(u''):
            str_value = item_value.encode(field.get_form_encoding())
        else:
            str_value = str(item_value)

        if str_value == value:
            return item_value

    # if we didn't find the value, return error
    self.raise_error('unknown_selection', field)

SelectionValidator.validate = SelectionValidator_validate

Sebastien Robin's avatar
Sebastien Robin committed
181 182 183
from Products.Formulator.Validator import MultiSelectionValidator

def MultiSelectionValidator_validate(self, field, key, REQUEST):
184 185 186 187
    if REQUEST.get('default_%s' % (key, )) is None:
      LOG('MultiSelectionValidator_validate', 0, 'Field %s is not present in request object (marker field default_%s not found).' % (repr(field.id), key))
      raise KeyError, 'Field %s is not present in request object (marker field default_%s not found).' % (repr(field.id), key)
    values = REQUEST.get(key, [])
Sebastien Robin's avatar
Sebastien Robin committed
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
    # NOTE: a hack to deal with single item selections
    if type(values) is not type([]):
        # put whatever we got in a list
        values = [values]
    # if we selected nothing and entry is required, give error, otherwise
    # give entry list
    if len(values) == 0:
        if field.get_value('required'):
            self.raise_error('required_not_found', field)
        else:
            return values
    # convert everything to unicode if necessary
    if field.get_value('unicode'):
        values = [unicode(value, field.get_form_encoding())
                  for value in values]

    # create a dictionary of possible values
    value_dict = {}
    for item in field.get_value('items', cell=getattr(REQUEST,'cell',None)): # Patch by JPS for Listbox
        try:
            item_text, item_value = item
        except ValueError:
            item_text = item
            item_value = item
        value_dict[item_value] = 0
213 214 215 216 217 218
    default_value = field.get_value('default', cell=getattr(REQUEST,'cell',None))
    if type(default_value) in (type([]), type(())):
      for v in default_value:
        value_dict[v] = 0
    else:
      value_dict[default_value] = 0
219

Sebastien Robin's avatar
Sebastien Robin committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

    # check whether all values are in dictionary
    result = []
    for value in values:
        # FIXME: hack to accept int values as well
        try:
            int_value = int(value)
        except ValueError:
            int_value = None
        if int_value is not None and value_dict.has_key(int_value):
            result.append(int_value)
            continue
        if value_dict.has_key(value):
            result.append(value)
            continue
        self.raise_error('unknown_selection', field)
    # everything checks out
    return result

MultiSelectionValidator.validate = MultiSelectionValidator_validate

from Products.Formulator.Validator import BooleanValidator

def BooleanValidator_validate(self, field, key, REQUEST):
244 245
    result = REQUEST.get(key, REQUEST.get('default_%s' % (key, )))
    if result is None:
246
       raise KeyError, 'Field %s is not present in request object.' % (repr(field.id), )
247
    if (not not result)==True:
Sebastien Robin's avatar
Sebastien Robin committed
248 249 250 251
       return 1
    else:
       return 0

252
BooleanValidator.validate = BooleanValidator_validate
Sebastien Robin's avatar
Sebastien Robin committed
253

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
from Products.Formulator.Widget import CheckBoxWidget
def CheckBoxWidget_render(self, field, key, value, REQUEST):
  """Render checkbox.
  """
  rendered = [render_element("input",
                             type="hidden",
                             name="default_%s:int" % (key, ),
                             value="0")
             ]
  if value:
    rendered.append(render_element("input",
                                   type="checkbox",
                                   name=key,
                                   css_class=field.get_value('css_class'),
                                   checked=None,
                                   extra=field.get_value('extra'))
                   )
  else:
    rendered.append(render_element("input",
                                   type="checkbox",
                                   name=key,
                                   css_class=field.get_value('css_class'),
                                   extra=field.get_value('extra'))
                   )
  return "".join(rendered)

CheckBoxWidget.render = CheckBoxWidget_render

Sebastien Robin's avatar
Sebastien Robin committed
282
# Patch the render_view of a TextAreaWidget so that
283
# it is rendered as a nice box, it is using the tag
Sebastien Robin's avatar
Sebastien Robin committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
# readonly understood by most browsers for a text area

from Products.Formulator.Widget import TextAreaWidget
from Products.Formulator.Widget import render_element
from DocumentTemplate.DT_Util import html_quote

def TextAreaWidget_render_view(self, field, value):
    width = field.get_value('width')
    height = field.get_value('height')

    return render_element("textarea",
                          name='',
                          css_class=field.get_value('css_class'),
                          cols=width,
                          rows=height,
                          contents=html_quote(value),
                          extra='readonly')

TextAreaWidget.render_view = TextAreaWidget_render_view

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
# Patch the render_view of LinkField so that it is clickable in read-only mode.
from Products.Formulator.Widget import TextWidget
from Products.Formulator.StandardFields import LinkField
from Globals import get_request
from urlparse import urljoin

class PatchedLinkWidget(TextWidget) :
  def render_view(self, field, value) :
    """Render link.
    """
    REQUEST = get_request()
    link_type = field.get_value('link_type')

    if link_type == 'internal':
      value = urljoin(REQUEST['BASE0'], value)
    elif link_type == 'relative':
      value = urljoin(REQUEST['URL1'], value)

    return '<a href="%s">%s</a>' % (value, field.get_value('title', cell=REQUEST.get('cell')))

PatchedLinkWidgetInstance = PatchedLinkWidget()
LinkField.widget = PatchedLinkWidgetInstance

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342

# Patch the render_view of TextField to enclose the value within <span> html tags if css class defined
def TextWidget_patched_render_view(self, field, value):
  """Render text as non-editable.
  """
  if value is None:
    return ''
  css_class = field.get_value('css_class')
  if css_class not in ('', None):
    return "<span class='%s'>%s</span>" % (css_class, value)
  return value

from Products.Formulator.Widget import TextWidget
TextWidget.render_view = TextWidget_patched_render_view


343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
class IntegerWidget(TextWidget) :
  def render(self, field, key, value, REQUEST) :
    """Render link.
    """
    if type(value) is type(1.0):
      value = int(value)
    display_maxwidth = field.get_value('display_maxwidth') or 0
    if display_maxwidth > 0:
        return render_element("input",
                              type="text",
                              name=key,
                              css_class=field.get_value('css_class'),
                              value=value,
                              size=field.get_value('display_width'),
                              maxlength=display_maxwidth,
                              extra=field.get_value('extra'))
359
    else:
360 361 362 363 364 365 366 367 368 369
        return render_element("input",
                              type="text",
                              name=key,
                              css_class=field.get_value('css_class'),
                              value=value,
                              size=field.get_value('display_width'),
                              extra=field.get_value('extra'))


from Products.Formulator.StandardFields import IntegerField
370
from Products.Formulator.Validator import IntegerValidator
371 372 373
IntegerFieldWidgetInstance = IntegerWidget()
IntegerField.widget = IntegerFieldWidgetInstance

Sebastien Robin's avatar
Sebastien Robin committed
374
import string
375

376 377 378 379 380 381
def IntegerValidator_validate(self, field, key, REQUEST):
    value = StringBaseValidator.validate(self, field, key, REQUEST)
    # we need to add this check again
    if value == "" and not field.get_value('required'):
        return value

382
    try:
383 384 385 386 387
        if value.find(' ')>0:
          value = value.replace(' ','')
        value = int(value)
    except ValueError:
        self.raise_error('not_integer', field)
388

389 390 391 392
    start = field.get_value('start')
    end = field.get_value('end')
    if start != "" and value < start:
        self.raise_error('integer_out_of_range', field)
393
    if end != "" and value >= end:
394 395 396 397 398
        self.raise_error('integer_out_of_range', field)
    return value

IntegerValidator.validate = IntegerValidator_validate

399 400
def StringBaseValidator_validate(self, field, key, REQUEST):
  # We had to add this patch for hidden fields of type "list"
401 402 403 404 405 406
  value = REQUEST.get(key)
  if value is None:
    if field.get_value('required'):
      raise Exception, 'Required field %s has not been transmitted. Check that all required fields are in visible groups.' % (repr(field.id), )
    else:
      raise KeyError, 'Field %s is not present in request object.' % (repr(field.id), )
407 408 409 410
  if type(value) is type('a'):
    value = string.strip(value)
  if field.get_value('required') and value == "":
      self.raise_error('required_not_found', field)
411 412 413
  #if field.get_value('uppercase'):
  #    value = value.upper()

414 415 416
  return value

StringBaseValidator.validate = StringBaseValidator_validate
Sebastien Robin's avatar
Sebastien Robin committed
417

418
def Widget_render_hidden(self, field, key, value, REQUEST):
Sebastien Robin's avatar
Sebastien Robin committed
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    """Renders this widget as a hidden field.
    """
    try:
        extra = field.get_value('extra')
    except KeyError:
    # In case extra is not defined as in DateTimeWidget
        extra = ''
    result = ''
    # We must adapt the rendering to the type of the value
    # in order to get the correct type back
    if type(value) is type([]) or type(value) is type(()):
      for v in value:
        result += render_element("input",
                          type="hidden",
                          name="%s:list" % key,
                          value=v,
                          extra=extra)
    else:
      result = render_element("input",
                          type="hidden",
                          name=key,
                          value=value,
                          extra=extra)
    return result

444 445 446
Widget.render_hidden = Widget_render_hidden
# default render_pdf for a Widget
Widget.render_pdf = Widget.render_view
Sebastien Robin's avatar
Sebastien Robin committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492

from Products.Formulator.Validator import LinesValidator

def LinesValidator_validate(self, field, key, REQUEST):
    value = StringBaseValidator.validate(self, field, key, REQUEST)
    # Added as a patch for hidden values
    if type(value) is type([]) or type(value) is type(()):
      value = string.join(value, "\n")
    # we need to add this check again
    if value == "" and not field.get_value('required'):
        return []
    if field.get_value('unicode'):
        value = unicode(value, field.get_form_encoding())
    # check whether the entire input is too long
    max_length = field.get_value('max_length') or 0
    if max_length and len(value) > max_length:
        self.raise_error('too_long', field)
    # split input into separate lines
    lines = string.split(value, "\n")

    # check whether we have too many lines
    max_lines = field.get_value('max_lines') or 0
    if max_lines and len(lines) > max_lines:
        self.raise_error('too_many_lines', field)

    # strip extraneous data from lines and check whether each line is
    # short enough
    max_linelength = field.get_value('max_linelength') or 0
    result = []
    whitespace_preserve = field.get_value('whitespace_preserve')
    for line in lines:
        if not whitespace_preserve:
            line = string.strip(line)
        if max_linelength and len(line) > max_linelength:
            self.raise_error('line_too_long', field)
        result.append(line)

    return result

LinesValidator.validate = LinesValidator_validate

from Products.Formulator.Validator import FloatValidator
def FloatValidator_validate(self, field, key, REQUEST):
    value = StringBaseValidator.validate(self, field, key, REQUEST)
    if value == "" and not field.get_value('required'):
        return value
493 494 495 496 497 498
    value = value.replace(' ','')
    input_style = field.get_value('input_style')
    if value.find(',') >= 0:
        value = value.replace(',','.')
    if value.find('%')>=0:
        value = value.replace('%','')
Sebastien Robin's avatar
Sebastien Robin committed
499 500
    try:
        value = float(value)
501 502
        if input_style.find('%')>=0:
            value = value/100
Sebastien Robin's avatar
Sebastien Robin committed
503 504 505 506 507
    except ValueError:
        self.raise_error('not_float', field)
    return value

FloatValidator.validate = FloatValidator_validate
508

509 510 511 512
from Products.Formulator.Widget import SingleItemsWidget

def SingleItemsWidget_render_items(self, field, key, value, REQUEST):
  # get items
513 514
  items = field.get_value('items', REQUEST=REQUEST, 
                          cell=getattr(REQUEST,'cell',None))
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566

  # check if we want to select first item
  if not value and field.get_value('first_item') and len(items) > 0:
      try:
          text, value = items[0]
      except ValueError:
          value = items[0]

  css_class = field.get_value('css_class')
  extra_item = field.get_value('extra_item')

  # if we run into multiple items with same value, we select the
  # first one only (for now, may be able to fix this better later)
  selected_found = 0
  rendered_items = []
  for item in items:
      try:
          item_text, item_value = item
      except ValueError:
          item_text = item
          item_value = item


      if item_value == value and not selected_found:
          rendered_item = self.render_selected_item(item_text,
                                                    item_value,
                                                    key,
                                                    css_class,
                                                    extra_item)
          selected_found = 1
      else:
          rendered_item = self.render_item(item_text,
                                            item_value,
                                            key,
                                            css_class,
                                            extra_item)

      rendered_items.append(rendered_item)

  # XXX We want to make sure that we always have the current value in items. -yo
  if not selected_found and value:
      rendered_item = self.render_selected_item('??? (%s)' % value,
                                                value,
                                                key,
                                                css_class,
                                                extra_item)
      rendered_items.append(rendered_item)

  return rendered_items

SingleItemsWidget.render_items = SingleItemsWidget_render_items

567 568 569
from Products.Formulator.Widget import MultiItemsWidget

def MultiItemsWidget_render_items(self, field, key, value, REQUEST):
Romain Courteaud's avatar
Romain Courteaud committed
570 571 572
  # list is needed, not a tuple
  if type(value) is type(()):
      value = list(value)
573 574 575 576
  # need to deal with single item selects
  if type(value) is not type([]):
      value = [value]

577
  # XXX -yo
578
  selected_found = {}
579

580
  items = field.get_value('items',REQUEST=REQUEST, cell=getattr(REQUEST,'cell',None)) # Added request
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
  css_class = field.get_value('css_class')
  extra_item = field.get_value('extra_item')
  rendered_items = []
  for item in items:
      try:
          item_text, item_value = item
      except ValueError:
          item_text = item
          item_value = item

      if item_value in value:
          rendered_item = self.render_selected_item(item_text,
                                                    item_value,
                                                    key,
                                                    css_class,
                                                    extra_item)
597
          # XXX -yo
598 599
          index = value.index(item_value)
          selected_found[index] = 1
600 601 602 603 604 605 606 607 608
      else:
          rendered_item = self.render_item(item_text,
                                           item_value,
                                           key,
                                           css_class,
                                           extra_item)

      rendered_items.append(rendered_item)

609
  # XXX We want to make sure that we always have the current value in items. -yo
610 611 612
  for index in range(len(value)):
    v = value[index]
    if index not in selected_found and v:
613 614 615 616 617 618
      rendered_item = self.render_selected_item('??? (%s)' % v,
                                                v,
                                                key,
                                                css_class,
                                                extra_item)
      rendered_items.append(rendered_item)
619 620 621
  
  # Moved marked field to Render
  # rendered_items.append(render_element('input', type='hidden', name="default_%s:int" % (key, ), value="0"))
622 623 624 625
  return rendered_items

MultiItemsWidget.render_items = MultiItemsWidget_render_items

626 627 628 629
from Products.Formulator.Widget import MultiListWidget

def MultiListWidget_render(self, field, key, value, REQUEST):
  rendered_items = self.render_items(field, key, value, REQUEST)
630 631 632 633 634 635 636 637 638 639 640
  input_hidden = render_element('input', type='hidden', name="default_%s:int" % (key, ), value="0")
  multi_list = render_element(
                'select',
                name=key,
                multiple=None,
                css_class=field.get_value('css_class', REQUEST=REQUEST),
                size=field.get_value('size', REQUEST=REQUEST),
                contents=string.join(rendered_items, "\n"),
                extra=field.get_value('extra', REQUEST=REQUEST))
   
  return "\n".join([multi_list,input_hidden]) 
641 642 643

MultiListWidget.render = MultiListWidget_render

644 645 646 647 648 649 650 651 652 653 654 655 656
from Products.Formulator.Widget import MultiCheckBoxWidget

def MultiCheckBoxWidget_render(self, field, key, value, REQUEST):
  rendered_items = self.render_items(field, key, value, REQUEST)
  rendered_items.append(render_element('input', type='hidden', name="default_%s:int" % (key, ), value="0"))
  orientation = field.get_value('orientation')
  if orientation == 'horizontal':
    return string.join(rendered_items, "&nbsp;&nbsp;")
  else:
    return string.join(rendered_items, "<br />")
                                                                    
MultiCheckBoxWidget.render = MultiCheckBoxWidget_render

657 658 659 660
from Products.Formulator.Widget import ListWidget

def ListWidget_render(self, field, key, value, REQUEST):
  rendered_items = self.render_items(field, key, value, REQUEST)
661 662
  input_hidden = render_element('input', type='hidden', 
                                name="default_%s:int" % (key, ), value="0") 
663 664 665 666 667 668 669 670
  list_widget = render_element(
                'select',
                name=key,
                css_class=field.get_value('css_class', REQUEST=REQUEST),
                size=field.get_value('size', REQUEST=REQUEST),
                contents=string.join(rendered_items, "\n"),
                extra=field.get_value('extra', REQUEST=REQUEST))

671
  return "\n".join([list_widget, input_hidden])
672
  
673 674 675 676 677 678 679 680 681 682 683 684 685 686
def ListWidget_render_view(self, field, value):
  """
  This method is not as efficient as using a StringField in read only.
  Always consider to change the field in your Form.
  """
  if value is None:
      return ''
  title_list = [x[0] for x in field.get_value("items") if x[1]==value]
  if len(title_list) == 0:
    return "??? (%s)" % value
  else:
    return title_list[0]
  return value
    
687
ListWidget.render = ListWidget_render
688
ListWidget.render_view = ListWidget_render_view
689

690 691 692
# JPS - Subfield handling with listbox requires extension
from Products.Formulator.StandardFields import DateTimeField

693 694 695 696 697 698
def DateTimeField_get_default(self, key, value, REQUEST):
    if value is not None:
        return value
    # if there is something in the request then return None
    # sub fields should pick up defaults themselves
    if REQUEST is not None and hasattr(REQUEST, 'form') and \
699
        REQUEST.form.has_key('subfield_%s_%s' % (key, 'year')):
700 701 702
        return None
    else:
        return self.get_value('default')
703

704
DateTimeField._get_default = DateTimeField_get_default
705

706
from Products.Formulator.Widget import DateTimeWidget
707
old_date_time_widget_property_names = DateTimeWidget.property_names
708
from Products.Formulator.StandardFields import create_datetime_text_sub_form
709 710

class PatchedDateTimeWidget(DateTimeWidget):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
711 712 713
    """
      Added support for key in every call to render_sub_field
    """
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
    hide_day = fields.CheckBoxField('hide_day',
                                  title="Hide Day",
                                  description=(
        "The day will be hidden on the output. Instead the default"
        "Day will be taken"),
                                  default=0)

    hidden_day_is_last_day = fields.CheckBoxField('hidden_day_is_last_day',
                                  title="Hidden Day is last day of the Month",
                                  description=(
        "Defines wether hidden day means, you want the last day of the month"
        "Else it will be the first day"),
                                  default=0)

    property_names = old_date_time_widget_property_names \
        + ['hide_day', 'hidden_day_is_last_day']

    def getInputOrder(self, field):
      input_order = field.get_value('input_order')
      if field.get_value('hide_day'):
        if input_order == 'ymd':
          input_order = 'ym'
        elif input_order in ('dmy', 'mdy'):
          input_order = 'my'
      return input_order
739

740 741 742 743 744
    def render(self, field, key, value, REQUEST):
        use_ampm = field.get_value('ampm_time_style')
        # FIXME: backwards compatibility hack:
        if not hasattr(field, 'sub_form'):
            field.sub_form = create_datetime_text_sub_form()
745

746 747
        if value is None and field.get_value('default_now'):
            value = DateTime()
748 749 750 751 752 753
        year   = None
        month  = None
        day    = None
        hour   = None
        minute = None
        ampm   = None
754
        if type(value) is type(DateTime()):
755 756 757 758 759 760 761 762 763
            year = "%04d" % value.year()
            month = "%02d" % value.month()
            day = "%02d" % value.day()
            if use_ampm:
                hour = "%02d" % value.h_12()
            else:
                hour = "%02d" % value.hour()
            minute = "%02d" % value.minute()
            ampm = value.ampm()
764
        input_order = self.getInputOrder(field)
765 766 767 768 769 770 771 772 773 774 775 776
        if input_order == 'ymd':
            order = [('year', year),
                     ('month', month),
                     ('day', day)]
        elif input_order == 'dmy':
            order = [('day', day),
                     ('month', month),
                     ('year', year)]
        elif input_order == 'mdy':
            order = [('month', month),
                     ('day', day),
                     ('year', year)]
777 778 779 780 781 782
        elif input_order == 'my':
            order = [('month', month),
                     ('year', year)]
        elif input_order == 'ym':
            order = [('year', year),
                     ('month', month)]
783 784 785 786
        else:
            order = [('year', year),
                     ('month', month),
                     ('day', day)]
787 788 789 790 791 792 793 794 795
        result = []
        for sub_field_name, sub_field_value in order:
            result.append(field.render_sub_field(sub_field_name,
                                                 sub_field_value, REQUEST, key=key))
        date_result = string.join(result, field.get_value('date_separator'))
        if not field.get_value('date_only'):
            time_result = (field.render_sub_field('hour', hour, REQUEST, key=key) +
                           field.get_value('time_separator') +
                           field.render_sub_field('minute', minute, REQUEST, key=key))
796

797
            if use_ampm:
798
                time_result += '&nbsp;' + field.render_sub_field('ampm',
799
                                                            ampm, REQUEST, key=key)
800

801 802 803
            return date_result + '&nbsp;&nbsp;&nbsp;' + time_result
        else:
            return date_result
804 805
    
    def format_value(self, field, value, mode='html'):
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
        if value is None:
            return ''

        use_ampm = field.get_value('ampm_time_style')

        year = "%04d" % value.year()
        month = "%02d" % value.month()
        day = "%02d" % value.day()
        if use_ampm:
            hour = "%02d" % value.h_12()
        else:
            hour = "%02d" % value.hour()
        minute = "%02d" % value.minute()
        ampm = value.ampm()

821
        order = self.getInputOrder(field)
822 823 824 825 826 827
        if order == 'ymd':
            output = [year, month, day]
        elif order == 'dmy':
            output = [day, month, year]
        elif order == 'mdy':
            output = [month, day, year]
828 829 830 831
        elif order == 'my':
            output = [month, year]
        elif order == 'ym':
            output = [year, month]
832 833 834
        else:
            output = [year, month, day]
        date_result = string.join(output, field.get_value('date_separator'))
835 836 837 838 839
        
        if mode in ('html', ):
            space = '&nbsp;'
        else:
            space = ' '
840 841 842 843

        if not field.get_value('date_only'):
            time_result = hour + field.get_value('time_separator') + minute
            if use_ampm:
844 845
                time_result += space + ampm
            return date_result + (space * 3) + time_result
846 847
        else:
            return date_result
848 849 850 851 852 853
    
    def render_view(self, field, value):
        return self.format_value(field, value, mode='html')
    
    def render_pdf(self, field, value):
        return self.format_value(field, value, mode='pdf')
854

Jean-Paul Smets's avatar
Jean-Paul Smets committed
855 856
DateTimeField.widget = PatchedDateTimeWidget()

Yoshinori Okuji's avatar
Yoshinori Okuji committed
857
from Products.Formulator.Validator import DateTimeValidator, ValidationError, DateTime
858
from DateTime.DateTime import DateError, TimeError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
859 860 861 862 863 864

class PatchedDateTimeValidator(DateTimeValidator):
    """
      Added support for key in every call to validate_sub_field
    """

865
    def validate(self, field, key, REQUEST):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
866 867 868
        try:
            year = field.validate_sub_field('year', REQUEST, key=key)
            month = field.validate_sub_field('month', REQUEST, key=key)
869 870 871 872
            if field.get_value('hide_day'):
              day = 1
            else:
              day = field.validate_sub_field('day', REQUEST, key=key)
873

Jean-Paul Smets's avatar
Jean-Paul Smets committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
            if field.get_value('date_only'):
                hour = 0
                minute = 0
            elif field.get_value('allow_empty_time'):
                hour = field.validate_sub_field('hour', REQUEST, key=key)
                minute = field.validate_sub_field('minute', REQUEST, key=key)
                if hour == '' and minute == '':
                    hour = 0
                    minute = 0
                elif hour == '' or minute == '':
                    raise ValidationError('not_datetime', field)
            else:
                hour = field.validate_sub_field('hour', REQUEST, key=key)
                minute = field.validate_sub_field('minute', REQUEST, key=key)
        except ValidationError:
            self.raise_error('not_datetime', field)

        # handling of completely empty sub fields
892 893
        if ((year == '' and month == '') and
            (field.get_value('hide_day') or day == '') and
Jean-Paul Smets's avatar
Jean-Paul Smets committed
894
            (field.get_value('date_only') or (hour == '' and minute == '')
895
            or (hour == 0 and minute == 0))):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
896 897 898 899 900 901
            if field.get_value('required'):
                self.raise_error('required_not_found', field)
            else:
                # field is not required, return None for no entry
                return None
        # handling of partially empty sub fields; invalid datetime
902 903
        if ((year == '' or month == '') or
            (not field.get_value('hide_day') and day == '') or
Jean-Paul Smets's avatar
Jean-Paul Smets committed
904 905 906 907 908 909 910 911 912 913 914 915 916 917
            (not field.get_value('date_only') and
             (hour == '' or minute == ''))):
            self.raise_error('not_datetime', field)


        if field.get_value('ampm_time_style'):
            ampm = field.validate_sub_field('ampm', REQUEST, key=key)
            if field.get_value('allow_empty_time'):
                if ampm == '':
                    ampm = 'am'
            hour = int(hour)
            # handling not am or pm
            # handling hour > 12
            if ((ampm != 'am') and (ampm != 'pm')) or (hour > 12):
918 919 920
                self.raise_error('not_datetime', field)
            if (ampm == 'pm') and (hour == 0):
                self.raise_error('not_datetime', field)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
921 922
            elif ampm == 'pm' and hour < 12:
                hour += 12
923

Jean-Paul Smets's avatar
Jean-Paul Smets committed
924
        try:
925 926 927 928 929 930 931 932 933 934 935 936
            # handling of hidden day, which can be first or last day of the month:
            if field.get_value('hidden_day_is_last_day'):
              if int(month) == 12:
                tmp_year = int(year) + 1
                tmp_month = 1
              else:
                tmp_year = int(year)
                tmp_month = int(month) + 1
              tmp_day = DateTime(tmp_year, tmp_month, 1, hour, minute)
              result = tmp_day - 1
            else:
              result = DateTime(int(year), int(month), int(day), hour, minute)
937 938 939
        # ugh, a host of string based exceptions (not since Zope 2.7)
        except ('DateTimeError', 'Invalid Date Components', 'TimeError',
                DateError, TimeError) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
            self.raise_error('not_datetime', field)

        # check if things are within range
        start_datetime = field.get_value('start_datetime')
        if (start_datetime is not None and
            result < start_datetime):
            self.raise_error('datetime_out_of_range', field)
        end_datetime = field.get_value('end_datetime')
        if (end_datetime is not None and
            result >= end_datetime):
            self.raise_error('datetime_out_of_range', field)

        return result

DateTimeField.validator = PatchedDateTimeValidator()
955

956 957
from Products.Formulator.Widget import TextWidgetInstance

958 959
class FloatWidget(TextWidget):

960
    property_names = TextWidget.property_names +\
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
                     ['input_style','precision']

    input_style = fields.ListField('input_style',
                                   title="Input style",
                                   description=(
        "The type of float we should enter. "),
                                   default="-1234.5",
                                   items=[("-1234.5",  "-1234.5"),
                                          ("-1 234.5", "-1 234.5"),
                                          ("-12.3%", "-12.3%"),],
                                   required=1,
                                   size=1)

    precision = fields.IntegerField('precision',
                                        title='Precision',
                                        description=(
        "Number of digits after the decimal point"),
                                        default=None,
                                        required=0)

981 982
    def format_value(self, field, value):
        """Formats the value as requested"""
983 984 985 986 987
        if value not in (None,''):
          input_style = field.get_value('input_style')
          percent = 0
          if input_style.find('%')>=0:
            percent=1
988
            value = float(value) * 100
989 990 991 992
          try :
            value = str(float(value))
          except ValueError:
            return value
993 994 995 996 997 998 999 1000 1001 1002 1003 1004
          value_list = value.split('.')
          integer = value_list[0]
          if input_style.find(' ')>=0:
            integer = value_list[0]
            i = len(integer)%3
            value = integer[:i]
            while i != len(integer):
              value += ' ' + integer[i:i+3]
              i += 3
          else:
            value = value_list[0]
          precision = field.get_value('precision')
1005 1006
          if precision != 0:
            value += '.'
1007 1008 1009
          if precision not in (None,''):
            for i in range(0,precision):
              if i < len(value_list[1]):
1010
                value += value_list[1][i]
1011 1012 1013 1014 1015 1016
              else:
                value += '0'
          else:
            value += value_list[1]
          if percent:
            value += '%'
1017
        return value.strip()
1018

1019 1020 1021 1022
    def render(self, field, key, value, REQUEST):
        """Render Float input field
        """
        value = self.format_value(field, value)
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
        display_maxwidth = field.get_value('display_maxwidth') or 0
        extra_keys = {}
        if display_maxwidth > 0:
          extra_keys['maxlength'] = display_maxwidth
        return render_element( "input",
                                type="text",
                                name=key,
                                css_class=field.get_value('css_class'),
                                value=value,
                                size=field.get_value('display_width'),
                                extra=field.get_value('extra'),
                                **extra_keys)

1036

1037
    def render_view(self, field, value):
Kevin Deldycke's avatar
Kevin Deldycke committed
1038 1039 1040 1041 1042
        """
          Render Float display field.
          This patch add:
            * replacement of spaces by unbreakable spaces if the content is float-like
            * support of extra CSS class when render as pure text
1043 1044
        """
        value = self.format_value(field, value)
Kevin Deldycke's avatar
Kevin Deldycke committed
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

        float_value = None
        try:
          float_value = float(value.replace(' ', ''))
        except:
          pass
        if float_value != None:
          value = value.replace(' ', '&nbsp;')

        extra = field.get_value('extra')
        if extra not in (None, ''):
          value = "<div %s>%s</div>" % (extra, value)

1058 1059
        return TextWidgetInstance.render_view(field, value)

1060 1061 1062
    def render_pdf(self, field, value):
        """Render the field as PDF."""
        return self.format_value(field, value)
Kevin Deldycke's avatar
Kevin Deldycke committed
1063

1064 1065 1066
FloatWidgetInstance = FloatWidget()
from Products.Formulator.StandardFields import FloatField
FloatField.widget = FloatWidgetInstance
1067 1068 1069

###################################################################
# New formulator API
1070
#
1071 1072
# render method on Field must change, and have a new parameter:
#   render_format
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073
# which is used to call others methods ('html' call render_html)
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
###################################################################
# XXX Patching all Fields is not easy, as ERP5 defines his own fields.
# def Widget_render(self, field, key, value, REQUEST, render_format='html')
#   # Test if method defined on class
#   method_id = 'render_%' % render_format
#   if hasattr(aq_self(self), method_id):
#     # Try to return built-in renderer
#     return getattr(self, method_id )(self, field, key, value, REQUEST)
#   raise KeyError, "Rendering not defined"

# Monkey Patch
1085
#
1086
# Lookup all registered widgets and create render_html
1087
# XXX This method is not a good way of patching,
1088
# because it breaks inheritance
1089
# XXX It's difficult to get all possible widgets, as ERP5 defines
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
# also his owns.
# for f in Formulator.widgets():
#   if not hasattr(f, '__erp5_patched'):
#     f.render_html = f.render
def Widget_render_html(self, *args, **kw):
  return self.render(*args, **kw)
Widget.render_html = Widget_render_html

def Field_render_html(self, *args, **kw):
  """
  render_html is used to as definition of render method in Formulator.
  """
  return self.render(*args, **kw)
Field.render_html = Field_render_html

def Field_render_htmlgrid(self, value=None, REQUEST=None, key=None):
  """
  render_htmlgrid returns a list of tuple (title, html render)
  """
  # What about CSS ? What about description ? What about error ?
1110 1111 1112 1113
  widget_key = self.generate_field_key(key=key)
  value = self._get_default(key, value, REQUEST)
  __traceback_info__ = ('key=%s value=%r' % (key, value))
  return self.widget.render_htmlgrid(self, widget_key, value, REQUEST)
1114 1115
Field.render_htmlgrid = Field_render_htmlgrid

1116 1117 1118 1119 1120 1121 1122 1123 1124
def Widget_render_htmlgrid(self, field, key, value, REQUEST):
  """
  render_htmlgrid returns a list of tuple (title, html render)
  """
  # XXX Calling _render_helper on the field is not optimized
  return ((field.get_value('title'), 
           field._render_helper(key, value, REQUEST)),)
Widget.render_htmlgrid = Widget_render_htmlgrid

1125
# Generic possible renderers
1126 1127
#   def render_ext(self, field, key, value, REQUEST):
#     return getattr(self, '%s_render' % self.__class__.__name__)
1128
#
1129 1130 1131 1132 1133
#   def render_pt(self, field, key, value, REQUEST):
#     """
#     Call a page template which contains 1 macro per field
#     """
#     return self.field_master(self.__class__.__name__)
1134
#
1135 1136 1137 1138 1139 1140
#   def render_grid(self, field, key, value, REQUEST):
#     return ((self.get_value('title'), self.get_value('value'),)
#    # What about CSS ? What about description ? What about error ?
#    # What about rendering a listbox ?
#    # Grid is only valid if stucture of grid has some meaning and is
#    # implemeted by listbox (ex. spreadsheet = grid)
1141
#
1142 1143 1144 1145 1146 1147 1148 1149

def Field_render_pdf(self, value=None, REQUEST=None, key=None, **kw):
  """
  render_pdf renders the field for reportlab
  """
  return self.widget.render_pdf(self, value)
Field.render_pdf = Field_render_pdf

1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165

from Products.Formulator.TALESField import TALESWidget
def TALESWidget_render_view(self, field, value):
  """
  Render TALES as read only
  """
  if value == None:
    text = field.get_value('default')
  else:
    if value != "":
      text = value._text
    else:
      text = ""
  return text

TALESWidget.render_view = TALESWidget_render_view