Initial commit

First public commit

2 files changed, 193 insertions, 0 deletions

diff --git a/servo/messaging/__init__.py b/servo/messaging/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/servo/messaging/__init__.py
diff --git a/servo/messaging/sms.py b/servo/messaging/sms.py
new file mode 100644
index 0000000..a51db7a
--- /dev/null
+++ b/servo/messaging/sms.py
@@ -0,0 +1,193 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2013, First Party Software
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without modification, 
+# are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, 
+# this list of conditions and the following disclaimer.
+
+# 2. Redistributions in binary form must reproduce the above copyright notice, 
+# this list of conditions and the following disclaimer in the documentation 
+# and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+
+import re
+import urllib
+from hashlib import md5
+from django.conf import settings
+from django.utils.translation import ugettext as _
+
+from servo.models.common import Configuration
+
+class BaseSMSProvider(object):
+    def __init__(self, recipient, note, msg):
+        self.conf = Configuration.conf()
+
+        if not self.conf.get('sms_http_sender'):
+            raise ValueError(_("SMS sender not configured"))
+
+        if len(recipient) < 8:
+            recipient = '372' + recipient
+        
+        recipient = re.sub(r'[\+\s\-]', '', recipient)
+        self.recipient = recipient.lstrip('+')
+        self.note = note
+        self.msg = msg
+
+        self.sender = self.conf['sms_http_sender']
+        self.body = self.note.body.encode('utf-8')
+
+
+class SMSJazzProvider(object):
+    """
+    SMS Jazz gateway provider
+    Used mainly by Estonian AASPs, hence default prefix of 372
+    """
+    URL = 'https://www.smsjazz.net/SMSjazzAPI/sendsms.php'
+
+    STATUSES = {
+        '1' : ('DELIVERED', 'SMS message is delivered to mobile phone'),
+        '2' : ('FAILED', 'SMS message has failed and is not delivered to mobile phone'),
+        '4' : ('SENT', 'SMS message is buffered and is waiting to be delivered to mobile phone'),
+        '8' : ('SENT', 'SMS message is buffered and is waiting to be delivered to mobile phone'),
+        '16': ('FAILED', 'Error in sender/receiver/message parameters'),
+        '32': ('SENT', ''),
+    }
+
+    def  __init__(self, recipient, note, msg):
+        if len(recipient) < 8:
+            recipient = '372' + recipient
+        
+        recipient = re.sub(r'[\+\s\-]', '', recipient)
+        self.recipient = recipient.lstrip('+')
+        self.note = note
+        self.msg = msg
+
+    def send(self):
+        """
+        Sends SMS through SMS Jazz Gateway
+        """
+        conf = Configuration.conf()
+
+        if not conf.get('sms_http_sender'):
+            raise ValueError(_("SMS sender name not configured"))
+
+        body = self.note.body.encode('utf-8')
+        sender = conf.get('sms_http_sender')
+        pwhash = md5(conf['sms_http_password']).hexdigest()
+        checksum = md5(body + self.recipient.encode('ascii') + pwhash).hexdigest()
+
+        params = {
+            'username'  : conf['sms_http_user'],
+            'password'  : pwhash,
+            'message'   : body,
+            'sender'    : sender.encode('ascii', 'replace'),
+            'receiver'  : self.recipient,
+            'charset'   : 'UTF8',
+            'checksum'  : checksum,
+        }
+
+        if self.msg:
+            dlruri = '/api/messages/?id={0}&status=%status%'.format(self.msg.code)
+            dlruri = settings.SERVO_URL + dlruri
+            params['dlruri'] = dlruri
+
+        params = urllib.urlencode(params)
+        from ssl import _create_unverified_context
+        r = urllib.urlopen(self.URL, params, context=_create_unverified_context()).read()
+
+        if not '1:OK' in r:
+            raise ValueError(_('Failed to send message to %s') % self.recipient)
+
+
+class HQSMSProvider(BaseSMSProvider):
+    """
+    HQSMS Gateway Provider.
+    API docs: http://www.hqsms.com/media/page/docs/HQSMS_https.pdf
+    """
+    URL = 'https://ssl.hqsms.com/sms.do'
+    BACKUP_URL = 'https://ssl2.hqsms.com/sms.do'
+
+    ERRORS = {
+        "ERROR:13"  : _("Lack of valid phone numbers (invalid or blacklisted numbers)"),
+        "ERROR:14"  : _("Wrong sender name"),
+        "ERROR:19"  : _("Too many messages in one request"),
+        "ERROR:102" : _("Invalid username or password"),
+        "ERROR:103" : _("Insufficient credits on your account"),
+        "ERROR:200" : _("Unsuccessful message submission"),
+        "ERROR:201" : _("Internal system error"),
+        "ERROR:999" : _("Internal system error"),
+    }
+
+    STATUSES = {
+        '401' : ('NOT_FOUND', 'Wrong ID or report has expired'),
+        '402' : ('EXPIRED', 'Messages expired'),
+        '403' : ('SENT', 'Message is sent'),
+        '404' : ('DELIVERED', 'Message is delivered to recipient'),
+        '405' : ('UNDELIVERED', 'Message is undelivered (invalid number, roaming error etc)'),
+        '406' : ('FAILED', 'Sending message failed – please report it to us'),
+        '407' : ('REJECTED', 'Message is undelivered (invalid number, roaming error etc)'),
+        '408' : ('UNKNOWN', 'No report (message may be either delivered or not)'),
+        '409' : ('QUEUED', 'Message is waiting to be sent'),
+        '410' : ('ACCEPTED', 'Message is delivered to operator'),
+    }
+
+    def send(self):
+        pwhash = md5(self.conf['sms_http_password']).hexdigest()
+
+        params = {
+            'username'  : self.conf['sms_http_user'],
+            'password'  : pwhash,
+            'message'   : self.body,
+            'from'      : self.sender,
+            'to'        : self.recipient,
+        }
+
+        if self.msg:
+            dlruri = settings.SERVO_URL + '/api/messages/?id={0}'.format(self.msg.code)
+            params['notify_url'] = dlruri
+
+        params = urllib.urlencode(params)
+        from ssl import _create_unverified_context
+        r = urllib.urlopen(self.URL, params, context=_create_unverified_context()).read()
+
+        if 'ERROR:' in r:
+            raise ValueError(self.ERRORS.get(r, _('Unknown error (%s)') % r))
+
+    def set_status(self, msg):
+        pass
+
+
+class HttpProvider(object):
+    """
+    Sends SMS through a HTTP gateway (ie Kannel)
+    """
+    def send(self, note, number):
+        conf = Configuration.conf()
+
+        if not conf.get('sms_http_url'):
+            raise ValueError(_("No SMS HTTP gateway defined"))
+
+        params = urllib.urlencode({
+            'username'  : conf['sms_http_user'],
+            'password'  : conf['sms_http_password'],
+            'text'      : note.body.encode('utf8'),
+            'to'        : number
+        })
+
+        from ssl import _create_unverified_context
+        f = urllib.urlopen("%s?%s" % (conf['sms_http_url'], params), context=_create_unverified_context())
+        return f.read()