ProxyField.py 6.31 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 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 31 32 33 34 35 36 37 38 39 40 41 42 43 44
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets <jp@nexedi.com>
#
# 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 import Widget, Validator
from Products.Formulator.Field import ZMIField
from Products.Formulator.DummyField import fields
from Products.Formulator.Errors import ValidationError
from Products.ERP5Type.Utils import convertToUpperCase
from Products.CMFCore.utils import getToolByName

from Products.PageTemplates.PageTemplateFile import PageTemplateFile

from Globals import get_request
from Products.PythonScripts.Utility import allow_class

from Products.PythonScripts.standard import url_quote_plus

import string

45
from zLOG import LOG, WARNING
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47 48 49 50 51 52 53 54 55

class ProxyWidget(Widget.Widget):
  """
      A widget that renders itself as a field from another form
      after changing its title and id. It is recommended to define
      a master form on which complex fields with a lot of TALES
      are defined in order to minimize code duplication.
  """

  property_names = Widget.Widget.property_names + [
56 57 58
    'form_id',
    'field_id',
    'extra_context',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
  ]

  form_id = fields.StringField(
                                'form_id',
                                title='Form ID',
                                description=(
    "ID of the master form."),
                                default="",
                                required=1)

  field_id = fields.StringField(
                                'field_id',
                                title='Field ID',
                                description=(
    "ID of the field in the master form."),
                                default="",
                                required=1)

  default = fields.StringField(
                                'default',
                                title='Default',
                                description=(
    "Default value."),
                                default="",
                                required=0)

85 86 87 88 89 90 91
  extra_context = fields.ListTextAreaField(
                                'extra_context', 
                                title='Extra Context', 
                                description='Additional context variables.', 
                                default=(), 
                                required=0)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
92 93 94 95 96
  def render(self, field, key, value, REQUEST):
    """
      Render proxy field
    """
    form = field.aq_parent
97 98 99 100
    try:
      proxy_form = getattr(form, field.get_value('form_id'))
      proxy_field = getattr(proxy_form, field.get_value('field_id'))
    except AttributeError:
101 102 103
      LOG('ProxyField', WARNING, 
          'could not get a field from a proxy field %s in %s' % \
              (field.id, form.id))
104
      return ''
105
    extra_context = REQUEST.other.get('erp5_extra_context', {})
106 107
    for k, v in field.get_value('extra_context'):
      extra_context[k] = v
108
    REQUEST.other['erp5_extra_context'] = extra_context
109
    return proxy_field.widget.render(proxy_field, key, value, REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
110 111

  def render_view(self, field, value):
112
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
113 114
      Display proxy field
    """
115 116
    if type(value) == type('') and value == '':
      return ''
Jean-Paul Smets's avatar
Jean-Paul Smets committed
117
    form = field.aq_parent
118 119 120 121
    try:
      proxy_form = getattr(form, field.get_value('form_id'))
      proxy_field = getattr(proxy_form, field.get_value('field_id'))
    except AttributeError:
122 123 124
      LOG('ProxyField', WARNING, 
          'could not get a field from a proxy field %s in %s' % \
              (field.id, form.id))
125
      return ''
126
    REQUEST = get_request()
127
    extra_context = REQUEST.other.get('erp5_extra_context', {})
128 129
    for k, v in field.get_value('extra_context'):
      extra_context[k] = v
130
    REQUEST.other['erp5_extra_context'] = extra_context
Aurel's avatar
Aurel committed
131
    return proxy_field.widget.render_view(proxy_field, value)
132

Jean-Paul Smets's avatar
Jean-Paul Smets committed
133 134 135 136 137 138 139 140 141 142 143

class ProxyValidator(Validator.Validator):
  """
    Validation of entered value through proxy field
  """
  property_names = Validator.Validator.property_names

  def validate(self, field, key, REQUEST):
    form = field.aq_parent
    proxy_form = getattr(form, field.get_value('form_id'))
    proxy_field = getattr(proxy_form, field.get_value('field_id'))
144 145 146 147
    extra_context = REQUEST.other.get('erp5_extra_context', {})
    for k, v in field.get_value('extra_context'):
      extra_context[k] = v
    REQUEST.other['erp5_extra_context'] = extra_context
Jean-Paul Smets's avatar
Jean-Paul Smets committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    try:
      result = proxy_field.validator.validate(proxy_field, key, REQUEST)
    except ValidationError, error:
      error.field_id = field.id
      raise error
    return result

ProxyWidgetInstance = ProxyWidget()
ProxyValidatorInstance = ProxyValidator()

class ProxyField(ZMIField):
  meta_type = "ProxyField"

  widget = ProxyWidgetInstance
  validator = ProxyValidatorInstance
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

  def _get_default(self, key, value, REQUEST):
    """
    Return default value of the field.
    """
    value = ZMIField._get_default(self, key, value, REQUEST)
    if value in (None, ''):
      form = self.aq_parent
      try:
        proxy_form = getattr(form, self.get_value('form_id'))
        proxy_self = getattr(proxy_form, self.get_value('field_id'))
      except AttributeError:
        pass
      else:
        value = proxy_self.get_value('default', REQUEST=REQUEST)
    return value