Back to index

plone3  3.1.7
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Static Private Attributes
Archetypes.Field.FileField Class Reference
Inheritance diagram for Archetypes.Field.FileField:
Inheritance graph
[legend]
Collaboration diagram for Archetypes.Field.FileField:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def setContentType
def getContentType
def get
def set
def getBaseUnit
def getFilename
def setFilename
def validate_required
def download
def get_size
def getIndexAccessor
def getIndexable
def getRaw
def unset
def setStorage
def getStorage
def getStorageName
def getStorageType
def copy
def __repr__
def validate
def validate_validators
def validate_vocabulary
def Vocabulary
def checkPermission
def writeable
def checkExternalEditor
def getWidgetName
def getName
def getType
def getDefault
def getAccessor
def getEditAccessor
def getMutator
def getIndexAccessorName
def toString
def isLanguageIndependent
def getI18nDomain

Public Attributes

 storage
 widget
 validators
 index_method

Static Public Attributes

tuple security = ClassSecurityInfo()

Private Member Functions

def _process_input
def _migrate_old
def _make_file
def _wrapValue

Static Private Attributes

 __implements__ = IFileField,ILayerContainer
tuple _properties = ObjectField._properties.copy()

Detailed Description

Something that may be a file, but is not an image and doesn't
want text format conversion

Definition at line 852 of file Field.py.


Member Function Documentation

def Archetypes.Field.Field.__repr__ (   self) [inherited]
Return a string representation consisting of name, type and permissions.

Definition at line 236 of file Field.py.

00236 
00237     def __repr__(self):
00238         """
00239         Return a string representation consisting of name, type and permissions.
00240         """
00241         return "<Field %s(%s:%s)>" % (self.getName(), self.type, self.mode)

Here is the call graph for this function:

def Archetypes.Field.FileField._make_file (   self,
  id,
  title = '',
  file = '',
  instance = None 
) [private]
File content factory

Reimplemented in Archetypes.Field.TextField.

Definition at line 988 of file Field.py.

00988 
00989     def _make_file(self, id, title='', file='', instance=None):
00990         """File content factory"""
00991         return self.content_class(id, title, file)

def Archetypes.Field.FileField._migrate_old (   self,
  value,
  default = None,
  mimetype = None,
  kwargs 
) [private]

Definition at line 962 of file Field.py.

00962 
00963     def _migrate_old(self, value, default=None, mimetype=None, **kwargs):
00964         filename = kwargs.get('filename', '')
00965         if isinstance(value, basestring):
00966             filename = kwargs.get('filename', '')
00967             if mimetype is None:
00968                 mimetype, enc = guess_content_type(filename, value, mimetype)
00969             if not value:
00970                 return default, mimetype, filename
00971             return value, mimetype, filename
00972         elif IBaseUnit.isImplementedBy(value):
00973             return value.getRaw(), value.getContentType(), value.getFilename()
00974 
00975         value = aq_base(value)
00976 
00977         if isinstance(value, File):
00978             # OFS.Image.File based
00979             filename = getattr(value, 'filename', value.getId())
00980             mimetype = value.content_type
00981             data = value.data
00982             if len(data) == 0:
00983                 return default, mimetype, filename
00984             else:
00985                 return data, mimetype, filename
00986 
00987         return '', mimetype, filename

def Archetypes.Field.FileField._process_input (   self,
  value,
  file = None,
  default = None,
  mimetype = None,
  instance = None,
  filename = '',
  kwargs 
) [private]

Definition at line 889 of file Field.py.

00889 
00890                        instance=None, filename='', **kwargs):
00891         if file is None:
00892             file = self._make_file(self.getName(), title='',
00893                                    file='', instance=instance)
00894         if IBaseUnit.isImplementedBy(value):
00895             mimetype = value.getContentType() or mimetype
00896             filename = value.getFilename() or filename
00897             value = value.getRaw()
00898         elif isinstance(value, self.content_class):
00899             filename = getattr(value, 'filename', value.getId())
00900             mimetype = getattr(value, 'content_type', mimetype)
00901             return value, mimetype, filename
00902         elif isinstance(value, File):
00903             # In case someone changes the 'content_class'
00904             filename = getattr(value, 'filename', value.getId())
00905             mimetype = getattr(value, 'content_type', mimetype)
00906             value = value.data
00907         elif isinstance(value, FileUpload) or shasattr(value, 'filename'):
00908             filename = value.filename
00909         elif isinstance(value, FileType) or shasattr(value, 'name'):
00910             # In this case, give preference to a filename that has
00911             # been detected before. Usually happens when coming from PUT().
00912             if not filename:
00913                 filename = value.name
00914                 # Should we really special case here?
00915                 for v in (filename, repr(value)):
00916                     # Windows unnamed temporary file has '<fdopen>' in
00917                     # repr() and full path in 'file.name'
00918                     if '<fdopen>' in v:
00919                         filename = ''
00920         elif isinstance(value, basestring):
00921             # Let it go, mimetypes_registry will be used below if available
00922             pass
00923         elif (isinstance(value, Pdata) or (shasattr(value, 'read') and
00924                                            shasattr(value, 'seek'))):
00925             # Can't get filename from those.
00926             pass
00927         elif value is None:
00928             # Special case for setDefault
00929             value = ''
00930         else:
00931             klass = getattr(value, '__class__', None)
00932             raise FileFieldException('Value is not File or String (%s - %s)' %
00933                                      (type(value), klass))
00934         filename = filename[max(filename.rfind('/'),
00935                                 filename.rfind('\\'),
00936                                 filename.rfind(':'),
00937                                 )+1:]
00938         file.manage_upload(value)
00939         if mimetype is None or mimetype == 'text/x-unknown-content-type':
00940             body = file.data
00941             if not isinstance(body, basestring):
00942                 body = body.data
00943             mtr = getToolByName(instance, 'mimetypes_registry', None)
00944             if mtr is not None:
00945                 kw = {'mimetype':None,
00946                       'filename':filename}
00947                 # this may split the encoded file inside a multibyte character
00948                 try:
00949                     d, f, mimetype = mtr(body[:8096], **kw)
00950                 except UnicodeDecodeError:
00951                     d, f, mimetype = mtr(len(body) < 8096 and body or '', **kw)
00952             else:
00953                 mimetype = getattr(file, 'content_type', None)
00954                 if mimetype is None:
00955                     mimetype, enc = guess_content_type(filename, body, mimetype)
00956         # mimetype, if coming from request can be like:
00957         # text/plain; charset='utf-8'
00958         mimetype = str(mimetype).split(';')[0].strip()
00959         setattr(file, 'content_type', mimetype)
00960         setattr(file, 'filename', filename)
00961         return file, mimetype, filename

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField._wrapValue (   self,
  instance,
  value,
  kwargs 
) [private]
Wraps the value in the content class if it's not wrapped

Definition at line 1062 of file Field.py.

01062 
01063     def _wrapValue(self, instance, value, **kwargs):
01064         """Wraps the value in the content class if it's not wrapped
01065         """
01066         if isinstance(value, self.content_class):
01067             return value
01068         mimetype = kwargs.get('mimetype', self.default_content_type)
01069         filename = kwargs.get('filename', '')
01070         obj = self._make_file(self.getName(), title='',
01071                               file=value, instance=instance)
01072         setattr(obj, 'filename', filename)
01073         setattr(obj, 'content_type', mimetype)
01074         try:
01075             delattr(obj, 'title')
01076         except (KeyError, AttributeError):
01077             pass
01078 
01079         return obj

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.checkExternalEditor (   self,
  instance 
) [inherited]
Checks if the user may edit this field and if
external editor is enabled on this instance 

Definition at line 550 of file Field.py.

00550 
00551     def checkExternalEditor(self, instance):
00552         """ Checks if the user may edit this field and if
00553         external editor is enabled on this instance """
00554 
00555         pp = getToolByName(instance, 'portal_properties')
00556         sp = getattr(pp, 'site_properties', None)
00557         if sp is not None:
00558             if getattr(sp, 'ext_editor', None) \
00559                    and self.checkPermission(mode='edit', instance=instance):
00560                 return True
00561         return None

Here is the call graph for this function:

def Archetypes.Field.Field.checkPermission (   self,
  mode,
  instance 
) [inherited]
Check whether the security context allows the given permission on
the given object.

Arguments:

mode -- 'w' for write or 'r' for read
instance -- The object being accessed according to the permission

Definition at line 507 of file Field.py.

00507 
00508     def checkPermission(self, mode, instance):
00509         """
00510         Check whether the security context allows the given permission on
00511         the given object.
00512 
00513         Arguments:
00514 
00515         mode -- 'w' for write or 'r' for read
00516         instance -- The object being accessed according to the permission
00517         """
00518         if mode in ('w', 'write', 'edit', 'set'):
00519             perm = self.write_permission
00520         elif mode in ('r', 'read', 'view', 'get'):
00521             perm = self.read_permission
00522         else:
00523             return None
00524         return getSecurityManager().checkPermission( perm, instance )
00525 

Here is the caller graph for this function:

def Archetypes.Field.Field.copy (   self,
  name = None 
) [inherited]
Return a copy of field instance, consisting of field name and
properties dictionary. field name can be changed to given name.

Definition at line 220 of file Field.py.

00220 
00221     def copy(self, name=None):
00222         """
00223         Return a copy of field instance, consisting of field name and
00224         properties dictionary. field name can be changed to given name.
00225         """
00226         cdict = dict(vars(self))
00227         cdict.pop('__name__')
00228         # Widget must be copied separatedly
00229         widget = cdict['widget']
00230         del cdict['widget']
00231         properties = deepcopy(cdict)
00232         properties['widget'] = widget.copy()
00233         name = name is not None and name or self.getName()
00234         return self.__class__(name, **properties)
00235 
    

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField.download (   self,
  instance,
  REQUEST = None,
  RESPONSE = None,
  no_output = False 
)
Kicks download.

Writes data including file name and content type to RESPONSE

Definition at line 1138 of file Field.py.

01138 
01139     def download(self, instance, REQUEST=None, RESPONSE=None, no_output=False):
01140         """Kicks download.
01141 
01142         Writes data including file name and content type to RESPONSE
01143         """
01144         file = self.get(instance, raw=True)
01145         if not REQUEST:
01146             REQUEST = aq_get(instance, 'REQUEST')
01147         if not RESPONSE:
01148             RESPONSE = REQUEST.RESPONSE
01149         filename = self.getFilename(instance)
01150         if filename is not None:
01151             if FILE_NORMALIZER:
01152                 filename = IUserPreferredFileNameNormalizer(REQUEST).normalize(
01153                     unicode(filename, instance.getCharset()))
01154             else:
01155                 filename = unicode(filename, instance.getCharset())
01156             header_value = contentDispositionHeader(
01157                 disposition='attachment',
01158                 filename=filename)
01159             RESPONSE.setHeader("Content-Disposition", header_value)
01160         if no_output:
01161             return file
01162         return file.index_html(REQUEST, RESPONSE)

Here is the call graph for this function:

def Archetypes.Field.FileField.get (   self,
  instance,
  kwargs 
)

Reimplemented from Archetypes.Field.ObjectField.

Definition at line 993 of file Field.py.

00993 
00994     def get(self, instance, **kwargs):
00995         value = ObjectField.get(self, instance, **kwargs)
00996         if value and not isinstance(value, self.content_class):
00997             value = self._wrapValue(instance, value)
00998         if (shasattr(value, '__of__', acquire=True)
00999             and not kwargs.get('unwrapped', False)):
01000             return value.__of__(instance)
01001         else:
01002             return value

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField.get_size (   self,
  instance 
)
Get size of the stored data used for get_size in BaseObject

Reimplemented from Archetypes.Field.ObjectField.

Reimplemented in Archetypes.Field.ImageField, and Archetypes.Field.TextField.

Definition at line 1164 of file Field.py.

01164 
01165     def get_size(self, instance):
01166         """Get size of the stored data used for get_size in BaseObject
01167         """
01168         file = self.get(instance)
01169         if isinstance(file, self.content_class):
01170             return file.get_size()
01171         # Backwards compatibility
01172         return len(str(file))

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.getAccessor (   self,
  instance 
) [inherited]
Return the accessor method for getting data out of this
field

Definition at line 602 of file Field.py.

00602 
00603     def getAccessor(self, instance):
00604         """Return the accessor method for getting data out of this
00605         field"""
00606         if self.accessor:
00607             return getattr(instance, self.accessor, None)
00608         return None

Here is the caller graph for this function:

def Archetypes.Field.FileField.getBaseUnit (   self,
  instance,
  full = False 
)
Return the value of the field wrapped in a base unit object

Reimplemented in Archetypes.Field.TextField.

Definition at line 1081 of file Field.py.

01081 
01082     def getBaseUnit(self, instance, full=False):
01083         """Return the value of the field wrapped in a base unit object
01084         """
01085         filename = self.getFilename(instance, fromBaseUnit=False)
01086         if not filename:
01087             filename = '' # self.getName()
01088         mimetype = self.getContentType(instance, fromBaseUnit=False)
01089         value = self.getRaw(instance) or self.getDefault(instance)
01090         if isinstance(aq_base(value), File):
01091             value = value.data
01092             if full:
01093                 # This will read the whole file in memory, which is
01094                 # very expensive specially with big files over
01095                 # ZEO. With small files is not that much of an issue.
01096                 value = str(value)
01097             elif not isinstance(value, basestring):
01098                 # It's a Pdata object, get only the first chunk, which
01099                 # should be good enough for detecting the mimetype
01100                 value = value.data
01101         bu = BaseUnit(filename, aq_base(value), instance,
01102                       filename=filename, mimetype=mimetype)
01103         return bu

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField.getContentType (   self,
  instance,
  fromBaseUnit = True 
)
Return the mime type of object if known or can be guessed;
otherwise, return default_content_type value or fallback to
'application/octet-stream'.

Reimplemented from Archetypes.Field.ObjectField.

Definition at line 884 of file Field.py.

00884 
00885     def getContentType(self, instance, fromBaseUnit=True):
00886         file = self.get(instance)
00887         return getattr(file, 'content_type', self.default_content_type)

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.getDefault (   self,
  instance 
) [inherited]
Return the default value to be used for initializing this
field

Definition at line 579 of file Field.py.

00579 
00580     def getDefault(self, instance):
00581         """Return the default value to be used for initializing this
00582         field"""
00583         dm = self.default_method
00584         if dm:
00585             if isinstance(dm, basestring) and shasattr(instance, dm):
00586                 method = getattr(instance, dm)
00587                 return method()
00588             elif callable(dm):
00589                 return dm()
00590             else:
00591                 raise ValueError('%s.default_method is neither a method of %s'
00592                                  ' nor a callable' % (self.getName(),
00593                                                       instance.__class__))
00594         
00595         if not self.default:
00596             default_adapter = component.queryAdapter(instance, IFieldDefaultProvider, name=self.__name__)
00597             if default_adapter is not None:
00598                 return default_adapter()
00599                 
00600         return self.default

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.getEditAccessor (   self,
  instance 
) [inherited]
Return the accessor method for getting raw data out of this
field e.g.: for editing

Definition at line 610 of file Field.py.

00610 
00611     def getEditAccessor(self, instance):
00612         """Return the accessor method for getting raw data out of this
00613         field e.g.: for editing
00614         """
00615         if self.edit_accessor:
00616             return getattr(instance, self.edit_accessor, None)
00617         return None

def Archetypes.Field.FileField.getFilename (   self,
  instance,
  fromBaseUnit = True 
)
Get file name of underlaying file object

Definition at line 1105 of file Field.py.

01105 
01106     def getFilename(self, instance, fromBaseUnit=True):
01107         """Get file name of underlaying file object
01108         """
01109         filename = None
01110         if fromBaseUnit:
01111             bu = self.getBaseUnit(instance)
01112             return bu.getFilename()
01113         raw = self.getRaw(instance)
01114         filename = getattr(aq_base(raw), 'filename', None)
01115         # for OFS.Image.*
01116         if filename is None:
01117             filename = getattr(raw, 'filename', None)
01118         # might still be None
01119         if filename:
01120             # taking care of stupid IE and be backward compatible
01121             # BaseUnit hasn't have a fix for long so we might have an old name
01122             filename = filename.split("\\")[-1]
01123         return filename

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.getI18nDomain (   self) [inherited]
returns the internationalization domain for translation 

Definition at line 678 of file Field.py.

00678 
00679     def getI18nDomain(self):
00680         """ returns the internationalization domain for translation """
00681         pass
00682 
00683 #InitializeClass(Field)
00684 setSecurity(Field)

def Archetypes.Field.FileField.getIndexable (   self,
  instance 
)

Definition at line 1182 of file Field.py.

01182 
01183     def getIndexable(self, instance):
01184         # XXX Naive implementation that loads all data contents into
01185         # memory.  To have this not happening set your field to not
01186         # 'searchable' (the default) or define your own 'index_method'
01187         # property.
01188         orig_mt = self.getContentType(instance)
01189 
01190         # If there's no path to text/plain, don't do anything
01191         transforms = getToolByName(instance, 'portal_transforms')
01192         if transforms._findPath(orig_mt, 'text/plain') is None:
01193             return ''
01194 
01195         f = self.get(instance)
01196 
01197         datastream = ''
01198         try:
01199             datastream = transforms.convertTo(
01200                 "text/plain",
01201                 str(f),
01202                 mimetype = orig_mt,
01203                 filename = self.getFilename(instance, 0),
01204                 )
01205         except (ConflictError, KeyboardInterrupt):
01206             raise
01207         except Exception, e:
01208             log("Error while trying to convert file contents to 'text/plain' "
01209                 "in %r.getIndexable() of %r: %s" % (self, instance, e))
01210 
01211         value = str(datastream)
01212         return value

Here is the call graph for this function:

def Archetypes.Field.FileField.getIndexAccessor (   self,
  instance 
)
Return the index accessor, i.e. the getter for an indexable
value.

Reimplemented from Archetypes.Field.Field.

Definition at line 1174 of file Field.py.

01174 
01175     def getIndexAccessor(self, instance):
01176         name = self.getIndexAccessorName()
01177         if name in (self.edit_accessor, self.accessor):
01178             return lambda: self.getIndexable(instance)
01179         else:
01180             return ObjectField.getIndexAccessor(self, instance)

Here is the call graph for this function:

def Archetypes.Field.Field.getIndexAccessorName (   self) [inherited]
Return the index accessor's name defined by the
'index_method' field property.

Definition at line 633 of file Field.py.

00633 
00634     def getIndexAccessorName(self):
00635         """Return the index accessor's name defined by the
00636         'index_method' field property."""
00637         if not hasattr(self, 'index_method'):
00638             return self.accessor
00639         elif self.index_method == '_at_accessor':
00640             return self.accessor
00641         elif self.index_method == '_at_edit_accessor':
00642             return self.edit_accessor or self.accessor
00643 
00644         # If index_method is not a string, we raise ValueError (this
00645         # is actually tested for in test_extensions_utils):
00646         elif not isinstance(self.index_method, (str, unicode)):
00647             raise ValueError("Bad index accessor value : %r"
00648                              % self.index_method)
00649         else:
00650             return self.index_method

Here is the caller graph for this function:

def Archetypes.Field.Field.getMutator (   self,
  instance 
) [inherited]
Return the mutator method used for changing the value
of this field

Definition at line 619 of file Field.py.

00619 
00620     def getMutator(self, instance):
00621         """Return the mutator method used for changing the value
00622         of this field"""
00623         if self.mutator:
00624             return getattr(instance, self.mutator, None)
00625         return None

Here is the caller graph for this function:

def Archetypes.Field.Field.getName (   self) [inherited]
Return the name of this field as a string

Definition at line 569 of file Field.py.

00569 
00570     def getName(self):
00571         """Return the name of this field as a string"""
00572         return self.__name__

Here is the caller graph for this function:

def Archetypes.Field.ObjectField.getRaw (   self,
  instance,
  kwargs 
) [inherited]

Reimplemented in Archetypes.Field.BooleanField, and Archetypes.Field.LinesField.

Definition at line 716 of file Field.py.

00716 
00717     def getRaw(self, instance, **kwargs):
00718         if self.accessor is not None:
00719             accessor = self.getAccessor(instance)
00720         else:
00721             # self.accessor is None for fields wrapped by an I18NMixIn
00722             accessor = None
00723         kwargs.update({'field': self,
00724                        'encoding':kwargs.get('encoding', None),
00725                      })
00726         if accessor is None:
00727             args = [instance,]
00728             return mapply(self.get, *args, **kwargs)
00729         return mapply(accessor, **kwargs)

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.ObjectField.getStorage (   self,
  instance = None 
) [inherited]

Definition at line 758 of file Field.py.

00758 
00759     def getStorage(self, instance=None):
00760         return self.storage

Here is the caller graph for this function:

def Archetypes.Field.ObjectField.getStorageName (   self,
  instance = None 
) [inherited]
Return the storage name that is configured for this field
as a string

Definition at line 762 of file Field.py.

00762 
00763     def getStorageName(self, instance=None):
00764         """Return the storage name that is configured for this field
00765         as a string"""
00766         return self.getStorage(instance).getName()

Here is the call graph for this function:

def Archetypes.Field.ObjectField.getStorageType (   self,
  instance = None 
) [inherited]
Return the type of the storage of this field as a string

Definition at line 768 of file Field.py.

00768 
00769     def getStorageType(self, instance=None):
00770         """Return the type of the storage of this field as a string"""
00771         return className(self.getStorage(instance))

Here is the call graph for this function:

def Archetypes.Field.Field.getType (   self) [inherited]
Return the type of this field as a string

Definition at line 574 of file Field.py.

00574 
00575     def getType(self):
00576         """Return the type of this field as a string"""
00577         return className(self)

Here is the call graph for this function:

def Archetypes.Field.Field.getWidgetName (   self) [inherited]
Return the widget name that is configured for this field as
a string

Definition at line 563 of file Field.py.

00563 
00564     def getWidgetName(self):
00565         """Return the widget name that is configured for this field as
00566         a string"""
00567         return self.widget.getName()

def Archetypes.Field.Field.isLanguageIndependent (   self,
  instance 
) [inherited]
Get the language independed flag for i18n content

Definition at line 672 of file Field.py.

00672 
00673     def isLanguageIndependent(self, instance):
00674         """Get the language independed flag for i18n content
00675         """
00676         return self.languageIndependent

def Archetypes.Field.FileField.set (   self,
  instance,
  value,
  kwargs 
)
Assign input value to object. If mimetype is not specified,
pass to processing method without one and add mimetype returned
to kwargs. Assign kwargs to instance.

Reimplemented from Archetypes.Field.ObjectField.

Reimplemented in Archetypes.Field.ImageField.

Definition at line 1004 of file Field.py.

01004 
01005     def set(self, instance, value, **kwargs):
01006         """
01007         Assign input value to object. If mimetype is not specified,
01008         pass to processing method without one and add mimetype returned
01009         to kwargs. Assign kwargs to instance.
01010         """
01011         if value == "DELETE_FILE":
01012             if shasattr(instance, '_FileField_types'):
01013                 delattr(aq_base(instance), '_FileField_types')
01014             ObjectField.unset(self, instance, **kwargs)
01015             return
01016 
01017         if not kwargs.has_key('mimetype'):
01018             kwargs['mimetype'] = None
01019 
01020         kwargs['default'] = self.getDefault(instance)
01021         initializing = kwargs.get('_initializing_', False)
01022 
01023         if not initializing:
01024             file = self.get(instance, raw=True, unwrapped=True)
01025         else:
01026             file = None
01027         factory = self.content_class
01028         if not initializing and not isinstance(file, factory):
01029             # Convert to same type as factory
01030             # This is here mostly for backwards compatibility
01031             v, m, f = self._migrate_old(file, **kwargs)
01032             kwargs['mimetype'] = m
01033             kwargs['filename'] = f
01034             obj = self._wrapValue(instance, v, **kwargs)
01035             # Store so the object gets a _p_jar,
01036             # if we are using a persistent storage, that is.
01037             ObjectField.set(self, instance, obj, **kwargs)
01038             file = self.get(instance, raw=True, unwrapped=True)
01039             # Should be same as factory now, but if it isn't, that's
01040             # very likely a bug either in the storage implementation
01041             # or on the field implementation.
01042 
01043         value, mimetype, filename = self._process_input(value, file=file,
01044                                                         instance=instance,
01045                                                         **kwargs)
01046 
01047         kwargs['mimetype'] = mimetype
01048         kwargs['filename'] = filename
01049 
01050         # remove ugly hack
01051         if shasattr(instance, '_FileField_types'):
01052             del instance._FileField_types
01053         if value is None:
01054             # do not send None back as file value if we get a default (None)
01055             # value back from _process_input.  This prevents
01056             # a hard error (NoneType object has no attribute 'seek') from
01057             # occurring if someone types in a bogus name in a file upload
01058             # box (at least under Mozilla).
01059             value = ''
01060         obj = self._wrapValue(instance, value, **kwargs)
01061         ObjectField.set(self, instance, obj, **kwargs)

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField.setContentType (   self,
  instance,
  value 
)
Set mimetype in the base unit.

Reimplemented from Archetypes.Field.ObjectField.

Reimplemented in Archetypes.Field.TextField.

Definition at line 871 of file Field.py.

00871 
00872     def setContentType(self, instance, value):
00873         """Set mimetype in the base unit.
00874         """
00875         file = self.get(instance)
00876         try: 
00877             # file might be None or an empty string
00878             setattr(file, 'content_type', value)
00879         except AttributeError:
00880             pass
00881         else:
00882             self.set(instance, file)

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField.setFilename (   self,
  instance,
  filename 
)
Set file name in the base unit.

Definition at line 1125 of file Field.py.

01125 
01126     def setFilename(self, instance, filename):
01127         """Set file name in the base unit.
01128         """
01129         bu = self.getBaseUnit(instance, full=True)
01130         bu.setFilename(filename)
01131         self.set(instance, bu)

Here is the call graph for this function:

def Archetypes.Field.ObjectField.setStorage (   self,
  instance,
  storage 
) [inherited]

Definition at line 746 of file Field.py.

00746 
00747     def setStorage(self, instance, storage):
00748         if not IStorage.isImplementedBy(storage):
00749             raise ObjectFieldException, "Not a valid Storage method"
00750         # raw=1 is required for TextField
00751         value = self.get(instance, raw=True)
00752         self.unset(instance)
00753         self.storage = storage
00754         if shasattr(self.storage, 'initializeInstance'):
00755             self.storage.initializeInstance(instance)
00756         self.set(instance, value)

Here is the call graph for this function:

def Archetypes.Field.Field.toString (   self) [inherited]
Utility method for converting a Field to a string for the
purpose of comparing fields.  This comparison is used for
determining whether a schema has changed in the auto update
function. Right now it's pretty crude.

Definition at line 652 of file Field.py.

00652 
00653     def toString(self):
00654         """Utility method for converting a Field to a string for the
00655         purpose of comparing fields.  This comparison is used for
00656         determining whether a schema has changed in the auto update
00657         function. Right now it's pretty crude."""
00658         # TODO fixme
00659         s = '%s(%s): {' % ( self.__class__.__name__, self.__name__ )
00660         sorted_keys = self._properties.keys()
00661         sorted_keys.sort()
00662         for k in sorted_keys:
00663             value = getattr( self, k, self._properties[k] )
00664             if k == 'widget':
00665                 value = value.__class__.__name__
00666             if type(value) is UnicodeType:
00667                 value = value.encode('utf-8')
00668             s = s + '%s:%s,' % (k, value )
00669         s = s + '}'
00670         return s

Here is the caller graph for this function:

def Archetypes.Field.ObjectField.unset (   self,
  instance,
  kwargs 
) [inherited]

Definition at line 740 of file Field.py.

00740 
00741     def unset(self, instance, **kwargs):
00742         #kwargs['field'] = self
00743         __traceback_info__ = (self.getName(), instance, kwargs)
00744         self.getStorage(instance).unset(self.getName(), instance, **kwargs)

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.validate (   self,
  value,
  instance,
  errors = None,
  kwargs 
) [inherited]
Validate passed-in value using all field validators.
Return None if all validations pass; otherwise, return failed
result returned by validator

Definition at line 299 of file Field.py.

00299 
00300     def validate(self, value, instance, errors=None, **kwargs):
00301         """
00302         Validate passed-in value using all field validators.
00303         Return None if all validations pass; otherwise, return failed
00304         result returned by validator
00305         """
00306         if errors is None:
00307             errors = {}
00308         name = self.getName()
00309         if errors and errors.has_key(name):
00310             return True
00311 
00312         if self.required:
00313             res = self.validate_required(instance, value, errors)
00314             if res is not None:
00315                 return res
00316 
00317         if self.enforceVocabulary:
00318             res = self.validate_vocabulary(instance, value, errors)
00319             if res is not None:
00320                 return res
00321 
00322         res = instance.validate_field(name, value, errors)
00323         if res is not None:
00324             return res
00325 
00326         if self.validators:
00327             res = self.validate_validators(value, instance, errors, **kwargs)
00328             if res is not True:
00329                 return res
00330 
00331         # all ok
00332         return None

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.FileField.validate_required (   self,
  instance,
  value,
  errors 
)

Reimplemented from Archetypes.Field.Field.

Definition at line 1133 of file Field.py.

01133 
01134     def validate_required(self, instance, value, errors):
01135         value = getattr(value, 'get_size', lambda: value and str(value))()
01136         return ObjectField.validate_required(self, instance, value, errors)

def Archetypes.Field.Field.validate_validators (   self,
  value,
  instance,
  errors,
  kwargs 
) [inherited]

Definition at line 334 of file Field.py.

00334 
00335     def validate_validators(self, value, instance, errors, **kwargs):
00336         """
00337         """
00338         if self.validators:
00339             result = self.validators(value, instance=instance, errors=errors,
00340                                      field=self, **kwargs)
00341         else:
00342             result = True
00343 
00344         if result is not True:
00345             return result

Here is the caller graph for this function:

def Archetypes.Field.Field.validate_vocabulary (   self,
  instance,
  value,
  errors 
) [inherited]
Make sure value is inside the allowed values
for a given vocabulary

Definition at line 363 of file Field.py.

00363 
00364     def validate_vocabulary(self, instance, value, errors):
00365         """Make sure value is inside the allowed values
00366         for a given vocabulary"""
00367         badvalues = []
00368         if value:
00369             # coerce value into a list called values
00370             values = value
00371             if type(value) in STRING_TYPES:
00372                 values = [value]
00373             elif type(value) == BooleanType:
00374                 values = [str(value)]
00375             elif type(value) not in (TupleType, ListType):
00376                 raise TypeError("Field value type error: %s" % type(value))
00377             vocab = self.Vocabulary(instance)
00378             # filter empty
00379             values = [instance.unicodeEncode(v)
00380                       for v in values if v.strip()]
00381             # extract valid values from vocabulary
00382             valids = []
00383             for v in vocab:
00384                 if type(v) in (TupleType, ListType):
00385                     v = v[0]
00386                 if not type(v) in STRING_TYPES:
00387                     v = str(v)
00388                 valids.append(instance.unicodeEncode(v))
00389             # check field values
00390             badvalues = [val for val in values if not val in valids]
00391 
00392         error = None
00393         if badvalues:
00394             request = aq_get(instance, 'REQUEST')
00395             label = self.widget.Label(instance)
00396             if isinstance(label, Message):
00397                 label = translate(label, context=request)
00398             if isinstance(val, Message):
00399                 val = translate(val, context=request)
00400             error = _( u'error_vocabulary',
00401                 default=u'Values ${val} is not allowed for vocabulary of element ${label}.',
00402                 mapping={'val': unicode(badvalues), 'name': label})
00403             error = translate(error, context=request)
00404             errors[self.getName()] = error
00405         return error

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.Vocabulary (   self,
  content_instance = None 
) [inherited]
Returns a DisplayList.

Uses self.vocabulary as source.

1) Static vocabulary

   - is already a DisplayList
   - is a list of 2-tuples with strings (see above)
   - is a list of strings (in this case a DisplayList
     with key=value will be created)

2) Dynamic vocabulary:

   - precondition: a content_instance is given.

   - has to return a:

* DisplayList or
* list of strings or
* list of 2-tuples with strings:
    '[("key1","value 1"),("key 2","value 2"),]'

   - the output is postprocessed like a static vocabulary.

   - vocabulary is a string:
if a method with the name of the string exists it will be called

   - vocabulary is a class implementing IVocabulary:
the "getDisplayList" method of the class will be called.

3) Zope 3 vocabulary factory vocabulary

    - precondition: a content_instance is given
    
    - self.vocabulary_factory is given
    
    - a named utility providing zope.schema.interfaces.IVocbularyFactory 
      exists for the name self.vocabulary_factory.

Reimplemented in Archetypes.Field.ReferenceField.

Definition at line 407 of file Field.py.

00407 
00408     def Vocabulary(self, content_instance=None):
00409         """
00410         Returns a DisplayList.
00411 
00412         Uses self.vocabulary as source.
00413 
00414         1) Static vocabulary
00415 
00416            - is already a DisplayList
00417            - is a list of 2-tuples with strings (see above)
00418            - is a list of strings (in this case a DisplayList
00419              with key=value will be created)
00420 
00421         2) Dynamic vocabulary:
00422 
00423            - precondition: a content_instance is given.
00424 
00425            - has to return a:
00426 
00427                 * DisplayList or
00428                 * list of strings or
00429                 * list of 2-tuples with strings:
00430                     '[("key1","value 1"),("key 2","value 2"),]'
00431 
00432            - the output is postprocessed like a static vocabulary.
00433 
00434            - vocabulary is a string:
00435                 if a method with the name of the string exists it will be called
00436 
00437            - vocabulary is a class implementing IVocabulary:
00438                 the "getDisplayList" method of the class will be called.
00439 
00440         3) Zope 3 vocabulary factory vocabulary
00441         
00442             - precondition: a content_instance is given
00443             
00444             - self.vocabulary_factory is given
00445             
00446             - a named utility providing zope.schema.interfaces.IVocbularyFactory 
00447               exists for the name self.vocabulary_factory.
00448 
00449         """
00450         value = self.vocabulary
00451         
00452         # Attempt to get the value from a a vocabulary factory if one was given
00453         # and no explicit vocabulary was set
00454         if not isinstance(value, DisplayList) and not value:
00455             factory_name = getattr(self, 'vocabulary_factory', None)
00456             if factory_name is not None:
00457                 factory = component.getUtility(schema.interfaces.IVocabularyFactory, name=factory_name)
00458                 factory_context = content_instance
00459                 if factory_context is None:
00460                     factory_context = self
00461                 value = DisplayList([(t.value, t.title or t.token) for t in factory(factory_context)])
00462                     
00463         if not isinstance(value, DisplayList):
00464 
00465             if content_instance is not None and isinstance(value, basestring):
00466                 # Dynamic vocabulary by method on class of content_instance
00467                 method = getattr(content_instance, value, None)
00468                 if method and callable(method):
00469                     args = []
00470                     kw = {'content_instance' : content_instance,
00471                           'field' : self}
00472                     value = mapply(method, *args, **kw)
00473             elif content_instance is not None and \
00474                  IVocabulary.isImplementedBy(value):
00475                 # Dynamic vocabulary provided by a class that
00476                 # implements IVocabulary
00477                 value = value.getDisplayList(content_instance)
00478 
00479             # Post process value into a DisplayList
00480             # Templates will use this interface
00481             sample = value[:1]
00482             if isinstance(sample, DisplayList):
00483                 # Do nothing, the bomb is already set up
00484                 pass
00485             elif isinstance(sample, (list, tuple)):
00486                 # Assume we have ((value, display), ...)
00487                 # and if not ('', '', '', ...)
00488                 if sample and not isinstance((sample[0]), (list, tuple)):
00489                     # if not a 2-tuple
00490                     value = zip(value, value)
00491                 value = DisplayList(value)
00492             elif len(sample) and isinstance(sample[0], basestring):
00493                 value = DisplayList(zip(value, value))
00494             else:
00495                 log('Unhandled type in Vocab')
00496                 log(value)
00497 
00498         if content_instance:
00499             # Translate vocabulary
00500             i18n_domain = (getattr(self, 'i18n_domain', None) or
00501                           getattr(self.widget, 'i18n_domain', None))
00502 
00503             return Vocabulary(value, content_instance, i18n_domain)
00504 
00505         return value

Here is the call graph for this function:

Here is the caller graph for this function:

def Archetypes.Field.Field.writeable (   self,
  instance,
  debug = False 
) [inherited]

Definition at line 527 of file Field.py.

00527 
00528     def writeable(self, instance, debug=False):
00529         if 'w' not in self.mode:
00530             if debug:
00531                 log("Tried to update %s:%s but field is not writeable." % \
00532                     (instance.portal_type, self.getName()))
00533             return False
00534 
00535         method = self.getMutator(instance)
00536         if not method:
00537             if debug:
00538                 log("No method %s on %s." % (self.mutator, instance))
00539             return False
00540 
00541         if not self.checkPermission('edit', instance):
00542             if debug:
00543                 log("User %s tried to update %s:%s but "
00544                     "doesn't have enough permissions." %
00545                     (_getAuthenticatedUser(instance).getId(),
00546                      instance.portal_type, self.getName()))
00547             return False
00548         return True

Here is the call graph for this function:


Member Data Documentation

Archetypes.Field.FileField.__implements__ = IFileField,ILayerContainer [static, private]

Reimplemented from Archetypes.Field.ObjectField.

Reimplemented in Archetypes.Field.TextField.

Definition at line 856 of file Field.py.

tuple Archetypes.Field.FileField._properties = ObjectField._properties.copy() [static, private]

Reimplemented from Archetypes.Field.ObjectField.

Reimplemented in Archetypes.Field.ImageField, and Archetypes.Field.TextField.

Definition at line 858 of file Field.py.

Definition at line 638 of file Field.py.

tuple Archetypes.Field.FileField.security = ClassSecurityInfo() [static]

Reimplemented from Archetypes.Field.ObjectField.

Reimplemented in Archetypes.Field.ImageField, and Archetypes.Field.TextField.

Definition at line 868 of file Field.py.

Definition at line 752 of file Field.py.

Definition at line 296 of file Field.py.

Definition at line 249 of file Field.py.


The documentation for this class was generated from the following file: