| :field.subPx[layoutType][fmt] |
| :field.subPx[layoutType][fmt] |
%s
' % value) emptyStringTuple = ('',) emptyValuesCatalogIgnored = (None, '') def getIndexValue(self, obj, forSearch=False): '''Pure text must be extracted from rich content; multilingual content must be concatenated.''' isXhtml = self.format == String.XHTML if self.isMultilingual(obj): res = self.getValue(obj) if res: vals = [] for v in res.itervalues(): if isinstance(v, unicode): v = v.encode('utf-8') if isXhtml: vals.append(self.extractText(v)) else: vals.append(v) res = ' '.join(vals) else: res = Field.getIndexValue(self, obj, forSearch) if res and isXhtml: res = self.extractText(res) # Ugly catalog: if I give an empty tuple as index value, it keeps the # previous value. If I give him a tuple containing an empty string, it # is ok. if isinstance(res, tuple) and not res: res = self.emptyStringTuple # Ugly catalog: if value is an empty string or None, it keeps the # previous index value. if res in self.emptyValuesCatalogIgnored: res = ' ' return res def getPossibleValues(self, obj, withTranslations=False, withBlankValue=False, className=None, ignoreMasterValues=False): '''Returns the list of possible values for this field (only for fields with self.isSelect=True). If p_withTranslations is True, instead of returning a list of string values, the result is a list of tuples (s_value, s_translation). Moreover, p_withTranslations can hold a given language: in this case, this language is used instead of the user language. If p_withBlankValue is True, a blank value is prepended to the list, excepted if the type is multivalued. If p_className is given, p_obj is the tool and, if we need an instance of p_className, we will need to use obj.executeQuery to find one.''' if not self.isSelect: raise Exception('This field is not a selection.') # Get the user language for translations, from "withTranslations". lg = isinstance(withTranslations, str) and withTranslations or None req = obj.REQUEST if ('masterValues' in req) and not ignoreMasterValues: # Get possible values from self.masterValue masterValues = req['masterValues'] if '*' in masterValues: masterValues = masterValues.split('*') values = self.masterValue(obj.appy(), masterValues) if not withTranslations: res = values else: res = [] for v in values: res.append( (v, self.getFormattedValue(obj,v,language=lg)) ) else: # If this field is an ajax-updatable slave, no need to compute # possible values: it will be overridden by method self.masterValue # by a subsequent ajax request (=the "if" statement above). if self.masterValue and callable(self.masterValue) and \ not ignoreMasterValues: return [] if isinstance(self.validator, Selection): # We need to call self.methodName for getting the (dynamic) # values. If methodName begins with _appy_, it is a special Appy # method: we will call it on the Mixin (=p_obj) directly. Else, # it is a user method: we will call it on the wrapper # (p_obj.appy()). Some args can be hidden into p_methodName, # separated with stars, like in this example: method1*arg1*arg2. # Only string params are supported. methodName = self.validator.methodName # Unwrap parameters if any. if methodName.find('*') != -1: elems = methodName.split('*') methodName = elems[0] args = elems[1:] else: args = () # On what object must we call the method that will produce the # values? if methodName.startswith('tool:'): obj = obj.getTool() methodName = methodName[5:] else: # We must call on p_obj. But if we have something in # p_className, p_obj is the tool and not an instance of # p_className as required. So find such an instance. if className: brains = obj.executeQuery(className, maxResults=1, brainsOnly=True) if brains: obj = brains[0].getObject() # Do we need to call the method on the object or on the wrapper? if methodName.startswith('_appy_'): exec 'res = obj.%s(*args)' % methodName else: exec 'res = obj.appy().%s(*args)' % methodName if not withTranslations: res = [v[0] for v in res] elif isinstance(res, list): res = res[:] else: # The list of (static) values is directly given in # self.validator. res = [] for value in self.validator: label = '%s_list_%s' % (self.labelId, value) if withTranslations: res.append( (value, obj.translate(label, language=lg)) ) else: res.append(value) if withBlankValue and not self.isMultiValued(): # Create the blank value to insert at the beginning of the list if withTranslations: blankValue = ('', obj.translate('choose_a_value', language=lg)) else: blankValue = '' # Insert the blank value in the result if isinstance(res, tuple): res = (blankValue,) + res else: res.insert(0, blankValue) return res def validateValue(self, obj, value): if self.format == String.CAPTCHA: challenge = obj.REQUEST.SESSION.get('captcha', None) # Compute the challenge minus the char to remove i = challenge['number']-1 text = challenge['text'][:i] + challenge['text'][i+1:] if value != text: return obj.translate('bad_captcha') elif self.isSelect: # Check that the value is among possible values possibleValues = self.getPossibleValues(obj,ignoreMasterValues=True) if isinstance(value, basestring): error = value not in possibleValues else: error = False for v in value: if v not in possibleValues: error = True break if error: return obj.translate('bad_select_value') def applyTransform(self, value): '''Applies a transform as required by self.transform on single value p_value.''' if self.transform in ('uppercase', 'lowercase'): # For those transforms, I will remove any accent, because, most of # the time, if the user wants to apply such effect, it is for ease # of data manipulation, so I guess without accent. value = sutils.normalizeString(value, usage='noAccents') # Apply the transform if self.transform == 'lowercase': return value.lower() elif self.transform == 'uppercase': return value.upper() elif self.transform == 'capitalize': return value.capitalize() return value def getUnilingualStorableValue(self, obj, value): isString = isinstance(value, basestring) isEmpty = Field.isEmptyValue(self, obj, value) # Apply transform if required if isString and not isEmpty and (self.transform != 'none'): value = self.applyTransform(value) # Clean XHTML strings if not isEmpty and (self.format == String.XHTML): # When image upload is allowed, ckeditor inserts some "style" attrs # (ie for image size when images are resized). So in this case we # can't remove style-related information. try: value = XhtmlCleaner(keepStyles=False).clean(value) except XhtmlCleaner.Error, e: # Errors while parsing p_value can't prevent the user from # storing it. pass # Clean TEXT strings if not isEmpty and (self.format == String.TEXT): value = value.replace('\r', '') # Truncate the result if longer than self.maxChars if isString and self.maxChars and (len(value) > self.maxChars): value = value[:self.maxChars] # Get a multivalued value if required. if value and self.isMultiValued() and \ (type(value) not in sutils.sequenceTypes): value = [value] return value def getStorableValue(self, obj, value): languages = self.getAttribute(obj, 'languages') if len(languages) == 1: return self.getUnilingualStorableValue(obj, value) # A multilingual value is stored as a dict whose keys are ISO 2-letters # language codes and whose values are strings storing content in the # language ~{s_language: s_content}~. if not value: return for lg in languages: value[lg] = self.getUnilingualStorableValue(obj, value[lg]) return value def store(self, obj, value): '''Stores p_value on p_obj for this field.''' languages = self.getAttribute(obj, 'languages') if (len(languages) > 1) and value and \ (not isinstance(value, dict) or (len(value) != len(languages))): raise Exception('Multilingual field "%s" accepts a dict whose '\ 'keys are in field.languages and whose ' \ 'values are strings.' % self.name) Field.store(self, obj, value) def storeFromAjax(self, obj): '''Stores the new field value from an Ajax request, or do nothing if the action was canceled.''' rq = obj.REQUEST if rq.get('cancel') == 'True': return requestValue = rq['fieldContent'] # Remember previous value if the field is historized. previousData = obj.rememberPreviousData([self]) if self.isMultilingual(obj): # We take a copy of previousData because it is mutable (dict). previousData[self.name] = previousData[self.name].copy() # We get a partial value, for one language only. language = rq['languageOnly'] v = self.getUnilingualStorableValue(obj, requestValue) getattr(obj.aq_base, self.name)[language] = v part = ' (%s)' % language else: self.store(obj, self.getStorableValue(obj, requestValue)) part = '' # Update the object history when relevant if previousData: obj.historizeData(previousData) # Update obj's last modification date from DateTime import DateTime obj.modified = DateTime() obj.reindex() obj.log('ajax-edited %s%s on %s.' % (self.name, part, obj.id)) def getIndexType(self): '''Index type varies depending on String parameters.''' # If String.isSelect, be it multivalued or not, we define a ListIndex: # this way we can use AND/OR operator. if self.isSelect: return 'ListIndex' elif self.format == String.TEXT: return 'TextIndex' elif self.format == String.XHTML: return 'XhtmlIndex' return Field.getIndexType(self) def getJs(self, layoutType, res): if self.format == String.XHTML: Field.getJs(self, layoutType, res) def getCaptchaChallenge(self, session): '''Returns a Captcha challenge in the form of a dict. At key "text", value is a string that the user will be required to re-type, but without 1 character whose position is at key "number". The challenge is stored in the p_session, for the server-side subsequent check.''' length = random.randint(5, 9) # The length of the challenge to encode number = random.randint(1, length) # The position of the char to remove text = '' # The challenge the user needs to type (minus one char) for i in range(length): j = random.randint(0, 1) chars = (j == 0) and passwordDigits or passwordLetters # Choose a char text += chars[random.randint(0,len(chars)-1)] res = {'text': text, 'number': number} session['captcha'] = res return res def generatePassword(self): '''Generates a password (we recycle here the captcha challenge generator).''' return self.getCaptchaChallenge({})['text'] ckLanguages = {'en': 'en_US', 'pt': 'pt_BR', 'da': 'da_DK', 'nl': 'nl_NL', 'fi': 'fi_FI', 'fr': 'fr_FR', 'de': 'de_DE', 'el': 'el_GR', 'it': 'it_IT', 'nb': 'nb_NO', 'pt': 'pt_PT', 'es': 'es_ES', 'sv': 'sv_SE'} def getCkLanguage(self, obj, language): '''Gets the language for CK editor SCAYT. p_language is one of self.languages if the field is multilingual, None else. If p_language is not supported by CK, we use english.''' if not language: language = self.getAttribute(obj, 'languages')[0] if language in self.ckLanguages: return self.ckLanguages[language] return 'en_US' def getCkParams(self, obj, language): '''Gets the base params to set on a rich text field.''' ckAttrs = {'toolbar': 'Appy', 'format_tags': ';'.join(self.styles), 'scayt_sLang': self.getCkLanguage(obj, language)} if self.width: ckAttrs['width'] = self.width if self.spellcheck: ckAttrs['scayt_autoStartup'] = True if self.allowImageUpload: ckAttrs['filebrowserUploadUrl'] = '%s/upload' % obj.absolute_url() ck = [] for k, v in ckAttrs.iteritems(): if isinstance(v, int): sv = str(v) if isinstance(v, bool): sv = str(v).lower() else: sv = '"%s"' % v ck.append('%s: %s' % (k, sv)) return ', '.join(ck) def getJsInit(self, obj, language): '''Gets the Javascript init code for displaying a rich editor for this field (rich field only). If the field is multilingual, we must init the rich text editor for a given p_language (among self.languages). Else, p_languages is None.''' name = not language and self.name or ('%s_%s' % (self.name, language)) return 'CKEDITOR.replace("%s", {%s})' % \ (name, self.getCkParams(obj, language)) def getJsInlineInit(self, obj, name, language): '''Gets the Javascript init code for enabling inline edition of this field (rich text only). If the field is multilingual, the current p_language is given and p_name includes it. Else, p_language is None.''' uid = obj.id fieldName = language and name.rsplit('_',1)[0] or name lg = language or '' return "CKEDITOR.disableAutoInline = true;\n" \ "CKEDITOR.inline('%s_%s_ck', {%s, on: {blur: " \ "function( event ) { var content = event.editor.getData(); " \ "doInlineSave('%s','%s','%s',content,'%s')}}})" % \ (uid, name, self.getCkParams(obj, language), uid, fieldName, obj.absolute_url(), lg) def isSelected(self, obj, fieldName, vocabValue, dbValue): '''When displaying a selection box (only for fields with a validator being a list), must the _vocabValue appear as selected? p_fieldName is given and used instead of field.name because it may be a a fake name containing a row number from a field within a list field.''' rq = obj.REQUEST # Get the value we must compare (from request or from database) if rq.has_key(fieldName): compValue = rq.get(fieldName) else: compValue = dbValue # Compare the value if type(compValue) in sutils.sequenceTypes: return vocabValue in compValue return vocabValue == compValue # ------------------------------------------------------------------------------