Form.py 20.2 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 36 37
from Products.CMFCore.utils import _checkPermission
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

# Patch the fiels methods to provide improved namespace handling

from Products.Formulator.Field import Field

53
from zLOG import LOG, PROBLEM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54

55 56 57 58 59
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 = {}
60

61 62
    tales_expr = self.tales.get(id, "")
    if tales_expr:
63
        REQUEST = get_request()
64
        form = self.aq_parent # XXX (JPS) form for default is wrong apparently in listbox - double check
65 66 67
        obj = getattr(form, 'aq_parent', None)
        if obj is not None:
            container = obj.aq_inner.aq_parent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
68
        else:
69
            container = None
70 71 72 73 74 75 76 77 78 79

        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' % (self.id, id), self)
          kw['field'] = field
        else:
          kw['field'] = self

80
        kw['form'] = form
81
        kw['request'] = REQUEST
82
        kw['here'] = obj
83
        kw['context'] = obj
84
        kw['modules'] = SecureModuleImporter
85
        kw['container'] = container
86
        try :
87
            kw['preferences'] = obj.getPortalObject().portal_preferences
88
        except AttributeError :
89
            LOG('ERP5Form', PROBLEM,
90
              'portal_preferences not put in TALES context (not installed?)')
91 92 93
        # 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
94
        if kw.has_key('REQUEST') and kw.get('cell',None) is None:
95 96 97 98
          if getattr(kw['REQUEST'],'cell',None) is not None:
            kw['cell'] = getattr(kw['REQUEST'],'cell')
          else:
            kw['cell'] = kw['REQUEST']
99
        elif kw.get('cell',None) is None:
100 101
          if getattr(REQUEST,'cell',None) is not None:
            kw['cell'] = getattr(REQUEST,'cell')
102
        try:
103
            value = tales_expr.__of__(self)(**kw)
104 105
        except (ConflictError, RuntimeError):
            raise
106 107 108
        except:
            # We add this safety exception to make sure we always get
            # something reasonable rather than generate plenty of errors
109 110 111
            LOG('ERP5Form', PROBLEM,
                'Field.get_value ( %s/%s [%s]), exception on tales_expr: ' %
                ( form.getId(), self.getId(), id), error=sys.exc_info())
112 113 114 115 116
            value = self.get_orig_value(id)
    else:
        # FIXME: backwards compat hack to make sure overrides dict exists
        if not hasattr(self, 'overrides'):
            self.overrides = {}
117

118 119 120 121
        override = self.overrides.get(id, "")
        if override:
            # call wrapped method to get answer
            value = override.__of__(self)()
122
        else:
123
            # Get a normal value.
124
            value = self.get_orig_value(id)
125

126 127
            # For the 'default' value, we try to get a property value
            # stored in the context, only if the field is prefixed with my_.
128 129
            REQUEST = get_request()
            if REQUEST is not None:
130 131
              field_id = REQUEST.get('field__proxyfield_%s_%s' % (self.id, id),
                                      self).id
132 133 134 135
            else:
              field_id = self.id

            if id == 'default' and field_id.startswith('my_'):
136 137 138
              try:
                form = self.aq_parent
                ob = getattr(form, 'aq_parent', None)
139
                key = field_id[3:]
140 141 142 143 144 145 146
                if value not in (None, ''):
                  # If a default value is defined on the field, it has precedence
                  value = ob.getProperty(key, d=value)
                else:
                  # else we should give a chance to the accessor to provide
                  # a default value (including None)
                  value = ob.getProperty(key)
147 148
              except (KeyError, AttributeError):
                value = None
149 150 151 152 153 154 155 156 157 158 159 160
            # 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
161 162 163

    # if normal value is a callable itself, wrap it
    if callable(value):
164
        value = value.__of__(self)
165 166 167
        #value=value() # Mising call ??? XXX Make sure compatible with listbox methods

    if id == 'default':
168 169 170 171 172
        # 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 = ''
173

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    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:
189
        value = self._get_user_input_value(key, REQUEST)
190 191
    except (KeyError, AttributeError):
        # fall back on default
192
        return self.get_value('default', REQUEST=REQUEST) # It was missing on Formulator
193

194 195 196 197 198 199 200 201 202
    # 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
203 204


Jean-Paul Smets's avatar
Jean-Paul Smets committed
205
# Dynamic Patch
206 207 208
Field.get_value = get_value
Field._get_default = _get_default
Field.om_icons = om_icons
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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

# 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
235
    except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
236 237 238 239 240
        u = REQUEST['URL1']
    if REQUEST['submit'] == " Add and Edit ":
        u = "%s/%s" % (u, quote(id))
    REQUEST.RESPONSE.redirect(u+'/manage_main')

241
def initializeForm(field_registry, form_class=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
242 243
    """Sets up ZMIForm with fields from field_registry.
    """
244
    if form_class is None: form_class = ERP5Form
245

Jean-Paul Smets's avatar
Jean-Paul Smets committed
246 247 248 249 250 251 252 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
    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',
280 281 282
                                     title='Number of groups in row (in order tab)',
                                     required=1,
                                     default=4)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
283 284 285 286 287 288 289 290 291 292 293 294
    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="")
295 296 297 298
    update_action = fields.StringField('update_action',
                                title='Form update action',
                                required=0,
                                default="")
Jean-Paul Smets's avatar
Jean-Paul Smets committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
    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)
316 317 318 319 320 321
    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',
322
                                      default='UTF-8',
323
                                      required=1)
324 325 326 327 328
    unicode_mode = fields.CheckBoxField('unicode_mode',
                                        title='Form properties are unicode',
                                        default=0,
                                        required=1)

329
    form.add_fields([title, row_length, name, pt, action, update_action, method,
330
                     enctype, encoding, stored_encoding, unicode_mode])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
    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)

351 352 353 354
    # 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
355 356
    # Default Attributes
    pt = 'form_view'
357
    update_action = ''
Jean-Paul Smets's avatar
Jean-Paul Smets committed
358 359 360 361

    # Special Settings
    settings_form = create_settings_form()

362
    def __init__(self, id, title, unicode_mode=0, encoding='UTF-8',
Romain Courteaud's avatar
Romain Courteaud committed
363
                 stored_encoding='UTF-8'):
364 365 366 367 368 369 370 371 372 373
        """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
374
        self.group_list = ["left", "right", "center", "bottom", "hidden"]
375 376 377 378
        groups = {}
        for group in self.group_list:
          groups[group] = []
        self.groups = groups
379

Jean-Paul Smets's avatar
Jean-Paul Smets committed
380 381
    # Proxy method to PageTemplate
    def __call__(self, *args, **kwargs):
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
        # 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
403 404 405
        if not kwargs.has_key('args'):
            kwargs['args'] = args
        form = self
406 407 408 409 410
        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
411 412 413
        else:
          container = None
        pt = getattr(self,self.pt)
414 415 416 417 418
        extra_context = dict( container=container,
                              template=self,
                              form=self,
                              options=kwargs,
                              here=obj )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
        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

442 443 444 445 446 447 448 449 450
    # 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 = []
451 452
        for group in self.get_groups():
            if group.lower() == 'hidden':
453
                continue
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
            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, ))
477
                
478 479 480 481
        if len(errors) > 0:
            raise FormValidationError(errors, result)
        return result

Jean-Paul Smets's avatar
Jean-Paul Smets committed
482 483 484 485 486 487 488 489 490 491 492 493
    # 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
494
          except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
            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)
511
# XXX Not useful, as we patch those methods in FormulatorPatch
Jean-Paul Smets's avatar
Jean-Paul Smets committed
512 513 514 515 516 517 518 519 520 521 522 523
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
524
#psyco.bind(ActionsTool.listFilteredActionsFor)