class IMAPSearchClient(object):
def __init__(self, account):
self.account_id = account.id
self.log = get_logger().new(account_id=account.id,
component='search')
def _open_crispin_connection(self, db_session):
account = db_session.query(Account).get(self.account_id)
conn = account.auth_handler.connect_account(account)
try:
acct_provider_info = provider_info(account.provider)
except NotSupportedError:
self.log.warn('Account provider not supported',
provider=account.provider)
raise
self.crispin_client = CrispinClient(self.account_id,
acct_provider_info,
account.email_address,
conn,
readonly=True)
def _close_crispin_connection(self):
self.crispin_client.logout()
def search_messages(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for messages',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = self._search(db_session, search_query)
query = db_session.query(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids))\
.order_by(desc(Message.received_date))\
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def search_threads(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for threads',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = self._search(db_session, search_query)
query = db_session.query(Thread) \
.join(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids),
Thread.id == Message.thread_id)\
.order_by(desc(Message.received_date))
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def _search(self, db_session, search_query):
self._open_crispin_connection(db_session)
if ':' not in search_query:
try:
query = search_query.encode('ascii')
criteria = 'TEXT {}'.format(query)
except UnicodeEncodeError:
criteria = u'TEXT {}'.format(search_query)
else:
criteria = re.sub('(\w+:[ ]?)', format_key, search_query)
folders = db_session.query(Folder).filter(
Folder.account_id == self.account_id).all()
imap_uids = set()
for folder in folders:
imap_uids.update(self._search_folder(db_session,
folder, criteria))
self._close_crispin_connection()
return imap_uids
def _search_folder(self, db_session, folder, criteria):
self.crispin_client.select_folder(folder.name, uidvalidity_cb)
try:
if isinstance(criteria, unicode):
matching_uids = self.crispin_client.conn. \
search(criteria=criteria, charset="UTF-8")
else:
matching_uids = self.crispin_client.conn. \
search(criteria=criteria)
except IMAP4.error as e:
self.log.warn('Search error', error=e)
raise
self.log.debug('Search found message for folder',
folder_name=folder.name,
matching_uids=len(matching_uids))
return matching_uids
class IMAPSearchClient(object):
def __init__(self, account):
self.account = account
self.account_id = account.id
self.log = get_logger().new(account_id=account.id,
component='search')
def _open_crispin_connection(self, db_session):
account = db_session.query(Account).get(self.account_id)
try:
conn = account.auth_handler.connect_account(account)
except (IMAPClient.Error, socket.error, IMAP4.error):
raise SearchBackendException(('Unable to connect to the IMAP '
'server. Please retry in a '
'couple minutes.'), 503)
except ValidationError:
raise SearchBackendException(("This search can't be performed "
"because the account's credentials "
"are out of date. Please "
"reauthenticate and try again."), 403)
try:
acct_provider_info = provider_info(account.provider)
except NotSupportedError:
self.log.warn('Account provider not supported',
provider=account.provider)
raise
self.crispin_client = CrispinClient(self.account_id,
acct_provider_info,
account.email_address,
conn,
readonly=True)
def _close_crispin_connection(self):
self.crispin_client.logout()
def search_messages(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for messages',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = []
for uids in self._search(db_session, search_query):
imap_uids.extend(uids)
query = db_session.query(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids))\
.order_by(desc(Message.received_date))\
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def stream_messages(self, search_query):
def g():
encoder = APIEncoder()
with session_scope(self.account_id) as db_session:
for imap_uids in self._search(db_session, search_query):
query = db_session.query(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids))\
.order_by(desc(Message.received_date))\
yield encoder.cereal(query.all()) + '\n'
return g
def search_threads(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for threads',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = []
for uids in self._search(db_session, search_query):
imap_uids.extend(uids)
query = db_session.query(Thread) \
.join(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids),
Thread.id == Message.thread_id)\
.order_by(desc(Message.received_date))
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def stream_threads(self, search_query):
def g():
encoder = APIEncoder()
with session_scope(self.account_id) as db_session:
for imap_uids in self._search(db_session, search_query):
query = db_session.query(Thread) \
.join(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids),
Thread.id == Message.thread_id)\
.order_by(desc(Message.received_date))
yield encoder.cereal(query.all()) + '\n'
return g
def _search(self, db_session, search_query):
self._open_crispin_connection(db_session)
try:
criteria = ['TEXT', search_query.encode('ascii')]
charset = None
except UnicodeEncodeError:
criteria = [u'TEXT', search_query]
charset = 'UTF-8'
folders = []
account_folders = db_session.query(Folder).filter(
Folder.account_id == self.account_id)
# We want to start the search with the 'inbox', 'sent'
# and 'archive' folders, if they exist.
for cname in ['inbox', 'sent', 'archive']:
special_folder = db_session.query(Folder).filter(
Folder.account_id == self.account_id,
Folder.canonical_name == cname).one_or_none()
if special_folder is not None:
folders.append(special_folder)
# Don't search the folder twice.
account_folders = account_folders.filter(
Folder.id != special_folder.id)
folders = folders + account_folders.all()
for folder in folders:
yield self._search_folder(folder, criteria, charset)
self._close_crispin_connection()
def _search_folder(self, folder, criteria, charset):
try:
self.crispin_client.select_folder(folder.name, uidvalidity_cb)
except FolderMissingError:
self.log.warn("Won't search missing IMAP folder", exc_info=True)
return []
except UidInvalid:
self.log.error(("Got Uidvalidity error when searching. "
"Skipping."), exc_info=True)
return []
try:
uids = self.crispin_client.conn.search(criteria, charset=charset)
except IMAP4.error:
self.log.warn('Search error', exc_info=True)
raise SearchBackendException(('Unknown IMAP error when '
'performing search.'), 503)
self.log.debug('Search found messages for folder',
folder_name=folder.name,
uids=len(uids))
return uids
class IMAPSearchClient(object):
def __init__(self, account):
self.account_id = account.id
self.log = get_logger().new(account_id=account.id, component='search')
def _open_crispin_connection(self, db_session):
account = db_session.query(Account).get(self.account_id)
conn = account.auth_handler.connect_account(account)
try:
acct_provider_info = provider_info(account.provider)
except NotSupportedError:
self.log.warn('Account provider not supported',
provider=account.provider)
raise
self.crispin_client = CrispinClient(self.account_id,
acct_provider_info,
account.email_address,
conn,
readonly=True)
def _close_crispin_connection(self):
self.crispin_client.logout()
def search_messages(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for messages',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = self._search(db_session, search_query)
query = db_session.query(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids))\
.order_by(desc(Message.received_date))\
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def search_threads(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for threads',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = self._search(db_session, search_query)
query = db_session.query(Thread) \
.join(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids),
Thread.id == Message.thread_id)\
.order_by(desc(Message.received_date))
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def _search(self, db_session, search_query):
self._open_crispin_connection(db_session)
if ':' not in search_query:
try:
query = search_query.encode('ascii')
criteria = 'TEXT {}'.format(query)
except UnicodeEncodeError:
criteria = u'TEXT {}'.format(search_query)
else:
criteria = re.sub('(\w+:[ ]?)', format_key, search_query)
folders = db_session.query(Folder).filter(
Folder.account_id == self.account_id).all()
imap_uids = set()
for folder in folders:
imap_uids.update(self._search_folder(db_session, folder, criteria))
self._close_crispin_connection()
return imap_uids
def _search_folder(self, db_session, folder, criteria):
self.crispin_client.select_folder(folder.name, uidvalidity_cb)
try:
if isinstance(criteria, unicode):
matching_uids = self.crispin_client.conn. \
search(criteria=criteria, charset="UTF-8")
else:
matching_uids = self.crispin_client.conn. \
search(criteria=criteria)
except IMAP4.error as e:
self.log.warn('Search error', error=e)
raise
self.log.debug('Search found message for folder',
folder_name=folder.name,
matching_uids=len(matching_uids))
return matching_uids
class IMAPSearchClient(object):
def __init__(self, account):
self.account_id = account.id
self.log = get_logger().new(account_id=account.id,
component='search')
def _open_crispin_connection(self, db_session):
account = db_session.query(Account).get(self.account_id)
try:
conn = account.auth_handler.connect_account(account)
except ValidationError:
raise SearchBackendException(
"This search can't be performed because the account's "
"credentials are out of date. Please reauthenticate and try "
"again.", 403)
try:
acct_provider_info = provider_info(account.provider)
except NotSupportedError:
self.log.warn('Account provider not supported',
provider=account.provider)
raise
self.crispin_client = CrispinClient(self.account_id,
acct_provider_info,
account.email_address,
conn,
readonly=True)
def _close_crispin_connection(self):
self.crispin_client.logout()
def search_messages(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for messages',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = self._search(db_session, search_query)
query = db_session.query(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids))\
.order_by(desc(Message.received_date))\
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def search_threads(self, db_session, search_query, offset=0, limit=40):
self.log.info('Searching account for threads',
account_id=self.account_id,
query=search_query,
offset=offset,
limit=limit)
imap_uids = self._search(db_session, search_query)
query = db_session.query(Thread) \
.join(Message) \
.join(ImapUid) \
.filter(ImapUid.account_id == self.account_id,
ImapUid.msg_uid.in_(imap_uids),
Thread.id == Message.thread_id)\
.order_by(desc(Message.received_date))
if offset:
query = query.offset(offset)
if limit:
query = query.limit(limit)
return query.all()
def _search(self, db_session, search_query):
self._open_crispin_connection(db_session)
try:
criteria = ['TEXT', search_query.encode('ascii')]
charset = None
except UnicodeEncodeError:
criteria = [u'TEXT', search_query]
charset = 'UTF-8'
folders = db_session.query(Folder).filter(
Folder.account_id == self.account_id).all()
imap_uids = set()
for folder in folders:
imap_uids.update(self._search_folder(folder,
criteria,
charset))
self._close_crispin_connection()
return imap_uids
def _search_folder(self, folder, criteria, charset):
self.crispin_client.select_folder(folder.name, uidvalidity_cb)
try:
uids = self.crispin_client.conn.search(criteria, charset=charset)
except IMAP4.error as e:
self.log.warn('Search error', error=e)
raise
self.log.debug('Search found messages for folder',
folder_name=folder.name,
uids=len(uids))
return uids