Django 1.11 Support, Python 3 compatibility, several bugfixes, updates, docs

Author: anx-ckreuzberger

.gitignore

@@ -22,5 +22,10 @@
 *.log
 *.pot
 *.pyc
+__pycache__
 env
 .idea
+.eggs
+*.egg-info
+dist
+build

.travis.yml

@@ -1,13 +1,11 @@
 language: python
 python:
   - "2.7"
-  - "2.6"
+  - "3.4"
+  - "3.5"
+  - "3.6"
 env:
-  - DJANGO_VERSION=1.6.11
-  - DJANGO_VERSION=1.7.7
-matrix:
-  exclude:
-   - python: "2.6"
-     env: DJANGO_VERSION=1.7.7
-install: pip install -q Django==$DJANGO_VERSION djangorestframework==3.2.5
+  - DJANGO_VERSION=1.11
+  - DJANGO_VERSION=2.0
+install: pip install -q Django==$DJANGO_VERSION djangorestframework>=3.6,<3.8
 script: python setup.py test

README.rst

@@ -3,7 +3,7 @@ DjangoDav
 
 Production ready WebDav extension for Django.
 
-.. image:: https://travis-ci.org/meteozond/djangodav.svg
+.. image:: https://travis-ci.org/anx-ckreuzberger/djangodav.svg
 
 Motivation
 ----------
@@ -13,13 +13,52 @@ machine access to it. Most popular production ready tools provide json based api
 advantages and disadvantages.
 
 WebDav today is a standard for cooperative document management. Its clients are built in the modern operation systems
-and supported by the world popular services. But it very important to remember that it's not only about file storage,
+and supported by the world popular services. But it is very important to remember that it's not only about file storage,
 WebDab provides a set of methods to deal with tree structured objects of any kind.
 
 Providing WebDav access to Django resources opens new horizons for building Web2.0 apps, with inplace edition and
 providing native operation system access to the stored objects.
 
 
+Example App
+-----------
+
+An example app is provided `at another repository <https://github.com/anx-ckreuzberger/djangodav-example-app>`_.
+
+For a quick example please look at the code at the bottom of this readme.
+
+
+Development & Contributions
+---------------------------
+
+- Create a virtual environment: ``virtualenv -p python3 env``
+- Activate virtual environment: ``source env/bin/activate``
+- Install dependencies: ``pip install requirements.txt``
+- Edit Source Code and make a Pull Request :)
+
+
+Contributions within this repository
+------------------------------------
+
+- Cleanup
+- Django 1.11+ compatibility
+- Python3 compatibility
+- Replaced `vulnerable lxml.etree.parse function <https://blog.python.org/2013/02/announcing-defusedxml-fixes-for-xml.html>`_ with ``defusedxml.lxml.parse``
+- Documentation
+- Pep8/Pycodestyle fixes
+
+
+Original Source
+---------------
+
+The original source code is from the following repositories
+
+- `djangodav by TZanke <https://github.com/TZanke/djangodav>`_
+- `djangodav by MnogoByte <https://github.com/MnogoByte/djangodav>`_
+- `django-webdav by sirmmo <https://github.com/sirmmo/django-webdav>`_
+
+
+
 Difference with SmartFile django-webdav
 ---------------------------------------
 
@@ -43,19 +82,29 @@ Added FSResource and DBResource to provide file system and data base access.
 Xml library usage is replaced with lxml to achieve proper xml generation code readability.
 
 
-How to create simple filesystem webdav resource
------------------------------------------------
+Basic Authentication on Windows
+-------------------------------
 
-1. Create resource.py
-~~~~~~~~~~~~~~~~~~~~~
+Be careful when using Basic Authentication on Windows, as it is not enabled by default (for non SSL sites). You can
+either set ``BasicAuthLevel`` to ``2`` in the `Windows Registry <http://www.windowspage.de/tipps/022703.html>`_ , or
+just make sure your site uses SSL and has a valid SSL certificate.
+
+
+Example 1: Create a simple filesystem webdav resource
+-----------------------------------------------------
+
+This will just host the provided directory ``/path/to/folder``, without any permission handling.
+
+1. Create resources.py
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. code:: python
 
     from django.conf import settings
     from djangodav.base.resources import MetaEtagMixIn
     from djangodav.fs.resources import DummyFSDAVResource
 
-    class MyDavResource(MetaEtagMixIn, DummyFSDAVResource):
+    class MyFSDavResource(MetaEtagMixIn, DummyFSDAVResource):
         root = '/path/to/folder'
 
 
@@ -70,9 +119,143 @@ How to create simple filesystem webdav resource
 
     from django.conf.urls import patterns
 
-    from .resource import MyDavResource
+    from .resource import MyFSDavResource
 
+    # include fsdav/webdav without trailing slash (do not use a slash like in 'fsdav/(?P<path>.*)$')
     urlpatterns = patterns('',
-        (r'^fsdav(?P<path>.*)$', DavView.as_view(resource_class=MyDavResource, lock_class=DummyLock,
+        (r'^fsdav(?P<path>.*)$', DavView.as_view(resource_class=MyFSDavResource, lock_class=DummyLock,
          acl_class=FullAcl)),
     )
+
+
+Example 2: Create a simple database webdav resource
+---------------------------------------------------
+
+This example is a bit more complex, as it requires two Django models and some handling.
+
+1. Create the following models in models.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    from django.db import models
+    from django.utils.timezone import now
+
+
+    class BaseWebDavModel(models.Model):
+        name = models.CharField(max_length=255)
+        created = models.DateTimeField(default=now)
+        modified = models.DateTimeField(default=now)
+
+        class Meta:
+            abstract = True
+
+
+    class CollectionModel(BaseWebDavModel):
+        parent = models.ForeignKey('self', blank=True, null=True)
+        size = 0
+
+        class Meta:
+            unique_together = (('parent', 'name'),)
+
+        def __str__(self):
+            return "Collection {}".format(self.name)
+
+
+    class ObjectModel(BaseWebDavModel):
+        parent = models.ForeignKey(CollectionModel, blank=True, null=True)
+        path = models.FileField(max_length=255)
+        size = models.IntegerField(default=0)
+        md5 = models.CharField(max_length=255)
+
+        class Meta:
+            unique_together = (('parent', 'name'),)
+
+        def __str__(self):
+            return "Object {}".format(self.name)
+
+
+
+2. Create resources.py
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    from hashlib import md5
+
+    from django.conf import settings
+    from djangodav.db.resources import NameLookupDBDavMixIn, BaseDBDavResource
+
+    from .models import CollectionModel, ObjectModel
+
+    class MyDBDavResource(NameLookupDBDavMixIn, BaseDBDavResource):
+        collection_model = CollectionModel
+        object_model = ObjectModel
+
+        root = "/path/to/folder"
+
+        def write(self, request, temp_file=None):
+            size = len(request.body)
+
+            # calculate a hashsum of the request (ToDo: probably need to replace this with SHA1 or such, and maybe add a salt)
+            hashsum = md5(request.body).hexdigest()
+
+            # save the file
+            new_path = os.path.join(settings.MEDIA_ROOT, self.displayname)
+
+            f = open(new_path, 'wb')
+            f.write(request.body)
+            f.close()
+
+            if not self.exists:
+                obj = self.object_model(
+                    name=self.displayname,
+                    parent=self.get_parent().obj,
+                    md5=hashsum,
+                    size=size
+                )
+
+                obj.path.name = new_path
+
+                obj.save()
+
+                return
+
+            self.obj.size = size
+            self.obj.modified = now()
+            self.obj.path.name = new_path
+            self.obj.md5 = hashsum
+
+            self.obj.save(update_fields=['path', 'size', 'modified', 'md5'])
+
+        def read(self):
+            return self.obj.path
+
+        @property
+        def etag(self):
+            return self.obj.md5
+
+        @property
+        def getcontentlength(self):
+            return self.obj.size
+
+
+
+3. Register WebDav view in urls.py
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    from djangodav.acls import FullAcl
+    from djangodav.locks import DummyLock
+    from djangodav.views import DavView
+
+    from django.conf.urls import patterns
+
+    from .resource import MyDBDavResource
+
+    # include fsdav/webdav without trailing slash (do not use a slash like in 'dbdav/(?P<path>.*)$')
+    urlpatterns = patterns('',
+        (r'^dbdav(?P<path>.*)$', DavView.as_view(resource_class=MyFSDavResource, lock_class=DummyLock,
+         acl_class=FullAcl)),
+    )

djangodav/__init__.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/acls.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/auth/__init__.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/auth/rest.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/auth/tasty.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/base/__init__.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/base/locks.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #

djangodav/base/resources.py

@@ -1,3 +1,6 @@
+# Refactoring, Django 1.11 compatibility, cleanups, bugfixes (c) 2018 Christian Kreuzberger <ckreuzberger@anexia-it.com>
+# All rights reserved.
+#
 # Portions (c) 2014, Alexander Klimenko <alex@erix.ru>
 # All rights reserved.
 #
@@ -48,6 +51,8 @@ def get_escaped_path(self):
 
     @property
     def displayname(self):
+        if len(self.path) == 0:
+            return '/'
         if not self.path:
             return None
         return self.path[-1]
@@ -77,6 +82,7 @@ def get_descendants(self, depth=1, include_self=True):
 
     @property
     def getcontentlength(self):
+        # ToDo: This is a property... it should not have a "get" in the name -> rename it
         raise NotImplementedError()
 
     @property
@@ -86,6 +92,7 @@ def creationdate(self):
 
     @property
     def getlastmodified(self):
+        # ToDo: This is a property... it should not have a "get" in the name -> rename it
         """Return the modified time as http_date."""
         return rfc1123_date(self.get_modified())
 
@@ -98,7 +105,8 @@ def get_modified(self):
         raise NotImplementedError()
 
     @property
-    def getetag(self):
+    def etag(self):
+        # ToDo: This is a property... it should not have a "get" in the name -> rename it
         raise NotImplementedError()
 
     def copy(self,  destination, depth=-1):
@@ -151,7 +159,7 @@ def clone(self, *args, **kwargs):
     def move_object(self, destination):
         raise NotImplemented()
 
-    def write(self, content):
+    def write(self, content, temp_file=None):
         raise NotImplementedError()
 
     def read(self):
@@ -185,14 +193,14 @@ def create_collection(self):
 
 class MetaEtagMixIn(object):
     @property
-    def getetag(self):
+    def etag(self):
         """Calculate an etag for this resource. The default implementation uses an md5 sub of the
         absolute path modified time and size. Can be overridden if resources are not stored in a
         file system. The etag is used to detect changes to a resource between HTTP calls. So this
         needs to change if a resource is modified."""
         hashsum = md5()
-        hashsum.update(self.displayname)
-        hashsum.update(str(self.creationdate))
-        hashsum.update(str(self.getlastmodified))
-        hashsum.update(str(self.getcontentlength))
+        hashsum.update(self.displayname.encode())
+        hashsum.update(str(self.creationdate).encode())
+        hashsum.update(str(self.getlastmodified).encode())
+        hashsum.update(str(self.getcontentlength).encode())
         return hashsum.hexdigest()