[PATCH] Allow to specify remote hostname even for the Gmail case
Sebastian Spaeth
Sebastian at SSpaeth.de
Thu May 19 19:56:40 UTC 2011
Previously we hard-coded the imap server name in the case of Gmail
repositories, but often we need a different host name. So, allow people
to specify the hostname via the regular "remotehosteval" and
"remotehost" settings, and only falling back to imap.gmail.com when
nothing has been specified.
Rename the gethost() function to the more modern pythonic get_host() and
cache the hostname, so we don't evaluate the whole thing each time we
query the host name.
Make the remotehosteval processing more robust, by catching any
Exceptions that occur, and throw a OfflineImapError, that explains where
exactly the error had occured. You can test this, e.g. by setting
remotehosteval to 1/"n" or some other invalid expression.
The whole IMAP.get_host() function has been documented code wise while
going through.
Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
---
This patch is a bit larger that strictly necessary, as it cleans up a whole
bunch and makes it more robust, throwing nicer errors in case of invalid
remotehosteval expressions. Patch is against "next" branch.
offlineimap/imapserver.py | 2 +-
offlineimap/repository/Base.py | 2 +-
offlineimap/repository/Gmail.py | 17 ++++++++++-----
offlineimap/repository/IMAP.py | 41 ++++++++++++++++++++++++++------------
4 files changed, 41 insertions(+), 21 deletions(-)
diff --git a/offlineimap/imapserver.py b/offlineimap/imapserver.py
index 7703879..f8e4045 100644
--- a/offlineimap/imapserver.py
+++ b/offlineimap/imapserver.py
@@ -378,7 +378,7 @@ class ConfigedIMAPServer(IMAPServer):
self.config = self.repos.getconfig()
usetunnel = self.repos.getpreauthtunnel()
if not usetunnel:
- host = self.repos.gethost()
+ host = self.repos.get_host()
user = self.repos.getuser()
port = self.repos.getport()
ssl = self.repos.getssl()
diff --git a/offlineimap/repository/Base.py b/offlineimap/repository/Base.py
index 594f864..34f2f4a 100644
--- a/offlineimap/repository/Base.py
+++ b/offlineimap/repository/Base.py
@@ -21,7 +21,7 @@ import traceback
from offlineimap import CustomConfig
from offlineimap.ui import getglobalui
-class BaseRepository(CustomConfig.ConfigHelperMixin):
+class BaseRepository(object, CustomConfig.ConfigHelperMixin):
def __init__(self, reposname, account):
self.ui = getglobalui()
self.account = account
diff --git a/offlineimap/repository/Gmail.py b/offlineimap/repository/Gmail.py
index 97637b8..2f2a73e 100644
--- a/offlineimap/repository/Gmail.py
+++ b/offlineimap/repository/Gmail.py
@@ -33,16 +33,21 @@ class GmailRepository(IMAPRepository):
def __init__(self, reposname, account):
"""Initialize a GmailRepository object."""
- account.getconfig().set('Repository ' + reposname,
- 'remotehost', GmailRepository.HOSTNAME)
- account.getconfig().set('Repository ' + reposname,
- 'remoteport', GmailRepository.PORT)
+ # Enforce SSL usage
account.getconfig().set('Repository ' + reposname,
'ssl', 'yes')
IMAPRepository.__init__(self, reposname, account)
- def gethost(self):
- return GmailRepository.HOSTNAME
+ def get_host(self):
+ """Return the server name to connect to.
+
+ Gmail implementation first checks for the usual IMAP settings
+ and falls back to imap.gmail.com if not specified."""
+ host = super(GmailRepository, self).get_host()
+ if host:
+ return host
+ self._host = GmailRepository.HOSTNAME
+ return self._host
def getport(self):
return GmailRepository.PORT
diff --git a/offlineimap/repository/IMAP.py b/offlineimap/repository/IMAP.py
index 0bc84eb..d83e484 100644
--- a/offlineimap/repository/IMAP.py
+++ b/offlineimap/repository/IMAP.py
@@ -17,7 +17,7 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
from offlineimap.repository.Base import BaseRepository
-from offlineimap import folder, imaputil, imapserver
+from offlineimap import folder, imaputil, imapserver, OfflineImapError
from offlineimap.folder.UIDMaps import MappedIMAPFolder
from offlineimap.threadutil import ExitNotifyThread
from threading import Event
@@ -32,6 +32,7 @@ class IMAPRepository(BaseRepository):
"""Initialize an IMAPRepository object."""
BaseRepository.__init__(self, reposname, account)
# self.ui is being set by the BaseRepository
+ self._host = None
self.imapserver = imapserver.ConfigedIMAPServer(self)
self.folders = None
self.nametrans = lambda foldername: foldername
@@ -87,18 +88,32 @@ class IMAPRepository(BaseRepository):
def getsep(self):
return self.imapserver.delim
- def gethost(self):
- host = None
- localeval = self.localeval
+ def get_host(self):
+ """Return the hostname to connect to
+
+ :returns: hostname as string or None if none configured"""
+ if self._host: # use cached value if possible
+ return self._host
+ # 1) check for remotehosteval setting
if self.config.has_option(self.getsection(), 'remotehosteval'):
host = self.getconf('remotehosteval')
+ try:
+ host = self.localeval.eval(host)
+ except Exception, e:
+ raise OfflineImapError("remotehosteval option for repository "\
+ "'%s' failed:\n%s" % (self, e),
+ OfflineImapError.ERROR.REPO)
+ if host:
+ self._host = host
+ return self._host
+ # 2) check for plain remotehost setting
+ host = self.getconf('remotehost', None)
if host != None:
- return localeval.eval(host)
-
- host = self.getconf('remotehost')
- if host != None:
- return host
+ self._host = host
+ return self._host
+ # no success
+ return None
def getuser(self):
user = None
@@ -114,7 +129,7 @@ class IMAPRepository(BaseRepository):
return user
try:
- netrcentry = netrc.netrc().authenticators(self.gethost())
+ netrcentry = netrc.netrc().authenticators(self.get_host())
except IOError, inst:
if inst.errno != errno.ENOENT:
raise
@@ -123,7 +138,7 @@ class IMAPRepository(BaseRepository):
return netrcentry[0]
try:
- netrcentry = netrc.netrc('/etc/netrc').authenticators(self.gethost())
+ netrcentry = netrc.netrc('/etc/netrc').authenticators(self.get_host())
except IOError, inst:
if inst.errno != errno.ENOENT:
raise
@@ -200,7 +215,7 @@ class IMAPRepository(BaseRepository):
return password
# 4. read password from ~/.netrc
try:
- netrcentry = netrc.netrc().authenticators(self.gethost())
+ netrcentry = netrc.netrc().authenticators(self.get_host())
except IOError, inst:
if inst.errno != errno.ENOENT:
raise
@@ -211,7 +226,7 @@ class IMAPRepository(BaseRepository):
return netrcentry[2]
# 5. read password from /etc/netrc
try:
- netrcentry = netrc.netrc('/etc/netrc').authenticators(self.gethost())
+ netrcentry = netrc.netrc('/etc/netrc').authenticators(self.get_host())
except IOError, inst:
if inst.errno != errno.ENOENT:
raise
--
1.7.4.1
More information about the OfflineIMAP-project
mailing list