From 27196a21aee2710b8c138cfd6265282bf0f92172 Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Sun, 20 Jan 2013 23:01:54 -0800 Subject: Modernize the Gmail plugin. --- sleekxmpp/plugins/gmail/__init__.py | 15 +++++ sleekxmpp/plugins/gmail/notifications.py | 92 ++++++++++++++++++++++++++++ sleekxmpp/plugins/gmail/stanza.py | 101 +++++++++++++++++++++++++++++++ 3 files changed, 208 insertions(+) create mode 100644 sleekxmpp/plugins/gmail/__init__.py create mode 100644 sleekxmpp/plugins/gmail/notifications.py create mode 100644 sleekxmpp/plugins/gmail/stanza.py (limited to 'sleekxmpp/plugins/gmail') diff --git a/sleekxmpp/plugins/gmail/__init__.py b/sleekxmpp/plugins/gmail/__init__.py new file mode 100644 index 00000000..a87c78bb --- /dev/null +++ b/sleekxmpp/plugins/gmail/__init__.py @@ -0,0 +1,15 @@ +""" + SleekXMPP: The Sleek XMPP Library + Copyright (C) 2013 Nathanael C. Fritz, Lance J.T. Stout + This file is part of SleekXMPP. + + See the file LICENSE for copying permission. +""" + +from sleekxmpp.plugins.base import register_plugin + +from sleekxmpp.plugins.gmail import stanza +from sleekxmpp.plugins.gmail.notifications import Gmail + + +register_plugin(Gmail) diff --git a/sleekxmpp/plugins/gmail/notifications.py b/sleekxmpp/plugins/gmail/notifications.py new file mode 100644 index 00000000..6c8a4a02 --- /dev/null +++ b/sleekxmpp/plugins/gmail/notifications.py @@ -0,0 +1,92 @@ +""" + SleekXMPP: The Sleek XMPP Library + Copyright (C) 2013 Nathanael C. Fritz, Lance J.T. Stout + This file is part of SleekXMPP. + + See the file LICENSE for copying permission. +""" + +import logging + +from sleekxmpp.stanza import Iq +from sleekxmpp.xmlstream.handler import Callback +from sleekxmpp.xmlstream.matcher import MatchXPath +from sleekxmpp.xmlstream import register_stanza_plugin +from sleekxmpp.plugins import BasePlugin +from sleekxmpp.plugins.gmail import stanza + + +log = logging.getLogger(__name__) + + +class Gmail(BasePlugin): + + """ + Google: Gmail Notifications + + Also see . + """ + + name = 'gmail' + description = 'Google: Gmail Notifications' + dependencies = set() + stanza = stanza + + def plugin_init(self): + register_stanza_plugin(Iq, stanza.GmailQuery) + register_stanza_plugin(Iq, stanza.MailBox) + register_stanza_plugin(Iq, stanza.NewMail) + + self.xmpp.register_handler( + Callback('Gmail Result', + MatchXPath('{%s}iq/{%s}%s' % ( + self.xmpp.default_ns, + stanza.MailBox.namespace, + stanza.MailBox.name)), + self._handle_gmail)) + + self.xmpp.register_handler( + Callback('Gmail New Mail', + MatchXPath('{%s}iq/{%s}%s' % ( + self.xmpp.default_ns, + stanza.NewMail.namespace, + stanza.NewMail.name)), + self._handle_new_mail)) + + self._last_result_time = None + + def plugin_end(self): + self.xmpp.remove_handler('Gmail Result') + self.xmpp.remove_handler('Gmail New Mail') + + def _handle_gmail(self, iq): + mailbox = iq['gmail_results'] + log.info('Gmail: Received%s %s emails', + ' approximately' if mailbox['estimated'] else '', + mailbox['matched']) + self._last_result_time = mailbox['result_time'] + self.xmpp.event('gmail_messages', iq) + + def _handle_new_mail(self, iq): + log.info("Gmail: New emails received!") + self.xmpp.event('gmail_notify', iq) + self.check(block=False) + + def check(self, block=True, timeout=None, callback=None): + return self.search(newer=self._last_result_time, + block=block, + timeout=timeout, + callback=callback) + + def search(self, query=None, newer=None, block=True, + timeout=None, callback=None): + if not query: + log.info('Gmail: Checking for new email') + else: + log.info('Gmail: Searching for emails matching: "%s"', query) + iq = self.xmpp.Iq() + iq['type'] = 'get' + iq['to'] = self.xmpp.boundjid.bare + iq['gmail']['search'] = query + iq['gmail']['newer_than_time'] = newer + return iq.send(block=block, timeout=timeout, callback=callback) diff --git a/sleekxmpp/plugins/gmail/stanza.py b/sleekxmpp/plugins/gmail/stanza.py new file mode 100644 index 00000000..fe56177d --- /dev/null +++ b/sleekxmpp/plugins/gmail/stanza.py @@ -0,0 +1,101 @@ +""" + SleekXMPP: The Sleek XMPP Library + Copyright (C) 2013 Nathanael C. Fritz, Lance J.T. Stout + This file is part of SleekXMPP. + + See the file LICENSE for copying permission. +""" + +from sleekxmpp.xmlstream import ElementBase, register_stanza_plugin + + +class GmailQuery(ElementBase): + namespace = 'google:mail:notify' + name = 'query' + plugin_attrib = 'gmail' + interfaces = set(['newer_than_time', 'newer_than_tid', 'search']) + + def get_search(self): + return self._get_attr('q', '') + + def set_search(self, search): + self._set_attr('q', search) + + def del_search(self): + self._del_attr('q') + + def get_newer_than_time(self): + return self._get_attr('newer-than-time', '') + + def set_newer_than_time(self, value): + self._set_attr('newer-than-time', value) + + def del_newer_than_time(self): + self._del_attr('newer-than-time') + + def get_newer_than_tid(self): + return self._get_attr('newer-than-tid', '') + + def set_newer_than_tid(self, value): + self._set_attr('newer-than-tid', value) + + def del_newer_than_tid(self): + self._del_attr('newer-than-tid') + + +class MailBox(ElementBase): + namespace = 'google:mail:notify' + name = 'mailbox' + plugin_attrib = 'gmail_results' + interfaces = set(['result_time', 'url', 'matched', 'estimate']) + + def get_matched(self): + return self._get_attr('total-matched', '') + + def get_estimate(self): + return self._get_attr('total-estimate', '') == '1' + + def get_result_time(self): + return self._get_attr('result-time', '') + + +class MailThread(ElementBase): + namespace = 'google:mail:notify' + name = 'mail-thread-info' + plugin_attrib = 'thread' + plugin_multi_attrib = 'threads' + interfaces = set(['tid', 'participation', 'messages', 'date', + 'senders', 'url', 'labels', 'subject', 'snippet']) + sub_interfaces = set(['labels', 'subject', 'snippet']) + + def get_senders(self): + result = [] + senders = self.xml.findall('{%s}senders/{%s}sender' % ( + self.namespace, self.namespace)) + + for sender in senders: + result.append(MailSender(xml=sender)) + + return result + + +class MailSender(ElementBase): + namespace = 'google:mail:notify' + name = 'sender' + plugin_attrib = name + interfaces = set(['address', 'name', 'originator', 'unread']) + + def get_originator(self): + return self.xml.attrib.get('originator', '0') == '1' + + def get_unread(self): + return self.xml.attrib.get('unread', '0') == '1' + + +class NewMail(ElementBase): + namespace = 'google:mail:notify' + name = 'new-mail' + plugin_attrib = 'gmail_notification' + + +register_stanza_plugin(MailBox, MailThread, iterable=True) -- cgit v1.2.3 From f34b9399cc3fa8bb87d0271293a891533c8dacfd Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Mon, 21 Jan 2013 01:37:42 -0800 Subject: Simplify Gmail notifications. --- sleekxmpp/plugins/gmail/notifications.py | 27 ++++++--------------------- sleekxmpp/plugins/gmail/stanza.py | 2 +- 2 files changed, 7 insertions(+), 22 deletions(-) (limited to 'sleekxmpp/plugins/gmail') diff --git a/sleekxmpp/plugins/gmail/notifications.py b/sleekxmpp/plugins/gmail/notifications.py index 6c8a4a02..dbc68162 100644 --- a/sleekxmpp/plugins/gmail/notifications.py +++ b/sleekxmpp/plugins/gmail/notifications.py @@ -37,14 +37,6 @@ class Gmail(BasePlugin): register_stanza_plugin(Iq, stanza.MailBox) register_stanza_plugin(Iq, stanza.NewMail) - self.xmpp.register_handler( - Callback('Gmail Result', - MatchXPath('{%s}iq/{%s}%s' % ( - self.xmpp.default_ns, - stanza.MailBox.namespace, - stanza.MailBox.name)), - self._handle_gmail)) - self.xmpp.register_handler( Callback('Gmail New Mail', MatchXPath('{%s}iq/{%s}%s' % ( @@ -56,24 +48,17 @@ class Gmail(BasePlugin): self._last_result_time = None def plugin_end(self): - self.xmpp.remove_handler('Gmail Result') self.xmpp.remove_handler('Gmail New Mail') - def _handle_gmail(self, iq): - mailbox = iq['gmail_results'] - log.info('Gmail: Received%s %s emails', - ' approximately' if mailbox['estimated'] else '', - mailbox['matched']) - self._last_result_time = mailbox['result_time'] - self.xmpp.event('gmail_messages', iq) - def _handle_new_mail(self, iq): - log.info("Gmail: New emails received!") - self.xmpp.event('gmail_notify', iq) - self.check(block=False) + log.info("Gmail: New email!") + iq.reply().send() + self.xmpp.event('gmail_notification') def check(self, block=True, timeout=None, callback=None): - return self.search(newer=self._last_result_time, + last_time = self._last_result_time + self._last_result_time = str(int(time.time() * 1000)) + return self.search(newer=last_time, block=block, timeout=timeout, callback=callback) diff --git a/sleekxmpp/plugins/gmail/stanza.py b/sleekxmpp/plugins/gmail/stanza.py index fe56177d..e7e308e1 100644 --- a/sleekxmpp/plugins/gmail/stanza.py +++ b/sleekxmpp/plugins/gmail/stanza.py @@ -46,7 +46,7 @@ class GmailQuery(ElementBase): class MailBox(ElementBase): namespace = 'google:mail:notify' name = 'mailbox' - plugin_attrib = 'gmail_results' + plugin_attrib = 'gmail_messages' interfaces = set(['result_time', 'url', 'matched', 'estimate']) def get_matched(self): -- cgit v1.2.3