<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>.: chiroux.com :. &#187; django</title>
	<atom:link href="http://www.chiroux.com/tag/django/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.chiroux.com</link>
	<description></description>
	<lastBuildDate>Fri, 09 Oct 2009 21:47:56 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=abc</generator>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
			<item>
		<title>Django : une arborescence de catalogue</title>
		<link>http://www.chiroux.com/django-une-arborescence-de-catalogue/</link>
		<comments>http://www.chiroux.com/django-une-arborescence-de-catalogue/#comments</comments>
		<pubDate>Wed, 08 Aug 2007 22:26:49 +0000</pubDate>
		<dc:creator>Thomas</dc:creator>
				<category><![CDATA[Obsolete]]></category>
		<category><![CDATA[Python]]></category>
		<category><![CDATA[ajax]]></category>
		<category><![CDATA[django]]></category>
		<category><![CDATA[javascript]]></category>
		<category><![CDATA[mootools]]></category>
		<category><![CDATA[mootree]]></category>

		<guid isPermaLink="false">http://www.chiroux.com/article-1186612009.html</guid>
		<description><![CDATA[<p>C&#8217;est la semaine de la publication&#8230; Après le gadget vista pour la NB4, voici un article qui explique comment gérer une structure arborescente avec django (un excellent framework python).
J&#8217;espère que cet article sur django est le premier d&#8217;une longue série. J&#8217;ai comme beaucoup l&#8217;intention de basculer mon site sur cette techno, mais cela va prendre [...]]]></description>
			<content:encoded><![CDATA[<p>C&#8217;est la semaine de la publication&#8230; Après le gadget vista pour la NB4, voici un article qui explique comment gérer une structure arborescente avec django (un excellent framework python).<br />
J&#8217;espère que cet article sur django est le premier d&#8217;une longue série. J&#8217;ai comme beaucoup l&#8217;intention de basculer mon site sur cette techno, mais cela va prendre du temps. En attendant, j&#8217;essaierais de continuer à proposer des morceaux de codes ou des applications django comme celle-ci à l&#8217;avenir.</p>
<p>Depuis ma &#8216;conversion&#8217; à python, j&#8217;ai eu &#8211; entre autre &#8211; l&#8217;occasion de découvrir le framework de développement web django. Après avoir fait un peu de tour du marché des framework python open source, c&#8217;est vraiment celui qui m&#8217;a paru le plus prometteur avec une approche à la fois intelligente et très pragmatique du développement web. Depuis ce temps, je n&#8217;avais pas vraiment eu l&#8217;occasion de développer un site en particulier, l&#8217;occasion s&#8217;est présentée il y a environ un mois où j&#8217;ai eu le besoin de maquetter un petit site de gestion de catalogue de films (une sorte de proof of concept), pour lequel il a donc fallu constuire une arborescence du catalogue. Voici donc une petite application django qui permet de gérer un catalogue hierarchique.<span id="more-23"></span></p>
<p style="text-align: right;">[<a href="#Telechargement">cliquez ici pour accéder directement au téléchargement</a>]</p>
<span id="Fonctionnalits_et_technologies_utilises"><h1>Fonctionnalités et technologies utilisées</h1></span>
<p>A ce stade, le catalogue affiche une page web avec un catalogue hierarchique que l&#8217;on peut gérer dynamiquement.<br />
Toutes les modifications de ce catalogue sont réalisées en AJAX.<br />
Les fonctionnalités sont donc les suivantes :</p>
<ul>
<li>afficher un catalogue avec une vue hierarchique</li>
<li>déplacer des éléments du catalogue vers une autre position (avant, après ou à l&#8217;intérieur d&#8217;un autre élément)</li>
<li>Ajouter des éléments du catalogue (avant, après ou à l&#8217;intérieur d&#8217;un autre élement)</li>
<li>Supprimer un élément du catalogue</li>
<li>Modifier un élément du catalogue (le renommer)</li>
</ul>
<p>Les techno utilisées sont :</p>
<ul>
<li>Coté client
<ul>
<li>mootools (cela devient une habitude)</li>
</ul>
<ul>
<li>mootree (une extension à mootols qui permet de gérer justement des catalogue), dans une version modifiée par moro (http://forum.mootools.net/viewtopic.php?pid=23580) qui permet tout particulièrement la gestion des drag&amp;drop.</li>
</ul>
</li>
<li>Côté serveur
<ul>
<li>django et donc python (j&#8217;utilise la version de devt, à la revision 5830 au moment où j&#8217;écris ces lignes)</li>
</ul>
</li>
</ul>
<span id="Django"><h1>Django</h1></span>
<p>Comme à mon habitude, mon but n&#8217;est pas de réécrire ce qui a déjà été présenté et expliqué dans d&#8217;autres sites bien mieux que je ne pourrais le faire.<br />
Pour débuter sur django et pour aller plus loin ensuite, il existe de plus en plus de ressources sur le net.<br />
Je ne saurais trop vous conseiller de suivre les étapes du <a href="http://www.djangobook.com/" target="_blank">book django</a>.<br />
Le <a href="http://www.djangoproject.com/" target="_blank">site officiel de django</a> qui regroupe tout ce qui est nécesaire :<br />
Ainsi que le site français <a href="http://www.django-fr.org/" target="_blank">django-fr</a><br />
J&#8217;ai aussi trouvé beaucoup d&#8217;information très intéressantes et pertinentes sur le site de David Larlet : <a href="http://www.biologeek.com/" target="_blank">Biologeek</a></p>
<span id="Django_et_AJAX"><h2>Django et AJAX</h2></span>
<p>Le principal reproche que l&#8217;on fait généralement à django (notamment quand on le compare à rails <img src='http://www.chiroux.com/wp-includes/images/smilies/icon_smile.gif' alt=':-)' class='wp-smiley' />  est qu&#8217;il ne gère pas les applications AJAX nativement.<br />
Nous allons voir plus loin que faire des applications AJAX avec django non seulement ne pose aucun problème mais en plus est extrèmement simple (comme souvent d&#8217;aileurs avec ce framework).</p>
<span id="Etape_1_la_modlisation_des_donnes"><h1>Etape 1, la modélisation des données</h1></span>
<p>Le principe général est que chaque élément est un noeud du catalogue et qu&#8217;il a donc un élémént &#8216;père&#8217;. Cela forme ainsi une structure hiérarchique potentiellement infinie. Les éléments qui n&#8217;ont pas de père sont les éléments en tête du catalogue.</p>
<p><img class="alignnone size-full wp-image-92" title="catalogue model" src="http://www.chiroux.com/wp-content/uploads/Import/Dev/catalogue model.JPG" alt="catalogue model" width="263" height="215" /></p>
<pre>
<pre class="brush: python;">class Catalogue(models.Model):
    node_name = models.CharField(maxlength=200)
    node_parent = models.ForeignKey('self', blank=True, null=True)
    path = models.CharField(maxlength=200, editable=False, null=True)
    indent_level = models.PositiveSmallIntegerField(editable=False, null=True)
    level_order = models.PositiveSmallIntegerField(editable=True, null=True)</pre>
</pre>
<p>l&#8217;élément de catalogue a également trois informations supplémentaires qui seront mises à jour automatiquement par l&#8217;application :</p>
<ul>
<li>le &#8216;path&#8217; qui représente de façon linéaire la position de l&#8217;élément dans le catalogue (ex pour l&#8217;émément d&#8217;id 4 : 1.2.3.4 signifie que son père est le 3 et que son grand père est le 2 et ainsi de suite)</li>
<li>l&#8217; &#8216;indent_level&#8217; représente le niveau de profondeur dans l&#8217;arbre où se site l&#8217;élément (0 est le niveau le plus haut, notre élément dans cet exemple a donc un indent_level de 3)</li>
<li>le &#8216;level_order&#8217; est un champ qui va servir à ordonner les éléments du même niveau hierarchique (pour ne pas obliger un tri en particulier)</li>
</ul>
<p>Ces 3 champs étant mis à jour dynamiquement, il est nécessaire, dans la définition du modèle, de réaliser des actions particulières lors de l&#8217;INSERT, l&#8217;UPDATE ou le DELETE d&#8217;un élémént.<br />
Dans les modèles django, c&#8217;est effectué en spécialisant les méthodes save() et delete() : a chaque action de save() [en cas d'INSERT ou UPDATE] ou de delete(), ces méthodes seront appelées et feront les calculs et modifications nécessaires à la mise à jour de ces données.</p>
<pre>
<pre class="brush: python;">    def save(self):
        &quot;&quot;&quot;Redéfinition du save afin de remplir les champs path, indent_level et level_order
        &quot;&quot;&quot;
        if self.id == None:
          # C'est un insert : On fait un premier save pour récupérer un id
          self.path = ''
          self.indent_level = 0
          #self.level_order=0
          super(Catalogue, self).save() # call the real save()

        # On modifie son path en ajoutant son id au path du parent
        parent = self.node_parent
        if self.node_parent != None:
          self.path=parent.path + '.%s' % self.id
          self.indent_level= parent.indent_level + 1
        else:
          self.path = '%s' % self.id
          self.indent_level = 0
        super(Catalogue, self).save() # call the real save()

        #Ensuite on resauvegarde les enfants pour remettre à jour path et indent_level
        for son in Catalogue.objects.filter(node_parent=self):
          son.save()</pre>
</pre>
<pre>
<pre class="brush: python;">	def delete(self):
	    &quot;&quot;&quot;Traitement du delete du catalogue afin notamment de raccrocher les fils au nouveau père
	    &quot;&quot;&quot;
	    #Identifier les fils
	    sons = Catalogue.objects.filter(node_parent=self)
	    for son in sons:
	      #pour chaque fils, le rattacher à mon propre pere
	      son.node_parent=self.node_parent
	      son.save()

	    super(Catalogue, self).delete() # call the real delete()</pre>
</pre>
<p>On peut remarquer ici que le delete ne supprime pas l&#8217;arborescence qui en sous l&#8217;élément effacé. C&#8217;est un choix de ma part, à la fois pour des questions de sécurité (eviter l&#8217;erreur fatale) et pour des raisons de gestions, cela me parait plus logique au jour le jour d&#8217;avoir des manipulations unitaires que des suppressions de catalogues complets.</p>
<p>Toutefois il serait imaginable de coder une sorte de &#8217;super delete&#8217; qui supprimerait l&#8217;élément et tous ses enfants.</p>
<span id="Etape_2_les_URLS"><h1>Etape 2, les URLS</h1></span>
<p>L&#8217;application et donc les URLS sont d&#8217;inspiration REST. Je ne peut pas encore parler de RESTFULL car je n&#8217;ai pas encore assez creusé le sujet. A ce sujet les articles de David sur son site, notamment <a href="http://www.biologeek.com/journal/index.php/une-solution-pour-faciliter-la-conception-d-applications-web-restful-avec-django" target="_blank">celui ci assez récent </a>sont des très bon points de départ.</p>
<p>La gestion des URLs est déléguée dans l&#8217;application, ainsi la config d&#8217;urls.py du projet est assez simple :</p>
<pre>
<pre class="brush: python;">urlpatterns = patterns('',
    (r'^catalogue/', include('myproject.catalogue.urls')),</pre>
</pre>
<p>le fichier urls.py du projet catalogue est plus intéressant :</p>
<pre>
<pre class="brush: python;">from django.conf.urls.defaults import *
from myproject.catalogue import views

urlpatterns = patterns('myproject.catalogue.views',
    (r'xml/?', 'catalogueXML'),
    (r'move/?', 'moveCatalogueItem'),
    (r'insert/?', 'insertCatalogueItem'),
    (r'delete/?', 'deleteCatalogueItem'),
    (r'update/?', 'updateCatalogueItem'),
    (r'/?$', 'catalogue'),</pre>
</pre>
<p>Les URLS globales seront donc de la forme : /catalogue/xml/, etc&#8230;</p>
<p>Voici leur rôle :</p>
<ul>
<li>/catalogue/
<ul>
<li>Affiche la page web du catalogue</li>
</ul>
</li>
<li>/catalogue/xml/
<ul>
<li>renvoie une strucute xml avec tout ou partie du catalogue (un filtrage peut être réalisé en envoyant des données en POST)</li>
</ul>
</li>
<li>/catalogue/move/
<ul>
<li>toujours en fonction des données envoyées en POST, permet de déplacer des éléments du catalogue</li>
</ul>
</li>
<li>/catalogue/insert/
<ul>
<li>insère un élément dans le catalogue (le PUT du REST)</li>
</ul>
</li>
<li>/catalogue/delete/
<ul>
<li>supprime un élément dans le catalogue</li>
</ul>
</li>
<li>/catalogue/update/
<ul>
<li>modifie un élément du catalogue</li>
</ul>
</li>
</ul>
<p>A chaque URL correspond une vue que nous allons décrire maintenant</p>
<span id="Etape_3_Les_vues"><h1>Etape 3, Les vues</h1></span>
<span id="la_vue_catalogue"><h2>la vue catalogue</h2></span>
<p>Cette vue est ultra simple et pourrait dans l&#8217;absolu être hébergée n&#8217;importe où : comme toutes les autres relations entre la page web et le site sont en AJAX, django n&#8217;a pas besoin de gérer cette vue. Elle est ajoutée ici pour des raisons de cohérence et de simplicité. Elle ne fait rien d&#8217;autre que d&#8217;afficher un template de la page catalogue.html. Nous reviendrons sur cette page plus bas car c&#8217;est là que se situe tout le code javascript.</p>
<span id="la_vue_catalogueXML"><h2>la vue catalogueXML</h2></span>
<p>cette vue renvoie une structure XML représentant l&#8217;arbre (ou une partie de l&#8217;arbre) du catalogue.<br />
Elle prend en argument en POST le &#8216;node_path&#8217; du node de l&#8217;arbre a partir duquel on souhaite récupérer l&#8217;arborescence. Si on n&#8217;envoie aucun paramètre c&#8217;est l&#8217;arbre entier qui est retourné.</p>
<p>A noter : toutes les vues gère à la fois la récupération des arguments en GET ou en POST, c&#8217;est principalement pour des raisons de debug.</p>
<p>Le parcours du catalogue en base est réalisé de façon récursive et cette méthode appelle donc une sous méthode récursive (recurseCatalogueXML) qui elle même continue à parcourir les sous éléments du noeud.<br />
Il y a d&#8217;autres façon de faire, certainement plus performantes (notamment en utilisant un parcours linéraire en ordonant les résultats du node_path), mais alors les fonctions pour générer la structure XML sont plus complexes à écrire. J&#8217;ai choisi ici la lisiblité au détriment de la performance.</p>
<pre>
<pre class="brush: python;">def catalogueXML(request):
    node=None
    try:
        if request.method == 'GET':
            debug('catalogueXML - method:GET')
            node_path = request.GET['node_path']
        elif request.method== 'POST':
            debug('catalogueXML - method:POST')
            node_path = request.POST['node_path']
        try:
            node = Catalogue.objects.get(path=node_path)
        except ObjectDoesNotExist:
            node = None
    except KeyError:
        # Pas de request, on part du root catalogue
        node = None

    xml = ''
    xml = recurseCatalogueXML(node)

    t = loader.get_template('catalogue_xml.xml')
    c = Context({
        'snippet': xml,
    })
    return HttpResponse(t.render(c), mimetype='application/xml')</pre>
</pre>
<pre>
<pre class="brush: python;">def recurseCatalogueXML(parent):
    if parent == None:
      items_list = Catalogue.objects.filter(node_parent__isnull=True).order_by('level_order')
    else:
      items_list = Catalogue.objects.filter(node_parent=parent).order_by('level_order')

    xml = ''

    for item in items_list:
        tmp_xml = recurseCatalogueXML(item)
        if tmp_xml == '':
            #pas d'enfants
            xml+= '\n'
        else:
            #des enfants
            xml+= '\n' + tmp_xml + ''

    return xml</pre>
</pre>
<span id="la_vue_updateCatalogueItem"><h2>la vue updateCatalogueItem</h2></span>
<p>C&#8217;est la vue &#8216;active&#8217; la plus simple. Elle prend en argument le path de l&#8217;item à modifier ainsi que le nouveau nom, récupère l&#8217;élément, le modifie et retourne le nouveau nom.</p>
<p>A noter : Pour cette vue et toutes les autres vues de modification, j&#8217;ai choisit aussi la simplicité concernant la gestion des valeurs de retour, en renvoyant du texte simple.<br />
Une bonne application bien faite et bien propre renverrait une structure JSON ou XML avec des valeurs normalisées. Je le modifierais peut-être à l&#8217;avenir dans ce sens (notamment en permettant de choisir le format de retout JSON ou XML). Il sera de toute façon obligatoire de le faire à partir du moment où il est nécessaire de retourner plusieurs éléments, ce qui est d&#8217;ailleurs en théorie le cas ici).</p>
<p>Dans cet exemple, si l&#8217;update n&#8217;a pas pu être réalisé, la vue renverra &#8216;NOK&#8217; et dans les autres cas le nouveau nom du noeud. Il y a donc un problème théorique si on renomme notre noeud en &#8216;NOK&#8217; et que tout se passe bien&#8230; j&#8217;ai un peu triché là dessus côté client, nous verrons tout à l&#8217;heure.</p>
<pre>
<pre class="brush: python;">def updateCatalogueItem(request):
    if request.method == 'GET':
        debug('updateCatalogueItem - method:GET')
        node_path = request.GET['node_path']
        item_new_name = request.GET['node_name']
    elif request.method== 'POST':
        debug('updateCatalogueItem - method:POST')
        node_path = request.POST['node_path']
        item_new_name = request.POST['node_name']

    debug('item:'+node_path)
    debug('new name:'+item_new_name)

    result=''
    try:
        node_to_be_updated = Catalogue.objects.get(path=node_path)
        node_to_be_updated.node_name = item_new_name
        node_to_be_updated.save()
        result=item_new_name
    except ObjectDoesNotExist:
        result='NOK'

    return HttpResponse(result)</pre>
</pre>
<span id="la_vue_deleteCatalogueItem"><h2>la vue deleteCatalogueItem</h2></span>
<p>Cette vue prends un seul paramètre : le node_path du noeud à supprimer et renvoye &#8216;OK&#8217; ou &#8216;NOK&#8217;.</p>
<p>En fait cette vue ne fait rien d&#8217;intelligent (elle récupère le noeud et le supprime) car toute l&#8217;intelligence de traitement (notamment rattacher les noeud fils au père du noeud supprimé) sont fait dans les modèles que nous avons vu tout à l&#8217;heure.</p>
<pre>
<pre class="brush: python;">def deleteCatalogueItem(request):
    if request.method == 'GET':
        debug('deleteCatalogueItem - method:GET')
        node_path = request.GET['node_path']
    elif request.method== 'POST':
        debug('deleteCatalogueItem - method:POST')
        node_path = request.POST['node_path']

    debug('node_path :'+node_path)

    result=''
    try:
        node_to_be_deleted = Catalogue.objects.get(path=node_path)
        node_to_be_deleted.delete()
        result='OK'
    except ObjectDoesNotExist:
        result='NOK'

    return HttpResponse(result)</pre>
</pre>
<span id="la_vue_insertCatalogueItem"><h2>la vue insertCatalogueItem</h2></span>
<p>Cette vue est un peu plus complexe car elle doit gérer 3 cas différents :</p>
<ul>
<li>L&#8217;insertion avant un item</li>
<li>L&#8217;insertion après un item</li>
<li>L&#8217;insertion à l&#8217;intérieur d&#8217;un item (et dans ce cas il faut gérer si c&#8217;est le premier élément sous l&#8217;item ou non)</li>
</ul>
<p>Elle prend donc 3 arguments :</p>
<ul>
<li>le nom de l&#8217;item à insérer</li>
<li>le node_path de l&#8217;item &#8216;près&#8217; duquel nous allons insérer ce nouveau noeud</li>
<li>le type d&#8217;insertion (before, after ou inside)</li>
</ul>
<pre>
<pre class="brush: python;">def insertCatalogueItem(request):
    if request.method == 'GET':
        debug('insertCatalogueItem - method:GET')
        new_node_name = request.GET['node_name']
        to_item = request.GET['to_item']
        insert_type = request.GET['insert_type'] # before, after or inside
    elif request.method== 'POST':
        debug('insertCatalogueItem - method:POST')
        new_node_name = request.POST['node_name']
        to_item = request.POST['to_item']
        insert_type = request.POST['insert_type'] # before, after or inside

    debug('node_name :'+new_node_name )
    debug('to:'+to_item)
    debug('type:'+insert_type)</pre>
</pre>
<p>Comme il faut gérer des notions comme avant ou après un noeud, il faut gérer l&#8217;ordre, c&#8217;est donc pour cela que le champ &#8216;level_order&#8217; existe.<br />
Donc pour insérer l&#8217;item au bon endroit, il est nécessaire de connaitre son père et son numéro d&#8217;ordre à côté de ses frères.<br />
La première chose à faire est donc de déterminer ces éléments en fonction des paramètres :</p>
<pre>
<pre class="brush: python;">#On récupère le père
if insert_type == 'before':
    new_node_parent=Catalogue.objects.get(path=to_item).node_parent
    new_level_order=Catalogue.objects.get(path=to_item).level_order
elif insert_type == 'after':
    new_node_parent=Catalogue.objects.get(path=to_item).node_parent
    new_level_order=Catalogue.objects.get(path=to_item).level_order+1
elif insert_type == 'inside':
    try:
        new_node_parent=Catalogue.objects.get(path=to_item)
    except ObjectDoesNotExist:
        # Il n'y a pas d'objet c'est vraissemblablement le premier
        new_node_parent = None

    try:
        items_list=Catalogue.objects.filter(node_parent=new_node_parent).order_by('-level_order')
        new_level_order = items_list[0].level_order+1
    except IndexError:
        new_level_order = 1</pre>
</pre>
<p>En cas d&#8217;insertion before ou after, le parent est le même : c&#8217;est le parent du node mis en référence.<br />
En cas d&#8217;insertion inside, le parent est directement le node mis en référence.<br />
J&#8217;ai choisi pour l&#8217;insersion inside d&#8217;insérer par défaut en dernière position, il faut donc récupérer quelle est la dernière position des fils du node en référence.</p>
<p>Ensuite, en cas d&#8217;insertion before ou after, on doit éventuellement décaler tous les autres items &#8216;frères&#8217; d&#8217;un cran afin de laisser la place à celui qui arrive :</p>
<pre>
<pre class="brush: python;"># Pour les insert before et after : On update le level order de tous les enregistrements suivant du même niveau
    if insert_type == 'before' or insert_type == 'after':
        items_list = Catalogue.objects.filter(node_parent=new_node_parent, level_order__gte=new_level_order).order_by('level_order')
        for item in items_list:
            item.level_order+=1
            item.save()</pre>
</pre>
<p>Enfin on crée l&#8217;élément avec ces valeurs et on retourne le path :</p>
<pre>
<pre class="brush: python;"># On crée l'enregistrement
p = Catalogue.objects.create(node_name=new_node_name, node_parent=new_node_parent, level_order=new_level_order)

return HttpResponse(p.path)</pre>
</pre>
<span id="la_vue_moveCatalogueItem"><h2>la vue moveCatalogueItem</h2></span>
<p>Comme pour l&#8217;insert, cette vue va gérer trois types de mouvements : before, after ou inside un élément.</p>
<pre>
<pre class="brush: python;">def moveCatalogueItem(request):
    if request.method == 'GET':
        debug('moveCatalogueItem - method:GET')
        item = request.GET['item']
        to_item = request.GET['to_item']
        move_type = request.GET['move_type'] # before, after or inside
    elif request.method== 'POST':
        debug('moveCatalogueItem - method:POST')
        item = request.POST['item']
        to_item = request.POST['to_item']
        move_type = request.POST['move_type'] # before, after or inside

    debug('item:'+item)
    debug('to:'+to_item)
    debug('type:'+move_type)</pre>
</pre>
<p>Ensuite, nous allons changer le parent de l&#8217;item en fonction des paramètres d&#8217;entrées pour le mettre au bon endroit :</p>
<pre>
<pre class="brush: python;">    # le père de l'item est maintenant le même père que le to
    # On récupère le père de to
    catalogue_item_to = Catalogue.objects.get(path=to_item)
    # On récupère l'item
    catalogue_item = Catalogue.objects.get(path=item)

    # On met le bon parent
    if move_type == 'inside':
        catalogue_item.node_parent = catalogue_item_to
    else:
        catalogue_item.node_parent = catalogue_item_to.node_parent
    catalogue_item.level_order = 0
    catalogue_item.save()</pre>
</pre>
<p>Enfin on gère l&#8217;ordre, en décalant tous les éléments qu&#8217;il est nécessaire de décaler.<br />
Cette partie est une des premières que j&#8217;avais réalisé, je m&#8217;aperçois aujourd&#8217;hui qu&#8217;elle est largement optimisable (éviter de parcourir tous les éléments)</p>
<pre>
<pre class="brush: python;">    items_list = Catalogue.objects.filter(node_parent=catalogue_item.node_parent).order_by('level_order')
    offset = 0
    for item in items_list:
        if item.path == to_item:
            if move_type == 'before':
                offset = 1
                catalogue_item.level_order = item.level_order # on donne le numéro d'ordre à l'item inséré puis on ajoute l'offset aux items suivants
                catalogue_item.save()
            elif move_type == 'after':
                #En insertion after, l'augmentation d'offset des items ne doit se produire qu'au tour suivant, on va donc 'forcer' un tour
                offset = 1
                catalogue_item.level_order = item.level_order+1
                catalogue_item.save()
                continue
            elif move_type == 'inside':
                pass
        if offset != 0:
            debug_string = 'On ajoute %s' % offset + ' a item %s' % item.node_name
            debug(debug_string)
            item.level_order+=offset
            item.save()
        last_level_order = item.level_order

    if offset == 0:
        # on a pas trouvé, donc on insére à la fin
        catalogue_item.level_order = last_level_order+1
        catalogue_item.save()

    result = catalogue_item.path
    return HttpResponse(result)</pre>
</pre>
<span id="Etape_4_le_ct_client_en_javascript"><h1>Etape 4, le côté client en javascript</h1></span>
<span id="Rsum_des_flux_AJAX"><h2>Résumé des flux AJAX</h2></span>
<p>Voici un petit dessin qui résume les différentes interfaces que l&#8217;on a définie dans l&#8217;application django et donc ce que le côté client doit transmettre et recevoir :</p>
<p><img title="Catalogue_flux_AJAX" src="../wp-content/uploads/Import/Dev/Catalogue_flux_AJAX.jpg" alt="Catalogue_flux_AJAX" width="491" height="744" /></p>
<span id="Le_code_HTML"><h2>Le code HTML</h2></span>
<p>Le code html est constitué de deux parties :<br />
le div qui va recevoir l&#8217;arbre :</p>
<pre>
<pre class="brush: xml;">&lt;div id=&quot;mytree_catalogue&quot;&gt;
&lt;/div&gt;</pre>
</pre>
<p>les formulaires qui servent à gérer les différentes actions possibles sur les éléments du catalogue.<br />
Ces formulaires sont très basiques et très moches. Le but est de montrer les fonctionnalités. Chacun intégrera ces fonctions à sa manière dans son site. Une implémentation sympa serait de gérer le bouton droit quand on est sur un élément de l&#8217;arbre et afficher un petit menu avec ces différentes possibilités. C&#8217;est éventuellement une évolution que j&#8217;apporterais à l&#8217;avenir.</p>
<p>Pour plus de lisibilité, j&#8217;ai séparé les différentes fonctions en différentes boites :</p>
<pre>
<pre class="brush: xml;">&lt;div id=&quot;boite1&quot; class=&quot;form_div&quot;&gt;
    &lt;input type=&quot;button&quot; value=&quot; expand all &quot; onclick=&quot;tree.expand()&quot; /&gt;
    &lt;input type=&quot;button&quot; value=&quot; collapse all &quot; onclick=&quot;tree.collapse()&quot; /&gt;
&lt;/div&gt;
&lt;div id=&quot;boite2&quot; class=&quot;form_div&quot;&gt;
    &lt;form id=&quot;insertForm&quot; action=&quot;/catalogue/insert/&quot; method=&quot;post&quot; name=&quot;insertForm&quot;&gt;
        &lt;input type=&quot;text&quot; value=&quot;&quot; name=&quot;node_name&quot; /&gt;&lt;br /&gt;
        &lt;input type=&quot;hidden&quot; value=&quot;&quot; name=&quot;to_item&quot; /&gt;
        &lt;input type=&quot;hidden&quot; value=&quot;before&quot; name=&quot;insert_type&quot; /&gt;
        &lt;input type=&quot;submit&quot; value=&quot; insert before&quot; name = &quot;button&quot; onclick=&quot;$('insertForm').insert_type.value='before';&quot; /&gt;
        &lt;input type=&quot;submit&quot; value=&quot; insert after&quot; name = &quot;button&quot; onclick=&quot;$('insertForm').insert_type.value='after'; &quot; /&gt;
        &lt;input type=&quot;submit&quot; value=&quot; insert inside&quot; name = &quot;button&quot; onclick=&quot;$('insertForm').insert_type.value='inside';&quot; /&gt;
    &lt;/form&gt;
&lt;/div&gt;
&lt;div id=&quot;boite3&quot; class=&quot;form_div&quot;&gt;
    &lt;form id=&quot;deleteForm&quot; action=&quot;/catalogue/delete/&quot; method=&quot;post&quot; name=&quot;deleteForm&quot;&gt;
        &lt;input type=&quot;hidden&quot; value=&quot;&quot; name=&quot;node_path&quot; /&gt;
        &lt;input type=&quot;submit&quot; value=&quot; delete selected &quot; name= &quot;button&quot; /&gt;
    &lt;/form&gt;
&lt;/div&gt;
&lt;div id=&quot;boite4&quot; class=&quot;form_div&quot;&gt;
    &lt;form id=&quot;updateForm&quot; action=&quot;/catalogue/update/&quot; method=&quot;post&quot; name=&quot;updateForm&quot;&gt;
        &lt;input type=&quot;text&quot; value=&quot;&quot; name=&quot;node_name&quot; /&gt;
        &lt;input type=&quot;hidden&quot; value=&quot;&quot; name=&quot;node_path&quot; /&gt;
        &lt;input type=&quot;submit&quot; value=&quot; update selected &quot; name= &quot;button&quot; /&gt;
    &lt;/form&gt;
&lt;/div&gt;</pre>
</pre>
<span id="Le_javascript"><h2>Le javascript</h2></span>
<p>Au chargement de la page, la fonction main() est appelée, tout est à l&#8217;intérieur.</p>
<span id="La_premire_chose__faire_est_d8217initaliser_le_mootree_:"><h3>La première chose à faire est d&#8217;initaliser le mootree :</h3></span>
<pre>
<pre class="brush: jscript;">    function main() {
    tree = new MooTreeControl({
            div: 'mytree_catalogue',
            mode: 'files',
            theme: '/site_media/js/mootree.gif',
            grid: true,
            onSelect: function() {
                //alert('coucou');
                $('updateForm').node_name.value = this.selected.text;
                $('updateForm').node_path.value = this.selected.id;

            },
            onReplace: function(from,to,where){
                var myXHR = new XHR({
                    method: 'post',
                    onSuccess: function(new_path) {
                        from.id = new_path;

                    },
                    headers: {'Content-type': 'application/x-www-form-urlencoded; charset=utf-8'}
                    }).send('/catalogue/move/', 'item='+from.id+'&amp;amp;to_item='+to.id+'&amp;amp;move_type='+where);

                //alert([from.id,to.id,where])
            },
        nodeOptions: {
            text: 'Catalogue',
            open: true
        }
        });</pre>
</pre>
<p>L&#8217;évènement onReplace est un événement ajouté par moro sur le <a href="http://forum.mootools.net/viewtopic.php?pid=23580" target="_blank">forum mootools</a> il permet de gérer les déplacement d&#8217;items. Donc en cas d&#8217;événement de déplacement d&#8217;item, on lance cette fonction qui va réaliser un appel AJAX vers le serveur sur l&#8217;url /catalogue/move avec les bons paramètres.<br />
En cas de retour ok, on met à jour l&#8217;id de l&#8217;élément du tree. (dans mootree, j&#8217;ai mappé l&#8217;id sur le &#8216;path&#8217; du modèle de donnée python).<br />
Avec cette seule fonction, on a déjà géré le déplacement d&#8217;items au sein de l&#8217;arbre (merci à mootree et à moro..)</p>
<p>le onSelect permet de faire des action lorsqu&#8217;on sélectionne un élément de l&#8217;arbre, cela sert ici à renseigner le champ &#8216;nom de l&#8217;arbre&#8217; du formulaire de modification (c&#8217;est plus pratique et cela évite de le retaper).</p>
<p>Une fois le mootree initialisé, il faut le remplir, cela se fait avec la fonction &#8216;load&#8217; :</p>
<pre>
<pre class="brush: jscript;">tree.root.load('/catalogue/xml/')</pre>
</pre>
<p>N&#8217;ayant founi aucun paramètre à /catalogue/xml/, nous chargeons l&#8217;arbre en entier comme nous l&#8217;avons vu tout à l&#8217;heure.</p>
<p>Ensuite il faut gérer les différentes actions des formulaires.</p>
<span id="Commenons_par_le_formulaire_d8217insertion_:"><h3>Commençons par le formulaire d&#8217;insertion :</h3></span>
<pre>
<pre class="brush: jscript;">    $('insertForm').addEvent('submit', function(e) {
        // Prevent the submit event
        new Event(e).stop();

        // récupère l'item actuellement sélectionné
        if (tree.selected != null) {
            this.to_item.value = tree.selected.id;

            this.send({
                //update: log,
                onComplete: function(path_inserted) {
                    //log.removeClass('ajax-loading');
                    //alert(text);

                    if ($('insertForm').insert_type.value=='before') {
                        node = tree.selected.parent.insert({text:$('insertForm').node_name.value, id:path_inserted});
                        node.injectBefore(tree.selected);
                    }
                    if ($('insertForm').insert_type.value=='after') {
                        node = tree.selected.parent.insert({text:$('insertForm').node_name.value, id:path_inserted});
                        node.injectAfter(tree.selected);
                    }
                    if ($('insertForm').insert_type.value=='inside') {
                        node = tree.selected.insert({text:$('insertForm').node_name.value, id:path_inserted});
                    }
                }
            });
        }
    });</pre>
</pre>
<p>la fonction mootols <em>$(&#8216;insertForm&#8217;).addEvent </em>permet d&#8217;ajouter un gestionnaire d&#8217;évenement sur le formulaire (ici sur l&#8217;évènement &#8217;submit&#8217;). Donc a chaque fois que le formulaire sera validé, l&#8217;événement se déclenchera.<br />
La variable &#8216;this&#8217; au sein de cette fonction représente donc le formulaire.</p>
<p>Pour réaliser une insertion, il faut avoir sélectionné un élément de l&#8217;arbre.<br />
On le récupère en javascript via <em>tree.selected</em></p>
<p>ensuite le this.send est un raccouci mootools qui déclenche l&#8217;envoi en AJAX du formulaire vers l&#8217;url et en utilisant la méthode définie dans le formulaire (dans le code html du formulaire que l&#8217;on a vu plus haut).</p>
<p>Au retour, on déclenche l&#8217;événement &#8216;onComplete&#8217;.<br />
Dans cette fonction, on va ajouter l&#8217;élément à l&#8217;arbre côté client (car à ce moment il est déjà ajouté côté serveur). L&#8217;insertion est différente en fonction des types d&#8217;insertion (before, after ou inside), mais le principe est le même : on utilise la méthode &#8216;insert&#8217; de mootree.</p>
<p>Ensuite le formulaire de suppression :</p>
<p>Il est construit sur le même principe que l&#8217;insertion</p>
<pre>
<pre class="brush: jscript;">    $('deleteForm').addEvent('submit', function(e) {
        new Event(e).stop();

        if (tree.selected != null) {
            this.node_path.value = tree.selected.id;
            this.send({
                onComplete: function(result) {
                    // On récupère le père (pour le rechargemetn de la partie du tree)
                    node_parent = tree.selected.parent;
                    // Ici effacer le node du tree
                    tree.selected.remove();
                    // reload du tree
                    // TODO: faire en sorte de ne reloader que à partir du père (nécessite aussi de changer le code serveur)
                    node_parent.load('/catalogue/xml/?node_path='+node_parent.id);
                    //tree.root.load('/catalogue/xml/');
                }
            });
        }

    });</pre>
</pre>
<p>Au retour de l&#8217;appel Ajax, une fois l&#8217;élément supprimé côté serveur, on le supprime dans l&#8217;arbre mootree.<br />
Ensuite on déclenche un reload du sous arbre en partant du père de l&#8217;élément sélectionné : ceci est fait parceque la méthode remove() de mootree, contrairement à ce qu&#8217;on a choisit de faire côté serveur supprime tous les enfants avec. Donc il faut recharger cette partie de l&#8217;arbre.</p>
<span id="Ensuite_le_formulaire_de_mise__jour_:"><h3>Ensuite le formulaire de mise à jour :</h3></span>
<pre>
<pre class="brush: jscript;">    $('updateForm').addEvent('submit', function(e) {
        new Event(e).stop();

        if (tree.selected != null) {
            //this.node_path.value = tree.selected.id;
            this.send({
                onComplete: function(result) {
                    // On récupère le père (pour le rechargemetn de la partie du tree)
                    if (result != 'NOK') {
                        tree.selected.text=result;
                        tree.selected.update();
                    } else {
                        node_parent = tree.selected.parent;
                        node_parent.load('/catalogue/xml/?node_path='+node_parent.id);
                    }
                }
            });
        }
    });</pre>
</pre>
<p>Ici il y a un petit truc qui fait echo au côté serveur : nous avons vu précedemment que la fonction côté serveur renvoyait le nouveau nom en cas de réussite et &laquo;&nbsp;NOK&nbsp;&raquo; en cas d&#8217;échec. Donc ici, si la valeur retournée est différente de &laquo;&nbsp;NOK&nbsp;&raquo;, on met à jour le noeud mootree avec cette valeur, mais si le retour est &laquo;&nbsp;NOK&nbsp;&raquo;, nous ne sommes pas certain si c&#8217;était une erreur ou si l&#8217;utilisateur voulait vraiment renommer son noeud en &laquo;&nbsp;NOK&nbsp;&raquo;, donc on recharge cette partie de l&#8217;arbre depuis le serveur, car c&#8217;est toujours le serveur qui a raison.<br />
On voit ici les limites de ne renvoyer qu&#8217;une seule valeur à l&#8217;appel AJAX (qui d&#8217;ailleurs est un nom abusif dans ce cas <img src='http://www.chiroux.com/wp-includes/images/smilies/icon_smile.gif' alt=':-)' class='wp-smiley' /> ). Dans une version plus évolué de ce programme, il faudra passer à un retour JSON ou XML et bien gérer tous les cas d&#8217;erreurs côté client.</p>
<span id="Enfin_le_formulaire_de_rechargement_:"><h3>Enfin le formulaire de rechargement :</h3></span>
<p>Le principe est simple : on recharge la partie de l&#8217;arbre qui est sous l&#8217;élément sélectionné :</p>
<pre>
<pre class="brush: jscript;">    $('reloadForm').addEvent('submit', function(e) {
        new Event(e).stop();

        if (tree.selected != null) {
            node = tree.selected;
            node.load('/catalogue/xml/?node_path='+node.id);
        }

    });</pre>
</pre>
<span id="Telechargement_et_Live_Dmo"><h1><a name="Telechargement"></a>Telechargement et Live Démo</h1></span>
<p>Le serveur de chiroux.com n&#8217;est pas -encore- compatible python / Django, donc pour héberger la démo j&#8217;ai choisi de le mettre sur alwaysdata suite aux conseils de <a href="http://jehaisleprintemps.net/detail.php?id=1595&amp;lang=fr" target="_blank">jehaisleprintemps</a>.</p>
<p><span style="font-size: medium;">Vous pouvez donc <a href="http://thomas_chiroux.alwaysdata.net/catalogue/" class="broken_link"  target="_blank">trouver la démo ici</a>. Amusez vous bien.</span></p>
<p>L&#8217;admin est également disponible <a href="http://thomas_chiroux.alwaysdata.net/admin/" class="broken_link"  target="_blank">en suivant ce lien</a>. Le login et pass sont : admin/admin</p>
<p>Vous pouvez télécharger l&#8217;archive d&#8217;un site django complet qui inclu cette seule application &#8216;catalogue&#8217; ci-dessous (archive extraite du site de démo) :</p>
Note: There is a file embedded within this post, please visit this post to download the file.
]]></content:encoded>
			<wfw:commentRss>http://www.chiroux.com/django-une-arborescence-de-catalogue/feed/</wfw:commentRss>
		<slash:comments>6</slash:comments>
		</item>
	</channel>
</rss>
