code.delx.au - offlineimap/blob - offlineimap/imaplibutil.py

   1 # imaplib
   2 # Copyright (C) 2002-2007 John Goerzen
   3 # <jgoerzen@complete.org>
   4 #
   5 #    This program is free software; you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License as published by
   7 #    the Free Software Foundation; either version 2 of the License, or
   8 #    (at your option) any later version.
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program; if not, write to the Free Software
  17 #    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18
  19 import re, string, types, binascii, socket, time, random, subprocess, sys, os
  20 from offlineimap.ui import UIBase
  21 from imaplib import *
  22
  23 class IMAP4_Tunnel(IMAP4):
  24     """IMAP4 client class over a tunnel
  25
  26     Instantiate with: IMAP4_Tunnel(tunnelcmd)
  27
  28     tunnelcmd -- shell command to generate the tunnel.
  29     The result will be in PREAUTH stage."""
  30
  31     def __init__(self, tunnelcmd):
  32         IMAP4.__init__(self, tunnelcmd)
  33
  34     def open(self, host, port):
  35         """The tunnelcmd comes in on host!"""
  36         self.process = subprocess.Popen(host, shell=True, close_fds=True,
  37                         stdin=subprocess.PIPE, stdout=subprocess.PIPE)
  38         (self.outfd, self.infd) = (self.process.stdin, self.process.stdout)
  39
  40     def read(self, size):
  41         retval = ''
  42         while len(retval) < size:
  43             retval += self.infd.read(size - len(retval))
  44         return retval
  45
  46     def readline(self):
  47         return self.infd.readline()
  48
  49     def send(self, data):
  50         self.outfd.write(data)
  51
  52     def shutdown(self):
  53         self.infd.close()
  54         self.outfd.close()
  55         self.process.wait()
  56
  57 class sslwrapper:
  58     def __init__(self, sslsock):
  59         self.sslsock = sslsock
  60         self.readbuf = ''
  61
  62     def write(self, s):
  63         return self.sslsock.write(s)
  64
  65     def _read(self, n):
  66         return self.sslsock.read(n)
  67
  68     def read(self, n):
  69         if len(self.readbuf):
  70             # Return the stuff in readbuf, even if less than n.
  71             # It might contain the rest of the line, and if we try to
  72             # read more, might block waiting for data that is not
  73             # coming to arrive.
  74             bytesfrombuf = min(n, len(self.readbuf))
  75             retval = self.readbuf[:bytesfrombuf]
  76             self.readbuf = self.readbuf[bytesfrombuf:]
  77             return retval
  78         retval = self._read(n)
  79         if len(retval) > n:
  80             self.readbuf = retval[n:]
  81             return retval[:n]
  82         return retval
  83
  84     def readline(self):
  85         retval = ''
  86         while 1:
  87             linebuf = self.read(1024)
  88             nlindex = linebuf.find("\n")
  89             if nlindex != -1:
  90                 retval += linebuf[:nlindex + 1]
  91                 self.readbuf = linebuf[nlindex + 1:] + self.readbuf
  92                 return retval
  93             else:
  94                 retval += linebuf
  95
  96 def new_mesg(self, s, secs=None):
  97             if secs is None:
  98                 secs = time.time()
  99             tm = time.strftime('%M:%S', time.localtime(secs))
 100             UIBase.getglobalui().debug('imap', '  %s.%02d %s' % (tm, (secs*100)%100, s))
 101
 102 def new_open(self, host = '', port = IMAP4_PORT):
 103         """Setup connection to remote server on "host:port"
 104             (default: localhost:standard IMAP4 port).
 105         This connection will be used by the routines:
 106             read, readline, send, shutdown.
 107         """
 108         self.host = host
 109         self.port = port
 110         res = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
 111                                  socket.SOCK_STREAM)
 112         self.sock = socket.socket(af, socktype, proto)
 113
 114         # Try each address returned by getaddrinfo in turn until we
 115         # manage to connect to one.
 116         # Try all the addresses in turn until we connect()
 117         last_error = 0
 118         for remote in res:
 119             af, socktype, proto, canonname, sa = remote
 120             self.sock = socket.socket(af, socktype, proto)
 121             last_error = self.sock.connect_ex(sa)
 122             if last_error == 0:
 123                 break
 124             else:
 125                 self.sock.close()
 126         if last_error != 0:
 127             # FIXME
 128             raise socket.error(last_error)
 129         self.file = self.sock.makefile('rb')
 130
 131 def new_open_ssl(self, host = '', port = IMAP4_SSL_PORT):
 132         """Setup connection to remote server on "host:port".
 133             (default: localhost:standard IMAP4 SSL port).
 134         This connection will be used by the routines:
 135             read, readline, send, shutdown.
 136         """
 137         self.host = host
 138         self.port = port
 139         #This connects to the first ip found ipv4/ipv6
 140         #Added by Adriaan Peeters <apeeters@lashout.net> based on a socket
 141         #example from the python documentation:
 142         #http://www.python.org/doc/lib/socket-example.html
 143         res = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
 144                                  socket.SOCK_STREAM)
 145         # Try all the addresses in turn until we connect()
 146         last_error = 0
 147         for remote in res:
 148             af, socktype, proto, canonname, sa = remote
 149             self.sock = socket.socket(af, socktype, proto)
 150             last_error = self.sock.connect_ex(sa)
 151             if last_error == 0:
 152                 break
 153             else:
 154                 self.sock.close()
 155         if last_error != 0:
 156             # FIXME
 157             raise socket.error(last_error)
 158         if sys.version_info[0] <= 2 and sys.version_info[1] <= 2:
 159             self.sslobj = socket.ssl(self.sock, self.keyfile, self.certfile)
 160         else:
 161             self.sslobj = socket.ssl(self.sock._sock, self.keyfile, self.certfile)
 162         self.sslobj = sslwrapper(self.sslobj)
 163
 164 mustquote = re.compile(r"[^\w!#$%&'+,.:;<=>?^`|~-]")
 165
 166 def Internaldate2epoch(resp):
 167     """Convert IMAP4 INTERNALDATE to UT.
 168
 169     Returns seconds since the epoch.
 170     """
 171
 172     mo = InternalDate.match(resp)
 173     if not mo:
 174         return None
 175
 176     mon = Mon2num[mo.group('mon')]
 177     zonen = mo.group('zonen')
 178
 179     day = int(mo.group('day'))
 180     year = int(mo.group('year'))
 181     hour = int(mo.group('hour'))
 182     min = int(mo.group('min'))
 183     sec = int(mo.group('sec'))
 184     zoneh = int(mo.group('zoneh'))
 185     zonem = int(mo.group('zonem'))
 186
 187     # INTERNALDATE timezone must be subtracted to get UT
 188
 189     zone = (zoneh*60 + zonem)*60
 190     if zonen == '-':
 191         zone = -zone
 192
 193     tt = (year, mon, day, hour, min, sec, -1, -1, -1)
 194
 195     return time.mktime(tt)