Generate GET request and response (not full yet). Add global id to the posts

based on the primary key pair

boards/migrations/0034_auto__del_field_post_public_key__add_field_post_global_id.py

@@ -0,0 +1,90 b''
+# -*- coding: utf-8 -*-
+from south.utils import datetime_utils as datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Deleting field 'Post.public_key'
+        db.delete_column('boards_post', 'public_key')
+
+        # Adding field 'Post.global_id'
+        db.add_column('boards_post', 'global_id',
+                      self.gf('django.db.models.fields.TextField')(null=True, blank=True),
+                      keep_default=False)
+
+
+    def backwards(self, orm):
+        # Adding field 'Post.public_key'
+        db.add_column('boards_post', 'public_key',
+                      self.gf('django.db.models.fields.TextField')(null=True, blank=True),
+                      keep_default=False)
+
+        # Deleting field 'Post.global_id'
+        db.delete_column('boards_post', 'global_id')
+
+
+    models = {
+        'boards.ban': {
+            'Meta': {'object_name': 'Ban'},
+            'can_read': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'ip': ('django.db.models.fields.GenericIPAddressField', [], {'max_length': '39'}),
+            'reason': ('django.db.models.fields.CharField', [], {'max_length': '200', 'default': "'Auto'"})
+        },
+        'boards.keypair': {
+            'Meta': {'object_name': 'KeyPair'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'key_type': ('django.db.models.fields.TextField', [], {}),
+            'primary': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'private_key': ('django.db.models.fields.TextField', [], {}),
+            'public_key': ('django.db.models.fields.TextField', [], {})
+        },
+        'boards.post': {
+            'Meta': {'ordering': "('id',)", 'object_name': 'Post'},
+            '_text_rendered': ('django.db.models.fields.TextField', [], {}),
+            'global_id': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'images': ('django.db.models.fields.related.ManyToManyField', [], {'db_index': 'True', 'null': 'True', 'to': "orm['boards.PostImage']", 'related_name': "'ip+'", 'blank': 'True', 'symmetrical': 'False'}),
+            'last_edit_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'poster_ip': ('django.db.models.fields.GenericIPAddressField', [], {'max_length': '39'}),
+            'poster_user_agent': ('django.db.models.fields.TextField', [], {}),
+            'pub_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'referenced_posts': ('django.db.models.fields.related.ManyToManyField', [], {'db_index': 'True', 'null': 'True', 'to': "orm['boards.Post']", 'related_name': "'rfp+'", 'blank': 'True', 'symmetrical': 'False'}),
+            'refmap': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'text': ('markupfield.fields.MarkupField', [], {'rendered_field': 'True'}),
+            'text_markup_type': ('django.db.models.fields.CharField', [], {'max_length': '30', 'default': "'bbcode'"}),
+            'thread_new': ('django.db.models.fields.related.ForeignKey', [], {'null': 'True', 'default': 'None', 'to': "orm['boards.Thread']"}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '200'})
+        },
+        'boards.postimage': {
+            'Meta': {'ordering': "('id',)", 'object_name': 'PostImage'},
+            'hash': ('django.db.models.fields.CharField', [], {'max_length': '36'}),
+            'height': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'image': ('boards.thumbs.ImageWithThumbsField', [], {'max_length': '100', 'blank': 'True'}),
+            'pre_height': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'pre_width': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'width': ('django.db.models.fields.IntegerField', [], {'default': '0'})
+        },
+        'boards.tag': {
+            'Meta': {'ordering': "('name',)", 'object_name': 'Tag'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '100'}),
+            'threads': ('django.db.models.fields.related.ManyToManyField', [], {'null': 'True', 'to': "orm['boards.Thread']", 'symmetrical': 'False', 'blank': 'True', 'related_name': "'tag+'"})
+        },
+        'boards.thread': {
+            'Meta': {'object_name': 'Thread'},
+            'archived': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'bump_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'last_edit_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'replies': ('django.db.models.fields.related.ManyToManyField', [], {'null': 'True', 'to': "orm['boards.Post']", 'symmetrical': 'False', 'blank': 'True', 'related_name': "'tre+'"}),
+            'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'to': "orm['boards.Tag']"})
+        }
+    }
+
+    complete_apps = ['boards']
  No newline at end of file

boards/migrations/0035_auto__add_signature__add_globalid__chg_field_post_global_id__add_index.py

@@ -0,0 +1,147 b''
+# -*- coding: utf-8 -*-
+from south.utils import datetime_utils as 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 'Signature'
+        db.create_table('boards_signature', (
+            ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('key_type', self.gf('django.db.models.fields.TextField')()),
+            ('key', self.gf('django.db.models.fields.TextField')()),
+            ('signature', self.gf('django.db.models.fields.TextField')()),
+        ))
+        db.send_create_signal('boards', ['Signature'])
+
+        # Adding model 'GlobalId'
+        db.create_table('boards_globalid', (
+            ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('key', self.gf('django.db.models.fields.TextField')()),
+            ('key_type', self.gf('django.db.models.fields.TextField')()),
+            ('local_id', self.gf('django.db.models.fields.IntegerField')()),
+        ))
+        db.send_create_signal('boards', ['GlobalId'])
+
+        # Adding M2M table for field signature on 'Post'
+        m2m_table_name = db.shorten_name('boards_post_signature')
+        db.create_table(m2m_table_name, (
+            ('id', models.AutoField(verbose_name='ID', primary_key=True, auto_created=True)),
+            ('post', models.ForeignKey(orm['boards.post'], null=False)),
+            ('signature', models.ForeignKey(orm['boards.signature'], null=False))
+        ))
+        db.create_unique(m2m_table_name, ['post_id', 'signature_id'])
+
+
+        # Renaming column for 'Post.global_id' to match new field type.
+        db.rename_column('boards_post', 'global_id', 'global_id_id')
+        # Changing field 'Post.global_id'
+        db.alter_column('boards_post', 'global_id_id', self.gf('django.db.models.fields.related.OneToOneField')(null=True, to=orm['boards.GlobalId'], unique=True))
+        # Adding index on 'Post', fields ['global_id']
+        db.create_index('boards_post', ['global_id_id'])
+
+        # Adding unique constraint on 'Post', fields ['global_id']
+        db.create_unique('boards_post', ['global_id_id'])
+
+
+    def backwards(self, orm):
+        # Removing unique constraint on 'Post', fields ['global_id']
+        db.delete_unique('boards_post', ['global_id_id'])
+
+        # Removing index on 'Post', fields ['global_id']
+        db.delete_index('boards_post', ['global_id_id'])
+
+        # Deleting model 'Signature'
+        db.delete_table('boards_signature')
+
+        # Deleting model 'GlobalId'
+        db.delete_table('boards_globalid')
+
+        # Removing M2M table for field signature on 'Post'
+        db.delete_table(db.shorten_name('boards_post_signature'))
+
+
+        # Renaming column for 'Post.global_id' to match new field type.
+        db.rename_column('boards_post', 'global_id_id', 'global_id')
+        # Changing field 'Post.global_id'
+        db.alter_column('boards_post', 'global_id', self.gf('django.db.models.fields.TextField')(null=True))
+
+    models = {
+        'boards.ban': {
+            'Meta': {'object_name': 'Ban'},
+            'can_read': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'ip': ('django.db.models.fields.GenericIPAddressField', [], {'max_length': '39'}),
+            'reason': ('django.db.models.fields.CharField', [], {'default': "'Auto'", 'max_length': '200'})
+        },
+        'boards.globalid': {
+            'Meta': {'object_name': 'GlobalId'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'key': ('django.db.models.fields.TextField', [], {}),
+            'key_type': ('django.db.models.fields.TextField', [], {}),
+            'local_id': ('django.db.models.fields.IntegerField', [], {})
+        },
+        'boards.keypair': {
+            'Meta': {'object_name': 'KeyPair'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'key_type': ('django.db.models.fields.TextField', [], {}),
+            'primary': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'private_key': ('django.db.models.fields.TextField', [], {}),
+            'public_key': ('django.db.models.fields.TextField', [], {})
+        },
+        'boards.post': {
+            'Meta': {'object_name': 'Post', 'ordering': "('id',)"},
+            '_text_rendered': ('django.db.models.fields.TextField', [], {}),
+            'global_id': ('django.db.models.fields.related.OneToOneField', [], {'null': 'True', 'to': "orm['boards.GlobalId']", 'unique': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'images': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'to': "orm['boards.PostImage']", 'blank': 'True', 'db_index': 'True', 'related_name': "'ip+'", 'null': 'True'}),
+            'last_edit_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'poster_ip': ('django.db.models.fields.GenericIPAddressField', [], {'max_length': '39'}),
+            'poster_user_agent': ('django.db.models.fields.TextField', [], {}),
+            'pub_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'referenced_posts': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'to': "orm['boards.Post']", 'blank': 'True', 'db_index': 'True', 'related_name': "'rfp+'", 'null': 'True'}),
+            'refmap': ('django.db.models.fields.TextField', [], {'blank': 'True', 'null': 'True'}),
+            'signature': ('django.db.models.fields.related.ManyToManyField', [], {'null': 'True', 'to': "orm['boards.Signature']", 'symmetrical': 'False', 'blank': 'True'}),
+            'text': ('markupfield.fields.MarkupField', [], {'rendered_field': 'True'}),
+            'text_markup_type': ('django.db.models.fields.CharField', [], {'default': "'bbcode'", 'max_length': '30'}),
+            'thread_new': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['boards.Thread']", 'default': 'None', 'null': 'True'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '200'})
+        },
+        'boards.postimage': {
+            'Meta': {'object_name': 'PostImage', 'ordering': "('id',)"},
+            'hash': ('django.db.models.fields.CharField', [], {'max_length': '36'}),
+            'height': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'image': ('boards.thumbs.ImageWithThumbsField', [], {'blank': 'True', 'max_length': '100'}),
+            'pre_height': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'pre_width': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'width': ('django.db.models.fields.IntegerField', [], {'default': '0'})
+        },
+        'boards.signature': {
+            'Meta': {'object_name': 'Signature'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'key': ('django.db.models.fields.TextField', [], {}),
+            'key_type': ('django.db.models.fields.TextField', [], {}),
+            'signature': ('django.db.models.fields.TextField', [], {})
+        },
+        'boards.tag': {
+            'Meta': {'object_name': 'Tag', 'ordering': "('name',)"},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100', 'db_index': 'True'}),
+            'threads': ('django.db.models.fields.related.ManyToManyField', [], {'null': 'True', 'to': "orm['boards.Thread']", 'symmetrical': 'False', 'related_name': "'tag+'", 'blank': 'True'})
+        },
+        'boards.thread': {
+            'Meta': {'object_name': 'Thread'},
+            'archived': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'bump_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'last_edit_time': ('django.db.models.fields.DateTimeField', [], {}),
+            'replies': ('django.db.models.fields.related.ManyToManyField', [], {'null': 'True', 'to': "orm['boards.Post']", 'symmetrical': 'False', 'related_name': "'tre+'", 'blank': 'True'}),
+            'tags': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['boards.Tag']", 'symmetrical': 'False'})
+        }
+    }
+
+    complete_apps = ['boards']
  No newline at end of file

boards/models/__init__.py

@@ -1,9 +1,9 b''
 __author__ = 'neko259'
 
 from boards.models.signature import GlobalId, Signature
+from boards.models.sync_key import KeyPair
 from boards.models.image import PostImage
 from boards.models.thread import Thread
 from boards.models.post import Post
 from boards.models.tag import Tag
 from boards.models.user import Ban
-from boards.models.sync_key import KeyPair

boards/models/post.py

@@ -2,15 +2,17 b' from datetime import datetime, timedelta'
 from datetime import time as dtime
 import logging
 import re
+import xml.etree.ElementTree as et
 
 from django.core.cache import cache
 from django.core.urlresolvers import reverse
 from django.db import models, transaction
 from django.template.loader import render_to_string
 from django.utils import timezone
+
 from markupfield.fields import MarkupField
 
-from boards.models import PostImage
+from boards.models import PostImage, KeyPair, GlobalId
 from boards.models.base import Viewable
 from boards.models.thread import Thread
 
@@ -38,6 +40,24 b" UNKNOWN_UA = ''"
 
 REGEX_REPLY = re.compile(r'\[post\](\d+)\[/post\]')
 
+TAG_MODEL = 'model'
+TAG_REQUEST = 'request'
+TAG_RESPONSE = 'response'
+TAG_ID = 'id'
+TAG_STATUS = 'status'
+TAG_MODELS = 'models'
+TAG_TITLE = 'title'
+TAG_TEXT =  'text'
+
+TYPE_GET = 'get'
+
+ATTR_VERSION = 'version'
+ATTR_TYPE = 'type'
+ATTR_NAME = 'name'
+ATTR_REF_ID = 'ref-id'
+
+STATUS_SUCCESS = 'success'
+
 logger = logging.getLogger(__name__)
 
 
@@ -71,6 +91,8 b' class PostManager(models.Manager):'
                            # last!
                            last_edit_time=posting_time)
 
+        post.set_global_id()
+
         if image:
             post_image = PostImage.objects.create(image=image)
             post.images.add(post_image)
@@ -164,6 +186,52 b' class PostManager(models.Manager):'
         return ppd
 
 
+    def generate_request_get(self, model_list: list):
+        """
+        Form a get request from a list of ModelId objects.
+        """
+
+        request = et.Element(TAG_REQUEST)
+        request.set(ATTR_TYPE, TYPE_GET)
+        request.set(ATTR_VERSION, '1.0')
+
+        model = et.SubElement(request, TAG_MODEL)
+        model.set(ATTR_VERSION, '1.0')
+        model.set(ATTR_NAME, 'post')
+
+        for post in model_list:
+            tag_id = et.SubElement(model, TAG_ID)
+            post.global_id.to_xml_element(tag_id)
+
+        return et.tostring(request, 'unicode')
+
+    def generate_response_get(self, model_list: list):
+        response = et.Element(TAG_RESPONSE)
+
+        status = et.SubElement(response, TAG_STATUS)
+        status.text = STATUS_SUCCESS
+
+        models = et.SubElement(response, TAG_MODELS)
+
+        ref_id = 1
+        for post in model_list:
+            model = et.SubElement(models, TAG_MODEL)
+            model.set(ATTR_NAME, 'post')
+            model.set(ATTR_REF_ID, str(ref_id))
+            ref_id += 1
+
+            tag_id = et.SubElement(model, TAG_ID)
+            post.global_id.to_xml_element(tag_id)
+
+            title = et.SubElement(model, TAG_TITLE)
+            title.text = post.title
+
+            text = et.SubElement(model, TAG_TEXT)
+            text.text = post.text.rendered
+
+        return et.tostring(response, 'unicode')
+
+
 class Post(models.Model, Viewable):
     """A post is a message."""
 
@@ -355,3 +423,25 b' class Post(models.Model, Viewable):'
         self.images.all().delete()
 
         super(Post, self).delete(using)
+
+    def set_global_id(self, key_pair=None):
+        """
+        Sets global id based on the given key pair. If no key pair is given,
+        default one is used.
+        """
+
+        if key_pair:
+            key = key_pair
+        else:
+            try:
+                key = KeyPair.objects.get(primary=True)
+            except KeyPair.DoesNotExist:
+                # Do not update the global id because there is no key defined
+                return
+        global_id = GlobalId(key_type=key.key_type,
+                             key=key.public_key,
+                             local_id = self.id)
+
+        self.global_id = global_id
+
+        self.save(update_fields=['global_id'])

boards/models/signature.py

@@ -1,6 +1,12 b''
+import xml.etree.ElementTree as et
 from django.db import models
 
 
+ATTR_KEY = 'key'
+ATTR_KEY_TYPE = 'type'
+ATTR_LOCAL_ID = 'local-id'
+
+
 class GlobalId(models.Model):
     class Meta:
         app_label = 'boards'
@@ -20,6 +26,15 b' class GlobalId(models.Model):'
     def __str__(self):
         return '%s / %s / %d' % (self.key_type, self.key, self.local_id)
 
+    def to_xml_element(self, element: et.SubElement):
+        """
+        Exports global id to an XML element.
+        """
+
+        element.set(ATTR_KEY, self.key)
+        element.set(ATTR_KEY_TYPE, self.key_type)
+        element.set(ATTR_LOCAL_ID, str(self.local_id))
+
 
 class Signature(models.Model):
     class Meta:

boards/tests/test_keys.py

@@ -1,6 +1,10 b''
+import logging
+
 from django.test import TestCase
-from boards.models import KeyPair, GlobalId
-from boards.views.sync import generate_request_get
+from boards.models import KeyPair, GlobalId, Post
+
+
+logger = logging.getLogger(__name__)
 
 
 class KeyTest(TestCase):
@@ -28,12 +32,38 b' class KeyTest(TestCase):'
         except Exception:
             pass
 
-    def test_request_get(self):
+    def test_model_id_save(self):
         model_id = GlobalId(key_type='test', key='test key', local_id='1')
         model_id.save()
 
+    def test_request_get(self):
+        post = self._create_post_with_key()
+
+        request = Post.objects.generate_request_get([post])
+        logger.debug(request)
+
         self.assertTrue('<request type="get" version="1.0"><model '
-                        'name="post" version="1.0"><id key="test key" '
-                        'local-id="1" type="test" /></model></request>' in
-                        generate_request_get([model_id]),
+                        'name="post" version="1.0"><id key="pubkey" '
+                        'local-id="1" type="test_key_type" /></model></request>' in
+                        request,
                         'Wrong XML generated for the GET request.')
+
+    def test_response_get(self):
+        post = self._create_post_with_key()
+
+        response = Post.objects.generate_response_get([post])
+        logger.debug(response)
+
+        self.assertTrue('<response><status>success</status><models><model '
+                        'name="post" ref-id="1"><id key="pubkey" local-id="1"'
+                        ' type="test_key_type" /><title>test_title</title>'
+                        '<text>test_text</text>'
+                        '</model></models></response>' in response,
+                        'Wrong XML generated for the GET response.')
+
+    def _create_post_with_key(self):
+        key = KeyPair(public_key='pubkey', private_key='privkey',
+                      key_type='test_key_type', primary=True)
+        key.save()
+
+        return Post.objects.create_post(title='test_title', text='test_text')

boards/views/sync.py

@@ -1,44 +1,6 b''
-import xml.etree.ElementTree as et
-
-TAG_MODEL = 'model'
-TAG_REQUEST = 'request'
-TAG_ID = 'id'
-
-TYPE_GET = 'get'
-
-ATTR_VERSION = 'version'
-ATTR_TYPE = 'type'
-ATTR_NAME = 'name'
-ATTR_KEY = 'key'
-ATTR_KEY_TYPE = 'type'
-ATTR_LOCAL_ID = 'local-id'
-
-
 def respond_pull(request):
     pass
 
 
 def respond_get(request):
     pass
-
-
-def generate_request_get(id_list: list):
-    """
-    Form a get request from a list of ModelId objects.
-    """
-
-    request = et.Element(TAG_REQUEST)
-    request.set(ATTR_TYPE, TYPE_GET)
-    request.set(ATTR_VERSION, '1.0')
-
-    model = et.SubElement(request, TAG_MODEL)
-    model.set(ATTR_VERSION, '1.0')
-    model.set(ATTR_NAME, 'post')
-
-    for model_id in id_list:
-        tag_id = et.SubElement(model, TAG_ID)
-        tag_id.set(ATTR_KEY, model_id.key)
-        tag_id.set(ATTR_KEY_TYPE, model_id.key_type)
-        tag_id.set(ATTR_LOCAL_ID, model_id.local_id)
-
-    return et.tostring(request, 'unicode')