flaskdav: initial version

uses modified PyWebDAV's fshandler.py as utils.py
original file and license for this: https://code.google.com/p/pywebdav/source/browse/pywebdav/server/fshandler.py
license: GPLv2

flaskdav.py

+from flask import Flask, request, redirect, url_for, render_template, make_response
+from flask.views import MethodView
+from string import atoi
+import shutil
+import utils
+import os
+DEBUG = True
+
+
+app = Flask(__name__.split('.')[0])
+app.config.from_object(__name__)
+
+FS_PATH = '/tmp/couscous'
+SECRET_KEY = os.urandom(24)
+
+URI_BEGINNING_PATH = {
+    'authorization': '/login/',
+    'system': '/system/',
+    'webdav': '/webdav/',
+    'links': '/',
+    'home': '/webdav/home/',
+    'editor': '/editor',
+    'devices': '/webdav/devices/'
+}
+
+def verify_cookie(cookie):
+    return False
+
+def is_authorized(cookies_list):
+    #return any(verify_cookie(cookie) for cookie in cookies_list)
+    return True
+
+FS_HANDLER = utils.FilesystemHandler(FS_PATH, URI_BEGINNING_PATH['webdav'])
+
+class WebDAV(MethodView):
+    methods = ['GET', 'HEAD', 'PUT', 'PROPFIND', 'PROPPATCH', 'MKCOL', 'DELETE', 'COPY', 'MOVE']
+
+    def __init__(self):
+        self.authorization = is_authorized(request.cookies)
+        self.baseuri = URI_BEGINNING_PATH['webdav']
+
+    def before_request(self, pathname):
+        pass
+
+    def get_body(self):
+        request_data = request.data
+        if not request_data and atoi(request.headers['Content-length']):
+            try:
+                d = request.form.items()[0][0]
+                request_data = d
+            except:
+                request_data = None
+        return request_data
+
+    def head(self, pathname):
+        """ HEAD: returns headers only """
+        origin = request.headers.get('Origin', '*')
+
+        response = None
+
+        headers = {}
+        headers['Access-Control-Max-Age'] = '3600'
+        headers['Access-Control-Allow-Credentials'] = 'true'
+        content = ''
+        if self.authorization:
+            headers['Access-Control-Allow-Origin'] = origin
+            headers['Access-Control-Allow-Headers'] = 'Origin, Accept, Accept-Encoding, Content-Length, Content-Type, Authorization, Depth, If-Modified-Since, If-None-Match'
+            headers['Access-Control-Expose-Headers'] = 'Content-Type, Last-Modified, WWW-Authenticate'
+            response = make_response(content, 200)
+        else:
+            headers['WWW-Authenticate'] = 'Nayookie login_url=' + request.url_root + URI_BEGINNING_PATH['authorization'] + '{?back_url}'
+            response = make_response(content, 401)
+
+        response.headers = headers
+        return response
+
+    def get(self, pathname):
+        """ GET: return headers + body (resource content or list of resources) """
+        localpath = FS_HANDLER.uri2local(pathname)
+
+        response = self.head(pathname)
+        # TODO if into a collection => list of the ressources
+        print('localpath: ' + localpath)
+        data = ''
+
+        if self.authorization:
+            if os.path.isdir(localpath):
+                data = "\n".join(FS_HANDLER.get_children(pathname))
+            elif os.path.isfile(localpath):
+                try:
+                    data_resource = FS_HANDLER.get_data(pathname)
+                    # TODO send large response by chunks would be nice for big
+                    # files... http://flask.pocoo.org/docs/0.10/patterns/streaming/
+                    data = data_resource.read()
+                except:
+                    # 403?
+                    response.status = '403'
+            else:
+                response.status = '404'
+
+            response.data = data
+
+        return response
+
+    def put(self, pathname):
+        """
+            PUT:
+            on collection: 405 Method Not Allowed,
+            on ressource: create if not existschange content
+        """
+        response = self.head(pathname)
+
+        if self.authorization:
+            localpath = FS_HANDLER.uri2local(pathname)
+            request_body = self.get_body()
+            if request_body is None:
+                response.status = '500'
+            elif os.path.isdir(localpath):
+                response.status = '405'
+            else:
+                response.status = str(FS_HANDLER.put(pathname, request_body))
+
+        return response
+
+    def propfind(self, pathname):
+        response = self.head(pathname)
+        if self.authorization:
+            # currently unsupported
+            response.status = '423'
+        return response
+
+    def proppatch(self, pathname):
+        response = self.head(pathname)
+        if self.authorization:
+            # currently unsupported
+            response.status = '423'
+        return response
+
+    def mkcol(self, pathname):
+        """
+            MKCOL:
+            creates a collection (that corresponds to a directory on the file system)
+        """
+
+        response = self.head(pathname)
+        if self.authorization:
+            response.status = str(FS_HANDLER.mkcol(pathname))
+        return response
+
+    def delete(self, pathname):
+        """
+           DELETE:
+           delete a resource or collection
+        """
+
+        response = self.head(pathname)
+        if self.authorization:
+            localpath = FS_HANDLER.uri2local(pathname)
+            if not os.path.exists(localpath):
+                response.status = '404'
+            if os.path.isdir(localpath):
+                try:
+                    shutil.rmtree(localpath)
+                    response.status = '204'
+                except OSError:
+                    response.status = '403'
+            elif os.path.isfile(localpath):
+                try:
+                    os.remove(localpath)
+                    response.status = '204'
+                except OSError:
+                    response.status = '403'
+        return response
+
+    def copy(self, pathname):
+        """
+           COPY:
+           copy a resource or collection
+        """
+
+        response = self.head(pathname)
+        if self.authorization:
+            localpath = FS_HANDLER.uri2local(pathname)
+            destination = request.headers['Destination']
+            host = request.headers['Host']
+            destination = destination.split(host + URI_BEGINNING_PATH['webdav'], 1)[-1]
+            destination_path = FS_HANDLER.uri2local(destination)
+            print('COPY: %s -> %s' % (localpath, destination_path))
+
+            if not os.path.exists(localpath):
+                response.status = '404'
+            elif not destination_path:
+                response.status = '400'
+            elif 'Overwrite' in request.headers and request.headers['Overwrite'] == 'F' and os.path.exists(destination_path):
+                response.status = '412'
+            else:
+                response.status = '201'
+                if os.path.exists(destination_path):
+                    delete_response = self.delete(destination)
+                    print delete_response.status
+                    response.status = '204'
+
+                if os.path.isfile(localpath):
+                    try:
+                        shutil.copy2(localpath, destination_path)
+                    except:
+                        print('problem with copy2')
+                else:
+                    try:
+                        shutil.copytree(localpath, destination_path)
+                    except:
+                        print('problem with copytree')
+        return response
+
+    def move(self, pathname):
+        """
+           MOVE:
+           move a resource or collection
+        """
+
+        response = self.head(pathname)
+        if self.authorization:
+            copy_response = self.copy(pathname)
+            response.status = copy_response.status
+            if copy_response.status == '201' or copy_response.status == '204':
+                delete_response = self.delete(pathname)
+                if delete_response.status != '204':
+                    response.status = '424'
+        return response
+
+app.add_url_rule(URI_BEGINNING_PATH['webdav'] + '<path:pathname>', view_func=WebDAV.as_view('dav'))
+
+
+@app.route(URI_BEGINNING_PATH['authorization'])
+def authorize():
+    origin = request.headers.get('Origin')
+    print origin
+    headers = request.headers
+    back_url = request.args.get('back_url')
+    print origin
+    response = make_response(render_template('authorization_page.html', headers=headers, origin=origin, back_url=back_url))
+    response.set_cookie('mycookie', value='', max_age=None, expires=None, path='/', domain=None, secure=None, httponly=False)
+    return response
+
+@app.route(URI_BEGINNING_PATH['editor'])
+def editor():
+    return render_template('code_editor.html')
+
+@app.route(URI_BEGINNING_PATH['system'])
+def system():
+    return 'TODO: page with system informations'
+
+@app.route('/')
+def links():
+    the_links = '<div><ul>'
+    the_links += '\n'.join(['<li>%s: %s </li>' % (key, URI_BEGINNING_PATH[key]) for key in URI_BEGINNING_PATH.keys()])
+    the_links += '</ul></div>'
+    return 'TODO: nice set of links to useful local pages: %s <br> + HOWTO' % the_links
+
+if __name__ == '__main__':
+    from OpenSSL import SSL
+    context = SSL.Context(SSL.TLSv1_2_METHOD)
+    # TODO set strong ciphers with context.set_cipher_list()
+    # TODO give path to key/cert using command line parameters
+    context.use_privatekey_file('ssl.key')
+    context.use_certificate_file('ssl.cert')
+
+    app.run(ssl_context=context)

templates/authorization_page.html

+<div>Headers: {{ headers }}</div>
+<div>Allow origin: {{ origin }} ? </div>
+<div>You will then be redirected to {{ back_url }} .</div>
+

templates/code_editor.html

+<!DOCTYPE html>
+<html manifest="//rawgit.com/TristanCavelier/apps/master/app/code-editor/manifest.appcache">
+  <head>
+    <meta charset="utf-8" />
+    <title>Code editor</title>
+    <meta name="viewport" content="width=device-width,user-scalable=yes,initial-scale=1" />
+    <link rel="stylesheet" href="//rawgit.com/TristanCavelier/apps/master/app/code-editor/dependency-concatenation.css" />
+    <script src="//rawgit.com/TristanCavelier/apps/master/app/code-editor/dependency-concatenation.js"></script>
+    <script src="//rawgit.com/TristanCavelier/apps/master/lib/toolbox.js"></script>
+    <script src="//rawgit.com/TristanCavelier/apps/master/lib/codemirror-keymap-krx.js"></script>
+    <link rel="stylesheet" href="//rawgit.com/TristanCavelier/apps/master/app/code-editor/app.css" />
+    <script src="//rawgit.com/TristanCavelier/apps/master/app/code-editor/app.js"></script>
+  </head>
+  <body>
+  </body>
+</html>

utils.py

+import sys
+import urlparse
+import os
+import time
+from string import joinfields, split, lower
+import types
+import shutil
+
+BUFFER_SIZE = 128 * 1000
+
+class Resource(object):
+    # XXX this class is ugly
+    def __init__(self, fp, file_size):
+        self.__fp = fp
+        self.__file_size = file_size
+
+    def __len__(self):
+        return self.__file_size
+
+    def __iter__(self):
+        while 1:
+            data = self.__fp.read(BUFFER_SIZE)
+            if not data:
+                break
+            yield data
+            time.sleep(0.005)
+        self.__fp.close()
+
+    def read(self, length = 0):
+        if length == 0:
+            length = self.__file_size
+
+        data = self.__fp.read(length)
+        return data
+
+
+class FilesystemHandler():
+    """
+    Model a filesystem for DAV
+
+    This class models a regular filesystem for the DAV server
+
+    The basic URL will be http://localhost/
+    And the underlying filesystem will be /tmp
+
+    Thus http://localhost/gfx/pix will lead
+    to /tmp/gfx/pix
+
+    """
+
+    def __init__(self, directory, uri, verbose=False):
+        self.setDirectory(directory)
+        self.setBaseURI(uri)
+        # should we be verbose?
+        self.verbose = verbose
+
+    def setDirectory(self, path):
+        """ Sets the directory """
+
+        if not os.path.isdir(path):
+            raise Exception, '%s not must be a directory!' % path
+
+        self.directory = path
+
+    def setBaseURI(self, uri):
+        """ Sets the base uri """
+
+        if uri:
+            self.baseuri = uri
+        else:
+            self.baseuri = '/'
+
+    def uri2local(self,uri):
+        """ map uri in baseuri and local part """
+
+        path=urlparse.urlparse(uri).path.strip('/')
+        fileloc=path
+        filename=os.path.join(self.directory,fileloc)
+        filename=os.path.normpath(filename)
+        print('uri2local: %s -> %s' % (uri, filename))
+        return filename
+
+    def local2uri(self,filename):
+        """ map local filename to self.baseuri """
+
+        pnum=len(split(self.directory.replace("\\","/"),"/"))
+        parts=split(filename.replace("\\","/"),"/")[pnum:]
+        sparts= joinfields(parts,"/")
+        uri=urlparse.urljoin(self.baseuri, sparts)
+        print('local2uri: %s -> %s' % (filename, uri))
+        return uri
+
+    def get_children(self, uri, filter=None):
+        """ return the child objects as self.baseuris for the given URI """
+
+        fileloc=self.uri2local(uri)
+        filelist=[]
+
+        if os.path.exists(fileloc):
+            if os.path.isdir(fileloc):
+                try:
+                    files=os.listdir(fileloc)
+                except:
+                    raise 404
+
+                for file in files:
+                    newloc=os.path.join(fileloc,file)
+                    filelist.append(self.local2uri(newloc))
+        return filelist
+
+    def get_data(self,uri, range = None):
+        """ return the content of an object """
+
+        path=self.uri2local(uri)
+        if os.path.exists(path):
+            if os.path.isfile(path):
+                file_size = os.path.getsize(path)
+                if range == None:
+                    fp=open(path,"r")
+                    return Resource(fp, file_size)
+                else:
+                    if range[1] == '':
+                        range[1] = file_size
+                    else:
+                        range[1] = int(range[1])
+
+                    if range[0] == '':
+                        range[0] = file_size - range[1]
+                    else:
+                        range[0] = int(range[0])
+
+                    if range[0] > file_size:
+                        return 416
+
+                    if range[1] > file_size:
+                        range[1] = file_size
+
+                    fp = open(path, "r")
+                    fp.seek(range[0])
+                    return Resource(fp, range[1] - range[0])
+            elif os.path.isdir(path):
+                # GET for collections is defined as 'return s/th meaningful' :-)
+                from StringIO import StringIO
+                stio = StringIO('Directory at %s' % uri)
+                return Resource(StringIO('Directory at %s' % uri), stio.len)
+            else:
+                pass
+                # also raise an error for collections
+                # don't know what should happen then..
+
+        return 404
+
+
+    def put(self, uri, data, content_type=None):
+        """ put the object into the filesystem """
+        path=self.uri2local(uri)
+        try:
+            fp=open(path, "w+")
+            if isinstance(data, types.GeneratorType):
+                for d in data:
+                    fp.write(d)
+            else:
+                if data:
+                    fp.write(data)
+            fp.close()
+            status = 201
+        except:
+            status = 409
+
+        return status
+
+    def mkcol(self,uri):
+        """ create a new collection """
+        path=self.uri2local(uri)
+
+        # remove trailing slash
+        if path[-1]=="/": path=path[:-1]
+
+        # test if file already exists
+        if os.path.exists(path):
+            return 405
+
+        # test if parent exists
+        h,t=os.path.split(path)
+        if not os.path.exists(h):
+            return 409
+
+        # test, if we are allowed to create it
+        try:
+            os.mkdir(path)
+            return 201
+        # No space left
+        except IOError:
+            return 507
+        except:
+            return 403

[Vincent Pelletier]

je ne sais pas si c'est bien de faire un dictionaire pour cette utilisation (vs. plusieurs constantes indépendantes). A moins qu'on veuille pouvoir en ajouter dynamiquement ou faire un lookup paramétrique (es-ce que ça ne serait pas d'ailleurs dangereux ?)

[Vincent Pelletier]

merger avec la ligne suivante (inutile de passer par une variable intermédiaire)

[Vincent Pelletier]

mettre une classe d'erreur suffisament restrictive à "except:" (probablement IndexError ici)

[Vincent Pelletier]

cf. module standard "argparse"