Form.py 34.3 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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 program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Products.Formulator.Form import Form, BasicForm, ZMIForm
from Products.Formulator.Form import manage_addForm, manage_add, initializeForm
31
from Products.Formulator.Errors import FormValidationError, ValidationError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33 34
from Products.Formulator.DummyField import fields
from Products.Formulator.XMLToForm import XMLToForm
from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
35
from Products.CMFCore.utils import _checkPermission, getToolByName
36 37
from Products.CMFCore.exceptions import AccessControl_Unauthorized
from Products.ERP5Type import PropertySheet, Permissions
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38 39

from urllib import quote
40
from Globals import InitializeClass, PersistentMapping, DTMLFile, get_request
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41
from AccessControl import Unauthorized, getSecurityManager, ClassSecurityInfo
Yoshinori Okuji's avatar
Yoshinori Okuji committed
42
from ZODB.POSException import ConflictError
43
from Products.PageTemplates.Expressions import SecureModuleImporter
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45
from Products.ERP5Type.Utils import UpperCase

46
from Products.ERP5Type.PsycoWrapper import psyco
47
import sys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48

49 50 51 52
_field_value_cache = {}
def purgeFieldValueCache():
  _field_value_cache.clear()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55
# Patch the fiels methods to provide improved namespace handling

from Products.Formulator.Field import Field
56
from Products.Formulator.TALESField import TALESMethod
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57

58
from zLOG import LOG, PROBLEM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59

60 61 62 63 64 65 66 67
class StaticValue:
  """
    Encapsulated a static value in a class
    (quite heavy, would be faster to store the
    value as is)
  """
  def __init__(self, value):
    self.value = value
68

69 70
  def __call__(self, field, id, **kw):
    return self.returnValue(field, id, self.value)
71

72
  def returnValue(self, field, id, value):
73 74
    # if normal value is a callable itself, wrap it
    if callable(value):
75 76
      value = value.__of__(field)
      #value=value() # Mising call ??? XXX Make sure compatible with listbox methods
77 78

    if id == 'default':
79 80 81 82 83
      # We make sure we convert values to empty strings
      # for most fields (so that we do not get a 'value'
      # message on screen)
      # This can be overriden by using TALES in the field
      if value is None: value = ''
84

85 86
    return value

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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
class TALESValue(StaticValue):
  def __init__(self, tales_expr):
    self.tales_expr = tales_expr

  def __call__(self, field, id, **kw):
    REQUEST = get_request()
    if REQUEST is not None:
      # Proxyfield stores the "real" field in the request. Look if the
      # corresponding field exists in request, and use it as field in the
      # TALES context 
      field = REQUEST.get('field__proxyfield_%s_%s' % (field.id, id), field)

    kw['field'] = field

    form = field.aq_parent # XXX (JPS) form for default is wrong apparently in listbox - double check
    obj = getattr(form, 'aq_parent', None)
    if obj is not None:
        container = obj.aq_inner.aq_parent
    else:
        container = None

    kw['form'] = form
    kw['request'] = REQUEST
    kw['here'] = obj
    kw['context'] = obj
    kw['modules'] = SecureModuleImporter
    kw['container'] = container
    try :
      kw['preferences'] = obj.getPortalObject().portal_preferences
    except AttributeError :
      LOG('ERP5Form', PROBLEM,
          'portal_preferences not put in TALES context (not installed?)')
    # This allows to pass some pointer to the local object
    # through the REQUEST parameter. Not very clean.
    # Used by ListBox to render different items in a list
    if kw.has_key('REQUEST') and kw.get('cell', None) is None:
      if getattr(kw['REQUEST'],'cell', None) is not None:
        kw['cell'] = getattr(kw['REQUEST'],'cell')
      else:
        kw['cell'] = kw['REQUEST']
    elif kw.get('cell', None) is None:
      if getattr(REQUEST, 'cell', None) is not None:
        kw['cell'] = getattr(REQUEST, 'cell')
    try:
      value = self.tales_expr.__of__(field)(**kw)
    except (ConflictError, RuntimeError):
      raise
    except:
      # We add this safety exception to make sure we always get
      # something reasonable rather than generate plenty of errors
      LOG('ERP5Form', PROBLEM,
          'Field.get_value ( %s/%s [%s]), exception on tales_expr: ' %
          ( form.getId(), field.getId(), id), error=sys.exc_info())
      value = field.get_orig_value(id)

    return self.returnValue(field, id, value)

class OverrideValue(StaticValue):
  def __init__(self, override):
    self.override = override

  def __call__(self, field, id, **kw):
    return self.returnValue(field, id, self.override.__of__(field)())

class DefaultValue(StaticValue):
  def __init__(self, field_id, value):
    self.key = field_id[3:]
    self.value = value

  def __call__(self, field, id, **kw):
    try:
      form = field.aq_parent
      ob = getattr(form, 'aq_parent', None)
      value = self.value
      if value not in (None, ''):
        # If a default value is defined on the field, it has precedence
        value = ob.getProperty(self.key, d=value)
      else:
        # else we should give a chance to the accessor to provide
        # a default value (including None)
        value = ob.getProperty(self.key)
    except (KeyError, AttributeError):
      value = None
    return self.returnValue(field, id, value)

class EditableValue(StaticValue):

  def __call__(self, field, id, **kw):
    # By default, pages are editable and
    # fields are editable if they are set to editable mode
    # However, if the REQUEST defines editable_mode to 0
    # then all fields become read only.
    # This is useful to render ERP5 content as in a web site (ECommerce)
    # editable_mode should be set for example by the page template
    # which defines the current layout
    if kw.has_key('REQUEST'):
      if not getattr(kw['REQUEST'], 'editable_mode', 1):
        self.value = 0
    return self.value

def getFieldValue(self, field, id, **kw):
  """
    Return a callable expression
  """
  # FIXME: backwards compat hack to make sure tales dict exists
  if not hasattr(self, 'tales'):
    self.tales = {}

  tales_expr = self.tales.get(id, "")
  if tales_expr:
    # TALESMethod is persistent object, so that we cannot cache original one.
    # Becase if connection which original talesmethod uses is closed,
    # RuntimeError must occurs in __setstate__.
    clone = TALESMethod(tales_expr._text)
    return TALESValue(clone)

  # FIXME: backwards compat hack to make sure overrides dict exists
  if not hasattr(self, 'overrides'):
      self.overrides = {}

  override = self.overrides.get(id, "")
  if override:
    return OverrideValue(override)

  # Get a normal value.
  value = self.get_orig_value(id)

  field_id = field.id

  if id == 'default' and field_id.startswith('my_'):
    return DefaultValue(field_id, value)

  # For the 'editable' value, we try to get a default value
  if id == 'editable':
    return EditableValue(value)

  # Return default value in non callable mode
  if callable(value):
    return StaticValue(value)

  # Return default value in non callable mode
  return StaticValue(value)(field, id, **kw)

def get_value(self, id, **kw):
  REQUEST = get_request()
  if REQUEST is not None:
    field = REQUEST.get('field__proxyfield_%s_%s' % (self.id, id), self)
  else:
    field = self

  cache_id = ('Form.get_value',
              self._p_oid or repr(self),
              field._p_oid or repr(field),
              id)

  try:
    value = _field_value_cache[cache_id]
  except KeyError:
    # either returns non callable value (ex. "Title")
    # or a FieldValue instance of appropriate class
    value = _field_value_cache[cache_id] = getFieldValue(self, field, id, **kw)

  if callable(value):
    return value(field, id, **kw)
  return value

253 254 255 256 257 258 259 260 261 262 263 264 265
psyco.bind(get_value)

def om_icons(self):
    """Return a list of icon URLs to be displayed by an ObjectManager"""
    icons = ({'path': self.icon,
              'alt': self.meta_type, 'title': self.meta_type},)
    return icons


def _get_default(self, key, value, REQUEST):
    if value is not None:
        return value
    try:
266
        value = self._get_user_input_value(key, REQUEST)
267 268
    except (KeyError, AttributeError):
        # fall back on default
269
        return self.get_value('default', REQUEST=REQUEST) # It was missing on Formulator
270

271 272 273 274 275 276 277 278 279
    # if we enter a string value while the field expects unicode,
    # convert to unicode first
    # this solves a problem when re-rendering a sticky form with
    # values from request
    if (self.has_value('unicode') and self.get_value('unicode') and
        type(value) == type('')):
        return unicode(value, self.get_form_encoding())
    else:
        return value
280 281


Jean-Paul Smets's avatar
Jean-Paul Smets committed
282
# Dynamic Patch
283 284 285
Field.get_value = get_value
Field._get_default = _get_default
Field.om_icons = om_icons
Jean-Paul Smets's avatar
Jean-Paul Smets committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

# Constructors

manage_addForm = DTMLFile("dtml/form_add", globals())

def addERP5Form(self, id, title="", REQUEST=None):
    """Add form to folder.
    id     -- the id of the new form to add
    title  -- the title of the form to add
    Result -- empty string
    """
    # add actual object
    id = self._setObject(id, ERP5Form(id, title))
    # respond to the add_and_edit button if necessary
    add_and_edit(self, id, REQUEST)
    return ''

def add_and_edit(self, id, REQUEST):
    """Helper method to point to the object's management screen if
    'Add and Edit' button is pressed.
    id -- id of the object we just added
    """
    if REQUEST is None:
        return
    try:
        u = self.DestinationURL()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
312
    except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
313 314 315 316 317
        u = REQUEST['URL1']
    if REQUEST['submit'] == " Add and Edit ":
        u = "%s/%s" % (u, quote(id))
    REQUEST.RESPONSE.redirect(u+'/manage_main')

318
def initializeForm(field_registry, form_class=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
319 320
    """Sets up ZMIForm with fields from field_registry.
    """
321
    if form_class is None: form_class = ERP5Form
322

Jean-Paul Smets's avatar
Jean-Paul Smets committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    meta_types = []
    for meta_type, field in field_registry.get_field_classes().items():
        # don't set up in form if this is a field for internal use only
        if field.internal_field:
            continue

        # set up individual add dictionaries for meta_types
        dict = { 'name': field.meta_type,
                 'action':
                 'manage_addProduct/Formulator/manage_add%sForm' % meta_type }
        meta_types.append(dict)
        # set up add method
        setattr(form_class,
                'manage_add%sForm' % meta_type,
                DTMLFile('dtml/fieldAdd', globals(), fieldname=meta_type))

    # set up meta_types that can be added to form
    form_class._meta_types = tuple(meta_types)

    # set up settings form
    form_class.settings_form._realize_fields()

# Special Settings

def create_settings_form():
    """Create settings form for ZMIForm.
    """
    form = BasicForm('manage_settings')

    title = fields.StringField('title',
                               title="Title",
                               required=0,
                               default="")
356 357 358 359
    description = fields.TextAreaField('description',
                               title="Description",
                               required=0,
                               default="")
Jean-Paul Smets's avatar
Jean-Paul Smets committed
360
    row_length = fields.IntegerField('row_length',
361 362 363
                                     title='Number of groups in row (in order tab)',
                                     required=1,
                                     default=4)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
364 365 366 367 368 369 370 371 372 373 374 375
    name = fields.StringField('name',
                              title="Form name",
                              required=0,
                              default="")
    pt = fields.StringField('pt',
                              title="Page Template",
                              required=0,
                              default="")
    action = fields.StringField('action',
                                title='Form action',
                                required=0,
                                default="")
376 377 378 379
    update_action = fields.StringField('update_action',
                                title='Form update action',
                                required=0,
                                default="")
Jean-Paul Smets's avatar
Jean-Paul Smets committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
    method = fields.ListField('method',
                              title='Form method',
                              items=[('POST', 'POST'),
                                     ('GET', 'GET')],
                              required=1,
                              size=1,
                              default='POST')
    enctype = fields.ListField('enctype',
                               title='Form enctype',
                               items=[('No enctype', ""),
                                      ('application/x-www-form-urlencoded',
                                       'application/x-www-form-urlencoded'),
                                      ('multipart/form-data',
                                       'multipart/form-data')],
                               required=0,
                               size=1,
                               default=None)
397 398 399 400 401 402
    encoding = fields.StringField('encoding',
                                  title='Encoding of pages the form is in',
                                  default="UTF-8",
                                  required=1)
    stored_encoding = fields.StringField('stored_encoding',
                                      title='Encoding of form properties',
403
                                      default='UTF-8',
404
                                      required=1)
405 406 407 408 409
    unicode_mode = fields.CheckBoxField('unicode_mode',
                                        title='Form properties are unicode',
                                        default=0,
                                        required=1)

410
    form.add_fields([title, description, row_length, name, pt, action, update_action, method,
411
                     enctype, encoding, stored_encoding, unicode_mode])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
412 413 414 415 416 417 418 419 420 421 422 423 424
    return form

class ERP5Form(ZMIForm, ZopePageTemplate):
    """
        A Formulator form with a built-in rendering parameter based
        on page templates or DTML.
    """
    meta_type = "ERP5 Form"
    icon = "www/Form.png"

    # Declarative Security
    security = ClassSecurityInfo()

425 426 427 428 429
    # Tabs in ZMI
    manage_options = (ZMIForm.manage_options[:5] +
                      ({'label':'Proxify', 'action':'formProxify'},)+
                      ZMIForm.manage_options[5:])

Jean-Paul Smets's avatar
Jean-Paul Smets committed
430 431 432 433 434 435 436
    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.SimpleItem)

    # Constructors
    constructors =   (manage_addForm, addERP5Form)

437 438 439 440
    # This is a patched dtml formOrder
    security.declareProtected('View management screens', 'formOrder')
    formOrder = DTMLFile('dtml/formOrder', globals())

441 442 443 444
    # Proxify form
    security.declareProtected('View management screens', 'formProxify')
    formProxify = DTMLFile('dtml/formProxify', globals())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
445 446
    # Default Attributes
    pt = 'form_view'
447
    update_action = ''
Jean-Paul Smets's avatar
Jean-Paul Smets committed
448 449 450 451

    # Special Settings
    settings_form = create_settings_form()

452
    def __init__(self, id, title, unicode_mode=0, encoding='UTF-8',
Romain Courteaud's avatar
Romain Courteaud committed
453
                 stored_encoding='UTF-8'):
454 455 456 457 458 459 460 461 462 463
        """Initialize form.
        id    -- id of form
        title -- the title of the form
        """
        ZMIForm.inheritedAttribute('__init__')(self, "", "POST", "", id,
                                               encoding, stored_encoding,
                                               unicode_mode)
        self.id = id
        self.title = title
        self.row_length = 4
464
        self.group_list = ["left", "right", "center", "bottom", "hidden"]
465 466 467 468
        groups = {}
        for group in self.group_list:
          groups[group] = []
        self.groups = groups
469

Jean-Paul Smets's avatar
Jean-Paul Smets committed
470 471
    # Proxy method to PageTemplate
    def __call__(self, *args, **kwargs):
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
        # Security
        #
        # The minimal action consists in checking that
        # we have View permission on the current object
        # before rendering a form. Otherwise, object with
        # AccessContentInformation can be viewed by invoking
        # a form directly.
        #
        # What would be better is to prevent calling certain
        # forms to render objects. This can not be done
        # through actions since we are using sometimes forms
        # to render the results of a report dialog form.
        # An a appropriate solutions could consist in adding
        # a permission field to the form. Another solutions
        # is the use of REFERER in the rendering process.
        #
        # Both solutions are not perfect if the goal is, for
        # example, to prevent displaying private information of
        # staff. The only real solution is to use a special
        # permission (ex. AccessPrivateInformation) for those
        # properties which are sensitive.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
493 494 495
        if not kwargs.has_key('args'):
            kwargs['args'] = args
        form = self
496 497 498 499 500
        obj = getattr(form, 'aq_parent', None)
        if obj is not None:
          container = obj.aq_inner.aq_parent
          if not _checkPermission(Permissions.View, obj):
            raise AccessControl_Unauthorized('This document is not authorized for view.')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
501 502 503
        else:
          container = None
        pt = getattr(self,self.pt)
504 505 506 507 508
        extra_context = dict( container=container,
                              template=self,
                              form=self,
                              options=kwargs,
                              here=obj )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
        return pt.pt_render(extra_context=extra_context)

    def _exec(self, bound_names, args, kw):
        pt = getattr(self,self.pt)
        return pt._exec(self, bound_names, args, kw)

    # Utilities
    def ErrorFields(self, validation_errors):
        """
            Create a dictionnary of validation_errors
            with field id as key
        """
        ef = {}
        for e in validation_errors.errors:
            ef[e.field_id] = e
        return ef

    def om_icons(self):
        """Return a list of icon URLs to be displayed by an ObjectManager"""
        icons = ({'path': 'misc_/ERP5Form/Form.png',
                  'alt': self.meta_type, 'title': self.meta_type},)
        return icons

532 533 534 535 536 537 538 539 540
    # Pached validate_all to support ListBox validation
    security.declareProtected('View', 'validate_all')
    def validate_all(self, REQUEST):
        """Validate all enabled fields in this form, catch any ValidationErrors
        if they occur and raise a FormValidationError in the end if any
        Validation Errors occured.
        """
        result = {}
        errors = []
541 542
        for group in self.get_groups():
            if group.lower() == 'hidden':
543
                continue
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
            for field in self.get_fields_in_group(group):
                # skip any field we don't need to validate
                if not field.need_validate(REQUEST):
                    continue
                if not (field.get_value('editable',REQUEST=REQUEST)):
                    continue
                try:
                    value = field.validate(REQUEST)
                    # store under id
                    result[field.id] = value
                    # store as alternate name as well if necessary
                    alternate_name = field.get_value('alternate_name')
                    if alternate_name:
                        result[alternate_name] = value
                except FormValidationError, e: # XXX JPS Patch for listbox
                    #LOG('validate_all', 0, 'FormValidationError: field = %s, errors=%s' % (repr(field), repr(errors)))
                    errors.extend(e.errors)
                    result.update(e.result)
                except ValidationError, err:
                    #LOG('validate_all', 0, 'ValidationError: field.id = %s, err=%s' % (repr(field.id), repr(err)))
                    errors.append(err)
                except KeyError, err:
                    LOG('ERP5Form/Form.py:validate_all', 0, 'KeyError : %s' % (err, ))
567
                
568 569 570 571
        if len(errors) > 0:
            raise FormValidationError(errors, result)
        return result

Jean-Paul Smets's avatar
Jean-Paul Smets committed
572 573 574 575 576 577 578 579 580 581 582 583
    # FTP/DAV Access
    manage_FTPget = ZMIForm.get_xml

    def PUT(self, REQUEST, RESPONSE):
        """Handle HTTP PUT requests."""
        self.dav__init(REQUEST, RESPONSE)
        self.dav__simpleifhandler(REQUEST, RESPONSE, refresh=1)
        body=REQUEST.get('BODY', '')
        # Empty the form (XMLToForm is unable to empty things before reopening)
        for k in self.get_field_ids():
          try:
            self._delObject(k)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
584
          except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
585 586 587 588 589 590 591 592 593 594 595
            pass
        self.groups = {}
        self.group_list = []
        # And reimport
        XMLToForm(body, self)
        self.ZCacheable_invalidate()
        RESPONSE.setStatus(204)
        return RESPONSE

    manage_FTPput = PUT

596
    #Methods for Proxify tab.
597 598 599 600 601 602
    security.declareProtected('View management screens', 'getFormFieldList')
    def getFormFieldList(self):
        """
        find fields and forms which name ends with 'FieldLibrary' in
        same skin folder.
        """
603 604 605
        form_list = []
        def iterate(obj):
            for i in obj.objectValues():
606 607
                if (i.meta_type=='ERP5 Form' and
                    i.getId().endswith('FieldLibrary')):
608 609 610 611 612 613 614
                    form_id = i.getId()
                    form_path = '%s.%s' % (obj.getId(), form_id)
                    field_list = []
                    form_list.append({'form_path':form_path,
                                      'form_id':form_id,
                                      'field_list':field_list})
                    for field in i.objectValues():
615 616 617
                        field_type, proxy_flag = get_field_meta_type_and_proxy_flag(field)
                        if proxy_flag:
                            field_type = '%s(Proxy)' % field_type
618 619 620 621 622 623 624 625 626 627 628
                        field_list.append({'field_object':field,
                                           'field_type':field_type,
                                           'proxy_flag':proxy_flag})
                if i.meta_type=='Folder':
                    iterate(i)
        iterate(getToolByName(self, 'portal_skins'))
        return form_list

    security.declareProtected('View management screens', 'getProxyableFieldList')
    def getProxyableFieldList(self, field, form_field_list=None):
        """"""
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
        def extract_keyword(name):
            return [i for i in name.split('_') if not i in ('my', 'default')]

        def check_keyword_list(name, keyword_list):
            count = 0
            for i in keyword_list:
                if i in name:
                    count += 1
            return count/float(len(keyword_list))

        def match(field_data):
            if not field_data['field_type'].startswith(field.meta_type):
                return 0
            field_object = field_data['field_object']
            if field_object.aq_base is field.aq_base:
                return 0
            field_id = field_object.getId()
            if id_.startswith('my_') and not field_id.startswith('my_'):
                return 0
            return check_keyword_list(field_id, extract_keyword(id_))

        def make_dict_list_append_function(dic, order_list):
            def append(key, item):
                if not key in order_list:
                    order_list.append(key)
                    dic[key] = []
                dic[key].append(item)
            return append

        def add_default_field_library():
            portal_url = getToolByName(self, 'portal_url')
            portal = portal_url.getPortalObject()
            portal_skins = getToolByName(self, 'portal_skins')

663
            default_field_library_path = portal.getProperty('erp5_default_field_library_path', None)
664 665 666 667 668 669 670 671 672 673
            if (not default_field_library_path or
                len(default_field_library_path.split('.'))!=2):
                return

            skinfolder_id, form_id = default_field_library_path.split('.')

            skinfolder = getattr(portal_skins, skinfolder_id, None)
            default_field_library = getattr(skinfolder, form_id, None)
            if default_field_library is None:
                return
674 675 676 677 678 679 680 681 682 683 684 685 686

            if not default_field_library_path in form_order:
                for i in default_field_library.objectValues():
                    field_meta_type, proxy_flag = get_field_meta_type_and_proxy_flag(i)
                    if meta_type==field_meta_type:
                        if proxy_flag:
                            field_meta_type = '%s(Proxy' % field_meta_type
                        matched_item = {'form_id':form_id,
                                        'field_type':field_meta_type,
                                        'field_object':i,
                                        'proxy_flag':proxy_flag,
                                        'matched_rate':0
                                        }
687 688 689 690
                        matched_append(default_field_library_path,
                                       matched_item)

        id_ = field.getId()
691
        meta_type = field.meta_type
692

693 694
        matched = {}
        form_order = []
695 696 697 698 699
        matched_append = make_dict_list_append_function(matched, form_order)

        perfect_matched = {}
        perfect_matched_form_order = []
        perfect_matched_append = make_dict_list_append_function(perfect_matched, perfect_matched_form_order)
700 701

        if form_field_list is None:
702
            form_field_list = self.getFormFieldList()
703 704 705

        for i in form_field_list:
            for data in i['field_list']:
706 707 708
                tmp = []
                matched_rate = match(data)
                if matched_rate>=0.5:
709 710 711 712 713
                    form_path = i['form_path']
                    form_id = i['form_id']
                    field_type = data['field_type']
                    field_object = data['field_object']
                    proxy_flag = data['proxy_flag']
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

                    matched_item = {'form_id':form_id,
                                    'field_type':field_type,
                                    'field_object':field_object,
                                    'proxy_flag':proxy_flag,
                                    'matched_rate':matched_rate
                                    }
                    if matched_rate==1:
                        perfect_matched_append(form_path, matched_item)
                    elif not perfect_matched:
                        matched_append(form_path, matched_item)

        if perfect_matched:
            perfect_matched_form_order.sort()
            return perfect_matched_form_order, perfect_matched

730
        form_order.sort()
731
        add_default_field_library()
732 733 734
        return form_order, matched

    security.declareProtected('Change Formulator Forms', 'proxifyField')
735
    def proxifyField(self, field_dict=None, REQUEST=None):
736 737 738 739 740
        """Convert fields to proxy fields"""
        from Products.ERP5Form.ProxyField import ProxyWidget
        from Products.Formulator.MethodField import Method
        from Products.Formulator.TALESField import TALESMethod

Jérome Perrin's avatar
Jérome Perrin committed
741
        def copy(_dict):
742
            new_dict = {}
Jérome Perrin's avatar
Jérome Perrin committed
743
            for key, value in _dict.items():
744 745 746 747 748 749
                if value=='':
                    continue
                if type(value) is Method:
                    value = Method(value.method_name)
                elif type(value) is TALESMethod:
                    value = TALESMethod(value._text)
Jérome Perrin's avatar
Jérome Perrin committed
750 751
                elif value is not None and not isinstance(value,
                        (str, unicode, int, long, bool, list, tuple, dict)):
Jérome Perrin's avatar
Jérome Perrin committed
752
                    raise ValueError, repr(value)
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
                new_dict[key] = value
            return new_dict

        def is_equal(a, b):
            type_a = type(a)
            type_b = type(b)
            if type_a is not type_b:
                return False
            elif type_a is Method:
                return a.method_name==b.method_name
            elif type_a is TALESMethod:
                return a._text==b._text
            else:
                return a==b

        def remove_same_value(new_dict, target_dict):
            for key, value in new_dict.items():
                target_value = target_dict.get(key)
                if is_equal(value, target_value):
                    del new_dict[key]
            return new_dict

        def get_group_and_position(field_id):
            for i in self.groups.keys():
                if field_id in self.groups[i]:
                    return i, self.groups[i].index(field_id)

        def set_group_and_position(group, position, field_id):
            self.field_removed(field_id)
            self.groups[group].insert(position, field_id)
            # Notify changes explicitly.
            self.groups = self.groups

        if field_dict is None:
            return

        for field_id in field_dict.keys():
            target = field_dict[field_id]
            target_form_id, target_field_id = target.split('.')

            # keep current group and position.
            group, position = get_group_and_position(field_id)

            # create proxy field
            old_field = getattr(self, field_id)
            self.manage_delObjects(field_id)
            self.manage_addField(id=field_id, title='', fieldname='ProxyField')
            proxy_field = getattr(self, field_id)
            proxy_field.values['form_id'] = target_form_id
            proxy_field.values['field_id'] = target_field_id

804
            target_field = proxy_field.getTemplateField()
805 806 807 808 809 810 811

            # copy data
            new_values = remove_same_value(copy(old_field.values),
                                           target_field.values)
            new_tales = remove_same_value(copy(old_field.tales),
                                          target_field.tales)

812 813
            if target_field.meta_type=='ProxyField':
                for i in new_values.keys():
814 815 816 817 818 819 820 821 822 823 824
                    if not i in target_field.delegated_list:
                        # obsolete variable check
                        try:
                            target_field.get_recursive_orig_value(i)
                        except KeyError:
                            # then `i` is obsolete!
                            del new_values[i]
                        else:
                            if is_equal(target_field.get_recursive_orig_value(i),
                                        new_values[i]):
                                del new_values[i]
Jérome Perrin's avatar
Jérome Perrin committed
825
                for i in new_tales.keys():
826 827 828 829 830 831 832 833 834 835 836
                    if not i in target_field.delegated_list:
                        # obsolete variable check
                        try:
                            target_field.get_recursive_tales(i)
                        except KeyError:
                            # then `i` is obsolete!
                            del new_tales[i]
                        else:
                            if is_equal(target_field.get_recursive_tales(i),
                                        new_tales[i]):
                                del new_tales[i]
837

838 839 840 841 842 843 844 845 846 847 848
            delegated_list = []
            for i in (new_values.keys()+new_tales.keys()):
                if not i in delegated_list:
                    delegated_list.append(i)
            proxy_field.values.update(new_values)
            proxy_field.tales.update(new_tales)
            proxy_field.delegated_list = delegated_list

            # move back to the original group and position.
            set_group_and_position(group, position, field_id)

849 850
        if REQUEST is not None:
            return self.formProxify(manage_tabs_message='Changed')
851

Jean-Paul Smets's avatar
Jean-Paul Smets committed
852 853 854
    psyco.bind(__call__)
    psyco.bind(_exec)

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
    # Overload of the Form method
    #   Use the include_disabled parameter since
    #   we should consider all fields to render the group tab
    #   moreoever, listbox rendering fails whenever enabled
    #   is based on the cell parameter.
    security.declareProtected('View', 'get_largest_group_length')
    def get_largest_group_length(self):
        """Get the largest group length available; necessary for
        'order' screen user interface.
        XXX - Copyright issue
        """
        max = 0
        for group in self.get_groups(include_empty=1):
            fields = self.get_fields_in_group(group, include_disabled=1)
            if len(fields) > max:
                max = len(fields)
        return max

    security.declareProtected('View', 'get_groups')
    def get_groups(self, include_empty=0):
        """Get a list of all groups, in display order.

        If include_empty is false, suppress groups that do not have
        enabled fields.
        XXX - Copyright issue
        """
        if include_empty:
            return self.group_list
        return [group for group in self.group_list
                if self.get_fields_in_group(group, include_disabled=1)]

886 887 888 889

# utility function
def get_field_meta_type_and_proxy_flag(field):
    if field.meta_type=='ProxyField':
890 891 892
        try:
            return field.getRecursiveTemplateField().meta_type, True
        except AttributeError:
893
            raise AttributeError, 'The proxy target of %s field does not exists. Please check the field setting.' % field.getId()
894 895 896 897
    else:
        return field.meta_type, False


Jean-Paul Smets's avatar
Jean-Paul Smets committed
898 899
# More optimizations
#psyco.bind(ERP5Field)
900
# XXX Not useful, as we patch those methods in FormulatorPatch
Jean-Paul Smets's avatar
Jean-Paul Smets committed
901 902 903 904 905 906 907 908 909 910 911 912
psyco.bind(Field.render)
psyco.bind(Field._render_helper)
psyco.bind(Field.get_value)

#from Products.PageTemplates.PageTemplate import PageTemplate
#from TAL import TALInterpreter
#psyco.bind(TALInterpreter.TALInterpreter)
#psyco.bind(TALInterpreter.TALInterpreter.interpret)
#psyco.bind(PageTemplate.pt_render)
#psyco.bind(PageTemplate.pt_macros)

#from Products.CMFCore.ActionsTool import ActionsTool
913
#psyco.bind(ActionsTool.listFilteredActionsFor)
914 915 916 917

# install interactor
from Products.ERP5Type.Interactor import fielf_value_interactor
fielf_value_interactor.install()