2 caching_data.py - The module contains the CachingData class.
4 Copyright (c) 2012 Intra2net AG
5 Author: Plamen Dimitrov
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.
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.
20 from mailbox_state import MailboxState
22 CACHE_FILENAME = "message_cache.dat"
26 """This class is responsible for the caching of data."""
29 # integer for version of the cache
31 # dictionary of usernames as keys and dictionaries as values
32 # the second dictionaries have unique mailbox keys and mailboxes as values
36 # open data file or create one and initialize date if not found
38 cachefile = open(CACHE_FILENAME, 'rb')
39 self.version, self.data = pickle.load(cachefile)
40 if(self.version != CACHE_VERSION):
41 logging.warning("Cache file has version %s and the script version is %s.",
42 self.version, CACHE_VERSION)
44 logging.info("Cache version %s", self.version)
45 logging.debug("%s users found.", len(self.data))
47 self.version = CACHE_VERSION
49 with open(CACHE_FILENAME, 'wb') as cachefile:
50 pickle.dump((self.version, self.data), cachefile)
53 # create temporary file first
54 location = os.path.dirname(CACHE_FILENAME)
55 file_descriptor, tmpname = tempfile.mkstemp(dir=location)
57 cachefile = os.fdopen(file_descriptor, 'wb')
59 # prepare data based on a save flag
61 for user in self.data:
63 for box_key in self.data[user]:
64 if(self.data[user][box_key].needs_save):
65 saved_data[user][box_key] = self.data[user][box_key]
66 logging.debug("The mailbox %s will be saved.", saved_data[user][box_key].name)
67 if(len(saved_data[user])==0):
69 logging.debug("The user %s will not be saved.", user)
70 self.data = saved_data
72 # avoid test mode or cases where nothing needs saving
73 if(len(saved_data)==0):
78 pickle.dump((self.version, self.data), cachefile)
79 logging.debug("%s users stored.", len(self.data))
81 os.rename(tmpname, CACHE_FILENAME)
85 def retrieve_cached_mailbox(self, name, uidvalidity, user):
86 """Retrieve a cached mailbox or create it."""
87 box_key = name.strip('"') + uidvalidity
88 if(user not in self.data):
90 logging.debug("New user %s cached.", user)
91 if(box_key not in self.data[user]):
92 self.data[user][box_key] = MailboxState(name, uidvalidity, user)
93 logging.debug("New mailbox %s cached.", box_key)
94 return self.data[user][box_key]
96 def report_conflicts(self):
97 """Write a date conflicts report in a file."""
98 with open("conflict_stats.txt", 'w') as statsfile:
99 owner_total_conflicts = {}
100 owner_total_missing = {}
101 for user in self.data:
102 owner_total_conflicts[user] = 0
103 owner_total_missing[user] = 0
104 for box_key in self.data[user]:
105 owner_total_conflicts[user] += self.data[user][box_key].date_conflicts
106 owner_total_missing[user] += self.data[user][box_key].no_received_field
107 statsfile.write("Total date conflicts to be corrected in a mailbox {0} are {1}.\n"\
108 .format(self.data[user][box_key].name, self.data[user][box_key].date_conflicts))
109 statsfile.write("Total messages without received headers in a mailbox {0} are {1}.\n"\
110 .format(self.data[user][box_key].name, self.data[user][box_key].no_received_field))
111 statsfile.write("Total date conflicts to be corrected for user {0} are {1}.\n\n"\
112 .format(user, owner_total_missing[user]))