Form.py 18.1 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 35 36 37
from Products.Formulator.DummyField import fields
from Products.Formulator.XMLToForm import XMLToForm
from Products.PageTemplates.ZopePageTemplate import ZopePageTemplate
from Products.ERP5Type import PropertySheet

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

import psyco
45
import sys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47 48 49 50 51 52

# Patch the fiels methods to provide improved namespace handling

from Products.Formulator.Field import Field

from zLOG import LOG

53 54 55 56 57
def get_value(self, id, **kw):
    """Get value for id."""
    # FIXME: backwards compat hack to make sure tales dict exists
    if not hasattr(self, 'tales'):
        self.tales = {}
58

59 60
    tales_expr = self.tales.get(id, "")
    if tales_expr:
61
        REQUEST = get_request()
62
        form = self.aq_parent # XXX (JPS) form for default is wrong apparently in listbox - double check
63 64 65 66 67 68
        object = getattr(form, 'aq_parent', None)
        if object:
            # NEEDS TO BE CHECKED
            # container = object.aq_inner.aq_parent ORIGINAL VERSION - not so good ?
            container = object.aq_parent
            #container = object.getParentNode()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69
        else:
70 71 72
            container = None
        kw['field'] = self
        kw['form'] = form
73
        kw['request'] = REQUEST
74
        kw['here'] = object
75
        kw['modules'] = SecureModuleImporter
76
        kw['container'] = container
77
        try :
78
            kw['preferences'] = object.getPortalObject().portal_preferences
79
        except AttributeError :
80
            LOG('ERP5Form', 0,
81
              'portal_preferences not put in TALES context (not installed?)')
82
        extra_context = REQUEST.other.get('erp5_extra_context', None)
83 84
        if extra_context:
          kw.update(extra_context)
85 86 87
        # 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
88
        if kw.has_key('REQUEST') and kw.get('cell',None) is None:
89 90 91 92
          if getattr(kw['REQUEST'],'cell',None) is not None:
            kw['cell'] = getattr(kw['REQUEST'],'cell')
          else:
            kw['cell'] = kw['REQUEST']
93
        elif kw.get('cell',None) is None:
94 95
          if getattr(REQUEST,'cell',None) is not None:
            kw['cell'] = getattr(REQUEST,'cell')
96
        try:
97
            value = tales_expr.__of__(self)(**kw)
98 99
        except (ConflictError, RuntimeError):
            raise
100 101 102 103 104 105 106 107 108 109
        except:
            # We add this safety exception to make sure we always get
            # something reasonable rather than generate plenty of errors
            LOG('ERP5Form.get_value ( %s/%s [%s]), exception on tales_expr: '%(
                self.aq_parent.getId(), self.getId(), id) ,0,'', error=sys.exc_info())
            value = self.get_orig_value(id)
    else:
        # FIXME: backwards compat hack to make sure overrides dict exists
        if not hasattr(self, 'overrides'):
            self.overrides = {}
110

111 112 113 114
        override = self.overrides.get(id, "")
        if override:
            # call wrapped method to get answer
            value = override.__of__(self)()
115
        else:
116
            # Get a normal value.
117
            value = self.get_orig_value(id)
118

119 120 121 122 123 124 125 126 127 128
            # For the 'default' value, we try to get a property value
            # stored in the context, only if the field is prefixed with my_.
            if id == 'default' and self.id[:3] == 'my_':
              try:
                form = self.aq_parent
                ob = getattr(form, 'aq_parent', None)
                key = self.id[3:]
                value = ob.getProperty(key, d=value)
              except (KeyError, AttributeError):
                value = None
129 130 131 132 133 134 135 136 137 138 139 140
            # For the 'editable' value, we try to get a default value
            elif id == 'editable':
                # 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):
                    value = 0
141 142 143

    # if normal value is a callable itself, wrap it
    if callable(value):
144
        value = value.__of__(self)
145 146 147 148 149 150 151 152 153
        #value=value() # Mising call ??? XXX Make sure compatible with listbox methods

    if id == 'default':
        if self.meta_type != 'DateTimeField':
          # We make sure we convert values to empty strings
          # for most fields (so that we do not get a 'value'
          # message on screeen)
          # This can be overriden by useing TALES in the field
          if value is None: value = ''
154

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
    return value

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:
        value = REQUEST.form[key]
    except (KeyError, AttributeError):
        # fall back on default
        return self.get_value('default',REQUEST=REQUEST) # It was missing on Formulator
174

175 176 177 178 179 180 181 182 183
    # 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
184 185


Jean-Paul Smets's avatar
Jean-Paul Smets committed
186
# Dynamic Patch
187 188 189
Field.get_value = get_value
Field._get_default = _get_default
Field.om_icons = om_icons
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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

# 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
216
    except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
217 218 219 220 221
        u = REQUEST['URL1']
    if REQUEST['submit'] == " Add and Edit ":
        u = "%s/%s" % (u, quote(id))
    REQUEST.RESPONSE.redirect(u+'/manage_main')

222
def initializeForm(field_registry, form_class=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
223 224
    """Sets up ZMIForm with fields from field_registry.
    """
225
    if form_class is None: form_class = ERP5Form
226

Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 253 254 255 256 257 258 259 260
    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="")
    row_length = fields.IntegerField('row_length',
261 262 263
                                     title='Number of groups in row (in order tab)',
                                     required=1,
                                     default=4)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
264 265 266 267 268 269 270 271 272 273 274 275
    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="")
276 277 278 279
    update_action = fields.StringField('update_action',
                                title='Form update action',
                                required=0,
                                default="")
Jean-Paul Smets's avatar
Jean-Paul Smets committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
    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)
297 298 299 300 301 302
    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',
303
                                      default='UTF-8',
304
                                      required=1)
305 306 307 308 309
    unicode_mode = fields.CheckBoxField('unicode_mode',
                                        title='Form properties are unicode',
                                        default=0,
                                        required=1)

310
    form.add_fields([title, row_length, name, pt, action, update_action, method,
311
                     enctype, encoding, stored_encoding, unicode_mode])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    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()

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.SimpleItem)

    # Constructors
    constructors =   (manage_addForm, addERP5Form)

332 333 334 335
    # This is a patched dtml formOrder
    security.declareProtected('View management screens', 'formOrder')
    formOrder = DTMLFile('dtml/formOrder', globals())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
336 337
    # Default Attributes
    pt = 'form_view'
338
    update_action = ''
Jean-Paul Smets's avatar
Jean-Paul Smets committed
339 340 341 342

    # Special Settings
    settings_form = create_settings_form()

343
    def __init__(self, id, title, unicode_mode=0, encoding='UTF-8',
Romain Courteaud's avatar
Romain Courteaud committed
344
                 stored_encoding='UTF-8'):
345 346 347 348 349 350 351 352 353 354 355
        """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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
    # Proxy method to PageTemplate
    def __call__(self, *args, **kwargs):
        if not kwargs.has_key('args'):
            kwargs['args'] = args
        form = self
        object = getattr(form, 'aq_parent', None)
        if object:
          container = object.aq_inner.aq_parent
        else:
          container = None
        pt = getattr(self,self.pt)
        extra_context = self.pt_getContext()
        extra_context['options'] = kwargs
        extra_context['form'] = self
        extra_context['container'] = container ## PROBLEM NOT TAKEN INTO ACCOUNT
        extra_context['here'] = object
372
        # We initialize here an index which is used to generate
373 374
        # different method ids for every field
        request = extra_context['request']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
        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

398 399 400 401 402 403 404
    # 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.
        """
405
#        import pdb; pdb.set_trace()
406 407 408 409 410 411
        result = {}
        errors = []
        for field in self.get_fields():
            # skip any field we don't need to validate
            if not field.need_validate(REQUEST):
                continue
412
            if not (field.get_value('editable',REQUEST=REQUEST)):
413
                continue
414 415 416 417 418 419 420 421 422
            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
423
                #LOG('validate_all', 0, 'FormValidationError: field = %s, errors=%s' % (repr(field), repr(errors)))
424 425 426
                errors.extend(e.errors)
                result.update(e.result)
            except ValidationError, err:
427
                #LOG('validate_all', 0, 'ValidationError: field.id = %s, err=%s' % (repr(field.id), repr(err)))
428
                errors.append(err)
429 430
            except KeyError, err:
                LOG('ERP5Form/Form.py:validate_all', 0, 'KeyError : %s' % (err, ))
431 432 433 434
        if len(errors) > 0:
            raise FormValidationError(errors, result)
        return result

Jean-Paul Smets's avatar
Jean-Paul Smets committed
435 436 437 438 439 440 441 442 443 444 445 446
    # 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
447
          except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
            pass
        self.groups = {}
        self.group_list = []
        # And reimport
        XMLToForm(body, self)
        self.ZCacheable_invalidate()
        RESPONSE.setStatus(204)
        return RESPONSE

    manage_FTPput = PUT

    psyco.bind(__call__)
    psyco.bind(_exec)

# More optimizations
#psyco.bind(ERP5Field)
464
# XXX Not useful, as we patch those methods in FormulatorPatch
Jean-Paul Smets's avatar
Jean-Paul Smets committed
465 466 467 468 469 470 471 472 473 474 475 476
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
477
#psyco.bind(ActionsTool.listFilteredActionsFor)