############################################################################## # # Copyright (c) 2002 Zope Corporation and Contributors. All Rights Reserved. # # This software is subject to the provisions of the Zope Public License, # Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS # FOR A PARTICULAR PURPOSE # ############################################################################## """HTML formated DocumentTemplates $Id: DT_HTML.py 40218 2005-11-18 14:39:19Z andreasjung $""" from DT_String import String, FileMixin import DT_String, re from DT_Util import ParseError, str class dtml_re_class: """ This needs to be replaced before 2.4. It's a hackaround. """ def search(self, text, start=0, name_match=re.compile('[\000- ]*[a-zA-Z]+[\000- ]*').match, end_match=re.compile('[\000- ]*(/|end)', re.I).match, start_search=re.compile('[<&]').search, ent_name=re.compile('[-a-zA-Z0-9_.]+').match, ): while 1: mo = start_search(text,start) if mo is None: return None s = mo.start(0) if text[s:s+5] == '',n) if e < 0: return None en=3 mo =end_match(text,n) if mo is not None: l = mo.end(0) - mo.start(0) end=text[n:n+l].strip() n=n+l else: end='' elif text[s:s+6] == '',e+1) if e < 0: return None if len(text[n:e].split('"'))%2: # check for even number of "s inside break en=1 end='' elif text[s:s+7] == '',e+1) if e < 0: return None if len(text[n:e].split('"'))%2: # check for even number of "s inside break en=1 end='/' else: if text[s:s+5] == '&dtml' and text[s+5] in '.-': n=s+6 e=text.find(';',n) if e >= 0: args=text[n:e] l=len(args) mo = ent_name(args) if mo is not None: if mo.end(0)-mo.start(0) == l: d=self.__dict__ if text[s+5]=='-': d[1]=d['end']='' d[2]=d['name']='var' d[0]=text[s:e+1] d[3]=d['args']=args+' html_quote' self._start = s return self else: nn=args.find('-') if nn >= 0 and nn < l-1: d[1]=d['end']='' d[2]=d['name']='var' d[0]=text[s:e+1] args=args[nn+1:]+' '+ \ args[:nn].replace('.',' ') d[3]=d['args']=args self._start = s return self start=s+1 continue break mo = name_match(text,n) if mo is None: return None l = mo.end(0) - mo.start(0) a=n+l name=text[n:a].strip() args=text[a:e].strip() d=self.__dict__ d[0]=text[s:e+en] d[1]=d['end']=end d[2]=d['name']=name d[3]=d['args']=args self._start = s return self def group(self, *args): get=self.__dict__.get if len(args)==1: return get(args[0]) return tuple(map(get, args)) def start(self, *args): return self._start class HTML(DT_String.String): """HTML Document Templates HTML Document templates use HTML server-side-include syntax, rather than Python format-string syntax. Here's a simple example: HTML document templates quote HTML tags in source when the template is converted to a string. This is handy when templates are inserted into HTML editing forms. """ tagre__roles__=() def tagre(self): return dtml_re_class() parseTag__roles__=() def parseTag(self, match_ob, command=None, sargs=''): """Parse a tag using an already matched re Return: tag, args, command, coname where: tag is the tag, args is the tag\'s argument string, command is a corresponding command info structure if the tag is a start tag, or None otherwise, and coname is the name of a continue tag (e.g. else) or None otherwise """ tag, end, name, args = match_ob.group(0, 'end', 'name', 'args') args=args.strip() if end: if not command or name != command.name: raise ParseError, ('unexpected end tag', tag) return tag, args, None, None if command and name in command.blockContinuations: if name=='else' and args: # Waaaaaah! Have to special case else because of # old else start tag usage. Waaaaaaah! l=len(args) if not (args==sargs or args==sargs[:l] and sargs[l:l+1] in ' \t\n'): return tag, args, self.commands[name], None return tag, args, None, name try: return tag, args, self.commands[name], None except KeyError: raise ParseError, ('Unexpected tag', tag) SubTemplate__roles__=() def SubTemplate(self, name): return HTML('', __name__=name) varExtra__roles__=() def varExtra(self, match_ob): return 's' manage_edit__roles__=() def manage_edit(self,data,REQUEST=None): 'edit a template' self.munge(data) if REQUEST: return self.editConfirmation(self,REQUEST) quotedHTML__roles__=() def quotedHTML(self, text=None, character_entities=( (('&'), '&'), (("<"), '<' ), ((">"), '>' ), (('"'), '"'))): #" if text is None: text=self.read_raw() for re,name in character_entities: if text.find(re) >= 0: text=name.join(text.split(re)) return text errQuote__roles__=() errQuote=quotedHTML def __str__(self): return self.quotedHTML() # these should probably all be deprecated. management_interface__roles__=() def management_interface(self): '''Hook to allow public execution of management interface with everything else private.''' return self manage_editForm__roles__=() def manage_editForm(self, URL1, REQUEST): '''Display doc template editing form''' #" return self._manage_editForm( self, mapping=REQUEST, __str__=str(self), URL1=URL1 ) manage_editDocument__roles__=() manage__roles__=() manage_editDocument=manage=manage_editForm class HTMLDefault(HTML): '''\ HTML document templates that edit themselves through copy. This is to make a distinction from HTML objects that should edit themselves in place. ''' copy_class__roles__=() copy_class=HTML manage_edit__roles__=() def manage_edit(self,data,PARENTS,URL1,REQUEST): 'edit a template' newHTML=self.copy_class(data,self.globals,self.__name__) setattr(PARENTS[1],URL1[URL1.rfind('/')+1:],newHTML) return self.editConfirmation(self,REQUEST) class HTMLFile(FileMixin, HTML): """\ HTML Document templates read from files. If the object is pickled, the file name, rather than the file contents is pickled. When the object is unpickled, then the file will be re-read to obtain the string. Note that the file will not be read until the document template is used the first time. """ manage_default__roles__=() def manage_default(self, REQUEST=None): 'Revert to factory defaults' if self.edited_source: self.edited_source='' self._v_cooked=self.cook() if REQUEST: return self.editConfirmation(self,REQUEST) manage_editForm__roles__=() def manage_editForm(self, URL1, REQUEST): '''Display doc template editing form''' return self._manage_editForm(mapping=REQUEST, document_template_edit_width= self.document_template_edit_width, document_template_edit_header= self.document_template_edit_header, document_template_form_header= self.document_template_form_header, document_template_edit_footer= self.document_template_edit_footer, URL1=URL1, __str__=str(self), FactoryDefaultString=FactoryDefaultString, ) manage_editDocument__roles__=() manage__roles__=() manage_editDocument=manage=manage_editForm manage_edit__roles__=() def manage_edit(self,data, PARENTS=[],URL1='',URL2='',REQUEST='', SUBMIT=''): 'edit a template' if SUBMIT==FactoryDefaultString: return self.manage_default(REQUEST) if data.find('\r'): data='\n\r'.join(data.split('\r\n')) data='\n'.join(data.split('\n\r')) if self.edited_source: self.edited_source=data self._v_cooked=self.cook() else: __traceback_info__=self.__class__ newHTML=self.__class__() newHTML.__setstate__(self.__getstate__()) newHTML.edited_source=data setattr(PARENTS[1],URL1[URL1.rfind('/')+1:],newHTML) if REQUEST: return self.editConfirmation(self,REQUEST)