MOD avancement dans la Grande Restructuration
[euphorik.git] / js / pageEvent.js
diff --git a/js/pageEvent.js b/js/pageEvent.js
new file mode 100644 (file)
index 0000000..4e69e81
--- /dev/null
@@ -0,0 +1,121 @@
+// coding: utf-8\r
+// Copyright 2008 Grégory Burri\r
+//\r
+// This file is part of Euphorik.\r
+//\r
+// Euphorik is free software: you can redistribute it and/or modify\r
+// it under the terms of the GNU General Public License as published by\r
+// the Free Software Foundation, either version 3 of the License, or\r
+// (at your option) any later version.\r
+//\r
+// Euphorik is distributed in the hope that it will be useful,\r
+// but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+// GNU General Public License for more details.\r
+//\r
+// You should have received a copy of the GNU General Public License\r
+// along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.\r
+\r
+/*jslint laxbreak:true */\r
+\r
+/**\r
+   * Permet de gérer les événements (push serveur).\r
+   * Principe de fonctionnement :\r
+   *  - La page courante créer un objet euphorik.PageEvent en indiquant le nom de la page\r
+   *  - La page courante attend un événement en appelant 'waitEvent' et en donnant deux fonctions :\r
+   *    - 'funSend' une fonction qui renvoie les données à envoyer avant l'attente, par exemple {"dernierMess" : 23}\r
+   *       "header" et "page" seront ajoutés aux données\r
+   *    - 'funsReceive' un ensemble de fonctions à appeler en fonction du "reply" sur serveur\r
+   *\r
+   * l'information envoyé est sous la forme :\r
+   *  {\r
+   *     "header" : {"action" : "wait_event", "version" : <v> },\r
+   *     "page" : <page>\r
+   *     [..]\r
+   *  }\r
+   * l'information reçu est sous la forme :\r
+   *  {\r
+   *     "reply" : <reply>\r
+   *     [..]\r
+   *  }\r
+   * @page la page courante pour laquelle on écoute des événements (un string)\r
+   * @util le helper 'util'\r
+   */\r
+euphorik.PageEvent = function(page, util) {\r
+   this.page = page;\r
+   this.util = util;\r
+   \r
+   // l'objet JSONHttpRequest représentant la connexion d'attente\r
+   this.attenteCourante = undefined;\r
+   \r
+   // le multhreading du pauvre, merci javascript de m'offrire autant de primitives pour la gestion de la concurrence...\r
+   this.stop = false;\r
+};\r
+\r
+/**\r
+  * Arrête l'attente courante s'il y en a une.\r
+  */\r
+euphorik.PageEvent.prototype.stopAttenteCourante = function() {\r
+   this.stop = true;\r
+         \r
+   if (this.attenteCourante) {\r
+      this.attenteCourante.abort();\r
+   }\r
+};\r
+\r
+/**\r
+  * Attend un événement lié à la page. \r
+  * @funSend une fonction renvoyant les données json à envoyer\r
+  * @funsReceive est un objet comprenant les fonctions à appeler en fonction du "reply"\r
+  * les fonctions acceptent un paramètre correspondant au données reçues.\r
+  * exemple : {"new_message" : function(data){ ... }}\r
+  */\r
+euphorik.PageEvent.prototype.waitEvent = function(funSend, funsReceive) {\r
+   this.stopAttenteCourante();\r
+   \r
+   this.stop = false;\r
+   \r
+   var thisPageEvent = this;\r
+      \r
+   // on doit conserver l'ordre des valeurs de l'objet JSON (le serveur les veut dans l'ordre définit dans le protocole)\r
+   // TODO : ya pas mieux ?\r
+   var dataToSend = {\r
+      "header" : { "action" : "wait_event", "version" : euphorik.conf.versionProtocole },\r
+      "page" : this.page\r
+   };\r
+   var poulpe = funSend();\r
+   poulpe.each(function(k, v) {\r
+      dataToSend[k] = v;\r
+   });\r
+   \r
+   this.attenteCourante = jQuery.ajax({\r
+      type: "POST",\r
+      url: "request",\r
+      dataType: "json",\r
+      // TODO : doit disparaitre\r
+      timeout: 180000, // timeout de 3min. Gros HACK pas beau. FIXME problème décrit ici : http://groups.google.com/group/jquery-en/browse_thread/thread/8724e64af3333a76\r
+      data: this.util.jsonVersAction(dataToSend),\r
+      success:\r
+         function(data) {                        \r
+            funsReceive[data.reply](data);\r
+            \r
+            // rappel de la fonction dans 100 ms\r
+            setTimeout(function(){ thisPageEvent.waitEvent2(funSend, funsReceive); }, 100);\r
+         },\r
+      error:\r
+         function(XMLHttpRequest, textStatus, errorThrown) {\r
+            ;; console.log("Connexion perdue dans PageEvent.prototype.waitEvent()");\r
+            setTimeout(function(){ thisPageEvent.waitEvent2(funSend, funsReceive); }, 1000);\r
+         }\r
+   });\r
+};\r
+\r
+/**\r
+  * Si un stopAttenteCourante survient un peu n'importe quand il faut imédiatement arreter de boucler.\r
+  */\r
+euphorik.PageEvent.prototype.waitEvent2 = function(funSend, funsReceive) {\r
+   if (this.stop) {\r
+      return;\r
+   }\r
+   this.waitEvent(funSend, funsReceive);\r
+};
\ No newline at end of file