def __init__(self,
app=None,
address="push_sandbox",
failure_callback=None,
**cert_params):
"""
:param app: The app to init
:param address: The APNS address as understood by
:py:meth:`apnsclient.apns.Session.get_connection`
:param failure_callback: Called when calls to
:py:meth:`apnsclient.apns.APNs.send` returns failures
:param cert_params: Parameters to initialize
:py:class:`apnsclient.apns.Certificate`
"""
self.session = Session()
self.failed_callback = failure_callback
self._cert_params = cert_params
self._address = address
self._certificate = None
if app is not None:
self.session = self.init_app(app)
def test_send(self):
# success, retry + include-failed, don't-retry + include-failed
backend = DummyBackend(push=(None, 1, 3))
session = Session(pool=backend)
msg = Message(["0123456789ABCDEF", "FEDCBA9876543210"], alert="my alert", badge=10, content_available=1, my_extra=15)
push_con = session.get_connection("push_production", cert_string="certificate")
srv = APNs(push_con)
res = srv.send(msg)
self.assertEqual(len(res.failed), 0)
self.assertEqual(len(res.errors), 0)
self.assertFalse(res.needs_retry())
push_con2 = session.get_connection("push_production", cert_string="certificate")
srv = APNs(push_con2)
self.assertEqual(session.pool.push_result_pos, 0)
session.pool.push_result_pos += 1
res = srv.send(msg)
self.assertEqual(len(res.failed), 0)
self.assertEqual(len(res.errors), 1)
self.assertTrue(res.needs_retry())
# indeed, we have used the cache
self.assertEqual(session.pool.new_connections, 1)
push_con = session.new_connection("push_production", cert_string="certificate")
srv = APNs(push_con)
res = srv.send(msg)
self.assertEqual(len(res.failed), 0)
self.assertEqual(len(res.errors), 1)
self.assertFalse(res.needs_retry())
# indeed, new connection, we haven't used the cache
self.assertEqual(session.pool.new_connections, 2)
def test_send(self):
# success, retry + include-failed, don't-retry + include-failed
backend = DummyBackend(push=(None, 1, 3))
session = Session(pool=backend)
msg = Message(["0123456789ABCDEF", "FEDCBA9876543210"], alert="my alert", badge=10, content_available=1, my_extra=15)
push_con = session.get_connection("push_production", cert_string="certificate")
srv = APNs(push_con)
res = srv.send(msg)
self.assertEqual(len(res.failed), 0)
self.assertEqual(len(res.errors), 0)
self.assertFalse(res.needs_retry())
push_con2 = session.get_connection("push_production", cert_string="certificate")
srv = APNs(push_con2)
self.assertEqual(session.pool.push_result_pos, 0)
session.pool.push_result_pos += 1
res = srv.send(msg)
self.assertEqual(len(res.failed), 0)
self.assertEqual(len(res.errors), 1)
self.assertTrue(res.needs_retry())
# indeed, we have used the cache
self.assertEqual(session.pool.new_connections, 1)
push_con = session.new_connection("push_production", cert_string="certificate")
srv = APNs(push_con)
res = srv.send(msg)
self.assertEqual(len(res.failed), 0)
self.assertEqual(len(res.errors), 1)
self.assertFalse(res.needs_retry())
# indeed, new connection, we haven't used the cache
self.assertEqual(session.pool.new_connections, 2)
def connect_apns_server(cls, sandbox, p12, secret, timestamp):
pub_key, priv_key = cls.gen_pem(p12, secret)
session = Session(read_tail_timeout=1)
address = 'push_sandbox' if sandbox else 'push_production'
conn = session.get_connection(address,
cert_string=pub_key,
key_string=priv_key)
apns = APNs(conn)
return apns
def send_push_notifications(tokens, title, message, cert_file, url_args=None):
url_args = url_args or ["", ""]
session = Session()
conn = session.get_connection("push_production", cert_file=cert_file)
apns = APNs(conn)
payload = {}
payload["aps"] = {}
payload["aps"]["alert"] = {
"title": title,
"body": message,
}
payload["aps"]["url-args"] = url_args
message = Message(tokens, payload=payload)
apns.send(message)
def __init__(self):
""" Obtain cached connection to APNs.
Session caches connection descriptors, that remain open after use.
Caching saves SSL handshaking time. Handshaking is lazy, it will be
performed on first message send.
"""
# get cert file full path
run_path = os.getcwd()
cert_file = "%s/%s/%s" %(
run_path,
CONF.IOS.cert_child_path,
CONF.IOS.cert_file_name
)
# use Session create apns connection pool
try:
self.apns_session = Session()
self.apns_conn = self.apns_session.get_connection(
address=CONF.IOS.apns_address,
cert_file=cert_file,
passphrase=CONF.IOS.cert_passphrase
)
except Exception as _ex:
LOG.error("apns connect pool exception: %s" % str(_ex))
def push(token, message, badge_num, name, item_type):
con = Session.new_connection(
("gateway.push.apple.com",
2195),
cert_file="cert.pem",
passphrase="this is the queue push key")
message_packet = Message(
token,
alert=message,
badge=badge_num,
user=name,
sound="default",
itemType=item_type)
srv = APNs(con)
res = srv.send(message_packet)
# Check failures. Check codes in APNs reference docs.
for token, reason in res.failed.items():
code, errmsg = reason
if res.needs_retry():
retry_message = res.retry()
res = srv.send(retry_message)
class ApnsPusher(Singleton):
def __init__(self):
""" Obtain cached connection to APNs.
Session caches connection descriptors, that remain open after use.
Caching saves SSL handshaking time. Handshaking is lazy, it will be
performed on first message send.
"""
# get cert file full path
run_path = os.getcwd()
cert_file = "%s/%s/%s" %(
run_path,
CONF.IOS.cert_child_path,
CONF.IOS.cert_file_name
)
# use Session create apns connection pool
try:
self.apns_session = Session()
self.apns_conn = self.apns_session.get_connection(
address=CONF.IOS.apns_address,
cert_file=cert_file,
passphrase=CONF.IOS.cert_passphrase
)
except Exception as _ex:
LOG.error("apns connect pool exception: %s" % str(_ex))
def push(self, ios_users, device_tokens, alert, extra_kwargs):
"""Send message to ios.
The method will block until the whole message is sent. The method
returns :class:`Result` object, which you can examine for possible
errors and retry attempts.
"""
pid = os.getpid()
pname = multiprocessing.current_process().name
try:
msg = Message(device_tokens, alert=alert, badge=0, **extra_kwargs)
apns_service = APNs(self.apns_conn)
ret_obj = apns_service.send(msg)
failed_message = ret_obj._failed
if not failed_message:
LOG.info("pid(%s) pname(%s) apns pusher send data"
" to ios_users(%s) success"
% (pid, pname, ios_users))
else:
LOG.warn("pid(%s) pname(%s) apns pusher send result"
" part failed: %r"
%(pid, pname, failed_message))
except Exception as _ex:
LOG.error("pid(%s) pname(%s) apns send data exception: %s"
% (pid, pname, str(_ex)))
return False
return True
def push_to_ios_devices_raw(devices=None, **kwargs):
conn = Session.new_connection(settings.IOS_PUSH_SERVER,
cert_file=settings.IOS_CERT)
srv = APNs(conn)
if devices is None:
devices = APNSDevice.objects.filter(active=True).values_list(
"registration_id", flat=True)
message = Message(devices, **kwargs)
res = srv.send(message)
if res.needs_retry():
push_to_ios_devices_raw.delay(devices=res.retry().tokens, **kwargs)
def __init__(self, push_connection=False):
if not APNSProvider.session:
APNSProvider.session = Session()
if settings.DEBUG:
feedback_property = "feedback_sandbox"
push_property = "push_sandbox"
else:
feedback_property = "feedback_production"
push_property = "push_production"
self.connection = APNSProvider.session.new_connection(feedback_property, cert_file=settings.APNS_CERT) \
if not push_connection else APNSProvider.session.get_connection(push_property,
cert_file=settings.APNS_CERT)
def get_ios_device_feedback():
conn = Session.new_connection(settings.IOS_FEEDBACK_SERVER,
cert_file=settings.IOS_CERT)
srv = APNs(conn, tail_timeout=10)
for token, since in srv.feedback():
print token
try:
obj = APNSDevice.objects.get(registration_id=token)
obj.active = False
obj.save()
except APNSDevice.DoesNotExist:
pass
def remove_tokens():
# feedback needs no persistent connections.
con = Session.new_connection(("gateway.push.apple.com", 2196), cert_file=os.path.join(os.getcwd(), 'cert.pem'), passphrase="this is the queue push key")
# feedback server might be slow, so allow it to time out in 10 seconds
srv = APNs(con, tail_timeout=10)
# automatically closes connection for you
for token, since in srv.feedback():
user = db.session.query(User).filter(User.device_token == token).one()
user.device_token = None
db.session.add(user)
db.session.commit()
def connect_apns(cls, appid):
logging.debug("connecting apns")
p12, secret, timestamp = cls.get_p12(appid)
if not p12:
return None
if sandbox:
pem_file = "/tmp/app_%s_sandbox_%s.pem" % (appid, timestamp)
address = 'push_sandbox'
else:
pem_file = "/tmp/app_%s_%s.pem" % (appid, timestamp)
address = 'push_production'
if not os.path.isfile(pem_file):
pem = cls.gen_pem(p12, secret)
f = open(pem_file, "wb")
f.write(pem)
f.close()
session = Session(read_tail_timeout=1)
conn = session.get_connection(address, cert_file=pem_file)
apns = APNs(conn)
return apns
def connect_apns(cls, appid):
logging.debug("connecting apns")
p12, secret, timestamp = cls.get_p12(appid)
if not p12:
return None
if sandbox:
pem_file = "/tmp/app_%s_sandbox_%s.pem" % (appid, timestamp)
address = 'push_sandbox'
else:
pem_file = "/tmp/app_%s_%s.pem" % (appid, timestamp)
address = 'push_production'
if not os.path.isfile(pem_file):
pem = cls.gen_pem(p12, secret)
f = open(pem_file, "wb")
f.write(pem)
f.close()
session = Session(read_tail_timeout=1)
conn = session.get_connection(address, cert_file=pem_file)
apns = APNs(conn)
return apns
def _init_apns(self):
"""Obtain new connection to APNs. This method will not re-use existing
connection from the pool. The connection will be closed after use.
Unlike: `get_connection` this method does not cache the connection.
Use it to fetch feedback from APNs and then close when you are done.
"""
run_path = os.getcwd()
cert_file = "%s/%s/%s" %(
run_path,
CONF.IOS.cert_child_path,
CONF.IOS.cert_file_name
)
try:
session = Session()
self.apns_conn = session.new_connection(
address=CONF.IOS.feedback_address,
cert_file=cert_file,
passphrase=CONF.IOS.cert_passphrase
)
except Exception as _ex:
LOG.error("init feedback non-cached connection exception: %s"
% str(_ex))
class StdIOBackendTest(Python26Mixin, unittest.TestCase):
""" Test stdio features. """
def setUp(self):
self.session = Session(pool="apnsclient.backends.stdio")
def test_locking(self):
""" Test thread locking mechanism """
lock = self.session.pool.create_lock()
self.assertIsNotNone(lock)
self.assertTrue(hasattr(lock, "acquire"))
self.assertTrue(hasattr(lock, "release"))
lock.acquire()
lock.release()
def test_certificates(self):
""" Test pyOpenSSL certificates. """
cert = self.session.pool.get_certificate({
"cert_string": CERTIFICATE,
"key_string": PRIVATE_KEY,
"passphrase": PRIVATE_PASS
})
cert2 = self.session.pool.get_certificate({
"cert_string": (CERTIFICATE + b"\n" + PRIVATE_KEY),
"passphrase":
PRIVATE_PASS
})
self.assertIsNotNone(cert.get_context())
self.assertEqual(cert, cert2)
def test_outdate(self):
# we are not allowed to do any IO in tests, so no real connections.
# however, it is good idea to test utility functions even with empty pool.
self.session.outdate(datetime.timedelta(seconds=60))
self.session.shutdown()
class StdIOBackendTest(Python26Mixin, unittest.TestCase):
""" Test stdio features. """
def setUp(self):
self.session = Session(pool="apnsclient.backends.stdio")
def test_locking(self):
""" Test thread locking mechanism """
lock = self.session.pool.create_lock()
self.assertIsNotNone(lock)
self.assertTrue(hasattr(lock, "acquire"))
self.assertTrue(hasattr(lock, "release"))
lock.acquire()
lock.release()
def test_certificates(self):
""" Test pyOpenSSL certificates. """
cert = self.session.pool.get_certificate({
"cert_string": CERTIFICATE,
"key_string": PRIVATE_KEY,
"passphrase": PRIVATE_PASS
})
cert2 = self.session.pool.get_certificate({
"cert_string": (CERTIFICATE + b"\n" + PRIVATE_KEY),
"passphrase": PRIVATE_PASS
})
self.assertIsNotNone(cert.get_context())
self.assertEqual(cert, cert2)
def test_outdate(self):
# we are not allowed to do any IO in tests, so no real connections.
# however, it is good idea to test utility functions even with empty pool.
self.session.outdate(datetime.timedelta(seconds=60))
self.session.shutdown()
def __init__(self, config):
"""Create a new instance of the consumer class, passing in the AMQP
URL used to connect to RabbitMQ.
:param str amqp_url: The AMQP url to connect with
"""
self._connection = None
self._channel = None
self._closing = False
self._consumer_tag = None
self._url = 'amqp://*****:*****@{}:5672/%2F'.format(config.get('rabbitmq', 'server'))
self.config = config
self.ios_session = Session()
self.load_settings()
def __init__(self, app=None, address="push_sandbox", failure_callback=None,
**cert_params):
"""
:param app: The app to init
:param address: The APNS address as understood by
:py:meth:`apnsclient.apns.Session.get_connection`
:param failure_callback: Called when calls to
:py:meth:`apnsclient.apns.APNs.send` returns failures
:param cert_params: Parameters to initialize
:py:class:`apnsclient.apns.Certificate`
"""
self.session = Session()
self.failed_callback = failure_callback
self._cert_params = cert_params
self._address = address
self._certificate = None
if app is not None:
self.session = self.init_app(app)
#
from apnsclient import (
Session,
Message,
APNs
)
from pprint import pprint
# device token and private key's passwd
deviceToken = '097271a3744d951fe233729b649b0d5bcdfbf7e0c8c10e11fa99d02e5cfa87ac';
invalid_deviceToken = '097271a3744d951fe233729b649b0d5bcdfbf7e0c8c10e11fa99d02e5cfa87ed';
passphrase = '1234';
# 使用session对象来创建一个连接池
session = Session()
conn = session.get_connection("push_sandbox", cert_file="apns.pem", passphrase=passphrase)
# 发送推送和得到反馈
tokenList = []
tokenList.append(deviceToken)
#tokenList.append(invalid_deviceToken)
msg = Message(tokenList, alert="use python send", badge=10)
# send message
service = APNs(conn)
res = service.send(msg)
pprint(vars(res))
print res.message.__dict__
import os
from flask import Flask
# from flask.ext.apns import APNS
from apnsclient import Session
app = Flask(__name__)
app.config['APNS_CERT_FILE'] = os.environ.get('APNS_CERT_FILE')
app.config['APNS_KEY_FILE'] = os.environ.get('APNS_CERT_FILE')
app.config['APNS_ADDRESS'] = 'push_sandbox'
session = Session()
# apns = APNS(app)
@app.route('/push/<token>')
def push(token):
global session
con = session.get_connection(app.config('APNS_ADDRESS'),
cert_file=app.config['APNS_CERT_FILE'],
key_file=app.config['APNS_KEY_FILE'])
msg = Message([token], alert='My message', badge=3)
sr = APNs(con)
try:
res = srv.send(message)
except:
print "Can't connect to APNs, network is down"
else:
for token, reason in res.failed.items():
code, errmsg = reason
print "Device failed:{0}, reason:{1}".format(token, errmsg)
for code, errmsg in res.errors:
from __future__ import absolute_import
from zerver.models import PushDeviceToken
from zerver.lib.timestamp import timestamp_to_datetime
from zerver.decorator import statsd_increment
from apnsclient import Session, Message, APNs
import gcmclient
from django.conf import settings
import base64, binascii, logging, os
# Maintain a long-lived Session object to avoid having to re-SSL-handshake
# for each request
session = Session()
connection = None
if settings.APNS_CERT_FILE is not None and os.path.exists(
settings.APNS_CERT_FILE):
connection = session.get_connection(settings.APNS_SANDBOX,
cert_file=settings.APNS_CERT_FILE)
# We maintain an additional APNS connection for pushing to Zulip apps that have been signed
# by the Dropbox certs (and have an app id of com.dropbox.zulip)
dbx_session = Session()
dbx_connection = None
if settings.DBX_APNS_CERT_FILE is not None and os.path.exists(
settings.DBX_APNS_CERT_FILE):
dbx_connection = session.get_connection(
settings.APNS_SANDBOX, cert_file=settings.DBX_APNS_CERT_FILE)
def setUp(self):
self.session = Session(pool="apnsclient.backends.stdio")
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Author: jinlong.yang
#
from apnsclient import (
Session,
APNs
)
from pprint import pprint
session = Session()
conn =session.new_connection("feedback_sandbox", cert_file="apns.pem", passphrase="1234")
service = APNs(conn)
pprint(vars(service))
try:
# on any IO failure after successfull connection this generator
# will simply stop iterating. you will pick the rest of the tokens
# during next feedback session.
# feedback的接口取到的是上次推送的过程中出现的已卸载应用的设备token，而且获取一次之后就会清空
for token, when in service.feedback():
# every time a devices sends you a token, you should store
# {token: given_token, last_update: datetime.datetime.now()})
print token
print when
# the token wasn't updated after the failure has
# been reported, so the token is invalid and you should
from zerver.models import PushDeviceToken, UserProfile
from zerver.lib.timestamp import timestamp_to_datetime
from zerver.decorator import statsd_increment
from apnsclient import Session, Message, APNs
from apnsclient.apns import Connection
import gcmclient
from django.conf import settings
import base64, binascii, logging, os
# Maintain a long-lived Session object to avoid having to re-SSL-handshake
# for each request
session = Session()
connection = None
if settings.APNS_CERT_FILE is not None and os.path.exists(settings.APNS_CERT_FILE):
connection = session.get_connection(settings.APNS_SANDBOX, cert_file=settings.APNS_CERT_FILE)
# We maintain an additional APNS connection for pushing to Zulip apps that have been signed
# by the Dropbox certs (and have an app id of com.dropbox.zulip)
dbx_session = Session()
dbx_connection = None
if settings.DBX_APNS_CERT_FILE is not None and os.path.exists(settings.DBX_APNS_CERT_FILE):
dbx_connection = session.get_connection(settings.APNS_SANDBOX, cert_file=settings.DBX_APNS_CERT_FILE)
def num_push_devices_for_user(user_profile, kind = None):
# type: (UserProfile, Optional[int]) -> PushDeviceToken
if kind is None:
return PushDeviceToken.objects.filter(user=user_profile).count()
class APNS(object):
"""
APNS extension
"""
def __init__(self, app=None, address="push_sandbox", failure_callback=None,
**cert_params):
"""
:param app: The app to init
:param address: The APNS address as understood by
:py:meth:`apnsclient.apns.Session.get_connection`
:param failure_callback: Called when calls to
:py:meth:`apnsclient.apns.APNs.send` returns failures
:param cert_params: Parameters to initialize
:py:class:`apnsclient.apns.Certificate`
"""
self.session = Session()
self.failed_callback = failure_callback
self._cert_params = cert_params
self._address = address
self._certificate = None
if app is not None:
self.session = self.init_app(app)
def init_app(self, app):
"""
Init the flask app. Tries to get parameters from the flask config,
if not take them from the default ones passed in the constructor.
Available flask config:
* APNS_ADDRESS
* APNS_CERT_STRING
* APNS_CERT_FILE
* APNS_KEY_STRING
* APNS_KEY_FILE
* APNS_PASSPHRASE_STRING
* APNS_PASSPHRASE_FILE
:param app: The app to init
"""
if app.config.get('APNS_ADDRESS'):
self._address = app.config.get('APNS_ADDRESS')
cert_def = {}
for key in (
'cert_string', 'cert_file', 'key_string', 'key_file',
'passphrase'):
cert_def[key] = app.config.get(
'APNS_%s' % key.upper()) or self._cert_params.get(key)
# Handle PASSPHRASE_STRING vs PASSPHRASE_FILE
# This is easier for dev vs. conf file vs. env based deployment
# such as Heroku
cert_def['passphrase'] = app.config.get(
'APNS_PASSPHRASE_STRING') or self._cert_params.get('passphrase')
if not cert_def['passphrase']:
passphrase_file = app.config.get('APNS_PASSPHRASE_FILE')
if passphrase_file:
try:
with open(passphrase_file) as f:
cert_def['passphrase'] = f.read().strip()
except IOError:
pass
try:
self._certificate = Certificate(**cert_def)
except Exception as e:
print("APNS is disabled: %r" % e)
return self.session
def get_connection(self):
"""
Get a connection to APNS
:returns: :py:class:`apnsclient.apns.Connection`
"""
if self._certificate is None:
return None
return self.session.get_connection(self._address, self._certificate)
def send_message(self, tokens, alert=None, badge=None, sound=None,
expiry=None, payload=None, **extra):
"""
Send a message. This will not retry but will call the
failed_callback in case of failure
.. seealso::
:py:class:`apnsclient.apns.Message` for a better description of the
parameters
:param tokens: The tokens to send to
:param alert: The alert message
:param badge: The badge to show
:param sound: The sound to play
:param expiry: A timestamp when message will expire
:param payload: The payload
:param extra: Extra info
"""
connection = self.get_connection()
if connection is None:
return None
if not tokens:
return False
message = Message(tokens, alert, badge, sound, expiry, payload,
**extra)
srv = APNs(connection)
res = srv.send(message)
if res.failed and self.failed_callback:
for key, reason in res.failed.iterkeys():
self.failed_callback(key, reason)
return res
def test_feedback(self):
backend = DummyBackend(feedback=5)
session = Session(pool=backend)
feed_con = session.new_connection("feedback_production", cert_string="certificate")
srv = APNs(feed_con)
self.assertEqual(len(list(srv.feedback())), 5)
def setUp(self):
self.session = Session(pool="apnsclient.backends.stdio")
class MAXPushConversationsConsumer(object):
"""This is an example consumer that will handle unexpected interactions
with RabbitMQ such as channel and connection closures.
If RabbitMQ closes the connection, it will reopen it. You should
look at the output, as there are limited reasons why the connection may
be closed, which usually are tied to permission related issues or
socket timeouts.
If the channel is closed, it will indicate a problem with one of the
commands that were issued and that should surface in the output as well.
"""
QUEUE = 'push'
def __init__(self, config):
"""Create a new instance of the consumer class, passing in the AMQP
URL used to connect to RabbitMQ.
:param str amqp_url: The AMQP url to connect with
"""
self._connection = None
self._channel = None
self._closing = False
self._consumer_tag = None
self._url = 'amqp://*****:*****@{}:5672/%2F'.format(config.get('rabbitmq', 'server'))
self.config = config
self.ios_session = Session()
self.load_settings()
def connect(self):
"""This method connects to RabbitMQ, returning the connection handle.
When the connection is established, the on_connection_open method
will be invoked by pika.
:rtype: pika.SelectConnection
"""
LOGGER.info('Connecting to %s', self._url)
return pika.SelectConnection(pika.URLParameters(self._url),
self.on_connection_open,
stop_ioloop_on_close=False)
def close_connection(self):
"""This method closes the connection to RabbitMQ."""
LOGGER.info('Closing connection')
self._connection.close()
def add_on_connection_close_callback(self):
"""This method adds an on close callback that will be invoked by pika
when RabbitMQ closes the connection to the publisher unexpectedly.
"""
LOGGER.info('Adding connection close callback')
self._connection.add_on_close_callback(self.on_connection_closed)
def on_connection_closed(self, connection, reply_code, reply_text):
"""This method is invoked by pika when the connection to RabbitMQ is
closed unexpectedly. Since it is unexpected, we will reconnect to
RabbitMQ if it disconnects.
:param pika.connection.Connection connection: The closed connection obj
:param int reply_code: The server provided reply_code if given
:param str reply_text: The server provided reply_text if given
"""
self._channel = None
if self._closing:
self._connection.ioloop.stop()
else:
LOGGER.warning('Connection closed, reopening in 5 seconds: (%s) %s',
reply_code, reply_text)
self._connection.add_timeout(5, self.reconnect)
def on_connection_open(self, unused_connection):
"""This method is called by pika once the connection to RabbitMQ has
been established. It passes the handle to the connection object in
case we need it, but in this case, we'll just mark it unused.
:type unused_connection: pika.SelectConnection
"""
LOGGER.info('Connection opened')
self.add_on_connection_close_callback()
self.open_channel()
def reconnect(self):
"""Will be invoked by the IOLoop timer if the connection is
closed. See the on_connection_closed method.
"""
# This is the old connection IOLoop instance, stop its ioloop
self._connection.ioloop.stop()
if not self._closing:
# Create a new connection
self._connection = self.connect()
# There is now a new connection, needs a new ioloop to run
self._connection.ioloop.start()
def add_on_channel_close_callback(self):
"""This method tells pika to call the on_channel_closed method if
RabbitMQ unexpectedly closes the channel.
"""
LOGGER.info('Adding channel close callback')
self._channel.add_on_close_callback(self.on_channel_closed)
def on_channel_closed(self, channel, reply_code, reply_text):
"""Invoked by pika when RabbitMQ unexpectedly closes the channel.
Channels are usually closed if you attempt to do something that
violates the protocol, such as re-declare an exchange or queue with
different parameters. In this case, we'll close the connection
to shutdown the object.
:param pika.channel.Channel: The closed channel
:param int reply_code: The numeric reason the channel was closed
:param str reply_text: The text reason the channel was closed
"""
LOGGER.warning('Channel %i was closed: (%s) %s',
channel, reply_code, reply_text)
self._connection.close()
def on_channel_open(self, channel):
"""This method is invoked by pika when the channel has been opened.
The channel object is passed in so we can make use of it.
Since the channel is now open, we'll declare the exchange to use.
:param pika.channel.Channel channel: The channel object
"""
LOGGER.info('Channel opened')
self._channel = channel
self.add_on_channel_close_callback()
# self.setup_exchange(self.EXCHANGE)
self.setup_queue(self.QUEUE)
def setup_exchange(self, exchange_name):
"""Setup the exchange on RabbitMQ by invoking the Exchange.Declare RPC
command. When it is complete, the on_exchange_declareok method will
be invoked by pika.
:param str|unicode exchange_name: The name of the exchange to declare
"""
LOGGER.info('Declaring exchange %s', exchange_name)
self._channel.exchange_declare(self.on_exchange_declareok,
exchange_name,
self.EXCHANGE_TYPE)
def on_exchange_declareok(self, unused_frame):
"""Invoked by pika when RabbitMQ has finished the Exchange.Declare RPC
command.
:param pika.Frame.Method unused_frame: Exchange.DeclareOk response frame
"""
LOGGER.info('Exchange declared')
self.setup_queue(self.QUEUE)
def setup_queue(self, queue_name):
"""Setup the queue on RabbitMQ by invoking the Queue.Declare RPC
command. When it is complete, the on_queue_declareok method will
be invoked by pika.
:param str|unicode queue_name: The name of the queue to declare.
"""
LOGGER.info('Declaring queue %s', queue_name)
self._channel.queue_declare(self.on_queue_declareok, queue_name)
def on_queue_declareok(self, method_frame):
"""Method invoked by pika when the Queue.Declare RPC call made in
setup_queue has completed. In this method we will bind the queue
and exchange together with the routing key by issuing the Queue.Bind
RPC command. When this command is complete, the on_bindok method will
be invoked by pika.
:param pika.frame.Method method_frame: The Queue.DeclareOk frame
"""
LOGGER.info('Queue %s declared ok' % self.QUEUE)
self.start_consuming()
# self._channel.queue_bind(self.on_bindok, self.QUEUE,
# self.EXCHANGE, self.ROUTING_KEY)
def add_on_cancel_callback(self):
"""Add a callback that will be invoked if RabbitMQ cancels the consumer
for some reason. If RabbitMQ does cancel the consumer,
on_consumer_cancelled will be invoked by pika.
"""
LOGGER.info('Adding consumer cancellation callback')
self._channel.add_on_cancel_callback(self.on_consumer_cancelled)
def on_consumer_cancelled(self, method_frame):
"""Invoked by pika when RabbitMQ sends a Basic.Cancel for a consumer
receiving messages.
:param pika.frame.Method method_frame: The Basic.Cancel frame
"""
LOGGER.info('Consumer was cancelled remotely, shutting down: %r',
method_frame)
if self._channel:
self._channel.close()
def acknowledge_message(self, delivery_tag):
"""Acknowledge the message delivery from RabbitMQ by sending a
Basic.Ack RPC method for the delivery tag.
:param int delivery_tag: The delivery tag from the Basic.Deliver frame
"""
LOGGER.info('Acknowledging message %s', delivery_tag)
self._channel.basic_ack(delivery_tag)
def on_message(self, unused_channel, basic_deliver, properties, body):
"""Invoked by pika when a message is delivered from RabbitMQ. The
channel is passed for your convenience. The basic_deliver object that
is passed in carries the exchange, routing key, delivery tag and
a redelivered flag for the message. The properties passed in is an
instance of BasicProperties with the message properties and the body
is the message that was sent.
:param pika.channel.Channel unused_channel: The channel object
:param pika.Spec.Basic.Deliver: basic_deliver method
:param pika.Spec.BasicProperties: properties
:param str|unicode body: The message body
"""
LOGGER.info('Received message # %s from %s: %s',
basic_deliver.delivery_tag, properties.app_id, body)
self.processMessage(body)
self.acknowledge_message(basic_deliver.delivery_tag)
def on_cancelok(self, unused_frame):
"""This method is invoked by pika when RabbitMQ acknowledges the
cancellation of a consumer. At this point we will close the channel.
This will invoke the on_channel_closed method once the channel has been
closed, which will in-turn close the connection.
:param pika.frame.Method unused_frame: The Basic.CancelOk frame
"""
LOGGER.info('RabbitMQ acknowledged the cancellation of the consumer')
self.close_channel()
def stop_consuming(self):
"""Tell RabbitMQ that you would like to stop consuming by sending the
Basic.Cancel RPC command.
"""
if self._channel:
LOGGER.info('Sending a Basic.Cancel RPC command to RabbitMQ')
self._channel.basic_cancel(self.on_cancelok, self._consumer_tag)
def start_consuming(self):
"""This method sets up the consumer by first calling
add_on_cancel_callback so that the object is notified if RabbitMQ
cancels the consumer. It then issues the Basic.Consume RPC command
which returns the consumer tag that is used to uniquely identify the
consumer with RabbitMQ. We keep the value to use it when we want to
cancel consuming. The on_message method is passed in as a callback pika
will invoke when a message is fully received.
"""
LOGGER.info('Issuing consumer related RPC commands')
self.add_on_cancel_callback()
self._consumer_tag = self._channel.basic_consume(self.on_message,
self.QUEUE)
def on_bindok(self, unused_frame):
"""Invoked by pika when the Queue.Bind method has completed. At this
point we will start consuming messages by calling start_consuming
which will invoke the needed RPC commands to start the process.
:param pika.frame.Method unused_frame: The Queue.BindOk response frame
"""
LOGGER.info('Queue bound')
self.start_consuming()
def close_channel(self):
"""Call to close the channel with RabbitMQ cleanly by issuing the
Channel.Close RPC command.
"""
LOGGER.info('Closing the channel')
self._channel.close()
def open_channel(self):
"""Open a new channel with RabbitMQ by issuing the Channel.Open RPC
command. When RabbitMQ responds that the channel is open, the
on_channel_open callback will be invoked by pika.
"""
LOGGER.info('Creating a new channel')
self._connection.channel(on_open_callback=self.on_channel_open)
def run(self):
"""Run the example consumer by connecting to RabbitMQ and then
starting the IOLoop to block and allow the SelectConnection to operate.
"""
self._connection = self.connect()
self._connection.ioloop.start()
def stop(self):
"""Cleanly shutdown the connection to RabbitMQ by stopping the consumer
with RabbitMQ. When RabbitMQ confirms the cancellation, on_cancelok
will be invoked by pika, which will then closing the channel and
connection. The IOLoop is started again because this method is invoked
when CTRL-C is pressed raising a KeyboardInterrupt exception. This
exception stops the IOLoop which needs to be running for pika to
communicate with RabbitMQ. All of the commands issued prior to starting
the IOLoop will be buffered but not processed.
"""
LOGGER.info('Stopping')
self._closing = True
self.stop_consuming()
self._connection.ioloop.start()
LOGGER.info('Stopped')
def processMessage(self, message):
message = json.loads(message)
conversation_id = message.get('conversation', None)
if conversation_id is None:
LOGGER.info('The message received is not a valid conversation')
return
req = requests.get('{}/conversations/{}/tokens'.format(self.config.get('max', 'server'), conversation_id), headers=self.oauth2Header(self.restricted_username, self.restricted_token))
tokens = req.json()
itokens = []
atokens = []
for token in tokens.get('items'):
# TODO: On production, not send notification to sender
# if token.get('username') != message.get('username'):
if token.get('platform') == 'iOS':
itokens.append(token.get('token'))
elif token.get('platform') == 'android':
atokens.append(token.get('token'))
self.send_ios_push_notifications(itokens, message.get('message'))
self.send_android_push_notifications(atokens)
def send_ios_push_notifications(self, tokens, message):
con = self.ios_session.get_connection("push_production",
cert_file=self.config.get('push', 'push_certificate_file'))
message = Message(tokens, alert=message, badge=1, sound='default')
# Send the message.
srv = APNs(con)
res = srv.send(message)
# Check failures. Check codes in APNs reference docs.
for token, reason in res.failed.items():
code, errmsg = reason
LOGGER.info("Device push failed: {0}, reason: {1}".format(token, errmsg))
LOGGER.info("Successfully sended {} to {}.".format(message.alert, tokens))
def send_android_push_notifications(self, tokens):
pass
def load_settings(self):
settings_file = '{}/.max_restricted'.format(self.config.get('max', 'config_directory'))
if os.path.exists(settings_file):
settings = json.loads(open(settings_file).read())
else:
settings = {}
if 'token' not in settings or 'username' not in settings:
LOGGER.info("Unable to load MAX settings, please execute init_maxpush script.")
sys.exit(1)
self.restricted_username = settings.get('username')
self.restricted_token = settings.get('token')
def oauth2Header(self, username, token, scope="widgetcli"):
return {
"X-Oauth-Token": token,
"X-Oauth-Username": username,
"X-Oauth-Scope": scope}
def test_feedback(self):
backend = DummyBackend(feedback=5)
session = Session(pool=backend)
feed_con = session.new_connection("feedback_production", cert_string="certificate")
srv = APNs(feed_con)
self.assertEqual(len(list(srv.feedback())), 5)
class APNS(object):
"""
APNS extension
"""
def __init__(self,
app=None,
address="push_sandbox",
failure_callback=None,
**cert_params):
"""
:param app: The app to init
:param address: The APNS address as understood by
:py:meth:`apnsclient.apns.Session.get_connection`
:param failure_callback: Called when calls to
:py:meth:`apnsclient.apns.APNs.send` returns failures
:param cert_params: Parameters to initialize
:py:class:`apnsclient.apns.Certificate`
"""
self.session = Session()
self.failed_callback = failure_callback
self._cert_params = cert_params
self._address = address
self._certificate = None
if app is not None:
self.session = self.init_app(app)
def init_certificate(self, address="push_sandbox", **cert_params):
"""
Provide alternative to init certificate without providing app.
"""
self._cert_params = cert_params
self._address = address
self._certificate = None
try:
self._certificate = Certificate(**self._cert_params)
except Exception as e:
print("APNS is disabled: %r" % e)
def init_app(self, app):
"""
Init the flask app. Tries to get parameters from the flask config,
if not take them from the default ones passed in the constructor.
Available flask config:
* APNS_ADDRESS
* APNS_CERT_STRING
* APNS_CERT_FILE
* APNS_KEY_STRING
* APNS_KEY_FILE
* APNS_PASSPHRASE_STRING
* APNS_PASSPHRASE_FILE
:param app: The app to init
"""
if app.config.get('APNS_ADDRESS'):
self._address = app.config.get('APNS_ADDRESS')
cert_def = {}
for key in ('cert_string', 'cert_file', 'key_string', 'key_file',
'passphrase'):
cert_def[key] = app.config.get(
'APNS_%s' % key.upper()) or self._cert_params.get(key)
# Handle PASSPHRASE_STRING vs PASSPHRASE_FILE
# This is easier for dev vs. conf file vs. env based deployment
# such as Heroku
cert_def['passphrase'] = app.config.get(
'APNS_PASSPHRASE_STRING') or self._cert_params.get('passphrase')
if not cert_def['passphrase']:
passphrase_file = app.config.get('APNS_PASSPHRASE_FILE')
if passphrase_file:
try:
with open(passphrase_file) as f:
cert_def['passphrase'] = f.read().strip()
except IOError:
pass
try:
self._certificate = Certificate(**cert_def)
except Exception as e:
print("APNS is disabled: %r" % e)
return self.session
def get_connection(self):
"""
Get a connection to APNS
:returns: :py:class:`apnsclient.apns.Connection`
"""
if self._certificate is None:
return None
return self.session.get_connection(self._address, self._certificate)
def send_message(self,
tokens,
alert=None,
badge=None,
sound=None,
content_available=None,
expiry=None,
payload=None,
**extra):
"""
Send a message. This will not retry but will call the
failed_callback in case of failure
.. seealso::
:py:class:`apnsclient.apns.Message` for a better description of the
parameters
:param tokens: The tokens to send to
:param alert: The alert message
:param badge: The badge to show
:param sound: The sound to play
:param expiry: A timestamp when message will expire
:param payload: The payload
:param extra: Extra info
"""
connection = self.get_connection()
if connection is None:
return None
if not tokens:
return False
message = Message(tokens, alert, badge, sound, expiry, payload,
content_available, **extra)
srv = APNs(connection)
res = srv.send(message)
if res.failed and self.failed_callback:
for key, reason in res.failed.iteritems():
self.failed_callback(key, reason)
return res
