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

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. __doc__='''Variable insertion parameters
  65.     When inserting variables, parameters may be specified to
  66.     control how the data will be formatted.  In HTML source, the
  67.     'fmt' parameter is used to specify a C-style or custom format
  68.     to be used when inserting an object.  In EPFS source, the 'fmt'
  69.     parameter is only used for custom formats, a C-style format is
  70.     specified after the closing parenthesis.
  71.     Custom formats
  72.        A custom format is used when outputing user-defined
  73.        objects.  The value of a custom format is a method name to
  74.        be invoked on the object being inserted.  The method should
  75.        return an object that, when converted to a string, yields
  76.        the desired text.  For example, the HTML source::
  77.           <!--#var date fmt=DayOfWeek-->
  78.        Inserts the result of calling the method 'DayOfWeek' of the
  79.        object bound to the variable 'date', with no arguments.
  80.        In addition to object methods, serveral additional custom
  81.        formats are available:
  82.            'whole-dollars' -- Show a numeric value with a dollar symbol.
  83.            'dollars-and-cents' -- Show a numeric value with a dollar
  84.              symbol and two decimal places.
  85.            'collection-length' -- Get the length of a collection of objects.
  86.        Note that when using the EPFS source format, both a
  87.        C-style and a custom format may be provided.  In this case,
  88.        the C-Style format is applied to the result of calling
  89.        the custom formatting method.
  90.     Null values and missing variables
  91.        In some applications, and especially in database applications,
  92.        data variables may alternate between "good" and "null" or
  93.        "missing" values.  A format that is used for good values may be
  94.        inappropriate for null values.  For this reason, the 'null'
  95.        parameter can be used to specify text to be used for null
  96.        values.  Null values are defined as values that:
  97.          - Cannot be formatted with the specified format, and
  98.          - Are either the special Python value 'None' or 
  99.            are false and yield an empty string when converted to
  100.            a string.
  101.        For example, when showing a monitary value retrieved from a
  102.        database that is either a number or a missing value, the
  103.        following variable insertion might be used::
  104.            <dtml-var cost fmt="$%.2d" null='n/a'>
  105.        Missing values are providing for variables which are not
  106.        present in the name space, rather than raising an NameError,
  107.        you could do this:
  108.            <dtml-var cost missing=0>
  109.        and in this case, if cost was missing, it would be set to 0.
  110.        In the case where you want to deal with both at the same time,
  111.        you can use 'default':
  112.            <dtml-var description default=''>
  113.        In this case, it would use '' if the value was null or if the
  114.        variable was missing.
  115.     String manipulation
  116.        A number of special attributes are provided to transform the
  117.        value after formatting has been applied.  These parameters
  118.        are supplied without arguments.
  119.        'lower' --  cause all upper-case letters to be converted to lower case. 
  120.        'upper' --  cause all upper-case letters to be converted to lower case. 
  121.        'capitalize' -- cause the first character of the inserted value
  122.        to be converted to upper case. 
  123.        'spacify' -- cause underscores in the inserted value to be
  124.        converted to spaces.
  125.        'thousands_commas' -- cause commas to be inserted every three
  126.        digits to the left of a decimal point in values containing
  127.        numbers.  For example, the value, "12000 widgets" becomes
  128.        "12,000 widgets".
  129.        'html_quote' -- convert characters that have special meaning
  130.        in HTML to HTML character entities.
  131.        'url_quote' -- convert characters that have special meaning
  132.        in URLS to HTML character entities using decimal values.
  133.        'url_quote_plus' -- like url_quote but also replace blank
  134.        space characters with '+'. This is needed for building
  135.        query strings in some cases.
  136.        'sql_quote' -- Convert single quotes to pairs of single
  137.        quotes. This is needed to safely include values in
  138.        Standard Query Language (SQL) strings.
  139.        'newline_to_br' -- Convert newlines and carriage-return and
  140.        newline combinations to break tags.
  141.        'url' -- Get the absolute URL of the object by calling it's
  142.        'absolute_url' method, if it has one.
  143.     Truncation
  144.        The attributes 'size' and 'etc'  can be used to truncate long
  145.        strings.  If the 'size' attribute is specified, the string to
  146.        be inserted is truncated at the given length.  If a space
  147.        occurs in the second half of the truncated string, then the
  148.        string is further truncated to the right-most space.  After
  149.        truncation, the value given for the 'etc' attribute is added to
  150.        the string.  If the 'etc' attribute is not provided, then '...'
  151.        is used.  For example, if the value of spam is
  152.        '"blah blah blah blah"', then the tag       
  153.        '<!--#var spam size=10-->' inserts '"blah blah ..."'.
  154. Evaluating expressions without rendering results
  155.    A 'call' tag is provided for evaluating named objects or expressions
  156.    without rendering the result.
  157.    
  158. ''' # '
  159. __rcs_id__='$Id: DT_Var.py,v 1.34.4.1 1999/12/13 18:14:51 jim Exp $'
  160. __version__='$Revision: 1.34.4.1 $'[11:-2]
  161. from DT_Util import parse_params, name_param, html_quote, str
  162. import regex, string, sys, regex
  163. from string import find, split, join, atoi, rfind
  164. from urllib import quote, quote_plus
  165. class Var: 
  166.     name='var'
  167.     expr=None
  168.     def __init__(self, args, fmt='s'):
  169.         if args[:4]=='var ': args=args[4:]
  170.         args = parse_params(args, name='', lower=1, upper=1, expr='',
  171.                             capitalize=1, spacify=1, null='', fmt='s',
  172.                             size=0, etc='...', thousands_commas=1,
  173.                             html_quote=1, url_quote=1, sql_quote=1,
  174.                             url_quote_plus=1, missing='',
  175.                             newline_to_br=1, url=1)
  176.         self.args=args
  177.         
  178.         self.modifiers=tuple(
  179.             map(lambda t: t[1],
  180.                 filter(lambda m, args=args, used=args.has_key:
  181.                        used(m[0]) and args[m[0]],
  182.                        modifiers)))
  183.         name, expr = name_param(args,'var',1)
  184.         self.__name__, self.expr = name, expr
  185.         self.fmt = fmt
  186.         if len(args)==1 and fmt=='s':
  187.             if expr is None: expr=name
  188.             else: expr=expr.eval
  189.             self.simple_form=expr,
  190.     def render(self, md):
  191.         args=self.args
  192.         have_arg=args.has_key
  193.         name=self.__name__
  194.         val=self.expr
  195.         if val is None:
  196.             if md.has_key(name):
  197.                 if have_arg('url'):
  198.                     val=md.getitem(name,0)
  199.                     val=val.absolute_url()
  200.                 else:
  201.                     val = md[name]
  202.             else:
  203.                 if have_arg('missing'):
  204.                     return args['missing']
  205.                 else:
  206.                     raise KeyError, name
  207.         else:
  208.             val=val.eval(md)
  209.             if have_arg('url'): val=val.absolute_url()
  210.         __traceback_info__=name, val, args
  211.         if val is None and have_arg('null'):
  212.             # Treat None as special case wrt null
  213.             return args['null']
  214.             
  215.         # handle special formats defined using fmt= first
  216.         if have_arg('fmt'):
  217.             fmt=args['fmt']
  218.             if have_arg('null') and not val and val != 0:
  219.                 try:
  220.                     if hasattr(val, fmt):
  221.                         val = getattr(val,fmt)()
  222.                     elif special_formats.has_key(fmt):
  223.                         val = special_formats[fmt](val, name, md)
  224.                     elif fmt=='': val=''
  225.                     else: val = fmt % val
  226.                 except:
  227.                     t, v= sys.exc_type, sys.exc_value
  228.                     if hasattr(sys, 'exc_info'): t, v = sys.exc_info()[:2]
  229.                     if val is None or not str(val): return args['null']
  230.                     raise t, v
  231.             else:
  232.                 # We duplicate the code here to avoid exception handler
  233.                 # which tends to screw up stack or leak
  234.                 if hasattr(val, fmt):
  235.                     val = getattr(val,fmt)()
  236.                 elif special_formats.has_key(fmt):
  237.                     val = special_formats[fmt](val, name, md)
  238.                 elif fmt=='': val=''
  239.                 else: val = fmt % val
  240.         # finally, pump it through the actual string format...
  241.         fmt=self.fmt
  242.         if fmt=='s': val=str(val)
  243.         else: val = ('%'+self.fmt) % (val,)
  244.         # next, look for upper, lower, etc
  245.         for f in self.modifiers: val=f(val)
  246.         if have_arg('size'):
  247.             size=args['size']
  248.             try: size=atoi(size)
  249.             except: raise 'Document Error',(
  250.                 '''a <code>size</code> attribute was used in a <code>var</code>
  251.                 tag with a non-integer value.''')
  252.             if len(val) > size:
  253.                 val=val[:size]
  254.                 l=rfind(val,' ')
  255.                 if l > size/2:
  256.                     val=val[:l+1]
  257.                 if have_arg('etc'): l=args['etc']
  258.                 else: l='...'
  259.                 val=val+l
  260.         return val
  261.     __call__=render
  262. class Call: 
  263.     name='call'
  264.     expr=None
  265.     def __init__(self, args):
  266.         args = parse_params(args, name='', expr='')
  267.         name, expr = name_param(args,'call',1)
  268.         if expr is None: expr=name
  269.         else: expr=expr.eval
  270.         self.simple_form=expr,None
  271. def url_quote(v, name='(Unknown name)', md={}):
  272.     return quote(str(v))
  273. def url_quote_plus(v, name='(Unknown name)', md={}):
  274.     return quote_plus(str(v))
  275. def newline_to_br(v, name='(Unknown name)', md={}):
  276.     v=str(v)
  277.     if find(v,'r') >= 0: v=join(split(v,'r'),'')
  278.     if find(v,'n') >= 0: v=join(split(v,'n'),'<br>n')
  279.     return v
  280. def whole_dollars(v, name='(Unknown name)', md={}):
  281.     try: return "$%d" % v
  282.     except: return ''
  283. def dollars_and_cents(v, name='(Unknown name)', md={}):
  284.     try: return "$%.2f" % v
  285.     except: return ''
  286. def thousands_commas(v, name='(Unknown name)', md={},
  287.                      thou=regex.compile(
  288.                          "([0-9])([0-9][0-9][0-9]([,.]|$))").search):
  289.     v=str(v)
  290.     vl=split(v,'.')
  291.     if not vl: return v
  292.     v=vl[0]
  293.     del vl[0]
  294.     if vl: s='.'+join(vl,'.')
  295.     else: s=''
  296.     l=thou(v)
  297.     while l >= 0:
  298.         v=v[:l+1]+','+v[l+1:]
  299.         l=thou(v)
  300.     return v+s
  301.     
  302. def whole_dollars_with_commas(v, name='(Unknown name)', md={}):
  303.     try: v= "$%d" % v
  304.     except: v=''
  305.     return thousands_commas(v)
  306. def dollars_and_cents_with_commas(v, name='(Unknown name)', md={}):
  307.     try: v= "$%.2f" % v
  308.     except: v= ''
  309.     return thousands_commas(v)
  310. def len_format(v, name='(Unknown name)', md={}):
  311.     return str(len(v))
  312. def len_comma(v, name='(Unknown name)', md={}):
  313.     return thousands_commas(str(len(v)))
  314. StructuredText=None
  315. def structured_text(v, name='(Unknown name)', md={}):
  316.     global StructuredText
  317.     if StructuredText is None: import StructuredText
  318.     return str(StructuredText.html_with_references(str(v), 3))
  319. def sql_quote(v, name='(Unknown name)', md={}):
  320.     """Quote single quotes in a string by doubling them.
  321.     This is needed to securely insert values into sql
  322.     string literals in templates that generate sql.
  323.     """
  324.     if find(v,"'") >= 0: return join(split(v,"'"),"''")
  325.     return v
  326. special_formats={
  327.     'whole-dollars': whole_dollars,
  328.     'dollars-and-cents': dollars_and_cents,
  329.     'collection-length': len_format,
  330.     'structured-text': structured_text,
  331.     # The rest are depricated:
  332.     'sql-quote': sql_quote,
  333.     'html-quote': html_quote,
  334.     'url-quote': url_quote,
  335.     'url-quote-plus': url_quote_plus,
  336.     'multi-line': newline_to_br,
  337.     'comma-numeric': thousands_commas,
  338.     'dollars-with-commas': whole_dollars_with_commas,
  339.     'dollars-and-cents-with-commas': dollars_and_cents_with_commas,
  340.     }
  341. def spacify(val):
  342.     if find(val,'_') >= 0: val=join(split(val,'_'))
  343.     return val
  344. modifiers=(html_quote, url_quote, url_quote_plus, newline_to_br,
  345.            string.lower, string.upper, string.capitalize, spacify,
  346.            thousands_commas, sql_quote)
  347. modifiers=map(lambda f: (f.__name__, f), modifiers)
  348. class Comment:
  349.     '''Comments
  350.     The 'comment' tag can be used to simply include comments
  351.     in DTML source.
  352.     
  353.     For example::
  354.     
  355.       <!--#comment-->
  356.       
  357.         This text is not rendered.
  358.       <!--#/comment-->
  359.     ''' 
  360.     name='comment'
  361.     blockContinuations=()
  362.     def __init__(self, args, fmt=''): pass
  363.     def render(self, md):
  364.         return ''
  365.     __call__=render