2002-10-07 22:59:02 +02:00
|
|
|
# OfflineIMAP initialization code
|
2007-07-04 19:53:48 +02:00
|
|
|
# Copyright (C) 2002-2007 John Goerzen
|
2002-10-07 22:59:02 +02:00
|
|
|
# <jgoerzen@complete.org>
|
|
|
|
#
|
|
|
|
# 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
|
2003-04-16 21:23:45 +02:00
|
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
|
|
# (at your option) any later version.
|
2002-10-07 22:59:02 +02:00
|
|
|
#
|
|
|
|
# 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
|
2006-08-12 06:15:55 +02:00
|
|
|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
2002-10-07 22:59:02 +02:00
|
|
|
|
2011-01-10 12:12:42 +01:00
|
|
|
import os
|
|
|
|
import sys
|
|
|
|
import threading
|
2009-08-12 21:49:58 +02:00
|
|
|
import imaplib
|
Patch for signal handling to start a sync by Jim Pryor
Here's the way I'd like to use offlineimap on my laptop:
1. Have a regular cron job running infrequently. The cron job
checks to see
if I'm online, plugged in, and that no other copy of offlineimap is
running. If
all of these conditions are satisfied, it runs offlineimap just once:
"offlineimap -o -u Noninteractive.Quiet"
2. When I start up mutt, I do it by calling a wrapper script that
delays
until cron-started copies of offlineimap have finished, then starts
offlineimap
on its regular, stay-alive and keep checking schedule. When I quit
mutt, the
wrapper script tells offlineimap to stop.
This way I get frequent regular checks while I have mutt running, but
I don't
waste my battery/cpu checking frequently for mail when I'm not
interested in
it.
To make this work, though, it'd be nicer if it were easier to tell
offlineimap,
from the outside, things like "terminate cleanly now" and "when you've
finished
synching, then terminate instead of sleeping and synching again."
OK, to put my money where my mouth is, I attach two patches against
offlineimap
6.0.3.
The first, "cleanup.patch", cleans up a few spots that tend to throw
exceptions
for me as offlineimap is exiting from a KeyboardInterrupt.
The second adds signaling capabilities to offlineimap.
* sending a SIGTERM tells offlineimap to terminate immediately but
cleanly,
just as if "q" had been pressed in the GUI interface
* sending a SIGUSR1 tells every account to do a full sync asap: if
it's
sleeping, then wake up and do the sync now. If it's mid-sync, then
re-synch
any folders whose syncing has already been started or completed, and
continue
to synch the other, queued but not-yet-synched folders.
* sending a SIGHUP tells every account to die as soon as it can (but
not
immediately: only after finishing any synch it's now engaged in)
* sending a SIGUSR2 tells every account to do a full sync asap (as
with
SIGUSR1), then die
It's tricky to mix signals with threads, but I think I've done this
correctly.
I've been using it now for a few weeks without any obvious
problems. But I'm passing it
on so that others can review the code and test it out on their
systems. I developed the
patch when I was running Python 2.5.2, but to my knowledge I don't use
any Python 2.5-specific
code. Now I'm using the patch with Python 2.6.
Although I said "without any obvious problems," let me confess that
I'm
seeing offlineimap regularly choke when I do things like this: start
up
my offlineimap-wrapped copy of mutt, wait a while, put the machine to
sleep (not sure if offlineimap is active in the background or idling),
move to a different spot, wake the machine up again and it acquires a
new network, sometimes a wired network instead of wifi. Offlineimap
doesn't like that so much. I don't yet have any reason to think the
problems here come from my patches. But I'm just acknowledging them,
so
that if others are able to use offlineimap without any difficulty in
situations like I described, then maybe the fault is with my patches.
2008-12-01 23:13:16 +01:00
|
|
|
import signal
|
2011-01-10 12:12:42 +01:00
|
|
|
import socket
|
2010-12-15 19:06:59 +01:00
|
|
|
import logging
|
2011-01-10 12:12:42 +01:00
|
|
|
from optparse import OptionParser
|
|
|
|
import offlineimap
|
|
|
|
from offlineimap import accounts, threadutil, syncmaster
|
|
|
|
from offlineimap.ui import UI_LIST, setglobalui, getglobalui
|
|
|
|
from offlineimap.localeval import LocalEval
|
|
|
|
from offlineimap.CustomConfig import CustomConfigParser
|
|
|
|
|
2002-10-07 22:59:02 +02:00
|
|
|
|
2003-07-25 04:15:27 +02:00
|
|
|
try:
|
|
|
|
import fcntl
|
|
|
|
hasfcntl = 1
|
|
|
|
except:
|
|
|
|
hasfcntl = 0
|
|
|
|
|
2003-01-30 02:19:53 +01:00
|
|
|
lockfd = None
|
|
|
|
|
2010-12-06 13:36:54 +01:00
|
|
|
class OfflineImap:
|
2010-12-15 19:06:59 +01:00
|
|
|
"""The main class that encapsulates the high level use of OfflineImap.
|
2010-12-06 13:36:54 +01:00
|
|
|
|
2010-12-15 19:06:59 +01:00
|
|
|
To invoke OfflineImap you would call it with:
|
|
|
|
oi = OfflineImap()
|
|
|
|
oi.run()
|
|
|
|
"""
|
2010-12-06 13:36:54 +01:00
|
|
|
def lock(self, config, ui):
|
|
|
|
global lockfd, hasfcntl
|
|
|
|
if not hasfcntl:
|
|
|
|
return
|
|
|
|
lockfd = open(config.getmetadatadir() + "/lock", "w")
|
|
|
|
try:
|
|
|
|
fcntl.flock(lockfd, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
|
|
|
except IOError:
|
|
|
|
ui.locked()
|
|
|
|
ui.terminate(1)
|
|
|
|
|
2010-12-15 19:06:59 +01:00
|
|
|
def run(self):
|
|
|
|
"""Parse the commandline and invoke everything"""
|
|
|
|
|
2010-12-22 12:35:41 +01:00
|
|
|
parser = OptionParser(version=offlineimap.banner,
|
|
|
|
description="%s.\n\n%s" %
|
|
|
|
(offlineimap.__copyright__,
|
|
|
|
offlineimap.__license__))
|
2010-12-15 19:06:59 +01:00
|
|
|
parser.add_option("-1",
|
|
|
|
action="store_true", dest="singlethreading",
|
|
|
|
default=False,
|
|
|
|
help="Disable all multithreading operations and use "
|
|
|
|
"solely a single-thread sync. This effectively sets the "
|
|
|
|
"maxsyncaccounts and all maxconnections configuration file "
|
|
|
|
"variables to 1.")
|
|
|
|
|
|
|
|
parser.add_option("-P", dest="profiledir", metavar="DIR",
|
|
|
|
help="Sets OfflineIMAP into profile mode. The program "
|
|
|
|
"will create DIR (it must not already exist). "
|
|
|
|
"As it runs, Python profiling information about each "
|
|
|
|
"thread is logged into profiledir. Please note: "
|
|
|
|
"This option is present for debugging and optimization "
|
|
|
|
"only, and should NOT be used unless you have a "
|
|
|
|
"specific reason to do so. It will significantly "
|
|
|
|
"decrease program performance, may reduce reliability, "
|
|
|
|
"and can generate huge amounts of data. This option "
|
|
|
|
"implies the -1 option.")
|
|
|
|
|
|
|
|
parser.add_option("-a", dest="accounts", metavar="ACCOUNTS",
|
|
|
|
help="""Overrides the accounts section in the config file.
|
|
|
|
Lets you specify a particular account or set of
|
|
|
|
accounts to sync without having to edit the config
|
|
|
|
file. You might use this to exclude certain accounts,
|
|
|
|
or to sync some accounts that you normally prefer not to.""")
|
|
|
|
|
|
|
|
parser.add_option("-c", dest="configfile", metavar="FILE",
|
|
|
|
default="~/.offlineimaprc",
|
|
|
|
help="Specifies a configuration file to use in lieu of "
|
2010-12-22 12:35:41 +01:00
|
|
|
"%default.")
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
parser.add_option("-d", dest="debugtype", metavar="type1,[type2...]",
|
|
|
|
help=
|
|
|
|
"Enables debugging for OfflineIMAP. This is useful "
|
|
|
|
"if you are trying to track down a malfunction or "
|
|
|
|
"figure out what is going on under the hood. It is recommended "
|
|
|
|
"to use this with -1 in order to make the "
|
|
|
|
"results more sensible. This option requires one or more "
|
|
|
|
"debugtypes, separated by commas. "
|
|
|
|
"These define what exactly will be debugged, "
|
|
|
|
"and so far include two options: imap, "
|
|
|
|
"maildir or ALL. The imap option will enable IMAP protocol "
|
|
|
|
"stream and parsing debugging. Note that the output "
|
|
|
|
"may contain passwords, so take care to remove that "
|
|
|
|
"from the debugging output before sending it to anyone else. "
|
|
|
|
"The maildir option will enable debugging "
|
|
|
|
"for certain Maildir operations.")
|
|
|
|
|
|
|
|
parser.add_option("-l", dest="logfile", metavar="FILE",
|
|
|
|
help="Log to FILE")
|
|
|
|
|
|
|
|
parser.add_option("-f", dest="folders", metavar="folder1,[folder2...]",
|
|
|
|
help=
|
|
|
|
"Only sync the specified folders. The folder names "
|
|
|
|
"are the *untranslated* foldernames. This "
|
|
|
|
"command-line option overrides any 'folderfilter' "
|
|
|
|
"and 'folderincludes' options in the configuration "
|
|
|
|
"file.")
|
|
|
|
|
|
|
|
parser.add_option("-k", dest="configoverride",
|
|
|
|
action="append",
|
|
|
|
metavar="[section:]option=value",
|
|
|
|
help=
|
|
|
|
"""Override configuration file option. If"section" is
|
|
|
|
omitted, it defaults to "general". Any underscores
|
|
|
|
in the section name are replaced with spaces:
|
|
|
|
for instance, to override option "autorefresh" in
|
|
|
|
the "[Account Personal]" section in the config file
|
|
|
|
one would use "-k Account_Personal:autorefresh=30".""")
|
|
|
|
|
|
|
|
parser.add_option("-o",
|
|
|
|
action="store_true", dest="runonce",
|
|
|
|
default=False,
|
|
|
|
help="Run only once, ignoring any autorefresh setting "
|
|
|
|
"in the configuration file.")
|
|
|
|
|
|
|
|
parser.add_option("-q",
|
|
|
|
action="store_true", dest="quick",
|
|
|
|
default=False,
|
|
|
|
help="Run only quick synchronizations. Ignore any "
|
|
|
|
"flag updates on IMAP servers (if a flag on the remote IMAP "
|
|
|
|
"changes, and we have the message locally, it will be left "
|
|
|
|
"untouched in a quick run.")
|
|
|
|
|
|
|
|
parser.add_option("-u", dest="interface",
|
|
|
|
help="Specifies an alternative user interface to "
|
|
|
|
"use. This overrides the default specified in the "
|
|
|
|
"configuration file. The UI specified with -u will "
|
|
|
|
"be forced to be used, even if checks determine that it is "
|
|
|
|
"not usable. Possible interface choices are: %s " %
|
2011-01-10 12:12:42 +01:00
|
|
|
", ".join(UI_LIST.keys()))
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
(options, args) = parser.parse_args()
|
|
|
|
|
|
|
|
#read in configuration file
|
|
|
|
configfilename = os.path.expanduser(options.configfile)
|
2010-12-06 13:36:54 +01:00
|
|
|
|
|
|
|
config = CustomConfigParser()
|
|
|
|
if not os.path.exists(configfilename):
|
2010-12-15 19:06:59 +01:00
|
|
|
logging.error(" *** Config file '%s' does not exist; aborting!" %
|
|
|
|
configfilename)
|
2010-12-06 13:36:54 +01:00
|
|
|
sys.exit(1)
|
|
|
|
config.read(configfilename)
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
#profile mode chosen?
|
|
|
|
if options.profiledir:
|
|
|
|
if not options.singlethreading:
|
|
|
|
logging.warn("Profile mode: Forcing to singlethreaded.")
|
|
|
|
options.singlethreaded = True
|
|
|
|
profiledir = options.profiledir
|
|
|
|
os.mkdir(profiledir)
|
|
|
|
threadutil.setprofiledir(profiledir)
|
|
|
|
logging.warn("Profile mode: Potentially large data will be "
|
|
|
|
"created in '%s'" % profiledir)
|
|
|
|
|
|
|
|
#override a config value
|
|
|
|
if options.configoverride:
|
|
|
|
for option in options.configoverride:
|
|
|
|
(key, value) = option.split('=', 1)
|
|
|
|
if ':' in key:
|
|
|
|
(secname, key) = key.split(':', 1)
|
|
|
|
section = secname.replace("_", " ")
|
|
|
|
else:
|
|
|
|
section = "general"
|
|
|
|
config.set(section, key, value)
|
|
|
|
|
2011-01-05 17:00:54 +01:00
|
|
|
#init the ui, cmd line option overrides config file
|
|
|
|
ui_type = config.getdefault('general','ui', 'TTY.TTYUI')
|
|
|
|
if options.interface != None:
|
|
|
|
ui_type = options.interface
|
|
|
|
try:
|
2011-01-10 12:12:42 +01:00
|
|
|
ui = UI_LIST[ui_type](config)
|
2011-01-05 17:00:54 +01:00
|
|
|
except KeyError:
|
|
|
|
logging.error("UI '%s' does not exist, choose one of: %s" % \
|
2011-01-10 12:12:42 +01:00
|
|
|
(ui_type,', '.join(UI_LIST.keys())))
|
2011-01-05 17:00:54 +01:00
|
|
|
sys.exit(1)
|
2011-01-10 12:12:42 +01:00
|
|
|
setglobalui(ui)
|
2011-01-05 17:00:54 +01:00
|
|
|
|
|
|
|
#set up additional log files
|
2010-12-15 19:06:59 +01:00
|
|
|
if options.logfile:
|
|
|
|
ui.setlogfd(open(options.logfile, 'wt'))
|
2010-12-06 13:36:54 +01:00
|
|
|
|
2010-12-15 19:06:59 +01:00
|
|
|
#welcome blurb
|
2010-12-06 13:36:54 +01:00
|
|
|
ui.init_banner()
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
if options.debugtype:
|
|
|
|
if options.debugtype.lower() == 'all':
|
|
|
|
options.debugtype = 'imap,maildir,thread'
|
|
|
|
for type in options.debugtype.split(','):
|
|
|
|
type = type.strip()
|
|
|
|
ui.add_debug(type)
|
|
|
|
if type.lower() == 'imap':
|
2010-12-06 13:36:54 +01:00
|
|
|
imaplib.Debug = 5
|
2010-12-15 19:06:59 +01:00
|
|
|
if type.lower() == 'thread':
|
2010-12-06 13:36:54 +01:00
|
|
|
threading._VERBOSE = 1
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
if options.runonce:
|
2010-12-06 13:36:54 +01:00
|
|
|
# FIXME: maybe need a better
|
|
|
|
for section in accounts.getaccountlist(config):
|
|
|
|
config.remove_option('Account ' + section, "autorefresh")
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
if options.quick:
|
2010-12-06 13:36:54 +01:00
|
|
|
for section in accounts.getaccountlist(config):
|
|
|
|
config.set('Account ' + section, "quick", '-1')
|
2010-12-15 19:06:59 +01:00
|
|
|
|
|
|
|
if options.folders:
|
|
|
|
foldernames = options.folders.replace(" ", "").split(",")
|
2010-12-06 13:36:54 +01:00
|
|
|
folderfilter = "lambda f: f in %s" % foldernames
|
|
|
|
folderincludes = "[]"
|
|
|
|
for accountname in accounts.getaccountlist(config):
|
|
|
|
account_section = 'Account ' + accountname
|
|
|
|
remote_repo_section = 'Repository ' + \
|
|
|
|
config.get(account_section, 'remoterepository')
|
|
|
|
local_repo_section = 'Repository ' + \
|
|
|
|
config.get(account_section, 'localrepository')
|
|
|
|
for section in [remote_repo_section, local_repo_section]:
|
|
|
|
config.set(section, "folderfilter", folderfilter)
|
|
|
|
config.set(section, "folderincludes", folderincludes)
|
2010-12-15 19:06:59 +01:00
|
|
|
|
2010-12-06 13:36:54 +01:00
|
|
|
self.lock(config, ui)
|
|
|
|
|
|
|
|
|
|
|
|
def sigterm_handler(self, signum, frame):
|
|
|
|
# die immediately
|
2011-01-10 12:12:42 +01:00
|
|
|
ui = getglobalui()
|
2010-12-06 13:36:54 +01:00
|
|
|
ui.terminate(errormsg="terminating...")
|
2010-12-13 20:40:25 +01:00
|
|
|
|
2010-12-06 13:36:54 +01:00
|
|
|
signal.signal(signal.SIGTERM,sigterm_handler)
|
|
|
|
|
|
|
|
try:
|
|
|
|
pidfd = open(config.getmetadatadir() + "/pid", "w")
|
|
|
|
pidfd.write(str(os.getpid()) + "\n")
|
|
|
|
pidfd.close()
|
|
|
|
except:
|
|
|
|
pass
|
|
|
|
|
|
|
|
try:
|
2010-12-15 19:06:59 +01:00
|
|
|
if options.logfile:
|
2010-12-06 13:36:54 +01:00
|
|
|
sys.stderr = ui.logfile
|
|
|
|
|
|
|
|
socktimeout = config.getdefaultint("general", "socktimeout", 0)
|
|
|
|
if socktimeout > 0:
|
|
|
|
socket.setdefaulttimeout(socktimeout)
|
|
|
|
|
|
|
|
activeaccounts = config.get("general", "accounts")
|
2010-12-15 19:06:59 +01:00
|
|
|
if options.accounts:
|
|
|
|
activeaccounts = options.accounts
|
2010-12-06 13:36:54 +01:00
|
|
|
activeaccounts = activeaccounts.replace(" ", "")
|
|
|
|
activeaccounts = activeaccounts.split(",")
|
|
|
|
allaccounts = accounts.AccountHashGenerator(config)
|
|
|
|
|
|
|
|
syncaccounts = []
|
|
|
|
for account in activeaccounts:
|
|
|
|
if account not in allaccounts:
|
|
|
|
if len(allaccounts) == 0:
|
|
|
|
errormsg = 'The account "%s" does not exist because no accounts are defined!'%account
|
|
|
|
else:
|
|
|
|
errormsg = 'The account "%s" does not exist. Valid accounts are:'%account
|
|
|
|
for name in allaccounts.keys():
|
|
|
|
errormsg += '\n%s'%name
|
|
|
|
ui.terminate(1, errortitle = 'Unknown Account "%s"'%account, errormsg = errormsg)
|
|
|
|
if account not in syncaccounts:
|
|
|
|
syncaccounts.append(account)
|
|
|
|
|
|
|
|
server = None
|
|
|
|
remoterepos = None
|
|
|
|
localrepos = None
|
|
|
|
|
2010-12-15 19:06:59 +01:00
|
|
|
if options.singlethreading:
|
2010-12-06 13:36:54 +01:00
|
|
|
threadutil.initInstanceLimit("ACCOUNTLIMIT", 1)
|
|
|
|
else:
|
|
|
|
threadutil.initInstanceLimit("ACCOUNTLIMIT",
|
|
|
|
config.getdefaultint("general", "maxsyncaccounts", 1))
|
|
|
|
|
|
|
|
for reposname in config.getsectionlist('Repository'):
|
|
|
|
for instancename in ["FOLDER_" + reposname,
|
|
|
|
"MSGCOPY_" + reposname]:
|
2010-12-15 19:06:59 +01:00
|
|
|
if options.singlethreading:
|
2010-12-06 13:36:54 +01:00
|
|
|
threadutil.initInstanceLimit(instancename, 1)
|
|
|
|
else:
|
|
|
|
threadutil.initInstanceLimit(instancename,
|
|
|
|
config.getdefaultint('Repository ' + reposname, "maxconnections", 1))
|
|
|
|
siglisteners = []
|
|
|
|
def sig_handler(signum, frame):
|
|
|
|
if signum == signal.SIGUSR1:
|
|
|
|
# tell each account to do a full sync asap
|
|
|
|
signum = (1,)
|
|
|
|
elif signum == signal.SIGHUP:
|
|
|
|
# tell each account to die asap
|
|
|
|
signum = (2,)
|
|
|
|
elif signum == signal.SIGUSR2:
|
|
|
|
# tell each account to do a full sync asap, then die
|
|
|
|
signum = (1, 2)
|
|
|
|
# one listener per account thread (up to maxsyncaccounts)
|
|
|
|
for listener in siglisteners:
|
|
|
|
for sig in signum:
|
|
|
|
listener.put_nowait(sig)
|
|
|
|
signal.signal(signal.SIGHUP,sig_handler)
|
|
|
|
signal.signal(signal.SIGUSR1,sig_handler)
|
|
|
|
signal.signal(signal.SIGUSR2,sig_handler)
|
|
|
|
|
|
|
|
threadutil.initexitnotify()
|
2011-01-10 12:12:42 +01:00
|
|
|
t = threadutil.ExitNotifyThread(target=syncmaster.syncitall,
|
2010-12-06 13:36:54 +01:00
|
|
|
name='Sync Runner',
|
|
|
|
kwargs = {'accounts': syncaccounts,
|
|
|
|
'config': config,
|
|
|
|
'siglisteners': siglisteners})
|
|
|
|
t.setDaemon(1)
|
|
|
|
t.start()
|
|
|
|
threadutil.exitnotifymonitorloop(threadutil.threadexited)
|
2011-01-12 11:15:08 +01:00
|
|
|
|
|
|
|
except KeyboardInterrupt:
|
|
|
|
ui.terminate(1, errormsg = 'CTRL-C pressed, aborting...')
|
|
|
|
return
|
|
|
|
except (SystemExit):
|
2010-12-06 13:36:54 +01:00
|
|
|
raise
|
|
|
|
except:
|
2011-01-12 11:15:08 +01:00
|
|
|
ui.mainException()
|
2002-10-07 22:59:02 +02:00
|
|
|
|
|
|
|
|