stephane-klein.info

1. J'ai choisi WsgiDAV

Au mois d'août dernier, je n'avais pas encore choisi entre le projet pywebdav et wsgidav. Depuis, j'ai fait mon choix, j'ai choisi wsgidav. Qu'est ce qui a motivé ce choix ?

• l'architecture de wsgidav est modulaire, je trouve que l'utilisation de plusieurs middleware wsgi pour ajouter des fonctionnalités est une chose intéressante
• comme son nom l'indique WsgiDAV est orienté WSGI ce qui est avantageux pour moi car c'est mon objectif premier et donc cela me donne moins de travail par rapport à pywebdav

2. Changements apportés à WsgiDAV

Lorsque je travaillais sur le projet pywebdav j'avais comme objectif d'apporter des modifications au code pour fournir une classe application ou middleware WSGI. Je n'ai plus à me préocuper de ce point car WsgiDAV est nativement orienté WSGI.

Par contre, depuis août j'ai tout de même apporté des améliorations à WsgiDAV. Ma plus importante contribution est la compatibilité avec le client WebDAV Finder de Apple.

3. Chantiers en cours

Depuis que les problèmes de compatibilités avec Apple Finder sont résolus, j'ai débuté d'autres chantiers...

provider = MixinProvider((
    ("/", FilesystemProvider('/tmp/root1/')),
    ("/", FilesystemProvider('/tmp/root2/')),
    ("/dav", FilesystemProvider('/tmp/root3/')),
    ("/foo/bar/", FilesystemProvider('/tmp/root3/'))
})

dummy_provider = DummyProvider(
    resources = ('/file1.txt', '/folder_a/file2.txt', '/file3.txt',),
    collections = ('/folder_b/', '/folder_c/folder_d/',)
)

4. Chantiers futurs

Voici une liste d'autres chantiers futurs :

• amélioration de la documentation : basé sur Sphinx, qui devra être hébergé sur http://packages.python.org/wsgidav/
• amélioration des tests..., mise en place d'un buildbots...
• rédiger une procédure de sortie de release : liste d'instructions à réaliser après chaque release stable. L'une de ces instructions serait de mettre à jour un tableau qui liste les clients webdav avec lesquels wsgidav est compatible.

5. En annexe du projet

À la marge du projet, j'ai réalisé un provider basé sur ZODB. Il fonctionne plutôt bien. Ce provider n'est pas libre pour le moment.

C'est dans le cadre de ce projet que j'ai eu besoin de créer le provider MixinProvider.

6. Temps passé sur le projet

Depuis août, on peut dire que j'ai travaillé en moyenne 3h par mois sur le projet... le problème est que j'y ai surtout passé de multiples petits moments... ce qui n'est pas ce qu'il y a de plus efficace... car la plupart du temps j'avais juste le temps de me replonger dans le code... avant d'arrêter.

Dans les semaines qui viennent, j'espère pouvoir travailler chaque dimanche quatre heures sur le projet afin de rapidement finir la partie provider Mixin (ce qui est presque réalisé).

1. Le besoin

Étant donné que ces dévelopements web sont basés sur sur l'interface WSGI (c'est du Python) c'est tout naturellement que je désire utiliser un serveur WebDAV écrit en Python qui s'interface sur WSGI.

Mes contraintes, désires concernant le serveur WebDAV que je recherche :

• peu de dépendances
• un code assez compréhensible
• basé sur WSGI afin de :
  • n'avoir qu'un seul serveur à lancer pour servir les pages web et répondre aux requêtes WebDAV
  • avoir tout sur le même port
  • pouvoir utiliser le serveur WebDAV en middleware WSGI

2. État des lieux

Il y a six mois, j'ai fait une recherche dans ce sens. Voici un peu mes conclusions :

• il existe un certain nombre de modules DAV basés sur le framework Twisted;
• il existe zanshin qui est un serveur WebDAV développé pour l'application chandler;
• il existe plein de choses à propos de WebDAV dans Zope 3;
• il existe PyWebDAV qui est basé sur BaseHTTPServer.

Une recherche sur Python Package Index vous permet de trouver pas mal de choses. On y trouve à la fois des packages liés à des clients et des serveurs WebDAV.

Il y a six mois je n'ai pas trouvé de serveurs WebDAV basés sur WSGI. À la fois au niveau de mes recherches sur le web, que mes questions sur IRC. Je ne sais plus si j'ai posé la question sur une mailing list… il va falloir que je recherche et si ce n'est pas le cas… c'est mal !

3. Mon choix initial

Au mois de mai dernier, mon choix s'est porté sur PyWebDAV. Pourquoi ?

• parce que au moment où je l'avais testé avec Nautilus et Apple Finder, il semblait bien fonctionner
• car il était facile à tester (peu de dépendances…)
• j'arrive à facilement comprendre le code source de ce projet
• les développeurs de PyWebDAV sont intéressés pour avoir une version WSGI de leur serveur

4. Après une petite étude, voici ce que je devais améliorer sur PyWebDAV

• adapter PyWebDAV à WSGI
• ajouter des tests unitaires et fonctionnels
• ajouter de la documentation
• tester les performances

Je pensais aussi utiliser les dépendances suivantes :

• WebOB
• Nose : pour les tests unitaires
• davclient : pour tester le serveur webdav
• Sphinx : pour la documentation

5. Ce que j'ai fait

6. En gros ce qu'il reste à faire

Maintenant que PyWebDAV en mode BaseHTTPServer fonctionne correctement avec différent clients WebDAV, c'est le moment d'effectuer proprement la conversion à WSGI.

Mais avant cela, pour faciliter cette phase de transformation, j'aimerais réaliser un certain nombre de tests fonctionnelles. Ceci facilitera le travaille de conversion à WSGI car je n'aurais qu'à lancer la batterie de tests pour voir si j'ai fait des erreurs ou non.

7. Ce que je découvre le 18 août 2009 !

Hier, peu après mon retour de vacances, en regardant les nouveaux packets sur "Python Package Index" je découvre "wsgidav".

Après avoir un peu regardé "wsgidav", voici quelques remarques :

• le projet est bien organisé, avec de la doc, le code source semble assez simple à comprendre
• le projet utilise plusieurs middleware WSGI pour certaine tâches :
  • pour faire du debug
  • pour gérer l'authentification
  • pour activer "un browser web" : explorer les dossiers… en lecture seule dans un navigateur
  • une solution pour configurer plusieurs points de montage
  • …
• lorsque j'ai testé un transfert de gros fichiers (500Mo) il a le même problème de performance qu'avait "PyWebDAV"

8. Et maintenant ? continuer à travailler sur "PyWebDAV" ou travailler sur "WsgiDAV" ?

Pour le moment, je n'ai pas encore pris de décision mais voici comment je vais faire mon choix :

• je vais tester "WsgiDAV" avec différent clients pour voir son niveau d'implémentation du protocole
• je vais entrer en communication avec le développeur de "WsgiDAV"
• je vais informer sur "PyWebDAV" l'existence du projet "WsgiDAV"

En fonction de tout cela, je jugerais si pour atteindre mes objectifs de départ, j'ai plus de travaille à faire avec "PyWebDAV" ou avec "WsgiDAV".