Files
Rodolfo García Peñas (kix) 4f5b2529e4 Full packaging review
This patch includes a lot of changes:

1. Split the `requirements.txt` file in multiple files. This change holds
   the required packages for OfflineIMAP in the `requirements.txt` file.
   The optional packages are included in the files `requirements-option.txt`
   files. Now the standard OfflineIMAP configuration does not include
   packages like `cygwin`. See for example issue #192.
2. The `setup.py` process includes a lot of files (see issue #110). This
   creates a problem in the setup process, because some libraries are not
   found (see #39, the problem still happends). For this reason we can
   read the variables from the `offlineimap/__init__py` to include them
   in the `setup.py` script, without import the `offlineimap` module. I
   used the method presented at `https://www.youtube.com/watch?v=fHNhhHMUW7k`.
   In the setup module we don't need the testing code (it creates the import
   problem too), so this code is removed. To read the variables, we use
   some regex search in the `offlineimap/__init__py` file, save the
   values as variables, and then use them in the `setup()` call.
3. `setup.py` uses requires and extra_requires libraries, aligned with
   the `requirements` files. We use four different options: `kerberos`,
   `keyring`, `cygwin`, `cygwin` and `testinternet`.
4. `pyproject.toml`. This file is fully rewritten. The file use now the
   right dependencies, includes the optional dependencies aligned with
   the requirements and the `setup.py` files. The file include other
   details, like classifiers, URLs,... This script uses now the the
   `project.scripts` option, with the module and the method to call when
   the setup file is created. Then, this script includes as module
   `offlineimap.init`, and the startup method is `main`. Because this
   method is new, this method and the `__main__` functions are created
   in the `offlineimap/init.py` file:

        ```python
        def main():
            oi = OfflineImap()
            oi.run()

        if __name__ == "__main__":
            main()
        ```
With these changes, the setup process works fine, with and without
optional modules. Finally, the folder `offlineimap.egg-info`,
created in the setup process is included in the `.gitignore` file.

It is possible check the creation using:

```python
python -m pip install .
```

And then use the command `offilineimap` to use the module. Finally, the
`bin/offlineimap` command is not used, so we probably can remove it.

Fix: #192, Fix: #110, Fix: #39, Fix: #90
2024-08-26 18:01:14 +02:00

580 lines
23 KiB
Python

# OfflineIMAP initialization code
# Copyright (C) 2002-2017 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 os
import sys
import threading
import signal
import socket
import logging
import traceback
import collections
from optparse import OptionParser
import offlineimap
from offlineimap.utils.distro_utils import get_os_name
import imaplib2 as imaplib
# Ensure that `ui` gets loaded before `threadutil` in order to
# break the circular dependency between `threadutil` and `Curses`.
from offlineimap.ui import UI_LIST, setglobalui, getglobalui
from offlineimap import threadutil, accounts, folder, mbnames
from offlineimap import globals as glob
from offlineimap.CustomConfig import CustomConfigParser
from offlineimap.utils import stacktrace
from offlineimap.repository import Repository
from offlineimap.folder.IMAP import MSGCOPY_NAMESPACE
ACCOUNT_LIMITED_THREAD_NAME = 'MAX_ACCOUNTS'
PYTHON_VERSION = sys.version.split(' ')[0]
def syncitall(list_accounts, config):
"""The target when in multithreading mode for running accounts threads."""
threads = threadutil.accountThreads() # The collection of accounts threads.
for accountname in list_accounts:
# Start a new thread per account and store it in the collection.
account = accounts.SyncableAccount(config, accountname)
thread = threadutil.InstanceLimitedThread(
ACCOUNT_LIMITED_THREAD_NAME,
target=account.syncrunner,
name="Account sync %s" % accountname
)
thread.daemon = True
# The add() method expects a started thread.
thread.start()
threads.add(thread)
# Wait for the threads to finish.
threads.wait() # Blocks until all accounts are processed.
class OfflineImap:
"""The main class that encapsulates the high level use of OfflineImap.
To invoke OfflineImap you would call it with::
oi = OfflineImap()
oi.run()
"""
def get_env_info(self):
# Transitional code between imaplib2 versions
try:
# imaplib2, previous versions, based on Python 2.x
l_imaplib_version = imaplib.__version__
except AttributeError:
# New imaplib2, version >= 3.06
l_imaplib_version = imaplib.version()
except:
# This should not happen
l_imaplib_version = " Unknown"
info = "imaplib2 v%s, Python v%s" % (l_imaplib_version, PYTHON_VERSION)
try:
import ssl
info = "%s, %s" % (info, ssl.OPENSSL_VERSION)
except:
pass
return info
def run(self):
"""Parse the commandline and invoke everything"""
# next line also sets self.config and self.ui
options, args = self.__parse_cmd_options()
if options.diagnostics:
self.__serverdiagnostics(options)
elif options.migrate_fmd5:
self.__migratefmd5(options)
elif options.mbnames_prune:
mbnames.init(self.config, self.ui, options.dryrun)
mbnames.prune(self.config.get("general", "accounts"))
mbnames.write()
elif options.deletefolder:
return self.__deletefolder(options)
else:
return self.__sync(options)
def __parse_cmd_options(self):
parser = OptionParser(
version=offlineimap.__version__,
description="%s.\n\n%s" % (offlineimap.__copyright__,
offlineimap.__license__)
)
parser.add_option("-V",
action="store_true", dest="version",
default=False,
help="show full version infos")
parser.add_option("--dry-run",
action="store_true", dest="dryrun",
default=False,
help="dry run mode")
parser.add_option("--info",
action="store_true", dest="diagnostics",
default=False,
help="output information on the configured email repositories")
parser.add_option("-1",
action="store_true", dest="singlethreading",
default=False,
help="(the number one) disable all multithreading operations")
parser.add_option("-P", dest="profiledir", metavar="DIR",
help="sets OfflineIMAP into profile mode.")
parser.add_option("-a", dest="accounts",
metavar="account1[,account2[,...]]",
help="list of accounts to sync")
parser.add_option("-c", dest="configfile", metavar="FILE",
default=None,
help="specifies a configuration file to use")
parser.add_option("-d", dest="debugtype",
metavar="type1[,type2[,...]]",
help="enables debugging for OfflineIMAP "
" (types: imap, maildir, thread)")
parser.add_option("-l", dest="logfile", metavar="FILE",
help="log to FILE")
parser.add_option("-s",
action="store_true", dest="syslog",
default=False,
help="log to syslog")
parser.add_option("-f", dest="folders",
metavar="folder1[,folder2[,...]]",
help="only sync the specified folders")
parser.add_option("-k", dest="configoverride",
action="append",
metavar="[section:]option=value",
help="override configuration file option")
parser.add_option("-o",
action="store_true", dest="runonce",
default=False,
help="run only once (ignore autorefresh)")
parser.add_option("-q",
action="store_true", dest="quick",
default=False,
help="run only quick synchronizations (don't update flags)")
parser.add_option("-u", dest="interface",
help="specifies an alternative user interface"
" (quiet, basic, syslog, ttyui, blinkenlights, machineui)")
parser.add_option("--delete-folder", dest="deletefolder",
default=None,
metavar="FOLDERNAME",
help="Delete a folder (on the remote repository)")
parser.add_option("--migrate-fmd5-using-nametrans",
action="store_true", dest="migrate_fmd5", default=False,
help="migrate FMD5 hashes from versions prior to 6.3.5")
parser.add_option("--mbnames-prune",
action="store_true", dest="mbnames_prune", default=False,
help="remove mbnames entries for accounts not in accounts")
parser.add_option("--ignore-keyring",
action="store_true", dest="ignore_keyring", default=False,
help="Ignore password which is stored in system keyring")
parser.add_option("--update-keyring",
action="store_true", dest="update_keyring", default=False,
help="Update system keyring with used password")
(options, args) = parser.parse_args()
glob.set_options(options)
if options.version:
print(("offlineimap v%s, %s" % (
offlineimap.__version__, self.get_env_info())
))
sys.exit(0)
# Read in configuration file.
if not options.configfile:
# Try XDG location, then fall back to ~/.offlineimaprc
xdg_var = 'XDG_CONFIG_HOME'
if xdg_var not in os.environ or not os.environ[xdg_var]:
xdg_home = os.path.expanduser('~/.config')
else:
xdg_home = os.environ[xdg_var]
options.configfile = os.path.join(xdg_home, "offlineimap", "config")
if not os.path.exists(options.configfile):
options.configfile = os.path.expanduser('~/.offlineimaprc')
configfilename = options.configfile
else:
configfilename = os.path.expanduser(options.configfile)
config = CustomConfigParser()
if not os.path.exists(configfilename):
# TODO, initialize and make use of chosen ui for logging
logging.error(" *** Config file '%s' does not exist; aborting!" %
configfilename)
sys.exit(1)
config.read(configfilename)
# Profile mode chosen?
if options.profiledir:
if not options.singlethreading:
# TODO, make use of chosen ui for logging
logging.warning("Profile mode: Forcing to singlethreaded.")
options.singlethreading = True
if os.path.exists(options.profiledir):
# TODO, make use of chosen ui for logging
logging.warning("Profile mode: Directory '%s' already exists!" %
options.profiledir)
else:
os.mkdir(options.profiledir)
# TODO, make use of chosen ui for logging
logging.warning("Profile mode: Potentially large data will be "
"created in '%s'" % options.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)
# Which ui to use? CLI option overrides config file.
ui_type = config.getdefault('general', 'ui', 'ttyui')
if options.interface is not None:
ui_type = options.interface
if '.' in ui_type:
# Transform Curses.Blinkenlights -> Blinkenlights.
ui_type = ui_type.split('.')[-1]
# TODO, make use of chosen ui for logging
logging.warning('Using old interface name, consider using one '
'of %s' % ', '.join(list(UI_LIST.keys())))
if options.diagnostics:
ui_type = 'ttyui' # Enforce this UI for --info.
# dry-run? Set [general]dry-run=True.
if options.dryrun:
config.set('general', 'dry-run', 'True')
config.set_if_not_exists('general', 'dry-run', 'False')
# ignore_keyring? Set [general]ignore_keyring=True.
if options.ignore_keyring:
config.set('general', 'ignore-keyring', 'True')
config.set_if_not_exists('general', 'ignore-keyring', 'False')
# update_keyring? Set [general]update_keyring=True.
if options.update_keyring:
config.set('general', 'update-keyring', 'True')
config.set_if_not_exists('general', 'update-keyring', 'False')
try:
# Create the ui class.
self.ui = UI_LIST[ui_type.lower()](config)
except KeyError:
logging.error("UI '%s' does not exist, choose one of: %s" %
(ui_type, ', '.join(list(UI_LIST.keys()))))
sys.exit(1)
setglobalui(self.ui)
# Set up additional log files.
if options.logfile:
self.ui.setlogfile(options.logfile)
# Set up syslog.
if options.syslog:
self.ui.setup_sysloghandler()
# Welcome blurb.
self.ui.init_banner()
self.ui.info(self.get_env_info())
if options.debugtype:
self.ui.logger.setLevel(logging.DEBUG)
if options.debugtype.lower() == 'all':
options.debugtype = 'imap,maildir,thread'
# Force single threading?
if not ('thread' in options.debugtype.split(',')
and not options.singlethreading):
self.ui._msg("Debug mode: Forcing to singlethreaded.")
options.singlethreading = True
debugtypes = options.debugtype.split(',') + ['']
for dtype in debugtypes:
dtype = dtype.strip()
self.ui.add_debug(dtype)
if options.runonce:
# Must kill the possible default option.
if config.has_option('DEFAULT', 'autorefresh'):
config.remove_option('DEFAULT', 'autorefresh')
# FIXME: spaghetti code alert!
for section in accounts.getaccountlist(config):
config.remove_option('Account ' + section, "autorefresh")
if options.quick:
for section in accounts.getaccountlist(config):
config.set('Account ' + section, "quick", '-1')
# Custom folder list specified?
if options.folders:
foldernames = options.folders.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')
config.set(remote_repo_section, "folderfilter", folderfilter)
config.set(remote_repo_section, "folderincludes",
folderincludes)
if options.logfile:
sys.stderr = self.ui.logfile
socktimeout = config.getdefaultint("general", "socktimeout", 0)
if socktimeout > 0:
socket.setdefaulttimeout(socktimeout)
threadutil.initInstanceLimit(
ACCOUNT_LIMITED_THREAD_NAME,
config.getdefaultint('general', 'maxsyncaccounts', 1)
)
for reposname in config.getsectionlist('Repository'):
# Limit the number of threads. Limitation on usage is handled at the
# imapserver level.
for namespace in [accounts.FOLDER_NAMESPACE + reposname,
MSGCOPY_NAMESPACE + reposname]:
if options.singlethreading:
threadutil.initInstanceLimit(namespace, 1)
else:
threadutil.initInstanceLimit(
namespace,
config.getdefaultint(
'Repository ' + reposname,
'maxconnections', 2)
)
self.config = config
return options, args
def __dumpstacks(self, context=1, sighandler_deep=2):
""" Signal handler: dump a stack trace for each existing thread."""
currentThreadId = threading.currentThread().ident
def unique_count(l):
d = collections.defaultdict(lambda: 0)
for v in l:
d[tuple(v)] += 1
return list((k, v) for k, v in list(d.items()))
stack_displays = []
for threadId, stack in list(sys._current_frames().items()):
stack_display = []
for filename, lineno, name, line in traceback.extract_stack(stack):
stack_display.append(' File: "%s", line %d, in %s'
% (filename, lineno, name))
if line:
stack_display.append(" %s" % (line.strip()))
if currentThreadId == threadId:
stack_display = stack_display[:- (sighandler_deep * 2)]
stack_display.append(' => Stopped to handle current signal. ')
stack_displays.append(stack_display)
stacks = unique_count(stack_displays)
self.ui.debug('thread', "** Thread List:\n")
for stack, times in stacks:
if times == 1:
msg = "%s Thread is at:\n%s\n"
else:
msg = "%s Threads are at:\n%s\n"
self.ui.debug('thread', msg % (times, '\n'.join(stack[- (context * 2):])))
self.ui.debug('thread', "Dumped a total of %d Threads." %
len(list(sys._current_frames().keys())))
def _get_activeaccounts(self, options):
activeaccounts = []
errormsg = None
activeaccountnames = self.config.get("general", "accounts")
if options.accounts:
activeaccountnames = options.accounts
activeaccountnames = [x.lstrip() for x in activeaccountnames.split(",")]
allaccounts = accounts.getaccountlist(self.config)
for accountname in activeaccountnames:
if accountname in allaccounts:
activeaccounts.append(accountname)
else:
errormsg = "Valid accounts are: %s" % (
", ".join(allaccounts))
self.ui.error("The account '%s' does not exist" % accountname)
if len(activeaccounts) < 1:
errormsg = "No accounts are defined!"
if errormsg is not None:
self.ui.terminate(1, errormsg=errormsg)
return activeaccounts
def __sync(self, options):
"""Invoke the correct single/multithread syncing
self.config is supposed to have been correctly initialized
already."""
def sig_handler(sig, frame):
if sig == signal.SIGUSR1:
# tell each account to stop sleeping
accounts.Account.set_abort_event(self.config, 1)
elif sig in (signal.SIGUSR2, signal.SIGABRT):
# tell each account to stop looping
getglobalui().warn("Terminating after this sync...")
accounts.Account.set_abort_event(self.config, 2)
elif sig in (signal.SIGTERM, signal.SIGINT, signal.SIGHUP):
# tell each account to ABORT ASAP (ctrl-c)
getglobalui().warn("Preparing to shutdown after sync (this may "
"take some time), press CTRL-C three "
"times to shutdown immediately")
accounts.Account.set_abort_event(self.config, 3)
if 'thread' in self.ui.debuglist:
self.__dumpstacks(5)
# Abort after three Ctrl-C keystrokes
self.num_sigterm += 1
if self.num_sigterm >= 3:
getglobalui().warn("Signaled thrice. Aborting!")
sys.exit(1)
elif sig == signal.SIGQUIT:
stacktrace.dump(sys.stderr)
os.abort()
try:
self.num_sigterm = 0
# We cannot use signals in Windows
if get_os_name() != 'windows':
signal.signal(signal.SIGHUP, sig_handler)
signal.signal(signal.SIGUSR1, sig_handler)
signal.signal(signal.SIGUSR2, sig_handler)
signal.signal(signal.SIGABRT, sig_handler)
signal.signal(signal.SIGTERM, sig_handler)
signal.signal(signal.SIGINT, sig_handler)
signal.signal(signal.SIGQUIT, sig_handler)
# Various initializations that need to be performed:
activeaccounts = self._get_activeaccounts(options)
mbnames.init(self.config, self.ui, options.dryrun)
if options.singlethreading:
# Singlethreaded.
self.__sync_singlethreaded(activeaccounts, options.profiledir)
else:
# Multithreaded.
t = threadutil.ExitNotifyThread(
target=syncitall,
name='Sync Runner',
args=(activeaccounts, self.config,)
)
# Special exit message for the monitor to stop looping.
t.exit_message = threadutil.STOP_MONITOR
t.start()
threadutil.monitor()
# All sync are done.
mbnames.write()
self.ui.terminate()
return 0
except SystemExit:
raise
except Exception as e:
self.ui.error(e)
self.ui.terminate()
return 1
def __sync_singlethreaded(self, list_accounts, profiledir):
"""Executed in singlethreaded mode only.
:param accs: A list of accounts that should be synced
"""
for accountname in list_accounts:
account = accounts.SyncableAccount(self.config, accountname)
threading.currentThread().name = \
"Account sync %s" % account.getname()
if not profiledir:
account.syncrunner()
# Profile mode.
else:
try:
import cProfile as profile
except ImportError:
import profile
prof = profile.Profile()
try:
prof = prof.runctx("account.syncrunner()", globals(), locals())
except SystemExit:
pass
from datetime import datetime
dt = datetime.now().strftime('%Y%m%d%H%M%S')
prof.dump_stats(os.path.join(
profiledir, "%s_%s.prof" % (dt, account.getname())))
def __serverdiagnostics(self, options):
self.ui.info(" imaplib2: %s" % imaplib.__version__)
for accountname in self._get_activeaccounts(options):
account = accounts.Account(self.config, accountname)
account.serverdiagnostics()
def __deletefolder(self, options):
list_accounts = self._get_activeaccounts(options)
if len(list_accounts) != 1:
self.ui.error("you must supply only one account with '-a'")
return 1
account = accounts.Account(self.config, list_accounts.pop())
return account.deletefolder(options.deletefolder)
def __migratefmd5(self, options):
for accountname in self._get_activeaccounts(options):
account = accounts.Account(self.config, accountname)
localrepo = Repository(account, 'local')
if localrepo.getfoldertype() != folder.Maildir.MaildirFolder:
continue
folders = localrepo.getfolders()
for f in folders:
f.migratefmd5(options.dryrun)
def main():
oi = OfflineImap()
oi.run()
if __name__ == "__main__":
main()