developer.intra2net.com Git - imap-restore-mail/blob - src/restore_mail_inject.py

   1 '''
   2 restore-mail-inject.py - Tool to inject mails via IMAP
   3
   4 Copyright (c) 2012 Intra2net AG
   5 Author: Plamen Dimitrov and Thomas Jarosch
   6
   7 This program is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16 '''
  17 import logging
  18 import argparse
  19 from mail_iterator import MailIterator
  20 from file_iterator import FileIterator
  21 from warnings_handler import WarningsHandler
  22
  23 LOG_FILENAME = "restore_mail_inject.log"
  24 LOG_FILE_LEVEL = logging.DEBUG
  25 LOG_SHELL_LEVEL = logging.INFO
  26 LOG_UNCLEAN_EXIT_LEVEL = logging.WARNING
  27
  28 def main():
  29     """Main function."""
  30
  31     # prepare configuration
  32     args = configure_args()
  33     warnings_handler = prepare_logger()
  34     logging.info("The module restore_mail_inject.py started with user %s, folder %s and source %s.",
  35           args.user, args.folder, args.srcdir)
  36
  37     # connect to unix socket or server
  38     if(args.unix_socket_disabled):
  39         session = MailIterator(args.user)
  40     else:
  41         session = MailIterator(args.user)
  42         #session = MailIterator("/var/imap/socket/imap", "cyrus", "geheim")
  43     storage = FileIterator()
  44
  45     # retrieve mailbox list from the mailbox list file
  46     mailbox_list = storage.load_mailbox_list(args.mboxlistfile)
  47
  48     # delete olf IMAP folders if no append requested
  49     if not args.append:
  50         session.delete_mailboxes(args.folder)
  51         if args.folder == "INBOX":
  52             session.clear_inbox_acls(args.user)
  53
  54     # inject emails
  55     path_generator = storage.load_mails(args.srcdir, args.folder)
  56     for message, mailbox, date_modified in path_generator:
  57
  58         # mailboxes marked for creating and acl update
  59         # add acls after all subfolders or their acls will be derived from parent folder
  60         for new_mailbox in storage.created_mailboxes:
  61             session.create_mailbox(new_mailbox)
  62         for acl_mailbox in storage.acl_mailboxes:
  63             session.add_acls(acl_mailbox, mailbox_list, args.ouser, args.user)
  64         storage.created_mailboxes = []
  65         storage.acl_mailboxes = []
  66
  67         session.inject_message(message, mailbox, date_modified)
  68
  69     # last iteration mailboxes in case root mailbox has no e-mails for injection
  70     for new_mailbox in storage.created_mailboxes:
  71         session.create_mailbox(new_mailbox)
  72     for acl_mailbox in storage.acl_mailboxes:
  73         session.add_acls(acl_mailbox, mailbox_list, args.ouser, args.user)
  74
  75     logging.info("Finished injecting mails. Exiting with code %s.", warnings_handler.detected_problems)
  76     return warnings_handler.detected_problems
  77
  78 def configure_args():
  79     """Configure arguments and return them."""
  80
  81     # parse arguments
  82     parser = argparse.ArgumentParser(description="Tool to inject mails via IMAP.")
  83     parser.add_argument('-u', '--username', dest='user', action='store',
  84                         required=True, help='user to store mails to')
  85     parser.add_argument('-f', '--foldername', dest='folder', action='store',
  86                         default="INBOX", help='folder to store mails to - if not specified we overwrite INBOX')
  87     parser.add_argument('-s', '--sourcedir', dest='srcdir', action='store',
  88                         required=True, help='folder to read mail from')
  89     parser.add_argument('-m', '--mboxlistfile', dest='mboxlistfile', action='store',
  90                         default="", help='mboxlist file (flat file format) to read the ACLs from')
  91     parser.add_argument('-o', '--ouser', dest='ouser', action='store',
  92                         default="", help='name of the original user (=username if not specified)')
  93     parser.add_argument('-a', '--append', dest='append', action='store_true',
  94                         default=False, help="append mails, don't delete anything")
  95     parser.add_argument('-n', '--normal', dest='unix_socket_disabled', action='store_true',
  96                         default=False, help='disable unix socket usage for the IMAP connection')
  97     args = parser.parse_args()
  98
  99     if (args.folder != "INBOX"):
 100         args.folder = "INBOX/" + args.folder
 101     if (args.ouser == ""):
 102         args.ouser = args.user
 103
 104     return args
 105
 106 def prepare_logger():
 107     """Sets up the logging functionality"""
 108
 109     # reset the log
 110     with open(LOG_FILENAME, 'w'):
 111         pass
 112
 113     # add basic configuration
 114     logging.basicConfig(filename=LOG_FILENAME,
 115                         format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
 116                         level=LOG_FILE_LEVEL)
 117
 118     # add a handler for a console output
 119     default_logger = logging.getLogger('')
 120     console = logging.StreamHandler()
 121     console.setLevel(LOG_SHELL_LEVEL)
 122     formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 123     console.setFormatter(formatter)
 124     default_logger.addHandler(console)
 125
 126     # add a handler for warnings counting
 127     warnings_handler = WarningsHandler()
 128     warnings_handler.setLevel(LOG_UNCLEAN_EXIT_LEVEL)
 129     default_logger.addHandler(warnings_handler)
 130
 131     return warnings_handler
 132
 133 if __name__ == "__main__":
 134     main()