<?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; ajax</title>
	<atom:link href="http://www.chiroux.com/tag/ajax/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>
		<item>
		<title>Tutoriel pour un formulaire Ajax</title>
		<link>http://www.chiroux.com/tutoriel-pour-un-formulaire-ajax/</link>
		<comments>http://www.chiroux.com/tutoriel-pour-un-formulaire-ajax/#comments</comments>
		<pubDate>Tue, 23 May 2006 23:06:50 +0000</pubDate>
		<dc:creator>Thomas</dc:creator>
				<category><![CDATA[Obsolete]]></category>
		<category><![CDATA[Programmation]]></category>
		<category><![CDATA[ajax]]></category>
		<category><![CDATA[javascript]]></category>
		<category><![CDATA[prototype]]></category>
		<category><![CDATA[script.aculo.us]]></category>

		<guid isPermaLink="false">http://www.chiroux.com/article-1148425610.html</guid>
		<description><![CDATA[<p>Ayant eu le besoin de réaliser un formulaire, j&#8217;ai choisi de tester un peu la techno Ajax et d&#8217;en mesurer les avantages et inconvénients</p>
Introduction
<p>Vous trouverez ci-dessous un petit tutoriel pour installer et utiliser un système de formulaires web utilisant la technologie AJAX, très facile et rapide d&#8217;installation et de configuration une fois que vous en [...]]]></description>
			<content:encoded><![CDATA[<p>Ayant eu le besoin de réaliser un formulaire, j&#8217;ai choisi de tester un peu la techno Ajax et d&#8217;en mesurer les avantages et inconvénients<span id="more-34"></span></p>
<span id="Introduction"><h1>Introduction</h1></span>
<p>Vous trouverez ci-dessous un petit tutoriel pour installer et utiliser un système de formulaires web utilisant la technologie AJAX, très facile et rapide d&#8217;installation et de configuration une fois que vous en avez compris les principes.</p>
<p>Le cahier des charges que je me suis fixé était le suivant :</p>
<ul>
<li>faire un système de formulaire simple à implémenter</li>
<li>qu&#8217;il soit générique et ne nécessite quasiment pas de programmation pour implémenter un nouveau formulaire</li>
<li>que les validations soient réalisées au niveau serveur</li>
<li>que les informations de validation soient communiquées en temps réél au client</li>
<li>qu&#8217;il soit le plus sécurisé possible (notamment : impossibilité pour le client de passer outre les validations en modifiant les javascript par exemple)</li>
<li>en Php et Mysql</li>
<li>en séparant clairement fond et forme (xhtml 1.1)</li>
</ul>
<p>J&#8217;ai commencé par tout coder directement manuellement, puis à force d&#8217;améliorations, je me suis orienté vers des librairies plus génériques : <a href="http://www.prototypejs.org/" target="_blank">prototype </a>et <a href="http://script.aculo.us/" target="_blank">script.aculo.us</a>.</p>
<span id="Structure"><h1>Structure</h1></span>
<p>Le formulaire est très simple, il s&#8217;appuie sur :</p>
<ul>
<li>une table dans une base de donnée Mysql</li>
<li>une page php &#8216;backend&#8217; qui réalise les validations et les updates en base</li>
<li>une page php &#8216;frontend&#8217; qui affiche le formulaire</li>
</ul>
<p>ci-dessous le schéma général, y compris les includes.</p>
<p><img class="alignnone size-full wp-image-93" title="formulaire_schema" src="http://www.chiroux.com/wp-content/uploads/Import/Dev/formulaire_schema.jpg" alt="formulaire_schema" width="651" height="478" /></p>
<span id="Logique_gnrale"><h1>Logique générale</h1></span>
<p>Le principe est de surveiller un événement sur les champs du formulaire (par exemple, focus, blur, keyup) et sur cet évènement on déclenche un appel Ajax vers la page en back office. On transmet à cette page l&#8217;id de l&#8217;enregistrement, le nom du champ qui est en train d&#8217;être mis à jour et sa valeur. La page en backoffice effectue la validation et si cette validation est ok, on l&#8217;update en base. Elle renvoie une structure XML avec les informations des actions réalisées et les messages d&#8217;erreur si nécessaire.</p>
<p>L&#8217;ID de l&#8217;enregistrement à mettre à jour est généré au début de l&#8217;appel de la page &#8216;formulaire&#8217; et, afin de garder une persistence du formulaire non terminé, cet ID est stocké dans un cookie chez le client. Le cookie est effacé une fois le formulaire validé ou annulé (ainsi le client peut commencer à saisir un formulaire, fermer son navigateur, aller boire un café, partir en vacances.. et revenir le terminer quelques jours plus tard sans avoir perdu une seule information ; la seule contrainte de persistence est la durée de vie du cookie.</p>
<p>La page de backoffice effectue un traitement particulier lorsqu&#8217;elle reçoit l&#8217;ordre de validation complète du formulaire : elle repasse une validation de chaque champ, et vérifie également si tous les champs obligatoire sont présents. Si c&#8217;est ok, elle update en base, sinon renvoie une erreur.</p>
<span id="Un_peu_plus_de_technique"><h1>Un peu plus de technique</h1></span>
<p>Afin que le code html / php soit le plus propre possible, j&#8217;ai utilisé la fonction Event.observe de prototype afin de déclencher les observateurs d&#8217;évennements de mise à jour des champs du formulaire, ne vous étonnez donc pas de ne pas trouver de &#8216;onclick&#8217;, &#8216;onblur&#8217;, etc.. un peu partout dans le code, c&#8217;est normal, tout est géré dans le javascript init() dans formulaire.php. Ce script n&#8217;a pas besoin d&#8217;être paramétré lorsqu&#8217;on ajoute ou supprime des champs du formulaire : il scanne automatiquement tous les champs du formulaire et détermine les actions. Par défaut, les actions sont réalisées en keyup, c&#8217;est à dire que à chaque fois qu&#8217;on tape un caractère, on réalise l&#8217;appel AJAX. C&#8217;est peut-être un peu dangereux pour les performances de gros sites, vous pouvez alors par exemple remplacer les keyup par des blur.<br />
Selon les types de champs du formulaire, on appelle une fonction spécifique située dans formulaire_backoffice.js qui a pour objet de récupérer le nom du champ et sa valeur afin de déclencher l&#8217;appel AJAX.<br />
La fonction de call-back ajax interprête le XML de résultat et affiche l&#8217;erreur si nécessaire.</p>
<p>L&#8217;enregistrement en base est créé par le php la première fois qu&#8217;on appelle formulaire.php, ensuite, le cookie enregistré sur le poste client permet de garder le contexte.<br />
A chaque modification d&#8217;un champ, l&#8217;appel AJAX lance une mise à jour du champ qui est en train d&#8217;être modifié. Avant la mise à jour, le php appelé par l&#8217;appel XMLHttpRequest fait d&#8217;abord une validation. Les validations sont gérées à l&#8217;aide d&#8217;expressions régulières, c&#8217;est donc assez facile d&#8217;ajouter d&#8217;autres types de validations plus évoluées (la fonction est dans inc_validation.php). Si la validation est ok, alors on update ce champ en base.</p>
<p>Une conséquence importante de ce mode de fonctionnement est ce que j&#8217;appelle la fonctionnalité &#8216;big brother&#8217; : le formulaire enregistre tout : il suffit de venir au moins une fois sur le formulaire, commencer à le remplir. Même en ne le terminant jamais, il restera toujour un enregistrement en base reflétant ce formulaire à moitié rempli (toutefois, seuls les valeurs des champs qui passent la validation sont enregistrés en base).</p>
<p>L&#8217;appui sur &#8216;valider le formulaire&#8217; fait également un simple update en base sur ce même enregistrement et passe le champ &#8216;formulairevalide&#8217; à 1. Ainsi, on peut distinguer les formulaires terminés et validés (ils ont le champ &#8216;formulairevalide&#8217; à 1) et ceux jamais terminé (le champ est alors à zéro).</p>
<p>L&#8217;appui sur &#8216;annuler&#8217; efface simplement le cookie : l&#8217;utilisateur aura donc l&#8217;impression de repartir sur un formulaire vide, mais ce qui a été saisi dans le formulaire précédent est resté en base&#8230;</p>
<p>Pour les sites à fort taux de fréquentation, cette fonctionnalité peut éventuellement générer beaucoup d&#8217;enregistrements, il faudra peut-être prévoir une tache de &#8216;purge&#8217; des formulaires non validés dont la date de dernière modification est trop ancienne par exemple.</p>
<span id="Installation_et_Configuration"><h1>Installation et Configuration</h1></span>
<span id="Installation"><h2>Installation</h2></span>
<p>Téléchargez l&#8217;archive située en bas de cette page, dézippez cette archive dans un répertoire quelconque de votre site web (ex: http://www.monsite.com/formulaire/)</p>
<span id="Cration_de_la_base_de_donne"><h2>Création de la base de donnée</h2></span>
<p>Pour l&#8217;instant, vous allez juste créer la base et l&#8217;utilisateur qui a le droit d&#8217;y accéder.<br />
Si votre hébergeur ne vous laisse le droit qu&#8217;à une seule base, vous pouvez passer cette section, nous créeront la table plus tard.<br />
Sinon, créez une nouvelle base du nom de votre choix  (dans notre exemple : &#8216;formulaire&#8217;).<br />
Créez ensuite un utilisateur mysql avec, au minimum, les droits d&#8217;accès SELECT, INSERT, UPDATE sur la base (vous pouvez choisir si vous le souhaitez, plus tard, une fois la table créée, de limiter ces grants à uniquement la table du formulaire)</p>
<span id="Paramtrage_des_fichiers_de_configuration."><h2>Paramétrage des fichiers de configuration.</h2></span>
<p>Il y a deux fichiers de configuration : un pour le côté client et un pour le côté serveur.<br />
Commençont par le côté client :<br />
Editez le fichier &#8216;<strong><em>parameters.js</em></strong>&#8216; :</p>
<ul>
<li><strong>gs_Base_url</strong>: indiquez l&#8217;utl d&#8217;accès de votre formulaire (dans notre exemple : <em>http://www.monsite.com/formulaire/</em>) [<span style="color: #ff0000;"><strong>attention de ne pas oublier le slash (/) à la fin</strong></span>]</li>
<li><strong>gs_Redirect_url</strong>: indiquez l&#8217;url qui sera appelée à la fin de la validation de votre formulaire (dans notre exemple, on retourne à la home page : <em>http://www.monsite.com/</em></li>
<li><strong>gs_Cookie_name</strong>: indiquez le nom du cookie qui sera stocké sur le poste client (dans notre exemple : <em>formulaire</em>)</li>
<li><strong>gl_Cookie_time</strong>: on indique la durée de vie de ce cookie. Par défaut elle est de 30Jours après la date de création.</li>
</ul>
<p>Editez ensuite le fichier &#8216;<strong><em>inc_parameters.php</em></strong>&#8216; :</p>
<ul>
<li>dans <strong>$DBnombase</strong>, indiquez le nom de la base que l&#8217;on a créé tout à l&#8217;heure (ou le nom de la base donnée par votre hébergeur)</li>
<li>dans <strong>$DBnomtable</strong>, indiquez le nom de la table que l&#8217;on créera ensuite (dans notre exemple : t_formulaire)</li>
<li>dans les paramètres de mysql_connect, indiquez où se situe votre serveur (ici : localhost) et le login et password de connexion à la base (ici : login et password)</li>
<li>dans <strong>$gs_Cookie_name</strong> et <strong>$gl_Cookie_time</strong> indiquez <span style="text-decoration: underline;">exactement </span>les même valeurs que ce que vous avez paramétré dans parameters.js</li>
</ul>
<span id="Personnalisation_du_formulaire"><h2>Personnalisation du formulaire</h2></span>
<p>Il est temps maintenant de définir le contenu des champs du formulaire, pour cela, Editez le fichier &#8216;<strong><em>formulaire.php</em></strong>&#8216; :</p>
<span id="Paramtrage_gnraux_de_la_page"><h3>Paramétrage généraux de la page</h3></span>
<ul>
<li>Choisissez un titre à l&#8217;intérieur des tags &lt;title&gt;&lt;/title&gt; (dans le Head)</li>
<li>Dans le &lt;body&gt;
<ul>
<li>Laissez tel que le &lt;div id=&nbsp;&raquo;infobox&nbsp;&raquo;&gt;</li>
<li>Entez un titre dans les tags &lt;div&gt;&lt;/div&gt;</li>
<li>Mettez le texte que vous voulez devant le formulaire (en utilisant les classes de style &#8216;explication&#8217; et &#8216;question&#8217;)</li>
</ul>
</li>
</ul>
<span id="Le_formulaire"><h3>Le formulaire</h3></span>
<span id="Organisation_gnrale"><h4>Organisation générale</h4></span>
<p>Les éléments du formulaire sont organisés par groupe, un groupe est un ensemble de champs du formulaire à l&#8217;intérieur d&#8217;un &lt;fieldset&gt;<br />
Les fieldset sont des éléments de présentation, vous pouvez choisir de mettre tout le formulaire dans un seul fieldset ou à l&#8217;opposé de faire un fieldset par champ à remplir, c&#8217;est votre choix.<br />
Dans le formulaire par défaut, je montre quelques exemples différents.</p>
<p>Chaque fieldset doit avoir une légende qui est représentée par les tags &lt;legend&gt;&lt;/legend&gt;</p>
<p>la classe &laquo;&nbsp;noerreur&nbsp;&raquo; : chaque élément de formulaire (input, checkbox, radio, etc..) doit être encadré par un div de classe &laquo;&nbsp;noerreur&nbsp;&raquo;. Cette classe sera changée dynamiquement en classe &laquo;&nbsp;erreur&nbsp;&raquo; en cas de pb de validation de cet élément de formulaire.</p>
<span id="Principe_de_l8217organisation_des_champs_du_formulaire"><h4>Principe de l&#8217;organisation des champs du formulaire</h4></span>
<p><span style="color: #ff0000;"><strong>Ce principe est un des points les plus structurant de ce formulaire</strong></span>, revenons donc sur un des élements de mon cahier des charges : &laquo;&nbsp;impossibilité pour le client de passer outre les validations en modifiant les javascript&nbsp;&raquo;.</p>
<p>D&#8217;habitude, dans la plupart des formulaires classiques, on réalise une validation en javascript du côté du client (par exemple la vérification : est-ce qu&#8217;un email est bien un email). Bien sûr cette validation n&#8217;est pas suffisante, car il suffit d&#8217;interdire les javascripts pour passer outre la validation. Donc les formulaires un peu plus évolués (tous devraient le faire) doublent cette validation javascript par une validation côté serveur. Mais encore une fois, il faut bien passer les paramètres de validation au serveur. Pour un formulaire non AJAX, cela se fait par exemple dans les infos de POST. J&#8217;aurais pu également faire la même chose et simplement éviter le POST et  le rechargement de page en utilisant XMLHttpRequest. Mais rien n&#8217;empèche non plus une personne mal intentionnée de recopier le formulaire sur un poste local, d&#8217;en changer les paramètres et d&#8217;appeler le script serveur avec d&#8217;autres types de validation (changer une validation email en simple validation txt par exemple).</p>
<p>J&#8217;ai donc choisi de passer les paramètres de validation directement dans le nom des champs du formulaires. Et ce sont ces même noms qui structurent la table d&#8217;enregistrement de la base de donnée. Ainsi si une personne mal intentionnée cherche à changer une validation, elle doit changer le nom du champ et même si la validation passe, l&#8217;enregistrement en base de donnée ne passera pas.</p>
<p>Cette solution est plus sécurisante, mais elle a l&#8217;inconvénient de générer des noms de champs un peu compliqués et peut-être un peu compliqué à faire évoluer (dans le cas de nouveau types de validation par exemple qui nécessiteraient de nouveaux paramètres).</p>
<p>Les noms des champs ont donc une structure qu&#8217;il faut respecter, en voici les règles :</p>
<span id="Structure_du_nom_du_champ"><h4>Structure du nom du champ</h4></span>
<p>La Structure du champ est la suivante : <strong>ttt_x_y_z_mmm</strong></p>
<ol>
<li><em><strong>ttt </strong></em>: représente le type du champ, il peut prendre les valeurs suivantes :
<ul>
<li><strong>num </strong>: numérique entier</li>
<li><strong>real </strong>: numérique à virgules</li>
<li><strong>tel </strong>: téléphone (français)</li>
<li><strong>date </strong>: date de type JJ/MM/AAAA</li>
<li><strong>cp </strong>: code postal</li>
<li><strong>email </strong>: email</li>
<li><strong>txt </strong>: texte libre</li>
</ul>
</li>
<li><em><strong>x</strong></em> : prends deux valeurs possibles :
<ul>
<li><strong>m</strong> : mandatory (champ obligatoire)</li>
<li><strong>o</strong> : optionnal (champ optionnel)</li>
</ul>
</li>
<li><strong><em>y</em> </strong>: nombre de caractères minimum : valable uniquement pour les type de champs txt et email, mettre 0 dans les autres cas</li>
<li><em><strong>z</strong></em> : nombre de caractères maximum : valable uniquement pour les type de champs txt et email, mettre 0 dans les autres cas</li>
<li><em><strong>mmm </strong></em>: nom du champ</li>
</ol>
<p>exemples :</p>
<ul>
<li>txt_m_1_100_nom : nom est un champ texte obligatoire qui doit comporter entre 1 et 100 caractères</li>
<li>email_m_4_50_couriel : couriel est un champ de type email obligatoire qui doit comporter entre 4 et 50 caractères</li>
<li>num_o_0_0_quantite : quantite est un champ numérique entier optionnel</li>
<li>etc&#8230;</li>
</ul>
<span id="type_de_champ_et_type_de_formulaire"><h4>type de champ et type de formulaire</h4></span>
<p>Voici les associations que vous pouvez utiliser sans risque entre les types de champs du formulaire et les champs en html :</p>
<ul>
<li>input type = &laquo;&nbsp;text&nbsp;&raquo; : num | real | tel | date | cp | email | txt</li>
<li>textarea : num | real | tel | date | cp | email | txt</li>
<li>input type = &laquo;&nbsp;checkbox&nbsp;&raquo; :  num</li>
<li>input type = &laquo;&nbsp;radio&nbsp;&raquo; : num</li>
<li>select : num | txt (dans l&#8217;absolu, même si c&#8217;est moins logique : num | real | tel | date | cp | email | txt)</li>
</ul>
<p>Dans l&#8217;archive, vous trouverez un exemple de chaque cas d&#8217;input afin de vous permettre de copier/coller ce qui vous interesse.<br />
<span style="color: #ff0000;"><strong>Attention </strong></span>: il y a une petite subtilité avec les input radio : le champ &#8216;name&#8217; doit avoir la même valeur pour tout les inputs radio du même groupe (ainsi donc que l&#8217;appel de la fonction php &#8216;RecupereValeur&#8217; qui doit avoir ce même champ name comme paramètre). Par contre, les champs &#8216;id&#8217; doivent être uniques (même un numéro incrémental en plus du name par exemple), ceci afin de faire correspondre l&#8217;id de l&#8217;input et le label associé.</p>
<span id="Cration_de_la_table_dans_la_base_de_donne"><h2>Création de la table dans la base de donnée</h2></span>
<p>La table a quelques colonnes obligatoires :</p>
<ul>
<li>idformulaire : la clef principale de la table : un id incrémental</li>
<li>idsession : la valeur du cookie qui sert à garder la persistence du formulaire</li>
<li>datecreation : la date de la première insertion de l&#8217;enregistrement</li>
<li>datemodification : la date de dernière modification de l&#8217;enregistrement</li>
<li>adresseIP : l&#8217;adresseIP du poste client qui a inscrit le formulaire</li>
<li>formulairevalide : est-ce que le formulaire est validé par l&#8217;utilisateur (la valeur est a zéro tant que le formulaire n&#8217;est pas terminé)</li>
</ul>
<p>Les autres colonnes représentent exactement les noms des champs input de votre formulaire<br />
(ex : `txt_m_1_100_nom` varchar(100) NOT NULL default &nbsp;&raquo; qui correspond à l&#8217;imput &#8216;nom&#8217; de votre formulaire). <strong>Notez bien que le nom du champ doit être exactement le même que le paramètre &#8216;name&#8217; de l&#8217;inputField.</strong></p>
<p>Regardez le fichier table.sql dans l&#8217;archive d&#8217;exemple pour plus de détails.</p>
<span id="La_Forme"><h2>La Forme</h2></span>
<p>Toute la forme est gérée dans la feuille de style (style.css)<br />
L&#8217;objet de cet article n&#8217;est pas de faire un détail sur les feuilles de style : l&#8217;utilisation des styles pour ce formulaire est très simple. N&#8217;hésitez pas à aller faire un tour sur <a href="http://www.alsacreations.com/" target="_blank">Alsacréations </a>par exemple, un excellent site français qui vous apprendra un tas de choses très pratiques sur les css et sur bien d&#8217;autres choses.</p>
<span id="Conclusion__Reste__faire"><h1>Conclusion / Reste à faire</h1></span>
<p>J&#8217;espère que ce petit formulaire et ce tutoriel pourront vous aider dans vos projets. En tout cas, sentez vous libre de l&#8217;exploiter, le modifier, l&#8217;améliorer, le triturer. Si toutefois vous avez réalisé des améliorations, rencontré des bugs, souhaitez des améliorations, n&#8217;hésitez pas à m&#8217;en faire part en utilisant les commentaires ci-dessous.<br />
Ce formulaire est encore très incomplet et il reste pas mal de choses à faire si on voulait le rentre véritablement professionnel. Voici une petite todoList qui résume les points à améliorer :</p>
<ul>
<li>être tolérant aux browser qui n&#8217;ont pas XMLHttpRequest (revenir en mode post classique par exemple)</li>
<li>faire un système de validation multichamps (par exemple n checkbox doivent être coché parmi n)</li>
<li>faire évoluer les messages d&#8217;erreur :
<ul>
<li>afficher l&#8217;erreur de validation directement à côté du champ (paramètre optionnel par exemple)</li>
<li>afficher le faire que le champ est obligatoire ou non</li>
</ul>
</li>
<li>faire un système d&#8217;auto config (wizard ?) / d&#8217;install plus simplifié</li>
</ul>
<span id="Live_Demo"><h1>Live Demo</h1></span>
<p>J&#8217;ai mis en ligne le formulaire de démo situé dans l&#8217;archive, vous pourrez le retrouver <a href="http://www.chiroux.com/dev/formulaire/formulaire.php" target="_blank">en suivant ce lien</a>.</p>
<span id="Tlcharger_l8217archive"><h1>Télécharger l&#8217;archive</h1></span>
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/tutoriel-pour-un-formulaire-ajax/feed/</wfw:commentRss>
		<slash:comments>34</slash:comments>
		</item>
	</channel>
</rss>
