[schema] Add support for keeping track of iOS APNS device tokens

In order to support iOS Push Notifications, we need to keep track
of a device's unique APNS Token. These are delivered to our iOS
code after registering for remote notifications

(imported from commit bbe34483e1380dc20a1c93e3ffa1fcfdb9087e67)

zerver/migrations/0050_auto__add_appledevicetoken.py

@@ -0,0 +1,219 @@
+# -*- coding: utf-8 -*-
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Adding model 'AppleDeviceToken'
+        db.create_table(u'zerver_appledevicetoken', (
+            (u'id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('token', self.gf('django.db.models.fields.CharField')(unique=True, max_length=255)),
+            ('user', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['zerver.UserProfile'])),
+        ))
+        db.send_create_signal(u'zerver', ['AppleDeviceToken'])
+
+
+    def backwards(self, orm):
+        # Deleting model 'AppleDeviceToken'
+        db.delete_table(u'zerver_appledevicetoken')
+
+
+    models = {
+        u'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        u'auth.permission': {
+            'Meta': {'ordering': "(u'content_type__app_label', u'content_type__model', u'codename')", 'unique_together': "((u'content_type', u'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['contenttypes.ContentType']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        u'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        u'zerver.appledevicetoken': {
+            'Meta': {'object_name': 'AppleDeviceToken'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'token': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.client': {
+            'Meta': {'object_name': 'Client'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30', 'db_index': 'True'})
+        },
+        u'zerver.defaultstream': {
+            'Meta': {'unique_together': "(('realm', 'stream'),)", 'object_name': 'DefaultStream'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'realm': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Realm']"}),
+            'stream': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Stream']"})
+        },
+        u'zerver.huddle': {
+            'Meta': {'object_name': 'Huddle'},
+            'huddle_hash': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '40', 'db_index': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'})
+        },
+        u'zerver.message': {
+            'Meta': {'object_name': 'Message'},
+            'content': ('django.db.models.fields.TextField', [], {}),
+            'edit_history': ('django.db.models.fields.TextField', [], {'null': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'last_edit_time': ('django.db.models.fields.DateTimeField', [], {'null': 'True'}),
+            'pub_date': ('django.db.models.fields.DateTimeField', [], {'db_index': 'True'}),
+            'recipient': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Recipient']"}),
+            'rendered_content': ('django.db.models.fields.TextField', [], {'null': 'True'}),
+            'rendered_content_version': ('django.db.models.fields.IntegerField', [], {'null': 'True'}),
+            'sender': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"}),
+            'sending_client': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Client']"}),
+            'subject': ('django.db.models.fields.CharField', [], {'max_length': '60', 'db_index': 'True'})
+        },
+        u'zerver.mituser': {
+            'Meta': {'object_name': 'MitUser'},
+            'email': ('django.db.models.fields.EmailField', [], {'unique': 'True', 'max_length': '75'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'status': ('django.db.models.fields.IntegerField', [], {'default': '0'})
+        },
+        u'zerver.preregistrationuser': {
+            'Meta': {'object_name': 'PreregistrationUser'},
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'invited_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}),
+            'realm': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Realm']", 'null': 'True'}),
+            'referred_by': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']", 'null': 'True'}),
+            'status': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'streams': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['zerver.Stream']", 'null': 'True', 'symmetrical': 'False'})
+        },
+        u'zerver.realm': {
+            'Meta': {'object_name': 'Realm'},
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'domain': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '40', 'db_index': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'notifications_stream': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'+'", 'null': 'True', 'to': u"orm['zerver.Stream']"}),
+            'restricted_to_domain': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
+        },
+        u'zerver.realmemoji': {
+            'Meta': {'unique_together': "(('realm', 'name'),)", 'object_name': 'RealmEmoji'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'img_url': ('django.db.models.fields.TextField', [], {}),
+            'name': ('django.db.models.fields.TextField', [], {}),
+            'realm': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Realm']"})
+        },
+        u'zerver.recipient': {
+            'Meta': {'unique_together': "(('type', 'type_id'),)", 'object_name': 'Recipient'},
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'type': ('django.db.models.fields.PositiveSmallIntegerField', [], {'db_index': 'True'}),
+            'type_id': ('django.db.models.fields.IntegerField', [], {'db_index': 'True'})
+        },
+        u'zerver.referral': {
+            'Meta': {'object_name': 'Referral'},
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'timestamp': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'user_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.stream': {
+            'Meta': {'unique_together': "(('name', 'realm'),)", 'object_name': 'Stream'},
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email_token': ('django.db.models.fields.CharField', [], {'default': "'2f3ca43d587f586a521a48cde82ce171'", 'max_length': '32'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'invite_only': ('django.db.models.fields.NullBooleanField', [], {'default': 'False', 'null': 'True', 'blank': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '60', 'db_index': 'True'}),
+            'realm': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Realm']"})
+        },
+        u'zerver.streamcolor': {
+            'Meta': {'object_name': 'StreamColor'},
+            'color': ('django.db.models.fields.CharField', [], {'max_length': '10'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'subscription': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Subscription']"})
+        },
+        u'zerver.subscription': {
+            'Meta': {'unique_together': "(('user_profile', 'recipient'),)", 'object_name': 'Subscription'},
+            'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'color': ('django.db.models.fields.CharField', [], {'default': "'#c2c2c2'", 'max_length': '10'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'in_home_view': ('django.db.models.fields.NullBooleanField', [], {'default': 'True', 'null': 'True', 'blank': 'True'}),
+            'notifications': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'recipient': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Recipient']"}),
+            'user_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.useractivity': {
+            'Meta': {'unique_together': "(('user_profile', 'client', 'query'),)", 'object_name': 'UserActivity'},
+            'client': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Client']"}),
+            'count': ('django.db.models.fields.IntegerField', [], {}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'last_visit': ('django.db.models.fields.DateTimeField', [], {}),
+            'query': ('django.db.models.fields.CharField', [], {'max_length': '50', 'db_index': 'True'}),
+            'user_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.useractivityinterval': {
+            'Meta': {'object_name': 'UserActivityInterval'},
+            'end': ('django.db.models.fields.DateTimeField', [], {'db_index': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'start': ('django.db.models.fields.DateTimeField', [], {'db_index': 'True'}),
+            'user_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.usermessage': {
+            'Meta': {'unique_together': "(('user_profile', 'message'),)", 'object_name': 'UserMessage'},
+            'archived': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'flags': ('django.db.models.fields.BigIntegerField', [], {'default': '0'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'message': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Message']"}),
+            'user_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.userpresence': {
+            'Meta': {'unique_together': "(('user_profile', 'client'),)", 'object_name': 'UserPresence'},
+            'client': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Client']"}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'status': ('django.db.models.fields.PositiveSmallIntegerField', [], {'default': '1'}),
+            'timestamp': ('django.db.models.fields.DateTimeField', [], {}),
+            'user_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']"})
+        },
+        u'zerver.userprofile': {
+            'Meta': {'object_name': 'UserProfile'},
+            'alert_words': ('django.db.models.fields.TextField', [], {'default': "'[]'"}),
+            'api_key': ('django.db.models.fields.CharField', [], {'max_length': '32'}),
+            'avatar_source': ('django.db.models.fields.CharField', [], {'default': "'G'", 'max_length': '1'}),
+            'bot_owner': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.UserProfile']", 'null': 'True', 'on_delete': 'models.SET_NULL'}),
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email': ('django.db.models.fields.EmailField', [], {'unique': 'True', 'max_length': '75', 'db_index': 'True'}),
+            'enable_desktop_notifications': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'enable_offline_email_notifications': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'enable_sounds': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'enter_sends': ('django.db.models.fields.NullBooleanField', [], {'default': 'False', 'null': 'True', 'blank': 'True'}),
+            'full_name': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'invites_granted': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'invites_used': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_bot': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_pointer_updater': ('django.db.models.fields.CharField', [], {'max_length': '64'}),
+            'last_reminder': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now', 'null': 'True'}),
+            'muted_topics': ('django.db.models.fields.TextField', [], {'default': "'[]'"}),
+            'onboarding_steps': ('django.db.models.fields.TextField', [], {'default': "'[]'"}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'pointer': ('django.db.models.fields.IntegerField', [], {}),
+            'rate_limits': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '100'}),
+            'realm': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['zerver.Realm']"}),
+            'short_name': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'tutorial_status': ('django.db.models.fields.CharField', [], {'default': "'W'", 'max_length': '1'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        }
+    }
+
+    complete_apps = ['zerver']

zerver/models.py

@@ -261,6 +261,15 @@ class PreregistrationUser(models.Model):
 
     realm = models.ForeignKey(Realm, null=True)
 
+class AppleDeviceToken(models.Model):
+    # The token is a unique device-specific token that is
+    # sent to us from each iOS device, after registering with
+    # the APNS service
+    token = models.CharField(max_length=255, unique=True)
+
+    # The user who's device this is
+    user = models.ForeignKey(UserProfile, db_index=True)
+
 class MitUser(models.Model):
     email = models.EmailField(unique=True)
     # status: whether an object has been confirmed.

zerver/tests.py

@@ -4175,6 +4175,25 @@ class CheckMessageTest(AuthedTestCase):
         self.assertEqual(new_count, old_count + 1)
         self.assertEqual(ret['message'].sender.email, 'othello-bot@zulip.com')
 
+class APNSTokenTests(AuthedTestCase):
+    def test_add_token(self):
+        email = "cordelia@zulip.com"
+        self.login(email)
+
+        result = self.client.post('/json/users/me/apns_device_token', {'token': "test_token"})
+        self.assert_json_success(result)
+
+    def test_delete_token(self):
+        email = "cordelia@zulip.com"
+        self.login(email)
+
+        token = "test_token"
+        result = self.client.post('/json/users/me/apns_device_token', {'token':token})
+        self.assert_json_success(result)
+
+        result = self.client.delete('/json/users/me/apns_device_token', urllib.urlencode({'token': token}))
+        self.assert_json_success(result)
+
 def full_test_name(test):
     test_class = test.__class__.__name__
     test_method = test._testMethodName

zerver/views/__init__.py

@@ -16,7 +16,7 @@ from django.contrib.auth.views import login as django_login_page, \
     logout_then_login as django_logout_then_login
 from django.db.models import Q, F
 from django.core.mail import send_mail, mail_admins, EmailMessage
-from django.db import transaction
+from django.db import transaction, IntegrityError
 from zerver.models import Message, UserProfile, Stream, Subscription, \
     Recipient, Realm, UserMessage, bulk_get_recipients, \
     PreregistrationUser, get_client, MitUser, UserActivity, UserActivityInterval, \
@@ -24,7 +24,7 @@ from zerver.models import Message, UserProfile, Stream, Subscription, \
     get_recipient, valid_stream_name, to_dict_cache_key, to_dict_cache_key_id, \
     extract_message_dict, stringify_message_dict, parse_usermessage_flags, \
     email_to_domain, email_to_username, get_realm, completely_open, \
-    is_super_user, get_active_user_profiles_by_realm
+    is_super_user, get_active_user_profiles_by_realm, AppleDeviceToken
 from zerver.lib.actions import do_remove_subscription, bulk_remove_subscriptions, \
     do_change_password, create_mit_user_if_needed, do_change_full_name, \
     do_change_enable_desktop_notifications, do_change_enter_sends, do_change_enable_sounds, \
@@ -2361,3 +2361,29 @@ def json_set_muted_topics(request, user_profile,
                          muted_topics=REQ(converter=json_to_list, default=[])):
     do_set_muted_topics(user_profile, muted_topics)
     return json_success()
+
+@has_request_variables
+def add_apns_device_token(request, user_profile, token=REQ):
+    if token == '' or len(token) > 255:
+        return json_error('Empty or invalid length APNS token')
+
+    try:
+        apns_token = AppleDeviceToken(user=user_profile, token=token)
+        apns_token.save()
+    except IntegrityError:
+        return json_error("APNS token already exists")
+
+    return json_success()
+
+@has_request_variables
+def remove_apns_device_token(request, user_profile, token=REQ):
+    if token == '' or len(token) > 255:
+        return json_error('Empty or invalid length APNS token')
+
+    try:
+        apns_token = AppleDeviceToken.objects.get(token=token)
+        apns_token.delete()
+    except AppleDeviceToken.DoesNotExist:
+        return json_error("APNS token does not exist")
+
+    return json_success()

zproject/urls.py

@@ -191,6 +191,11 @@ v1_api_and_json_patterns = patterns('zerver.views',
              'DELETE': 'remove_alert_words'}),
     url(r'^users/me/api_key/regenerate$', 'rest_dispatch',
             {'POST': 'regenerate_api_key'}),
+    # Endpoint used by iOS devices to register their
+    # unique APNS device token
+    url(r'^users/me/apns_device_token$', 'rest_dispatch',
+        {'POST'  : 'add_apns_device_token',
+         'DELETE': 'remove_apns_device_token'}),
     url(r'^users/(?P<email>.*)$', 'rest_dispatch',
             {'DELETE': 'deactivate_user_backend'}),
     url(r'^bots/(?P<email>.*)/api_key/regenerate$', 'rest_dispatch',