DT_String.py
上传用户:gyjinxi
上传日期:2007-01-04
资源大小:159k
文件大小:19k
源码类别:

WEB邮件程序

开发平台:

Python

  1. ##############################################################################
  2. # Zope Public License (ZPL) Version 1.0
  3. # -------------------------------------
  4. # Copyright (c) Digital Creations.  All rights reserved.
  5. # This license has been certified as Open Source(tm).
  6. # Redistribution and use in source and binary forms, with or without
  7. # modification, are permitted provided that the following conditions are
  8. # met:
  9. # 1. Redistributions in source code must retain the above copyright
  10. #    notice, this list of conditions, and the following disclaimer.
  11. # 2. Redistributions in binary form must reproduce the above copyright
  12. #    notice, this list of conditions, and the following disclaimer in
  13. #    the documentation and/or other materials provided with the
  14. #    distribution.
  15. # 3. Digital Creations requests that attribution be given to Zope
  16. #    in any manner possible. Zope includes a "Powered by Zope"
  17. #    button that is installed by default. While it is not a license
  18. #    violation to remove this button, it is requested that the
  19. #    attribution remain. A significant investment has been put
  20. #    into Zope, and this effort will continue if the Zope community
  21. #    continues to grow. This is one way to assure that growth.
  22. # 4. All advertising materials and documentation mentioning
  23. #    features derived from or use of this software must display
  24. #    the following acknowledgement:
  25. #      "This product includes software developed by Digital Creations
  26. #      for use in the Z Object Publishing Environment
  27. #      (http://www.zope.org/)."
  28. #    In the event that the product being advertised includes an
  29. #    intact Zope distribution (with copyright and license included)
  30. #    then this clause is waived.
  31. # 5. Names associated with Zope or Digital Creations must not be used to
  32. #    endorse or promote products derived from this software without
  33. #    prior written permission from Digital Creations.
  34. # 6. Modified redistributions of any form whatsoever must retain
  35. #    the following acknowledgment:
  36. #      "This product includes software developed by Digital Creations
  37. #      for use in the Z Object Publishing Environment
  38. #      (http://www.zope.org/)."
  39. #    Intact (re-)distributions of any official Zope release do not
  40. #    require an external acknowledgement.
  41. # 7. Modifications are encouraged but must be packaged separately as
  42. #    patches to official Zope releases.  Distributions that do not
  43. #    clearly separate the patches from the original work must be clearly
  44. #    labeled as unofficial distributions.  Modifications which do not
  45. #    carry the name Zope may be packaged in any form, as long as they
  46. #    conform to all of the clauses above.
  47. # Disclaimer
  48. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  49. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  51. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  52. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  53. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  54. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  55. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  56. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  57. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  58. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59. #   SUCH DAMAGE.
  60. # This software consists of contributions made by Digital Creations and
  61. # many individuals on behalf of Digital Creations.  Specific
  62. # attributions are listed in the accompanying credits file.
  63. ##############################################################################
  64. "$Id: DT_String.py,v 1.31 1999/08/18 20:50:37 jim Exp $"
  65. from string import split, strip
  66. import regex, ts_regex
  67. from DT_Util import ParseError, InstanceDict, TemplateDict, render_blocks, str
  68. from DT_Var import Var, Call, Comment
  69. from DT_Return import ReturnTag, DTReturn
  70. class String:
  71.     """Document templates defined from strings.
  72.     Document template strings use an extended form of python string
  73.     formatting.  To insert a named value, simply include text of the
  74.     form: '%(name)x', where 'name' is the name of the value and 'x' is
  75.     a format specification, such as '12.2d'.
  76.     To intrduce a block such as an 'if' or an 'in' or a block continuation,
  77.     such as an 'else', use '[' as the format specification.  To
  78.     terminate a block, ise ']' as the format specification, as in::
  79.       %(in results)[
  80.         %(name)s
  81.       %(in results)]
  82.     """ 
  83.     isDocTemp=1
  84.     # Document Templates masquerade as functions:
  85.     class func_code: pass
  86.     func_code=func_code()
  87.     func_code.co_varnames='self','REQUEST'
  88.     func_code.co_argcount=2
  89.     func_defaults=()
  90.     def errQuote(self, s): return s
  91.       
  92.     def parse_error(self, mess, tag, text, start):
  93.         raise ParseError, "%s, for tag %s, on line %s of %s<p>" % (
  94.             mess, self.errQuote(tag), len(split(text[:start],'n')),
  95.             self.errQuote(self.__name__))
  96.     commands={
  97.         'var': Var,
  98.         'call': Call,
  99.         'in': ('in', 'DT_In','In'),
  100.         'with': ('with', 'DT_With','With'),
  101.         'if': ('if', 'DT_If','If'),
  102.         'unless': ('unless', 'DT_If','Unless'),
  103.         'else': ('else', 'DT_If','Else'),
  104.         'comment': Comment,
  105.         'raise': ('raise', 'DT_Raise','Raise'),
  106.         'try': ('try', 'DT_Try','Try'),
  107.         'let': ('let', 'DT_Let', 'Let'),
  108.         'return': ReturnTag,
  109.         }
  110.     def SubTemplate(self, name): return String('', __name__=name)
  111.     def tagre(self):
  112.         return regex.symcomp(
  113.             '%('                                     # beginning
  114.             '(<name>[a-zA-Z0-9_/.-]+)'                       # tag name
  115.             '('
  116.             '[- ]+'                                # space after tag name
  117.             '(<args>([^)"]+("[^"]*")?)*)'      # arguments
  118.             ')?'
  119.             ')(<fmt>[0-9]*[.]?[0-9]*[a-z]|[]![])' # end
  120.             , regex.casefold) 
  121.     def _parseTag(self, tagre, command=None, sargs='', tt=type(())):
  122.         tag, args, command, coname = self.parseTag(tagre,command,sargs)
  123.         if type(command) is tt:
  124.             cname, module, name = command
  125.             d={}
  126.             try:
  127.                 exec 'from %s import %s' % (module, name) in d
  128.             except ImportError:
  129.                 exec 'from DocumentTemplate.%s import %s' % (module, name) in d
  130.             command=d[name]
  131.             self.commands[cname]=command
  132.         return tag, args, command, coname
  133.     
  134.     def parseTag(self, tagre, command=None, sargs=''):
  135.         """Parse a tag using an already matched re
  136.         Return: tag, args, command, coname
  137.         where: tag is the tag,
  138.                args is the tag's argument string,
  139.                command is a corresponding command info structure if the
  140.                   tag is a start tag, or None otherwise, and
  141.                coname is the name of a continue tag (e.g. else)
  142.                  or None otherwise
  143.         """
  144.         tag, name, args, fmt =tagre.group(0, 'name', 'args', 'fmt')
  145.         args=args and strip(args) or ''
  146.         if fmt==']':
  147.             if not command or name != command.name:
  148.                 raise ParseError, ('unexpected end tag', tag)
  149.             return tag, args, None, None
  150.         elif fmt=='[' or fmt=='!':
  151.             if command and name in command.blockContinuations:
  152.                 if name=='else' and args:
  153.                     # Waaaaaah! Have to special case else because of
  154.                     # old else start tag usage. Waaaaaaah!
  155.                     l=len(args)
  156.                     if not (args==sargs or
  157.                             args==sargs[:l] and sargs[l:l+1] in ' tn'):
  158.                         return tag, args, self.commands[name], None
  159.                 return tag, args, None, name
  160.             try: return tag, args, self.commands[name], None
  161.             except KeyError:
  162.                 raise ParseError, ('Unexpected tag', tag)
  163.         else:
  164.             # Var command
  165.             args=args and ("%s %s" % (name, args)) or name
  166.             return tag, args, Var, None
  167.     def varExtra(self,tagre): return tagre.group('fmt')
  168.     def parse(self,text,start=0,result=None,tagre=None):
  169.         if result is None: result=[]
  170.         if tagre is None: tagre=self.tagre()
  171.         l=tagre.search(text,start)
  172.         while l >= 0:
  173.             try: tag, args, command, coname = self._parseTag(tagre)
  174.             except ParseError, m: self.parse_error(m[0],m[1],text,l)
  175.             s=text[start:l]
  176.             if s: result.append(s)
  177.             start=l+len(tag)
  178.             if hasattr(command,'blockContinuations'):
  179.                 start=self.parse_block(text, start, result, tagre,
  180.                                        tag, l, args, command)
  181.             else:
  182.                 try:
  183.                     if command is Var: r=command(args, self.varExtra(tagre))
  184.                     else: r=command(args)
  185.                     if hasattr(r,'simple_form'): r=r.simple_form
  186.                     result.append(r)
  187.                 except ParseError, m: self.parse_error(m[0],tag,text,l)
  188.             l=tagre.search(text,start)
  189.         text=text[start:]
  190.         if text: result.append(text)
  191.         return result
  192.     def skip_eol(self, text, start, eol=regex.compile('[ t]*n')):
  193.         # if block open is followed by newline, then skip past newline
  194.         l=eol.match(text,start)
  195.         if l > 0: start=start+l
  196.         return start
  197.     def parse_block(self, text, start, result, tagre,
  198.                     stag, sloc, sargs, scommand):
  199.         start=self.skip_eol(text,start)
  200.         blocks=[]
  201.         tname=scommand.name
  202.         sname=stag
  203.         sstart=start
  204.         sa=sargs
  205.         while 1:
  206.             l=tagre.search(text,start)
  207.             if l < 0: self.parse_error('No closing tag', stag, text, sloc)
  208.             try: tag, args, command, coname= self._parseTag(tagre,scommand,sa)
  209.             except ParseError, m: self.parse_error(m[0],m[1], text, l)
  210.             
  211.             if command:
  212.                 start=l+len(tag)
  213.                 if hasattr(command, 'blockContinuations'):
  214.                     # New open tag.  Need to find closing tag.
  215.                     start=self.parse_close(text, start, tagre, tag, l,
  216.                                            command, args)
  217.             else:
  218.                 # Either a continuation tag or an end tag
  219.                 section=self.SubTemplate(sname)
  220.                 section._v_blocks=section.blocks=self.parse(text[:l],sstart)
  221.                 section._v_cooked=None
  222.                 blocks.append((tname,sargs,section))
  223.     
  224.                 start=self.skip_eol(text,l+len(tag))
  225.                 if coname:
  226.                     tname=coname
  227.                     sname=tag
  228.                     sargs=args
  229.                     sstart=start
  230.                 else:
  231.                     try:
  232.                         r=scommand(blocks)
  233.                         if hasattr(r,'simple_form'): r=r.simple_form
  234.                         result.append(r)
  235.                     except ParseError, m: self.parse_error(m[0],stag,text,l)
  236.                     return start
  237.     
  238.     def parse_close(self, text, start, tagre, stag, sloc, scommand, sa):
  239.         while 1:
  240.             l=tagre.search(text,start)
  241.             if l < 0: self.parse_error('No closing tag', stag, text, sloc)
  242.             try: tag, args, command, coname= self._parseTag(tagre,scommand,sa)
  243.             except ParseError, m: self.parse_error(m[0],m[1], text, l)
  244.             start=l+len(tag)
  245.             if command:
  246.                 if hasattr(command, 'blockContinuations'):
  247.                     # New open tag.  Need to find closing tag.
  248.                     start=self.parse_close(text, start, tagre, tag, l,
  249.                                            command,args)
  250.             elif not coname: return start
  251.     shared_globals={}
  252.     def __init__(self, source_string='', mapping=None, __name__='<string>',
  253.                  **vars):
  254.         """
  255.         Create a document template from a string.
  256.         The optional parameter, 'mapping', may be used to provide a
  257.         mapping object containing defaults for values to be inserted.
  258.         """
  259.         self.raw=source_string
  260.         self.initvars(mapping, vars)
  261.         self.setName(__name__)
  262.     def name(self): return self.__name__
  263.     id=name
  264.     def setName(self,v): self.__dict__['__name__']=v
  265.     def default(self,name=None,**kw):
  266.         """
  267.         Change or query default values in a document template.
  268.         If a name is specified, the value of the named default value
  269.         before the operation is returned.
  270.         Keyword arguments are used to provide default values.
  271.         """
  272.         if name: name=self.globals[name]
  273.         for key in kw.keys(): self.globals[key]=kw[key]
  274.         return name
  275.     def var(self,name=None,**kw):
  276.         """
  277.         Change or query a variable in a document template.
  278.         If a name is specified, the value of the named variable before
  279.         the operation is returned.
  280.         Keyword arguments are used to provide variable values.
  281.         """
  282.         if name: name=self._vars[name]
  283.         for key in kw.keys(): self._vars[key]=kw[key]
  284.         return name
  285.     def munge(self,source_string=None,mapping=None,**vars):
  286.         """
  287.         Change the text or default values for a document template.
  288.         """
  289.         if mapping is not None or vars:
  290.             self.initvars(mapping, vars)
  291.         if source_string is not None: 
  292.             self.raw=source_string
  293.         self.cook()
  294.     def manage_edit(self,data,REQUEST=None):
  295.         self.munge(data)
  296.     def read_raw(self,raw=None):
  297.         return self.raw
  298.     def read(self,raw=None):
  299.         return self.read_raw()
  300.     def cook(self,
  301.              cooklock=ts_regex.allocate_lock(),
  302.              ):
  303.         cooklock.acquire()
  304.         try:
  305.             self._v_blocks=self.parse(self.read())
  306.             self._v_cooked=None
  307.         finally:
  308.             cooklock.release()
  309.     def initvars(self, globals, vars):
  310.         if globals:
  311.             for k in globals.keys():
  312.                 if k[:1] != '_' and not vars.has_key(k): vars[k]=globals[k]
  313.         self.globals=vars
  314.         self._vars={}
  315.     def __call__(self,client=None,mapping={},**kw):
  316.         '''
  317.         Generate a document from a document template.
  318.         The document will be generated by inserting values into the
  319.         format string specified when the document template was
  320.         created.  Values are inserted using standard python named
  321.         string formats.
  322.         The optional argument 'client' is used to specify a object
  323.         containing values to be looked up.  Values will be looked up
  324.         using getattr, so inheritence of values is supported.  Note
  325.         that names beginning with '_' will not be looked up from the
  326.         client. 
  327.         The optional argument, 'mapping' is used to specify a mapping
  328.         object containing values to be inserted.
  329.         Values to be inserted may also be specified using keyword
  330.         arguments. 
  331.         Values will be inserted from one of several sources.  The
  332.         sources, in the order in which they are consulted, are:
  333.           o  Keyword arguments,
  334.           o  The 'client' argument,
  335.           o  The 'mapping' argument,
  336.           o  The keyword arguments provided when the object was
  337.              created, and
  338.           o  The 'mapping' argument provided when the template was
  339.              created. 
  340.         '''
  341.         # print '============================================================'
  342.         # print '__called__'
  343.         # print self.raw
  344.         # print kw
  345.         # print client
  346.         # print mapping
  347.         # print '============================================================'
  348.         if mapping is None: mapping = {}
  349.         if not hasattr(self,'_v_cooked'):
  350.             try: changed=self.__changed__()
  351.             except: changed=1
  352.             self.cook()
  353.             if not changed: self.__changed__(0)
  354.         pushed=None
  355.         try:
  356.             if mapping.__class__ is TemplateDict: pushed=0
  357.         except: pass
  358.         globals=self.globals
  359.         if pushed is not None:
  360.             # We were passed a TemplateDict, so we must be a sub-template
  361.             md=mapping
  362.             push=md._push
  363.             if globals:
  364.                 push(self.globals)
  365.                 pushed=pushed+1
  366.         else:
  367.             md=TemplateDict()
  368.             push=md._push
  369.             shared_globals=self.shared_globals
  370.             if shared_globals: push(shared_globals)
  371.             if globals: push(globals)
  372.             if mapping:
  373.                 push(mapping)
  374.                 if hasattr(mapping,'AUTHENTICATED_USER'):
  375.                     md.AUTHENTICATED_USER=mapping['AUTHENTICATED_USER']
  376.             md.validate=self.validate
  377.             if client is not None:
  378.                 if type(client)==type(()):
  379.                     md.this=client[-1]
  380.                 else: md.this=client
  381.             pushed=0
  382.         level=md.level
  383.         if level > 200: raise SystemError, (
  384.             'infinite recursion in document template')
  385.         md.level=level+1
  386.         if client is not None:
  387.             if type(client)==type(()):
  388.                 # if client is a tuple, it represents a "path" of clients
  389.                 # which should be pushed onto the md in order.
  390.                 for ob in client:
  391.                     push(InstanceDict(ob, md)) # Circ. Ref. 8-|
  392.                     pushed=pushed+1
  393.             else:
  394.                 # otherwise its just a normal client object.
  395.                 push(InstanceDict(client, md)) # Circ. Ref. 8-|
  396.                 pushed=pushed+1
  397.                 
  398.         if self._vars: 
  399.             push(self._vars)
  400.             pushed=pushed+1
  401.         if kw:
  402.             push(kw)
  403.             pushed=pushed+1
  404.         try:
  405.             try: return render_blocks(self._v_blocks, md)
  406.             except DTReturn, v: return v.v
  407.         finally:
  408.             if pushed: md._pop(pushed) # Get rid of circular reference!
  409.             md.level=level # Restore previous level
  410.     validate=None
  411.     def __str__(self):
  412.         return self.read()
  413.     def __getstate__(self, _special=('_v_', '_p_')):
  414.         # Waaa, we need _v_ behavior but we may not subclass Persistent
  415.         d={}
  416.         for k, v in self.__dict__.items():
  417.             if k[:3] in _special: continue
  418.             d[k]=v
  419.         return d
  420. class FileMixin:
  421.     # Mix-in class to abstract certain file-related attributes
  422.     edited_source=''
  423.     
  424.     def __init__(self, file_name='', mapping=None, __name__='', **vars):
  425.         """
  426.         Create a document template based on a named file.
  427.         The optional parameter, 'mapping', may be used to provide a
  428.         mapping object containing defaults for values to be inserted.
  429.         """
  430.         self.raw=file_name
  431.         self.initvars(mapping, vars)
  432.         self.setName(__name__ or file_name)
  433.     def read_raw(self):
  434.         if self.edited_source: return self.edited_source
  435.         if self.raw: return open(self.raw,'r').read()
  436.         return ''
  437. class File(FileMixin, String):
  438.     """
  439.     Document templates read from files.
  440.     If the object is pickled, the file name, rather
  441.     than the file contents is pickled.  When the object is
  442.     unpickled, then the file will be re-read to obtain the string.
  443.     Note that the file will not be read until the document
  444.     template is used the first time.
  445.     """
  446.     def manage_edit(self,data): raise TypeError, 'cannot edit files'