Added README.txt

6fa6ff2b · Michel Pelletier · 8d2ff751 · 6fa6ff2b · 6fa6ff2b · 6fa6ff2b
Commit 6fa6ff2b authored Apr 02, 1999 by Michel Pelletier
3 changed files
--- a/lib/python/Products/MIMETools/MIMETag.py
+++ b/lib/python/Products/MIMETools/MIMETag.py
+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+__rcs_id__='$Id: MIMETag.py,v 1.1 1999/04/02 16:47:24 michel Exp $'
+__version__='$Revision: 1.1 $'[11:-2]
+
+from DocumentTemplate.DT_Util import *
+from DocumentTemplate.DT_String import String
+from MimeWriter import MimeWriter
+from cStringIO import StringIO
+import string, mimetools
+
+MIMEError = "MIME Tag Error"
+
+class MIMETag:
+    '''
+    '''
+
+    name='mime'
+    blockContinuations=('boundary',)
+    encode=None
+
+    def __init__(self, blocks):
+        self.sections = []
+
+        for tname, args, section in blocks:
+            args = parse_params(args, type=None, disposition=None, encode=None)
+
+            has_key=args.has_key
+
+            if has_key('type'): 
+                type = args['type']
+            else:
+                type = 'application/octet-stream'
+
+            if has_key('disposition'):
+                disposition = args['disposition']
+            else:
+                disposition = ''
+
+            if has_key('encode'):
+                encode = args['encode']
+            else:
+                encode = 'base64'
+
+            if encode not in \
+            ('base64', 'quoted-printable', 'uuencode', 'x-uuencode',
+             'uue', 'x-uue', '7bit'):
+                raise MIMEError, (
+                    'An unsupported encoding was specified in tag')
+
+            self.sections.append((type, disposition, encode, section.blocks))
+
+
+    def render(self, md):
+        contents=[]
+        mw = MimeWriter(StringIO())
+        outer = mw.startmultipartbody('mixed')
+        for x in self.sections:
+            inner = mw.nextpart()
+            t, d, e, b = x
+
+            if d:
+                inner.addheader('Content-Disposition', d)
+
+            inner.addheader('Content-Transfer-Encoding', e)
+            innerfile = inner.startbody(t)
+            output = StringIO()
+            if e == '7bit':
+                innerfile.write(render_blocks(b, md))
+            else:
+                mimetools.encode(StringIO(render_blocks(b, md)), output,
+                             e)
+                output.seek(0)
+                innerfile.write(output.read())
+
+            if x is self.sections[-1]:
+                mw.lastpart()
+                  
+        outer.seek(0)
+        return outer.read()
+
+
+    __call__=render
+
+
+
+String.commands['mime'] = MIMETag
+
+
+
+
+
--- a/lib/python/Products/MIMETools/README.txt
+++ b/lib/python/Products/MIMETools/README.txt
+The MIMETools Product
+
+ The MIMETools product is alpha quality software.  It may not work as
+ documented or at all.  If you encounter bugs in MIMETools, please
+ report your problem to support@digicool.com or discuss it on the Zope 
+ mailing list, zope@zope.org.
+
+ Currently, the MIMETools product's only function is to provide the
+ <!--#mime--> DTML tag.
+
+ The <!--#mime--> tag is used to construct MIME containers.  The
+ syntax of the <!--#mime--> tag is:
+
+
+ <!--#mime [type=x, disposition=y, encode=z]-->
+
+  Contents of first part
+
+ <!--#boundary [type=x, disposition=y, encode=z]--> 
+
+  Contents of second part
+   
+ <!--#boundary [type=x, disposition=y, encode=z]--> 
+
+  Contents of nth part
+
+ <!--#/mime-->
+
+
+ The area of data between tags, called a block, is encoded into
+ whatever is specified with the 'encode' tag attribute for that block.
+ If no encoding is specified, 'base64' is defaulted.  Valid encoding
+ options include 'base64', 'quoted-printable', 'uuencode',
+ 'x-uuencode', 'uue' and 'x-uue'.  If the 'encode' attribute is set to
+ '7bit' no encoding is done on the block and the data is assumed to be
+ in a valid MIME format.
+
+ If the 'disposition' attribute is not specified for a certain block,
+ then the 'Content-Disposition:' MIME header is not included in that
+ block's MIME part.
+
+ The entire MIME container, from the opening mime tag to the closing,
+ has it's 'Content-Type:' MIME header set to 'multipart/mixed'.
+
+ For example, the following DTML:
+
+  <!--#mime encode=7bit type=text/plain-->
+  This is the first part.
+  <!--#boundary encode=base64 type=text/plain-->
+  This is the second.
+  <!--#/mime-->
+
+ Is rendered to the following text:
+
+  Content-Type: multipart/mixed;
+      boundary="216.164.72.30.501.1550.923070182.795.22531"
+
+
+  --216.164.72.30.501.1550.923070182.795.22531
+  Content-Type: text/plain
+  Content-Transfer-Encoding: 7bit
+
+  This is the first part.
+
+  --216.164.72.30.501.1550.923070182.795.22531
+  Content-Type: text/plain
+  Content-Transfer-Encoding: base64
+
+  VGhpcyBpcyB0aGUgc2Vjb25kLgo=
+
+  --216.164.72.30.501.1550.923070182.795.22531--
+
+
+ The #mime tag is particulary handy in conjunction with the #sendmail
+ tag.  This allows Zope to send attachments along with email.  Here is 
+ an example:
+
+  Create a DTML method called 'input' with the following code:
+
+    <!--#var standard_html_header-->
+    <form method=post action="send" ENCTYPE="multipart/form-data">
+    <input type=file name="afile"><br>
+    Send to:<input type=textbox name="who"><br>
+    <input type=submit value="Send">
+    </form>
+    <!--#var standard_html_footer-->
+
+
+  Create another DTML Method called 'send' with the following code:
+
+    <!--#var standard_html_header-->
+    <!--#sendmail smtphost=localhost -->
+    From: michel@digicool.com
+    To: <!--#var who-->
+    <!--#mime type=text/plain encode=7bit-->
+
+    Hi <!--#var who-->, someone sent you this attachment.
+
+    <!--#boundary type=application/octet-stream disposition=attachment 
+    encode=base64--><!--#var "afile.read()"--><!--#/mime-->
+
+    <!--#/sendmail-->
+
+    Mail with attachment was sent.
+    <!--#var standard_html_footer-->
+
+
+  Notice that there is no blank line between the 'To:' header and the
+  starting #mime tag.  If a blank line is inserted between them then
+  the message will not be interpreted as multipart by the recieving mailreader.
+
+  Also notice that there is no newline between the #boundary tag and
+  the #var tag, or the end of the #var tag and the closing #mime tag.
+  This is important, if you break the tags up with newlines then they
+  will be encoded and included in the MIME part, which is probably not
+  what you're after.
+
+  As per the MIME spec, #mime tags may be nested within #mime tags arbitrarily.
+
+
+
+
+
+
+
+
--- a/lib/python/Products/MIMETools/__init__.py
+++ b/lib/python/Products/MIMETools/__init__.py
+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+__doc__='''MIMETools Product Initialization
+$Id: __init__.py,v 1.1 1999/04/02 16:47:25 michel Exp $'''
+__version__='$Revision: 1.1 $'[11:-2]
+
+import MIMETag
+
+
+
+
+