1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
from . import ForeignDataWrapper, ANY, ALL
from .utils import log_to_postgres, ERROR, WARNING
from imaplib import IMAP4
import re
from multicorn.compat import basestring_
from email.header import decode_header
from imapclient import IMAPClient
from itertools import islice
try:
from itertools import zip_longest
except ImportError:
from itertools import izip_longest as zip_longest
from functools import reduce
STANDARD_FLAGS = {
'seen': 'Seen',
'flagged': 'Flagged',
'delete': 'Deleted',
'draft': 'Draft',
'recent': 'Recent'
}
SEARCH_HEADERS = ['BCC', 'CC', 'FROM', 'TO']
def compact_fetch(messages):
"""Compact result in ranges.
For example, [1, 2, 3, 4, 10, 11, 12, 14, 17, 18, 19, 21, 92]
can be compacted in ['1:4', '10:12', '14', '17:19', '21', '92']
"""
first_i = messages[0]
for (i, inext) in zip_longest(messages, islice(messages, 1, None)):
if inext == i + 1:
continue
elif first_i != i:
yield '%s:%s' % (first_i, i)
first_i = inext
else:
yield "%s" % i
first_i = inext
class NoMatchPossible(Exception):
"""An exception raised when the conditions can NOT be met by any message,
ever."""
def make_or(values):
"""Create an imap OR filter based on a list of conditions to be or'ed"""
values = [x for x in values if x not in (None, '()')]
if values:
if len(values) > 1:
return reduce(lambda x, y: '(OR %s %s)' % (x, y), values)
else:
return values[0]
class ImapFdw(ForeignDataWrapper):
"""An imap foreign data wrapper
"""
def __init__(self, options, columns):
super(ImapFdw, self).__init__(options, columns)
self._imap_agent = None
self.host = options.get('host', None)
if self.host is None:
log_to_postgres('You MUST set the imap host',
ERROR)
self.port = options.get('port', None)
self.ssl = options.get('ssl', False)
self.login = options.get('login', None)
self.password = options.get('password', None)
self.folder = options.get('folder', 'INBOX')
self.imap_server_charset = options.get('imap_server_charset', 'UTF8')
self.columns = columns
self.payload_column = options.get('payload_column', None)
self.flags_column = options.get('flags_column', None)
self.internaldate_column = options.get('internaldate_column', None)
def get_rel_size(self, quals, columns):
"""Inform the planner that it can be EXTREMELY costly to use the
payload column, and that a query on Message-ID will return only one row."""
width = len(columns) * 100
nb_rows = 1000000
if self.payload_column in columns:
width += 100000000000
nb_rows = nb_rows / (10 ** len(quals))
for qual in quals:
if qual.field_name.lower() == 'in-reply-to' and\
qual.operator == '=':
nb_rows = 10
if qual.field_name.lower() == 'message-id' and qual.operator == '=':
nb_rows = 1
break
return (nb_rows, width)
def _create_agent(self):
self._imap_agent = IMAPClient(self.host, self.port, ssl=self.ssl)
if self.login:
self._imap_agent.login(self.login, self.password)
self._imap_agent.select_folder(self.folder)
@property
def imap_agent(self):
if self._imap_agent is None:
self._create_agent()
try:
self._imap_agent.select_folder(self.folder)
except IMAP4.abort:
self._create_agent()
return self._imap_agent
def get_path_keys(self):
"""Helps the planner by supplying a list of list of access keys, as well
as a row estimate for each one."""
return [(('Message-ID',), 1), (('From',), 100), (('To',), 100),
(('In-Reply-To',), 10)]
def _make_condition(self, key, operator, value):
if operator not in ('~~', '!~~', '=', '<>', '@>', '&&', '~~*', '!~~*'):
# Do not manage special operators
return ''
if operator in ('~~', '!~~', '~~*', '!~~*') and\
isinstance(value, basestring_):
# 'Normalize' the sql like wildcards
if value.startswith(('%', '_')):
value = value[1:]
if value.endswith(('%', '_')):
value = value[:-1]
if re.match(r'.*[^\\][_%]', value):
return ''
value = value.replace('\\%', '%').replace('\\_', '_')
prefix = ''
if operator in ('!~~', '<>', '!~~*'):
if key == self.flags_column:
prefix = 'UN'
else:
prefix = 'NOT '
if isinstance(value, basestring_):
if value.lower() in STANDARD_FLAGS:
prefix = ''
value = value.upper()
if key == self.flags_column:
if operator == '@>':
# Contains on flags
return ' '.join(['%s%s' % (prefix,
(STANDARD_FLAGS.get(atom.lower(), '%s %s'
% ('KEYWORD', atom)))) for atom in value])
elif operator == '&&':
# Overlaps on flags => Or
values = ['(%s%s)' %
(prefix, (STANDARD_FLAGS.get(atom.lower(), '%s %s' %
('KEYWORD', atom)))) for atom in value]
return make_or(values)
else:
value = '\\\\%s' % value
elif key == self.payload_column:
value = 'TEXT "%s"' % value
elif key in SEARCH_HEADERS:
value = '%s "%s"' % (key, value)
else:
# Special case for Message-ID and In-Reply-To:
# zero-length strings are forbidden so dont bother
# searching them
if not value:
raise NoMatchPossible()
prefix = 'HEADER '
value = '%s "%s"' % (key, value)
return '%s%s' % (prefix, value)
def extract_conditions(self, quals):
"""Build an imap search criteria string from a list of quals"""
conditions = []
for qual in quals:
# Its a list, so we must translate ANY to OR, and ALL to AND
if qual.list_any_or_all == ANY:
values = [
'(%s)' % self._make_condition(qual.field_name,
qual.operator[0], value)
for value in qual.value]
conditions.append(make_or(values))
elif qual.list_any_or_all == ALL:
conditions.extend([
self._make_condition(qual.field_name, qual.operator[0],
value)
for value in qual.value])
else:
# its not a list, so everything is fine
conditions.append(self._make_condition(qual.field_name,
qual.operator, qual.value))
conditions = [x for x in conditions if x not in (None, '()')]
return conditions
def execute(self, quals, columns):
# The header dictionary maps columns to their imap search string
col_to_imap = {}
headers = []
for column in list(columns):
if column == self.payload_column:
col_to_imap[column] = 'BODY[TEXT]'
elif column == self.flags_column:
col_to_imap[column] = 'FLAGS'
elif column == self.internaldate_column:
col_to_imap[column] = 'INTERNALDATE'
else:
col_to_imap[column] = 'BODY[HEADER.FIELDS (%s)]' %\
column.upper()
headers.append(column)
try:
conditions = self.extract_conditions(quals) or ['ALL']
except NoMatchPossible:
matching_mails = []
else:
matching_mails = self.imap_agent.search(
charset=self.imap_server_charset,
criteria=conditions)
if matching_mails:
data = self.imap_agent.fetch(list(compact_fetch(matching_mails)),
list(col_to_imap.values()))
item = {}
for msg in data.values():
for column, key in col_to_imap.items():
item[column] = msg[key]
if column in headers:
item[column] = item[column].split(':', 1)[-1].strip()
values = decode_header(item[column])
for decoded_header, charset in values:
# Values are of the from "Header: value"
if charset:
try:
item[column] = decoded_header.decode(
charset)
except LookupError:
log_to_postgres('Unknown encoding: %s' %
charset, WARNING)
else:
item[column] = decoded_header
yield item
|
