Merge branch 'master' of stigma:platforma

[redakcja.git] / apps / explorer / models.py

diff --git a/apps/explorer/models.py b/apps/explorer/models.py
index 0927152..23acd7f 100644 (file)
--- a/apps/explorer/models.py
+++ b/apps/explorer/models.py
@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 import os
 
 from django.db import models
@@ -10,6 +11,30 @@ import toolbar.models
 from explorer import fields
 
 class EditorSettings(models.Model):
+    """Ustawienia edytora dla użytkownika.
+    
+    Pole settings zawiera obiekt JSON o  kluczach:
+     - panels - lista otwartych paneli i ich proporcje
+     - recentFiles - lista otwartych plików i ustawienia dla nich
+    
+    Przykład:
+    {
+        'panels': [
+            {'name': 'htmleditor',
+            'ratio': 0.5},
+            {'name': 'gallery', 'ratio': 0.5}
+        ],
+        'recentFiles': [
+            {
+                'fileId': 'mickiewicz_pan_tadeusz.xml',
+                'panels': [
+                    {'name': 'htmleditor', 'ratio': 0.4},
+                    {'name': 'gallery', 'ratio': 0.6}
+                ]
+            }
+        ]
+    }
+    """
     user = models.ForeignKey(User, unique=True)
     settings = fields.JSONField()
     
@@ -30,36 +55,51 @@ class EditorPanel(models.Model):
     def __unicode__(self):
         return self.display_name
     
-class Book(models.Model):
+class Document(models.Model):
     class Meta:
-        permissions = (
-            ("can_add_files", "Can do hg add."),
+        permissions = (            
+            ("can_share", "Can share documents without pull requests."),
         )
+        
     pass
 
+class PullRequest(models.Model):    
+    REQUEST_STATUSES = (
+        ("N", "Pending for resolution"),
+        ("R", "Rejected"),
+        ("A", "Accepted & merged"),
+    )
 
-class PullRequest(models.Model):
-    comitter = models.ForeignKey(User) # the user who request the pull 
-    file = models.CharField(max_length=256) # the file to request
-    source_rev = models.CharField(max_length=40) # revision number of the commiter
-
+    comitter = models.ForeignKey(User) # the user who request the pull
     comment = models.TextField() # addtional comments to the request
 
+    # document to merge
+    document = models.CharField(max_length=255)
+
+    # revision to be merged into the main branch
+    source_revision = models.CharField(max_length=40, unique=True)
+
+    # current status
+    status = models.CharField(max_length=1, choices=REQUEST_STATUSES)
+
+    # comment to the status change of request (if applicable)
+    response_comment = models.TextField(blank=True)
+
     # revision number in which the changes were merged (if any)
-    merged_rev = models.CharField(max_length=40, null=True) 
-    
+    merged_rev = models.CharField(max_length=40, blank=True, null=True)
+
     def __unicode__(self):
-        return u"Pull request from %s, source: %s %s, status: %s." % \
-            (self.commiter, self.file, self.source_rev, \
-                (("merged into "+self.merged_rev) if self.merged_rev else "pending") )
+        return unicode(self.comitter) + u':' + self.document
 
+# Yes, this is intentionally unnormalized !
+class GalleryForDocument(models.Model):
+    name = models.CharField(max_length=100)
     
-def get_image_folders():
-    return sorted(fn for fn in os.listdir(os.path.join(settings.MEDIA_ROOT, settings.IMAGE_DIR)) if not fn.startswith('.'))
+    # directory containing scans under MEDIA_ROOT/
+    subpath = models.CharField(max_length=255)
 
+    # document associated with the gallery
+    document = models.CharField(max_length=255)
 
-def get_images_from_folder(folder):
-    return sorted(settings.MEDIA_URL + settings.IMAGE_DIR + u'/' + folder + u'/' + fn.decode('utf-8') for fn
-            in os.listdir(os.path.join(settings.MEDIA_ROOT, settings.IMAGE_DIR, folder))
-            if not fn.decode('utf-8').startswith('.'))
-
+    def __unicode__(self):
+        return u"%s:%s" % (self.subpath, self.document)
\ No newline at end of file