e1fb9492f8
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.
230 lines
8.5 KiB
Python
230 lines
8.5 KiB
Python
# OfflineIMAP initialization code
|
|
# Copyright (C) 2002-2007 John Goerzen
|
|
# <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
|
|
# 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 imaplib
|
|
from offlineimap import imapserver, repository, folder, mbnames, threadutil, version, syncmaster, accounts
|
|
from offlineimap.localeval import LocalEval
|
|
from offlineimap.threadutil import InstanceLimitedThread, ExitNotifyThread
|
|
from offlineimap.ui import UIBase
|
|
import re, os, os.path, offlineimap, sys
|
|
from offlineimap.CustomConfig import CustomConfigParser
|
|
from threading import *
|
|
import threading, socket
|
|
from getopt import getopt
|
|
import signal
|
|
|
|
try:
|
|
import fcntl
|
|
hasfcntl = 1
|
|
except:
|
|
hasfcntl = 0
|
|
|
|
lockfd = None
|
|
|
|
def lock(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)
|
|
|
|
def startup(versionno):
|
|
assert versionno == version.versionstr, "Revision of main program (%s) does not match that of library (%s). Please double-check your PYTHONPATH and installation locations." % (versionno, version.versionstr)
|
|
options = {}
|
|
if '--help' in sys.argv[1:]:
|
|
sys.stdout.write(version.getcmdhelp() + "\n")
|
|
sys.exit(0)
|
|
|
|
for optlist in getopt(sys.argv[1:], 'P:1oqa:c:d:l:u:hk:f:')[0]:
|
|
options[optlist[0]] = optlist[1]
|
|
|
|
if options.has_key('-h'):
|
|
sys.stdout.write(version.getcmdhelp())
|
|
sys.stdout.write("\n")
|
|
sys.exit(0)
|
|
configfilename = os.path.expanduser("~/.offlineimaprc")
|
|
if options.has_key('-c'):
|
|
configfilename = options['-c']
|
|
if options.has_key('-P'):
|
|
if not options.has_key('-1'):
|
|
sys.stderr.write("FATAL: profile mode REQUIRES -1\n")
|
|
sys.exit(100)
|
|
profiledir = options['-P']
|
|
os.mkdir(profiledir)
|
|
threadutil.setprofiledir(profiledir)
|
|
sys.stderr.write("WARNING: profile mode engaged;\nPotentially large data will be created in " + profiledir + "\n")
|
|
|
|
config = CustomConfigParser()
|
|
if not os.path.exists(configfilename):
|
|
sys.stderr.write(" *** Config file %s does not exist; aborting!\n" % configfilename)
|
|
sys.exit(1)
|
|
|
|
config.read(configfilename)
|
|
|
|
# override config values with option '-k'
|
|
for option in options.keys():
|
|
if option == '-k':
|
|
(key, value) = options['-k'].split('=', 1)
|
|
if ':' in key:
|
|
(secname, key) = key.split(':', 1)
|
|
section = secname.replace("_", " ")
|
|
else:
|
|
section = "general"
|
|
config.set(section, key, value)
|
|
|
|
ui = offlineimap.ui.detector.findUI(config, options.get('-u'))
|
|
UIBase.setglobalui(ui)
|
|
|
|
if options.has_key('-l'):
|
|
ui.setlogfd(open(options['-l'], 'wt'))
|
|
|
|
ui.init_banner()
|
|
|
|
if options.has_key('-d'):
|
|
for debugtype in options['-d'].split(','):
|
|
ui.add_debug(debugtype.strip())
|
|
if debugtype == 'imap':
|
|
imaplib.Debug = 5
|
|
if debugtype == 'thread':
|
|
threading._VERBOSE = 1
|
|
|
|
if options.has_key('-o'):
|
|
# FIXME: maybe need a better
|
|
for section in accounts.getaccountlist(config):
|
|
config.remove_option('Account ' + section, "autorefresh")
|
|
|
|
if options.has_key('-q'):
|
|
for section in accounts.getaccountlist(config):
|
|
config.set('Account ' + section, "quick", '-1')
|
|
|
|
if options.has_key('-f'):
|
|
foldernames = options['-f'].replace(" ", "").split(",")
|
|
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)
|
|
|
|
lock(config, ui)
|
|
|
|
def sigterm_handler(signum, frame):
|
|
# die immediately
|
|
ui.terminate(errormsg="terminating...")
|
|
signal.signal(signal.SIGTERM,sigterm_handler)
|
|
|
|
try:
|
|
pidfd = open(config.getmetadatadir() + "/pid", "w")
|
|
pidfd.write(str(os.getpid()) + "\n")
|
|
pidfd.close()
|
|
except:
|
|
pass
|
|
|
|
try:
|
|
if options.has_key('-l'):
|
|
sys.stderr = ui.logfile
|
|
|
|
socktimeout = config.getdefaultint("general", "socktimeout", 0)
|
|
if socktimeout > 0:
|
|
socket.setdefaulttimeout(socktimeout)
|
|
|
|
activeaccounts = config.get("general", "accounts")
|
|
if options.has_key('-a'):
|
|
activeaccounts = options['-a']
|
|
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)
|
|
syncaccounts[account] = allaccounts[account]
|
|
|
|
server = None
|
|
remoterepos = None
|
|
localrepos = None
|
|
|
|
if options.has_key('-1'):
|
|
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]:
|
|
if options.has_key('-1'):
|
|
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()
|
|
t = ExitNotifyThread(target=syncmaster.syncitall,
|
|
name='Sync Runner',
|
|
kwargs = {'accounts': syncaccounts,
|
|
'config': config,
|
|
'siglisteners': siglisteners})
|
|
t.setDaemon(1)
|
|
t.start()
|
|
except:
|
|
ui.mainException()
|
|
|
|
try:
|
|
threadutil.exitnotifymonitorloop(threadutil.threadexited)
|
|
except SystemExit:
|
|
raise
|
|
except:
|
|
ui.mainException() # Also expected to terminate.
|
|
|
|
|