MOD cleanage de code

[euphorik.git] / modules / erl / euphorik_requests.erl

diff --git a/modules/erl/euphorik_requests.erl b/modules/erl/euphorik_requests.erl
index 8c46b7b..1cd460a 100755 (executable)
--- a/modules/erl/euphorik_requests.erl
+++ b/modules/erl/euphorik_requests.erl
@@ -16,14 +16,14 @@
 % 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
-% Ce module est fait pour répondre à des requêtes 'AJAX'.\r
-% Il est définit comme 'appmods' pour l'url "request" dans yaws.\r
+% Ce module est fait pour répondre à des requêtes JSON via 'AJAX'.\r
+% Il est définit comme 'appmods' pour l'url "request" dans Yaws.\r
 % Par exemple http://www.euphorik.ch/request abouti sur la fonction out/1 de ce module.\r
 % @author G.Burri\r
 \r
 \r
 -module(euphorik_requests).\r
--export([out/1, traiter_donnees/2]).\r
+-export([out/1]).\r
 -include_lib("yaws/include/yaws_api.hrl").\r
 -include("../include/euphorik_defines.hrl").\r
 \r
@@ -38,12 +38,13 @@ out(A) ->
    % keepalive -> true, evite que des firewalls coupe la connexion TCP sans prévenir\r
    inet:setopts(A#arg.clisock, [{active, true}, {keepalive, true}]),\r
    {value, {_, Contenu}} = lists:keysearch("action", 1, yaws_api:parse_post(A)),\r
-   Ret = traiter_donnees(Contenu, IP),\r
+   Ret = traiter_message(Contenu, IP),\r
    {content, "application/json", Ret}.\r
 \r
 \r
-% Décode les données JSON.\r
-traiter_donnees(Contenu, IP) ->\r
+% Décode le message JSON.\r
+traiter_message(Contenu, IP) ->\r
+   % extrait l'entête obligatoire des messages JSON\r
    {ok, {struct, [{header, {struct, [{action, Action}, {version, Version_client}]}} | Reste]}} = json:decode_string(Contenu),\r
    json:encode(\r
       if Version_client =:= ?VERSION_PROTOCOLE ->\r
@@ -56,40 +57,40 @@ traiter_donnees(Contenu, IP) ->
    ).\r
    \r
 \r
-% authentification d'un client\r
+% Authentification d'un client.\r
 traiter_action("authentification", JSON, IP) ->\r
    euphorik_protocole:login(JSON, IP);\r
-% un client s'enregistre : (pseudo + password) ou de manière anonyme\r
+% Un client s'enregistre : (pseudo + password) ou de manière anonyme.\r
 traiter_action("register", JSON, IP) ->\r
    euphorik_protocole:register(JSON, IP);\r
-% modification du profile\r
+% Modification du profile.\r
 traiter_action("set_profile", JSON, _) ->\r
    euphorik_protocole:profile(JSON);\r
-% un utilisateur attend un événement (par exemple l'arrivé d'un nouveau message)\r
+% Un utilisateur attend un événement (par exemple l'arrivée d'un nouveau message).\r
 traiter_action("wait_event", JSON, _) ->\r
    euphorik_protocole:wait_event(JSON);\r
-% un utilisateur envoie un message\r
+% Un utilisateur envoie un message.\r
 traiter_action("put_message", JSON, _) ->\r
    euphorik_protocole:put_message(JSON);\r
-% un ekMaster bannie un utilisateur (ip)\r
+% Un ekMaster bannie un utilisateur (ip).\r
 traiter_action("ban", JSON, _) ->\r
    euphorik_protocole:ban(JSON);\r
-% un ekMaster slap un utilisateur\r
+% Un ekMaster slap un utilisateur.\r
 traiter_action("slap", JSON, _) ->\r
    euphorik_protocole:slap(JSON);\r
-% un ekMaster envoie un nouveau troll\r
+% Un ekMaster envoie un nouveau troll.\r
 traiter_action("put_troll", JSON, _) ->\r
    euphorik_protocole:put_troll(JSON);\r
-% un ekMaster modifie un troll\r
+% Un ekMaster modifie un troll.\r
 traiter_action("mod_troll", JSON, _) ->\r
    euphorik_protocole:mod_troll(JSON);\r
-% un ekMaster supprime un troll\r
+% Un ekMaster supprime un troll.\r
 traiter_action("del_troll", JSON, _) ->\r
    euphorik_protocole:del_troll(JSON);\r
-% un ekMaster demande la liste des ips bannies\r
+% Un ekMaster demande la liste des ips bannies.\r
 traiter_action("list_banned_ips", JSON, _) ->\r
    euphorik_protocole:list_banned_ips(JSON);\r
-% un ekMaster débannie une ip\r
+% Un ekMaster débannie une ip.\r
 traiter_action("unban", JSON, _) ->\r
    euphorik_protocole:unban_ip(JSON).\r
  
\ No newline at end of file