librarian in submodule, HTML and TXT book previews, URL fixes
[redakcja.git] / apps / wiki / forms.py
index 836d8f0..b057be0 100644 (file)
+# -*- coding: utf-8 -*-
+#
+# This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+#
 from django import forms
-from wiki.models import Document, storage
+from wiki.constants import DOCUMENT_TAGS, DOCUMENT_STAGES
+from wiki.models import Book
+from django.utils.translation import ugettext_lazy as _
 
 
-class DocumentForm(forms.Form):
-    name = forms.CharField(widget=forms.HiddenInput)
-    text = forms.CharField(widget=forms.Textarea)
+class DocumentTagForm(forms.Form):
+    """
+        Form for tagging revisions.
+    """
+
+    id = forms.CharField(widget=forms.HiddenInput)
+    tag = forms.ChoiceField(choices=DOCUMENT_TAGS)
+    revision = forms.IntegerField(widget=forms.HiddenInput)
+
+
+class DocumentCreateForm(forms.ModelForm):
+    """
+        Form used for creating new documents.
+    """
+    file = forms.FileField(required=False)
+    text = forms.CharField(required=False, widget=forms.Textarea)
+
+    class Meta:
+        model = Book
+        exclude = ['gallery']
+
+    def clean(self):
+        super(DocumentCreateForm, self).clean()
+        file = self.cleaned_data['file']
+
+        if file is not None:
+            try:
+                self.cleaned_data['text'] = file.read().decode('utf-8')
+            except UnicodeDecodeError:
+                raise forms.ValidationError("Text file must be UTF-8 encoded.")
+
+        if not self.cleaned_data["text"]:
+            raise forms.ValidationError("You must either enter text or upload a file")
+
+        return self.cleaned_data
+
+
+class DocumentsUploadForm(forms.Form):
+    """
+        Form used for uploading new documents.
+    """
+    file = forms.FileField(required=True, label=_('ZIP file'))
+
+    def clean(self):
+        file = self.cleaned_data['file']
+
+        import zipfile
+        try:
+            z = self.cleaned_data['zip'] = zipfile.ZipFile(file)
+        except zipfile.BadZipfile:
+            raise forms.ValidationError("Should be a ZIP file.")
+        if z.testzip():
+            raise forms.ValidationError("ZIP file corrupt.")
+
+        return self.cleaned_data
+
+
+class DocumentTextSaveForm(forms.Form):
+    """
+    Form for saving document's text:
+
+        * parent_revision - revision which the modified text originated from.
+        * comment - user's verbose comment; will be used in commit.
+        * stage_completed - mark this change as end of given stage.
+
+    """
+
+    parent_revision = forms.IntegerField(widget=forms.HiddenInput)
+    text = forms.CharField(widget=forms.HiddenInput)
+
+    author_name = forms.CharField(
+        required=False,
+        label=_(u"Author"),
+        help_text=_(u"Your name"),
+    )
+
+    author_email = forms.EmailField(
+        required=False,
+        label=_(u"Author's email"),
+        help_text=_(u"Your email address, so we can show a gravatar :)"),
+    )
+
+    comment = forms.CharField(
+        required=True,
+        widget=forms.Textarea,
+        label=_(u"Your comments"),
+        help_text=_(u"Describe changes you made."),
+    )
+
+    stage_completed = forms.ChoiceField(
+        choices=DOCUMENT_STAGES,
+        required=False,
+        label=_(u"Completed"),
+        help_text=_(u"If you completed a life cycle stage, select it."),
+    )
+
+
+class DocumentTextRevertForm(forms.Form):
+    """
+    Form for reverting document's text:
+
+        * revision - revision to revert to.
+        * comment - user's verbose comment; will be used in commit.
+
+    """
+
     revision = forms.IntegerField(widget=forms.HiddenInput)
-    author = forms.CharField()
-    comment = forms.CharField()
-    
-    def __init__(self, *args, **kwargs):
-        document = kwargs.pop('instance', None)
-        super(DocumentForm, self).__init__(*args, **kwargs)
-        if document:
-            self.fields['name'].initial = document.name
-            self.fields['text'].initial = document.text
-            self.fields['revision'].initial = document.revision()
-    
-    def get_storage(self):
-        return storage
-    
-    def save(self):
-        document = Document(self.get_storage(), name=self.cleaned_data['name'], text=self.cleaned_data['text'])
-        storage.put(document, self.cleaned_data['author'], self.cleaned_data['comment'],
-            self.cleaned_data['revision'])
-        return storage.get(self.cleaned_data['name'])
 
+    author_name = forms.CharField(
+        required=False,
+        label=_(u"Author"),
+        help_text=_(u"Your name"),
+    )
+
+    author_email = forms.EmailField(
+        required=False,
+        label=_(u"Author's email"),
+        help_text=_(u"Your email address, so we can show a gravatar :)"),
+    )
+
+    comment = forms.CharField(
+        required=True,
+        widget=forms.Textarea,
+        label=_(u"Your comments"),
+        help_text=_(u"Describe the reason for reverting."),
+    )