a6fd6b1ded
This patch include the usage of portalocker for Windows environments, because fcntl is not available. This patch is related to issue #37, issue 1.
279 lines
9.7 KiB
Python
279 lines
9.7 KiB
Python
# imaplib utilities
|
|
# Copyright (C) 2002-2016 John Goerzen & contributors
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
import datetime
|
|
import os
|
|
import time
|
|
import subprocess
|
|
import threading
|
|
import socket
|
|
import errno
|
|
import zlib
|
|
from sys import exc_info
|
|
from hashlib import sha512, sha384, sha256, sha224, sha1
|
|
import rfc6555
|
|
from offlineimap import OfflineImapError
|
|
from offlineimap.ui import getglobalui
|
|
from imaplib2 import IMAP4, IMAP4_SSL, InternalDate
|
|
|
|
try:
|
|
import portalocker
|
|
except:
|
|
try:
|
|
import fcntl
|
|
except:
|
|
pass # Ok if this fails, we can do without.
|
|
|
|
|
|
class UsefulIMAPMixIn:
|
|
def __getselectedfolder(self):
|
|
if self.state == 'SELECTED':
|
|
return self.mailbox
|
|
return None
|
|
|
|
def select(self, mailbox='INBOX', readonly=False, force=False):
|
|
"""Selects a mailbox on the IMAP server
|
|
|
|
:returns: 'OK' on success, nothing if the folder was already
|
|
selected or raises an :exc:`OfflineImapError`."""
|
|
|
|
if self.__getselectedfolder() == mailbox and \
|
|
self.is_readonly == readonly and \
|
|
not force:
|
|
# No change; return.
|
|
return
|
|
try:
|
|
result = super(UsefulIMAPMixIn, self).select(mailbox, readonly)
|
|
except self.readonly as e:
|
|
# pass self.readonly to our callers
|
|
raise
|
|
except self.abort as e:
|
|
# self.abort is raised when we are supposed to retry
|
|
errstr = "Server '%s' closed connection, error on SELECT '%s'. Ser" \
|
|
"ver said: %s" % (self.host, mailbox, e.args[0])
|
|
severity = OfflineImapError.ERROR.FOLDER_RETRY
|
|
raise OfflineImapError(errstr, severity, exc_info()[2])
|
|
|
|
if result[0] != 'OK':
|
|
# in case of error, bail out with OfflineImapError
|
|
errstr = "Error SELECTing mailbox '%s', server reply:\n%s" % \
|
|
(mailbox, result)
|
|
severity = OfflineImapError.ERROR.FOLDER
|
|
raise OfflineImapError(errstr, severity)
|
|
return result
|
|
|
|
# Overrides private function from IMAP4 (@imaplib2)
|
|
def _mesg(self, s, tn=None, secs=None):
|
|
new_mesg(self, s, tn, secs)
|
|
|
|
# Overrides private function from IMAP4 (@imaplib2)
|
|
def open_socket(self):
|
|
"""open_socket()
|
|
Open socket choosing first address family available."""
|
|
if self.af == socket.AF_UNSPEC:
|
|
# happy-eyeballs!
|
|
return rfc6555.create_connection((self.host, self.port))
|
|
else:
|
|
return self._open_socket_for_af(self.af)
|
|
|
|
def _open_socket_for_af(self, af):
|
|
msg = (-1, 'could not open socket')
|
|
for res in socket.getaddrinfo(self.host, self.port, af, socket.SOCK_STREAM):
|
|
af, socktype, proto, canonname, sa = res
|
|
try:
|
|
# use socket of our own, possiblly socksified socket.
|
|
s = self.socket(af, socktype, proto)
|
|
except socket.error as msg:
|
|
continue
|
|
try:
|
|
for i in (0, 1):
|
|
try:
|
|
s.connect(sa)
|
|
break
|
|
except socket.error as msg:
|
|
if len(msg.args) < 2 or msg.args[0] != errno.EINTR:
|
|
raise
|
|
else:
|
|
raise socket.error(msg)
|
|
except socket.error as msg:
|
|
s.close()
|
|
continue
|
|
break
|
|
else:
|
|
raise socket.error(msg)
|
|
|
|
return s
|
|
|
|
|
|
class IMAP4_Tunnel(UsefulIMAPMixIn, IMAP4):
|
|
"""IMAP4 client class over a tunnel
|
|
|
|
Instantiate with: IMAP4_Tunnel(tunnelcmd)
|
|
|
|
tunnelcmd -- shell command to generate the tunnel.
|
|
The result will be in PREAUTH stage."""
|
|
|
|
def __init__(self, tunnelcmd, **kwargs):
|
|
if "use_socket" in kwargs:
|
|
self.socket = kwargs['use_socket']
|
|
del kwargs['use_socket']
|
|
IMAP4.__init__(self, tunnelcmd, **kwargs)
|
|
|
|
def open(self, host, port):
|
|
"""The tunnelcmd comes in on host!"""
|
|
|
|
self.host = host
|
|
self.process = subprocess.Popen(host, shell=True, close_fds=True,
|
|
stdin=subprocess.PIPE, stdout=subprocess.PIPE)
|
|
(self.outfd, self.infd) = (self.process.stdin, self.process.stdout)
|
|
# imaplib2 polls on this fd
|
|
self.read_fd = self.infd.fileno()
|
|
|
|
self.set_nonblocking(self.read_fd)
|
|
|
|
def set_nonblocking(self, fd):
|
|
"""Mark fd as nonblocking"""
|
|
|
|
# get the file's current flag settings
|
|
fl = fcntl.fcntl(fd, fcntl.F_GETFL)
|
|
# clear non-blocking mode from flags
|
|
fl = fl & ~os.O_NONBLOCK
|
|
fcntl.fcntl(fd, fcntl.F_SETFL, fl)
|
|
|
|
def read(self, size):
|
|
"""data = read(size)
|
|
Read at most 'size' bytes from remote."""
|
|
|
|
if self.decompressor is None:
|
|
return os.read(self.read_fd, size)
|
|
|
|
if self.decompressor.unconsumed_tail:
|
|
data = self.decompressor.unconsumed_tail
|
|
else:
|
|
data = os.read(self.read_fd, 8192)
|
|
|
|
return self.decompressor.decompress(data, size)
|
|
|
|
def send(self, data):
|
|
if self.compressor is not None:
|
|
data = self.compressor.compress(data)
|
|
data += self.compressor.flush(zlib.Z_SYNC_FLUSH)
|
|
self.outfd.write(data)
|
|
self.outfd.flush()
|
|
|
|
def shutdown(self):
|
|
self.infd.close()
|
|
self.outfd.close()
|
|
self.process.wait()
|
|
|
|
|
|
def new_mesg(self, s, tn=None, secs=None):
|
|
if secs is None:
|
|
secs = time.time()
|
|
if tn is None:
|
|
tn = threading.currentThread().getName()
|
|
tm = time.strftime('%M:%S', time.localtime(secs))
|
|
getglobalui().debug('imap', ' %s.%02d %s %s' % (tm, (secs * 100) % 100, tn, s))
|
|
|
|
|
|
class WrappedIMAP4_SSL(UsefulIMAPMixIn, IMAP4_SSL):
|
|
"""Improved version of imaplib.IMAP4_SSL overriding select()."""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
if "af" in kwargs:
|
|
self.af = kwargs['af']
|
|
del kwargs['af']
|
|
if "use_socket" in kwargs:
|
|
self.socket = kwargs['use_socket']
|
|
del kwargs['use_socket']
|
|
self._fingerprint = kwargs.get('fingerprint', None)
|
|
if type(self._fingerprint) != type([]):
|
|
self._fingerprint = [self._fingerprint]
|
|
if 'fingerprint' in kwargs:
|
|
del kwargs['fingerprint']
|
|
super(WrappedIMAP4_SSL, self).__init__(*args, **kwargs)
|
|
|
|
def open(self, host=None, port=None):
|
|
if not self.ca_certs and not self._fingerprint:
|
|
raise OfflineImapError("No CA certificates "
|
|
"and no server fingerprints configured. "
|
|
"You must configure at least something, otherwise "
|
|
"having SSL helps nothing.", OfflineImapError.ERROR.REPO)
|
|
super(WrappedIMAP4_SSL, self).open(host, port)
|
|
if self._fingerprint:
|
|
server_cert = self.sock.getpeercert(True)
|
|
hashes = sha512, sha384, sha256, sha224, sha1
|
|
server_fingerprints = [my_hash(server_cert).hexdigest() for my_hash in hashes]
|
|
# compare fingerprints
|
|
matches = [(server_fingerprint in self._fingerprint) for server_fingerprint in server_fingerprints]
|
|
if not any(matches):
|
|
raise OfflineImapError("Server SSL fingerprint(s) '%s' "
|
|
"for hostname '%s' "
|
|
"does not match configured fingerprint(s) %s. "
|
|
"Please verify and set 'cert_fingerprint' accordingly "
|
|
"if not set yet." %
|
|
(list(zip([my_hash.__name__ for my_hash in hashes], server_fingerprints)), host,
|
|
self._fingerprint),
|
|
OfflineImapError.ERROR.REPO)
|
|
|
|
|
|
class WrappedIMAP4(UsefulIMAPMixIn, IMAP4):
|
|
"""Improved version of imaplib.IMAP4 overriding select()."""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
if "af" in kwargs:
|
|
self.af = kwargs['af']
|
|
del kwargs['af']
|
|
if "use_socket" in kwargs:
|
|
self.socket = kwargs['use_socket']
|
|
del kwargs['use_socket']
|
|
IMAP4.__init__(self, *args, **kwargs)
|
|
|
|
|
|
def Internaldate2epoch(resp):
|
|
"""Convert IMAP4 INTERNALDATE to UT.
|
|
|
|
Returns seconds since the epoch."""
|
|
|
|
from calendar import timegm
|
|
|
|
mo = InternalDate.match(resp)
|
|
if not mo:
|
|
return None
|
|
|
|
# Get the month number
|
|
datetime_object = datetime.datetime.strptime(mo.group('mon').decode('utf-8'), "%b")
|
|
mon = datetime_object.month
|
|
|
|
zonen = mo.group('zonen')
|
|
|
|
day = int(mo.group('day'))
|
|
year = int(mo.group('year'))
|
|
hour = int(mo.group('hour'))
|
|
minu = int(mo.group('min'))
|
|
sec = int(mo.group('sec'))
|
|
zoneh = int(mo.group('zoneh'))
|
|
zonem = int(mo.group('zonem'))
|
|
|
|
# INTERNALDATE timezone must be subtracted to get UT
|
|
|
|
zone = (zoneh * 60 + zonem) * 60
|
|
if zonen == '-':
|
|
zone = -zone
|
|
|
|
tt = (year, mon, day, hour, minu, sec, -1, -1, -1)
|
|
|
|
return timegm(tt) - zone
|