__doc__ = "Module documentation."
from piston.handler import BaseHandler, AnonymousBaseHandler
-from piston.utils import rc
+
import settings
import librarian
from datetime import date
from django.core.urlresolvers import reverse
-from wlrepo import MercurialLibrary, RevisionNotFound
+from wlrepo import MercurialLibrary, RevisionNotFound, DocumentAlreadyExists
from librarian import dcparser
+import api.response as response
+from api.utils import validate_form, hglibrary
+
#
# Document List Handlers
#
class BasicLibraryHandler(AnonymousBaseHandler):
allowed_methods = ('GET',)
- def read(self, request):
- """Return the list of documents."""
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
-
+ @hglibrary
+ def read(self, request, lib):
+ """Return the list of documents."""
document_list = [{
'url': reverse('document_view', args=[docid]),
'name': docid } for docid in lib.documents() ]
return {'documents' : document_list}
+
class LibraryHandler(BaseHandler):
allowed_methods = ('GET', 'POST')
anonymous = BasicLibraryHandler
- def read(self, request):
+ @hglibrary
+ def read(self, request, lib):
"""Return the list of documents."""
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
document_list = [{
'url': reverse('document_view', args=[docid]),
'name': docid } for docid in lib.documents() ]
- return {'documents' : document_list }
+ return {'documents' : document_list }
- def create(self, request):
- """Create a new document."""
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+ @validate_form(forms.DocumentUploadForm, 'POST')
+ @hglibrary
+ def create(self, request, form, lib):
+ """Create a new document."""
- form = forms.DocumentUploadForm(request.POST, request.FILES)
- if not form.is_valid():
- return rc.BAD_REQUEST
-
- f = request.FILES['ocr']
- data = f.read().decode('utf-8')
+ if form.cleaned_data['ocr_data']:
+ data = form.cleaned_data['ocr_data'].encode('utf-8')
+ else:
+ data = request.FILES['ocr_file'].read().decode('utf-8')
if form.cleaned_data['generate_dc']:
data = librarian.wrap_text(data, unicode(date.today()))
- # TODO: what if the file exists ?
- doc = lib.document_create(form.cleaned_data['bookname'])
- doc.quickwrite('xml', data, '$AUTO$ XML data uploaded.',
- user=request.user.username)
-
- return {
- 'url': reverse('document_view', args=[doc.id]),
- 'name': doc.id,
- 'revision': doc.revision }
+ docid = form.cleaned_data['bookname']
+ try:
+ doc = lib.document_create(docid)
+ doc = doc.quickwrite('xml', data, '$AUTO$ XML data uploaded.',
+ user=request.user.username)
+
+ url = reverse('document_view', args=[doc.id])
+
+ return response.EntityCreated().django_response(\
+ body = {
+ 'url': url,
+ 'name': doc.id,
+ 'revision': doc.revision },
+ url = url )
+
+ except DocumentAlreadyExists:
+ # Document is already there
+ return response.EntityConflict().django_response(\
+ {"reason": "Document %s already exists." % docid})
#
# Document Handlers
class BasicDocumentHandler(AnonymousBaseHandler):
allowed_methods = ('GET',)
- def read(self, request, docid):
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
-
- opts = forms.DocumentGetForm(request.GET)
- if not opts.is_valid():
- return rc.BAD_REQUEST
-
- doc = lib.document(docid)
+ @hglibrary
+ def read(self, request, docid, lib):
+ try:
+ doc = lib.document(docid)
+ except RevisionNotFound:
+ return rc.NOT_FOUND
result = {
'name': doc.id,
- 'text_url': reverse('doctext_view', args=[doc.id]),
- 'dc_url': reverse('docdc_view', docid=doc.id),
- 'latest_rev': doc.revision,
+ 'text_url': reverse('doctext_view', args=[doc.id,doc.revision]),
+ 'dc_url': reverse('docdc_view', args=[doc.id,doc.revision]),
+ 'public_revision': doc.revision,
}
return result
allowed_methods = ('GET', 'PUT')
anonymous = BasicDocumentHandler
- def read(self, request, docid):
- """Read document's meta data"""
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
-
- opts = forms.DocumentGetForm(request.GET)
- if not opts.is_valid():
- return rc.BAD_REQUEST
-
+ @hglibrary
+ def read(self, request, docid, lib):
+ """Read document's meta data"""
try:
doc = lib.document(docid)
udoc = doc.take(request.user.username)
except RevisionNotFound:
- return rc.NOT_HERE
+ return request.EnityNotFound().django_response()
# is_shared = udoc.ancestorof(doc)
# is_uptodate = is_shared or shared.ancestorof(document)
result = {
'name': udoc.id,
- 'text_url': reverse('doctext_view', args=[udoc.id]),
- 'dc_url': reverse('docdc_view', args=[udoc.id]),
- 'parts_url': reverse('docparts_view', args=[udoc.id]),
- 'latest_rev': udoc.revision,
- 'latest_shared_rev': doc.revision,
- # 'shared': is_shared,
- # 'up_to_date': is_uptodate,
- }
-
- #if request.GET.get('with_part', 'no') == 'yes':
- # result['parts'] = document.parts()
+ 'text_url': reverse('doctext_view', args=[doc.id,doc.revision]),
+ 'dc_url': reverse('docdc_view', args=[doc.id,doc.revision]),
+ 'user_revision': udoc.revision,
+ 'public_revision': doc.revision,
+ }
return result
+ @hglibrary
+ def update(self, request, docid, lib):
+ """Update information about the document, like display not"""
+ return
+
#
# Document Text View
#
class DocumentTextHandler(BaseHandler):
allowed_methods = ('GET', 'PUT')
- def read(self, request, docid):
- """Read document as raw text"""
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+ @hglibrary
+ def read(self, request, docid, revision, lib):
+ """Read document as raw text"""
try:
- return lib.document(docid, request.user.username).data('xml')
+ if revision == 'latest':
+ document = lib.document(docid)
+ else:
+ document = lib.document_for_rev(revision)
+
+ # TODO: some finer-grained access control
+ return document.data('xml')
except RevisionNotFound:
- return rc.NOT_HERE
+ return response.EntityNotFound().django_response()
- def update(self, request, docid):
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+ @hglibrary
+ def update(self, request, docid, revision, lib):
try:
- data = request.PUT['contents']
- prev = request.PUT['revision']
+ data = request.PUT['contents']
if request.PUT.has_key('message'):
msg = u"$USER$ " + request.PUT['message']
msg = u"$AUTO$ XML content update."
current = lib.document(docid, request.user.username)
- orig = lib.document_for_rev(prev)
+ orig = lib.document_for_rev(revision)
if current != orig:
- return rc.DUPLICATE_ENTRY
-
- doc.quickwrite('xml', data, msg)
-
- return rc.ALL_OK
+ return response.EntityConflict().django_response({
+ "reason": "out-of-date",
+ "provided_revision": orig.revision,
+ "latest_revision": current.revision })
+
+ ndoc = doc.quickwrite('xml', data, msg)
+
+ # return the new revision number
+ return {
+ "document": ndoc.id,
+ "subview": "xml",
+ "previous_revision": prev,
+ "updated_revision": ndoc.revision
+ }
+
except (RevisionNotFound, KeyError):
- return rc.NOT_HERE
+ return response.EntityNotFound().django_response()
#
# Dublin Core handlers
class DocumentDublinCoreHandler(BaseHandler):
allowed_methods = ('GET', 'PUT')
- def read(self, request, docid):
- """Read document as raw text"""
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+ @hglibrary
+ def read(self, request, docid, revision, lib):
+ """Read document as raw text"""
try:
- doc = lib.document(docid, request.user.username).data('xml')
- bookinfo = dcparser.BookInfo.from_string(doc.read())
-
+ if revision == 'latest':
+ document = lib.document(docid)
+ else:
+ document = lib.document_for_rev(revision)
+
+ bookinfo = dcparser.BookInfo.from_string(doc.data('xml'))
return bookinfo.serialize()
except RevisionNotFound:
- return rc.NOT_HERE
+ return response.EntityNotFound().django_response()
- def update(self, request, docid):
- lib = MercurialLibrary(path=settings.REPOSITORY_PATH)
+ @hglibrary
+ def update(self, request, docid, revision, lib):
try:
- bi_json = request.PUT['contents']
- prev = request.PUT['revision']
+ bi_json = request.PUT['contents']
if request.PUT.has_key('message'):
msg = u"$USER$ " + request.PUT['message']
else:
msg = u"$AUTO$ Dublin core update."
current = lib.document(docid, request.user.username)
- orig = lib.document_for_rev(prev)
+ orig = lib.document_for_rev(revision)
if current != orig:
- return rc.DUPLICATE_ENTRY
+ return response.EntityConflict().django_response({
+ "reason": "out-of-date",
+ "provided": orig.revision,
+ "latest": current.revision })
xmldoc = parser.WLDocument.from_string(current.data('xml'))
document.book_info = dcparser.BookInfo.from_json(bi_json)
# zapisz
- current.quickwrite('xml', document.serialize().encode('utf-8'),\
+ ndoc = current.quickwrite('xml', \
+ document.serialize().encode('utf-8'),\
message=msg, user=request.user.username)
- return rc.ALL_OK
+ return {
+ "document": ndoc.id,
+ "subview": "xml",
+ "previous_revision": prev,
+ "updated_revision": ndoc.revision
+ }
except (RevisionNotFound, KeyError):
- return rc.NOT_HERE
+ return response.EntityNotFound().django_response()
+
+
+class MergeHandler(BaseHandler):
+ allowed_methods = ('POST',)
+
+ @validate_form(forms.MergeRequestForm)
+ @hglibrary
+ def create(self, request, form, docid, lib):
+ """Create a new document revision from the information provided by user"""
+
+ pass
+
+
+
+
fnp / redakcja.git / blobdiff