Commit | Line | Data |
---|---|---|
c9da760a PD |
1 | ''' |
2 | fix_imap_internaldate.py - Fix the INTERNALDATE field on IMAP servers | |
3 | ||
4 | Copyright (c) 2012 Intra2net AG | |
5 | Author: Plamen Dimitrov | |
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. | |
c9da760a PD |
16 | ''' |
17 | ||
d0cfa9d0 | 18 | import sys |
c9da760a | 19 | import csv |
d0cfa9d0 PD |
20 | import argparse |
21 | # python version handling | |
22 | try: | |
23 | import configparser | |
24 | except ImportError: | |
25 | print("This module needs python version 3 or later.") | |
26 | sys.exit() | |
8fe4e3ff | 27 | import logging |
8a9d4c89 | 28 | from mail_date_parser import MailDateParser |
c9da760a | 29 | from mail_iterator import MailIterator |
8301e589 | 30 | from caching_data import CachingData |
c9da760a | 31 | |
6177b21d TJ |
32 | CONFIG_FILENAME = "fix_imap_internaldate.cfg" |
33 | LOG_FILENAME = "fix_imap_internaldate.log" | |
34 | CSV_FILENAME = "userdata.csv" | |
35 | ||
c9da760a | 36 | def main(): |
97bd6bea PD |
37 | """Interprets command arguments and initializes configuration and logger. |
38 | Then begins mail synchronization.""" | |
648f0037 | 39 | |
97bd6bea | 40 | # parse arguments |
648f0037 PD |
41 | parser = argparse.ArgumentParser(description="Fix the INTERNALDATE field on IMAP servers. " |
42 | "Small tool to fix the IMAP internaldate " | |
43 | "in case it's too much off compared to the last date " | |
44 | "stored in the received lines.") | |
45 | parser.add_argument('-u', '--update', dest='test_mode', action='store_false', | |
46 | default=True, help='update all e-mails and exit test mode') | |
c9da760a | 47 | |
8fe4e3ff | 48 | # config and logging setup |
c9da760a | 49 | config = load_configuration() |
8fe4e3ff | 50 | prepare_logger(config) |
97bd6bea | 51 | args = parser.parse_args() |
648f0037 | 52 | if(args.test_mode): |
f9fd9b29 | 53 | logging.info("Testing mode initiated. No message will be modified on the server.") |
648f0037 | 54 | else: |
f9fd9b29 | 55 | logging.info("Update mode initiated. Messages will be modified.") |
3b81023f | 56 | |
97bd6bea | 57 | # proceed to main functionality |
d0cfa9d0 PD |
58 | try: |
59 | synchronize_csv(config, args.test_mode) | |
60 | except KeyboardInterrupt: | |
61 | logging.info("Script was interrupted by the user.") | |
97bd6bea | 62 | |
28d8aa17 | 63 | logging.info("All done. Exiting.") |
97bd6bea PD |
64 | return |
65 | ||
66 | def load_configuration(): | |
67 | """Loads the script configuration from a file or creates such.""" | |
68 | config = configparser.RawConfigParser() | |
6177b21d | 69 | success = config.read(CONFIG_FILENAME) |
95467f63 PD |
70 | try: |
71 | config.get('basic_settings', 'file_log_level') | |
72 | config.get('basic_settings', 'console_log_level') | |
73 | config.get('basic_settings', 'imap_server') | |
74 | config.getint('basic_settings', 'tolerance_mins') | |
a05fef0a PD |
75 | config.getboolean('basic_settings', 'skip_shared_folders') |
76 | config.getboolean('basic_settings', 'fallback_to_date_header') | |
95467f63 PD |
77 | except configparser.NoOptionError: |
78 | success = [] | |
79 | except ValueError: | |
80 | success = [] | |
81 | ||
82 | # if corrupted settings save file and load default | |
97bd6bea | 83 | if(len(success)==0): |
95467f63 PD |
84 | if(not config.has_section('basic_settings')): |
85 | config.add_section('basic_settings') | |
97bd6bea PD |
86 | config.set('basic_settings', 'file_log_level', logging.INFO) |
87 | config.set('basic_settings', 'console_log_level', logging.INFO) | |
88 | config.set('basic_settings', 'imap_server', 'imap.company.com') | |
a936a06b | 89 | config.set('basic_settings', 'tolerance_mins', 30) |
a05fef0a PD |
90 | config.set('basic_settings', 'skip_shared_folders', True) |
91 | config.set('basic_settings', 'fallback_to_date_header', False) | |
6177b21d | 92 | with open(CONFIG_FILENAME, 'w') as configfile: |
97bd6bea | 93 | config.write(configfile) |
926e6e98 | 94 | configfile.write("# 0 NOTSET, 10 DEBUG, 20 INFO, 30 WARNING, 40 ERROR, 50 CRITICAL") |
95467f63 | 95 | |
97bd6bea PD |
96 | return config |
97 | ||
98 | def prepare_logger(config): | |
99 | """Sets up the logging functionality""" | |
6177b21d | 100 | |
97bd6bea | 101 | # reset the log |
6177b21d | 102 | with open(LOG_FILENAME, 'w'): |
97bd6bea | 103 | pass |
6177b21d | 104 | |
97bd6bea | 105 | # add basic configuration |
6177b21d | 106 | logging.basicConfig(filename=LOG_FILENAME, |
97bd6bea PD |
107 | format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', |
108 | level=config.getint('basic_settings', 'file_log_level')) | |
6177b21d | 109 | |
97bd6bea PD |
110 | # add a handler for a console output |
111 | console = logging.StreamHandler() | |
112 | console.setLevel(config.getint('basic_settings', 'console_log_level')) | |
113 | formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') | |
114 | console.setFormatter(formatter) | |
115 | logging.getLogger('').addHandler(console) | |
116 | return | |
117 | ||
118 | def synchronize_csv(config, test_mode): | |
119 | """Iterates through csv list of users and synchronizes their messages.""" | |
120 | ||
121 | # initialize loop permanent data | |
122 | caching_data = CachingData() | |
123 | date_parser = MailDateParser() | |
c9da760a | 124 | server = config.get('basic_settings', 'imap_server') |
a936a06b | 125 | tolerance = config.getint('basic_settings', 'tolerance_mins') * 60 |
c9da760a | 126 | |
97bd6bea | 127 | # iterate through the users in the csv data |
6177b21d | 128 | user_reader = csv.DictReader(open(CSV_FILENAME, "r"), delimiter=',') |
c9da760a PD |
129 | for user in user_reader: |
130 | try: | |
95467f63 | 131 | session = MailIterator(server, user['username'], user['password'], |
a05fef0a | 132 | config.getboolean('basic_settings', 'skip_shared_folders')) |
c9da760a PD |
133 | except UserWarning as ex: |
134 | logging.error(ex) | |
135 | continue | |
136 | for mailbox in session: | |
137 | try: | |
7a1d4c35 | 138 | box = caching_data.retrieve_cached_mailbox(mailbox[0], mailbox[1], user['username']) |
c9da760a | 139 | mail_ids = session.fetch_messages() |
3b81023f | 140 | new_ids = box.synchronize(mail_ids, tolerance) |
6f2bc406 | 141 | logging.info("%s new messages out of %s found in %s.", len(new_ids), len(mail_ids), box.name) |
c9da760a PD |
142 | except UserWarning as ex: |
143 | logging.error(ex) | |
144 | continue | |
8301e589 | 145 | for mid in new_ids: |
c9da760a PD |
146 | try: |
147 | fetched_internal_date = session.fetch_internal_date(mid) | |
8a9d4c89 | 148 | internal_date = date_parser.extract_internal_date(fetched_internal_date) |
87cde111 PD |
149 | fetched_correct_date = session.fetch_received_date(mid) |
150 | correct_date = date_parser.extract_received_date(fetched_correct_date) | |
151 | # check for empty received headers | |
152 | if(correct_date == ""): | |
d5ccfbec | 153 | logging.debug("No received date could be found in message uid: %s - mailbox: %s - user: %s.", |
8a9d4c89 | 154 | mid.decode('iso-8859-1'), box.name, box.owner) |
7a1d4c35 | 155 | box.no_received_field += 1 |
87cde111 | 156 | # correct these messages if required and override received_date from basic date |
a05fef0a | 157 | if(config.getboolean('basic_settings', 'fallback_to_date_header')): |
87cde111 PD |
158 | fetched_correct_date = session.fetch_basic_date(mid) |
159 | correct_date = date_parser.extract_received_date(fetched_correct_date) | |
031ddbdf TJ |
160 | if(correct_date == ""): |
161 | logging.debug("No fallback date header could be found in message uid: %s - mailbox: %s - user: %s.", | |
162 | mid.decode('iso-8859-1'), box.name, box.owner) | |
163 | ||
164 | if(correct_date == ""): | |
87cde111 PD |
165 | # skip synchronization for this message |
166 | continue | |
167 | else: | |
168 | # preserve only the first received line as fetched if everything is ok | |
169 | fetched_correct_date = fetched_correct_date.split("Received:")[1] | |
c9da760a PD |
170 | except UserWarning as ex: |
171 | logging.error(ex) | |
172 | continue | |
87cde111 PD |
173 | if(date_parser.compare_dates(correct_date, internal_date, tolerance)): |
174 | logging.warning("Date conflict found in message uid: %s - mailbox: %s - user: %s.\nInternal date %s is different from extracted date %s from header:\n%s.", | |
36f4d196 TJ |
175 | mid.decode('iso-8859-1'), box.name, box.owner, |
176 | internal_date.strftime("%d %b %Y %H:%M:%S"), | |
87cde111 PD |
177 | correct_date.strftime("%d %b %Y %H:%M:%S"), |
178 | fetched_correct_date) | |
5a4bc5d8 | 179 | if(not test_mode): |
c9da760a | 180 | try: |
87cde111 | 181 | session.update_message(mid, box.name, correct_date) |
c9da760a PD |
182 | except UserWarning as ex: |
183 | logging.error(ex) | |
184 | continue | |
36f4d196 | 185 | |
8301e589 | 186 | # count total emails for every user and mailbox |
7a1d4c35 | 187 | box.date_conflicts += 1 |
36f4d196 | 188 | |
8301e589 | 189 | # if all messages were successfully fixed confirm caching |
97bd6bea | 190 | if(not test_mode): |
7a1d4c35 | 191 | box.confirm_change() |
6177b21d | 192 | |
08ba5736 PD |
193 | # final report on date conflicts |
194 | caching_data.report_conflicts() | |
8fe4e3ff PD |
195 | return |
196 | ||
c9da760a PD |
197 | if(__name__ == "__main__"): |
198 | main() |