TP6: étude d'une extension Firefox

Installation

Constituez-vous un environnement de développement en vous créant un profil firefox spécifique (cf TP 5).

Télécharger et décompresser l'extension de test feakeext Pour tester cette extension, copier le fichier nommé "fakeext @ isicil.inria.fr" qui se trouve dans l'archive, dans le dossier "extensions" de votre profil firefox de développement. Le nom de ce fichier correspond à l'identifiant de l'extension déclaré dans le fichier install.rdf:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:em="http://www.mozilla.org/2004/em-rdf#">
    <RDF:Description about="urn:mozilla:install-manifest">
        <em:aboutURL>chrome://fakeext/content/dialogs/about.xul</em:aboutURL>
        <em:creator>INRIA Sophia</em:creator>
        <em:description/>
        <em:homepageURL>http://isicil.inria.fr</em:homepageURL>
        <em:iconURL>chrome://fakeext/skin/logo/isicil.png</em:iconURL>
        <em:id>fakeext@isicil.inria.fr</em:id>
        <em:name>ISICIL Fake Extension</em:name>
        <em:version>0.1.0</em:version>
        <em:updateURL>https://isicil.inria.fr/updates</em:updateURL>
        <em:type>2</em:type>
        <em:targetApplication>
            <RDF:Description>
                <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
                <em:maxVersion>3.*.*</em:maxVersion>
                <em:minVersion>3.0</em:minVersion>
            </RDF:Description>
        </em:targetApplication>
    </RDF:Description>
</RDF>

Ouvrez ensuite ce fichier qui contient une seule ligne indiquant le chemin du dossier "src" de l'extension. Modifiez ce chemin pour pointer vers le bon dossier (par ex dans mon cas "D:\flimpens\web-pgm\workspace_cours\fakeext\src").

Redémarrez Firefox et allez voir le menu Outils/Modules complémentaires et vérifiez que l'extension ISICIL Fake Extension a bien été installée, elle doit apparaitre sous la forme d'une entrée dans le menu.

Etude de la structure

La structure de l'extension est la suivante:

• src

•  chrome.manifest

•  install.rdf

•  defaults/

•    preferences/

•      prefs.js

•   chrome/

•     fakeext/

•       content/

•         overlay.xul  
•         dialogs/   
•           about.xul    
•       locale/    
•        en-EN/      
•          locale.dtd    
•        fr-FR/      
•          locale.dtd

•       skin/    
•        global/     
•             logo/      
•            isicil.png

Obeservez tout d'abord le contenu du fichier install.rdf (cf ci-dessus) qui contient tous les détails liés à l'identification de l'extension.

Regardez maintenant le fichier chrome.manifest:

1. content fakeext         chrome/fakeext/content/

2. skin     fakeext global     chrome/fakeext/skin/global/

3. locale     fakeext fr-FR     chrome/fakeext/locale/fr-FR/

4. 

5. overlay    chrome://browser/content/browser.xul    chrome://fakeext/content/overlay.xul

C'est dans ce fichier que sont déclarées  les correspondances entre les adresses chrome:// et les dossiers de l'arborescences. Par exemple le fichier image isicil.png sera accessible à l'adresse : chrome://fakeext/skin/global/logo/isicil.png. A la ligne 5 est déclaré le fichier d'overlay qui sera utilisé pour insérer des éléments dans le navigateur. Ce mécanisme est spécifique aux extensions, en comparaison avec les applications XULRunner vues la séance précédente. Observez la correspondances des adresses et de l'emplacement du fichier overlay.xul. Un "overlay" est un "ajout" à la GUI de firefox.

Regardez maintenant le fichier overlay.xul:

1. <?xml version="1.0" encoding="UTF-8"?>

2. <!DOCTYPE overlay SYSTEM "chrome://fakeext/locale/locale.dtd">

3. <?xml-stylesheet href="chrome://fakeext/skin/skin.css" type="text/css"?>

4. <overlay xmlns="http://www.mozilla.org/keymaster/gat...re.is.only.xul">

5.     <menupopup id="menu_ToolsPopup">

6.         <menuitem id="fakeext-menuitem" label="&fakeext.title;"/>

7.     </menupopup>

8. </overlay>

 La ligne 2 donne l'adresse du fichier où sont déclarées les entités qui sont des variables accessibles avec la syntaxe "&mavariable;" comme par exemple &fakeext.title; utilisée à la ligne 6 pour donner une valeur au label du "menuitem". La ligne 5 montre comment  est inséré un élément dans le navigateur, c'est à dire en récupérant un élément déjà existant dans firefox (menupopup id="menu_ToolsPopup") puis en le "surchargeant" par des éléments additionels (menuitem id="fakeext-menuitem"). En utilisant le DOM inspector, retrouvez dans le dom du navigateur les éléments correspondants.

NOTE POUR LES EXERCICES : vous devez avoir installé les extensions firefox recommandées lors du TP précédent : 

• Extension Developper : https://addons.mozilla.org/fr/<wbr/>firefox/addon/7434?src=api
• DOM Inspector : https://addons.mozilla.org/fr/<wbr/>firefox/addon/6622  (Attention il semble souffrir de gros bugs sous windows depuis Firefox 3.6)
• Firebug ou LiveHTTPHeaders pour voir les requêtes HTTP

Lorsque vous modifierez un des fichiers de votre extension, au lieu de relancer à chaque fois firefox, utilisez l'option "reload all xul module" de l'extension Developper. Vous pouvez aussi faire apparaitre la barre d'outil de cette extension, ce qui donne un accès immédiat à cette fonctionnalité (dans le menu affichage/Barres d'outils)

Exercice: Ajouter une interaction ouvrant la fenêtre de dialogue:

1. retrouvez l'adresse chrome de la boite de dialogue about.xul, située dans les sources de l'extension;
2. ajoutez l'attribut "oncommand" au menuitem de l'extension. Cet attribut prend en valeur un appel à une fonction javascript. Déclarez une fonction qui ouvre la boîte de dialogue about.xul en vous aidant de la référence de la fonction window.openDialog (ref) (ne spécifiez que l'url et le nom de la boite de dialogue, la variable "features" peut être égale à "").

Exercice: Ajoutez un bouton à la fenêtre de dialogue qui ouvre une page dans un nouvel onglet du navigateur.

1.  ajoutez un boutton à la suite des éléments "description" situés dans la boite de dialogue en vous aidant de la référence de l'élément "button"
2. ajoutez une image à ce bouton (par exemple isicil.png)
3. ajoutez un attribut "value" auquel vous donnerez la valeur de l'url de la page à ouvrir (par exemple "http://isicil.inria.fr").
4. l'attribut "oncommand" permet d'exécuter une fonction lorsque le bouton est cliqué. Dans la valeur de cet attribut, déclarez l'appel à une fonction qui prend en paramètre la valeur de l'attribut "value" (hint: regardez les référence de getAttribute et notez que l'élément en question est l'élément courant)
5. Déclarez la fonction appelée. Cette fonction prend en paramètre une URL et charge dans un nouvel onglet cet URL. Aidez vous de cette référence vous expliquant comment récupérez un élément "gBrowser" qui correspond au navigateur principal de firefox. Ensuite utilisez la méthode loadOneTab de cet élément (ref).

Déploiement et test de l'extension

Téléchargez et décompressez l'archive boomtag. Cette extension consomme des web services du serveur de bookmarks étudiés dans le séance 1. Une version adaptée pour la création de bookmark et basée sur la version correspondante au TP 3 est disponible ici (la librairie dojo a été supprimée pour un gain de place, si vous souhaitez utilisez ces librairies vous pourrez les récupérez depuis l'archive du TP3). Récupérez l'archive et vérifiez que le server fonctionne bien. Le web service qui est appelé à l'ouverture de l'extension est le suivant: http://localhost:9998/bookmark/all.

Pour l'installation et le test, procédez comme pour fakeext : 

1. copier le fichier boomtag @ sophia.inria.fr dans le dossier extensions de votre profil
2. modifier le chemin pour qu'il pointe vers le dossier /path/to/Boomtag/srcExtension
3. relancez Firefox

Cette extension se compose d'une sidebar (sur la gauche) qui est ouverte par défaut au lancement et qui liste les bookmarks donnés par l'appel au web service. Le serveur de tags doit bien sûr avoir été lancé sur votre machine !!!! Vérifiez que tous les bookmarks sont bien listés d'abord en accédant depuis votre navigateur à cette adresse : http://localhost:9998/bookmark/all. Ensuite seulement, votre extension pourra les visualiser dans la side-bar.

Cette extension permet aussi d'enregistrer des bookmarks. Pour l'utiliser faites ALT+SHIFT+D. Une fenetre apparait contenant 3 champs dont certains sont déjà complétés. Le web service pour l'enregistrement des bookmarks nécessite d'être identifié au préalable via le formulaire à l'adresse http://localhost:9998/.

L'objectif maintenant est d'enrichir ce squelette d'extension avec des fonctionnalités de tagging, mais aussi (selon votre inspiration) avec des fonctions gérant l'identification, la recherche des bookmarks par tags, etc.

Etude des spécificités de boomtag

Nous allons maintenant regarder plus en détail le code source de cette extension.

L'éditeur de bookmarks: bmeditor.xul

L'élement XUL est ici de type "dialog" :

<dialog xmlns="http://www.mozilla.org/keymaster/gat...re.is.only.xul"
title="Boomtag Editor" orient="vertical" buttons="accept,cancel"
style="padding:0" minwidth="600px" minheight="300px"
ondialogaccept="return doOK();"
ondialogcancel="return doCancel();"
onload="bmeditor.init();">

Cette fenêtre est appelée par la combinaison ALT+SHIFT+D depuis un onglet du navigateur. La méthode bmeditor.init() déclarée dans le fichier bmeditor.js permet de récupérer des éléments de la page HTML chargé dans l'onglet:

init:function(){
        $("bmtitle").value = window.opener.gBrowser.contentDocument.title;
        $("bmurl").value = window.opener.gBrowser.contentDocument.URL;
        $("bmdescr").value = window.opener.gBrowser.contentWindow.getSelection();    
        $("bmtags").value = ""; // initialisation ajax
    },

Attention à la correspondance des ids des éléments XUL utilisées pour peupler les élements (seuls les tags ne sont pas peuplés) (Notez aussi qu'ici encore, il faut passer par window.opener afin d'accéder au "gBrowser" depuis une fenêtre de dialogue) :

<rows>
            <row align="center">
                <label value="Titre :" />
                <textbox id="bmtitle" flex="1" value=""/>
            </row>

Lorsque l'utilisateur clique sur le bouton OK, la fonction save est appelée depuis bmeditor.js

1. save:function(){

2.         var postdata = "title="+$("bmtitle").value

3.         + "&url="+$("bmurl").value

4.         + "&descr="+$("bmdescr").value

5.         + "&tags="+$("bmtags").value;

6.        

7.         var urlws="http://localhost:9998/bookmark/create";

8.         var contenttype="application/x-www-form-urlencoded";

9.         var async=false;

10.        

11.         var xhr=new XMLHttpRequest();

12.         xhr.open("POST",urlws,async);

13.         xhr.setRequestHeader("Content-Type",contenttype) ;

14.         xhr.send(postdata);

15.         var old_ds = window.opener.document.getElementById("bmtree").getAttribute("datasources");

16.         window.opener.document.getElementById("bmtree").setAttribute("datasources", "");

17.         window.opener.document.getElementById("bmtree").setAttribute("datasources", old_ds);

18.     },

Cette fonction effectue un appel AJAX vers le serveur de bookmark bmserv.

• Lignes 2-5 : préparation des données au format "POST".
• L7 : on déclare l'url appelée, l8 le type de contenu attendu en retour
• L9 déclare que l'appel se fera en mode synchrone, (pour plus de simplicité).
• l11-14 déclaration et envoie de l'appel.
• l15-17 : afin que les bookmarks listés dans le tableau de la sidebar soit raffraichi, on réactualise la valeur de l'attribut "datasources".

Observez maintenant la manière dont l'appel est traité côté serveur dans la classe BookmarkResource.java:

1. @POST

2.     @Path("/create")

3.     @Consumes("application/x-www-form-urlencoded")

4.     @Produces("text/html")

5.     public String create(@Context HttpServletRequest req, MultivaluedMap<String, String> formParams){

6.         HttpSession session= req.getSession(true);

7.         session.getAttributeNames();

8.         TemplateEngine.setSession(req.getSession());

9.         String userid = (String) session.getAttribute("userid");

10.         if (userid!=null) {

11.                 System.out.println(userid);

12.                 String urlstr = formParams.getFirst("url");

13.                 String title = formParams.getFirst("title");

14.                 String descr = formParams.getFirst("descr");

15.                 String tags = formParams.getFirst("tags");

16.                 String bmid = Server.bmh.createBookmark(title, urlstr, descr, userid);

17.                 String[]taglist = tags.split(" ");

18.                 for(String t:taglist){

19.                     Server.tgh.createTagging(userid, bmid, Server.th.createTag(t).getId());

20.                 }

21.         }else{

22.             System.out.println("Impossible de créer le bookmark, l'utilisateur n'est pas authentifié dans le système.");

23.         }

24.         return "<html><body><pre>"+formParams.toString()+"</pre></body></html>";

25.     }

Notez aussi comment est gérée l'identification de l'utilisateur, car celui-ci doit être logué pour pouvoir enregistrer un bookmark. Dans le script boomtag.js :

1. showBMEditor:function(pEvent){

2.         var xhr=new XMLHttpRequest();

3. 

4.         var urlws="http://localhost:9998/user/current";

5.         var async=false;

6.         xhr.open("GET",urlws,async);       

7.         xhr.send(null);

8.        

9.         if(xhr.responseText != "") {

10.             window.openDialog(this.bmeditor_url,'bmeditor','chrome,modal,resizable,centerscreen');

11.         }

12.         else gBrowser.loadOneTab("http://localhost:9998/form/login");

13.     },

La fonction showBMEditor vérifie que l'utilisateur est bien logué en faisant un appel AJAX au web service http://localhost:9998/user/current. Ce web service (cf UserResource.java dans le server BMServ) retourne le login de l'utilsateur si celui-ci est logué, ou la chaine de charactère vide sinon. La fonction (cote client) showBMEditor vérifie donc que la réponse ne soit pas égale à "", auquel cas l'utilisateur est redirigé vers la page d'authentification du web service; sinon, le dialogue de bmeditor est ouvert.