home *** CD-ROM | disk | FTP | other *** search
/ Freelog 116 / FreelogNo116-JuilletSeptembre2013.iso / Bureautique / gImageReader / gimagereader_0.9-1_win32.exe / bin / email / base64mime.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2011-03-24  |  5KB  |  148 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.7)
  3.  
  4. """Base64 content transfer encoding per RFCs 2045-2047.
  5.  
  6. This module handles the content transfer encoding method defined in RFC 2045
  7. to encode arbitrary 8-bit data using the three 8-bit bytes in four 7-bit
  8. characters encoding known as Base64.
  9.  
  10. It is used in the MIME standards for email to attach images, audio, and text
  11. using some 8-bit character sets to messages.
  12.  
  13. This module provides an interface to encode and decode both headers and bodies
  14. with Base64 encoding.
  15.  
  16. RFC 2045 defines a method for including character set information in an
  17. `encoded-word' in a header.  This method is commonly used for 8-bit real names
  18. in To:, From:, Cc:, etc. fields, as well as Subject: lines.
  19.  
  20. This module does not do the line wrapping or end-of-line character conversion
  21. necessary for proper internationalized headers; it only does dumb encoding and
  22. decoding.  To deal with the various line wrapping issues, use the email.header
  23. module.
  24. """
  25. __all__ = [
  26.     'base64_len',
  27.     'body_decode',
  28.     'body_encode',
  29.     'decode',
  30.     'decodestring',
  31.     'encode',
  32.     'encodestring',
  33.     'header_encode']
  34. from binascii import b2a_base64, a2b_base64
  35. from email.utils import fix_eols
  36. CRLF = '\r\n'
  37. NL = '\n'
  38. EMPTYSTRING = ''
  39. MISC_LEN = 7
  40.  
  41. def base64_len(s):
  42.     '''Return the length of s when it is encoded with base64.'''
  43.     (groups_of_3, leftover) = divmod(len(s), 3)
  44.     n = groups_of_3 * 4
  45.     if leftover:
  46.         n += 4
  47.     return n
  48.  
  49.  
  50. def header_encode(header, charset = 'iso-8859-1', keep_eols = False, maxlinelen = 76, eol = NL):
  51.     '''Encode a single header line with Base64 encoding in a given charset.
  52.  
  53.     Defined in RFC 2045, this Base64 encoding is identical to normal Base64
  54.     encoding, except that each line must be intelligently wrapped (respecting
  55.     the Base64 encoding), and subsequent lines must start with a space.
  56.  
  57.     charset names the character set to use to encode the header.  It defaults
  58.     to iso-8859-1.
  59.  
  60.     End-of-line characters (\\r, \\n, \\r\\n) will be automatically converted
  61.     to the canonical email line separator \\r\\n unless the keep_eols
  62.     parameter is True (the default is False).
  63.  
  64.     Each line of the header will be terminated in the value of eol, which
  65.     defaults to "\\n".  Set this to "\\r\\n" if you are using the result of
  66.     this function directly in email.
  67.  
  68.     The resulting string will be in the form:
  69.  
  70.     "=?charset?b?WW/5ciBtYXp66XLrIHf8eiBhIGhhbXBzdGHuciBBIFlv+XIgbWF6euly?=\\n
  71.       =?charset?b?6yB3/HogYSBoYW1wc3Rh7nIgQkMgWW/5ciBtYXp66XLrIHf8eiBhIGhh?="
  72.  
  73.     with each line wrapped at, at most, maxlinelen characters (defaults to 76
  74.     characters).
  75.     '''
  76.     if not header:
  77.         return header
  78.     if not None:
  79.         header = fix_eols(header)
  80.     base64ed = []
  81.     max_encoded = maxlinelen - len(charset) - MISC_LEN
  82.     max_unencoded = max_encoded * 3 // 4
  83.     for i in range(0, len(header), max_unencoded):
  84.         base64ed.append(b2a_base64(header[i:i + max_unencoded]))
  85.     
  86.     lines = []
  87.     for line in base64ed:
  88.         if line.endswith(NL):
  89.             line = line[:-1]
  90.         lines.append('=?%s?b?%s?=' % (charset, line))
  91.     
  92.     joiner = eol + ' '
  93.     return joiner.join(lines)
  94.  
  95.  
  96. def encode(s, binary = True, maxlinelen = 76, eol = NL):
  97.     '''Encode a string with base64.
  98.  
  99.     Each line will be wrapped at, at most, maxlinelen characters (defaults to
  100.     76 characters).
  101.  
  102.     If binary is False, end-of-line characters will be converted to the
  103.     canonical email end-of-line sequence \\r\\n.  Otherwise they will be left
  104.     verbatim (this is the default).
  105.  
  106.     Each line of encoded text will end with eol, which defaults to "\\n".  Set
  107.     this to "\r
  108. " if you will be using the result of this function directly
  109.     in an email.
  110.     '''
  111.     if not s:
  112.         return s
  113.     if not None:
  114.         s = fix_eols(s)
  115.     encvec = []
  116.     max_unencoded = maxlinelen * 3 // 4
  117.     for i in range(0, len(s), max_unencoded):
  118.         enc = b2a_base64(s[i:i + max_unencoded])
  119.         if enc.endswith(NL) and eol != NL:
  120.             enc = enc[:-1] + eol
  121.         encvec.append(enc)
  122.     
  123.     return EMPTYSTRING.join(encvec)
  124.  
  125. body_encode = encode
  126. encodestring = encode
  127.  
  128. def decode(s, convert_eols = None):
  129.     '''Decode a raw base64 string.
  130.  
  131.     If convert_eols is set to a string value, all canonical email linefeeds,
  132.     e.g. "\\r\\n", in the decoded text will be converted to the value of
  133.     convert_eols.  os.linesep is a good choice for convert_eols if you are
  134.     decoding a text attachment.
  135.  
  136.     This function does not parse a full MIME header value encoded with
  137.     base64 (like =?iso-8895-1?b?bmloISBuaWgh?=) -- please use the high
  138.     level email.header class for that functionality.
  139.     '''
  140.     if not s:
  141.         return s
  142.     dec = None(s)
  143.     if convert_eols:
  144.         return dec.replace(CRLF, convert_eols)
  145.  
  146. body_decode = decode
  147. decodestring = decode
  148.