X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=modules%2Ferl%2Feuphorik_requests.erl;h=49cbe026132afa200c3b98e313c0382faf002045;hp=f49738287e3a49914b2c68c3447b02ad81875d88;hb=5d9992368bb386d2e606ae037c5478fe10ac70e8;hpb=7e5121be583a78ecd2cca8553717959d121df226

diff --git a/modules/erl/euphorik_requests.erl b/modules/erl/euphorik_requests.erl
index f497382..49cbe02 100755
--- a/modules/erl/euphorik_requests.erl
+++ b/modules/erl/euphorik_requests.erl
@@ -15,39 +15,41 @@
 %
 % You should have received a copy of the GNU General Public License
 % along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
-% 
-% Ce module est fait pour répondre à des requêtes 'AJAX'.
-% Il est définit comme 'appmods' pour l'url "request" dans yaws.
-% Par exemple http://www.euphorik.ch/request abouti sur la fonction out() de ce module.
-% @author G.Burri
+%
+% This module responds to JSON requests via 'AJAX'.
+% It's defined as an Yaws 'appmods' with the url '/request'.
+% For instance in debug mode 'http://localhost:8090/request' will call the out/1 function.
 
 
 -module(euphorik_requests).
--export([out/1, traiter_donnees/2]).
--include_lib("xmerl/include/xmerl.hrl").
--include_lib("yaws/include/yaws_api.hrl").
+-author("Greg Burri <greg.burri@gmail.com>").
+-export([out/1]).
+-include_lib("yaws_api.hrl").
 -include("../include/euphorik_defines.hrl").
 
 
+% Entry point for all AJAX requests on '/request'.
 out(A) ->
-   %io:format("~p~n", [A]), % utilisé parfois pendant le debug
    IP = case inet:peername(A#arg.clisock) of
-      {ok, {Adresse, _Port}} -> Adresse;
-      _ -> inconnue
+      {ok, {Address, _Port}} -> Address;
+      _ -> unknown
    end,
-   % passive -> active, permet de recevoir {tcp_closed, _} lorsque le socket se ferme
-   % keepalive -> true, evite que des firewalls coupe la connexion TCP sans prévenir
+   % active: to receive {tcp_closed, _} when the socket is closing.
+   % keepalive: avoid firewalls to cut the connection.
+
    inet:setopts(A#arg.clisock, [{active, true}, {keepalive, true}]),
    {value, {_, Contenu}} = lists:keysearch("action", 1, yaws_api:parse_post(A)),
-   Ret = traiter_donnees(Contenu, IP),
-   %io:format("~p~n", [Ret]),
+
+   Ret = traiter_message(Contenu, IP),
    {content, "application/json", Ret}.
 
 
-% Décode les données JSON.
-traiter_donnees(Contenu, IP) ->
-   {ok, {struct, [{header, {struct, [{action, Action}, {version, Version_client}]}} | Reste]}} = json:decode_string(Contenu),
-   json:encode(
+% Décode le message JSON.
+traiter_message(Contenu, IP) ->
+   % extrait l'entête obligatoire des messages JSON
+   {ok, {struct, [{"header", {struct, [{"action", Action}, {"version", Version_client}]}} | Reste]}} = json2:decode_string(Contenu),
+
+   json2:encode(
       if Version_client =:= ?VERSION_PROTOCOLE ->
             traiter_action(Action, Reste, IP);
          true ->
@@ -56,35 +58,32 @@ traiter_donnees(Contenu, IP) ->
             )))
       end
    ).
-   
 
-% authentification d'un client
+
+% Authentification d'un client.
 traiter_action("authentification", JSON, IP) ->
    euphorik_protocole:login(JSON, IP);
-% un client s'enregistre (pseudo + password)
+% Un client s'enregistre : (pseudo + password) ou de manière anonyme.
 traiter_action("register", JSON, IP) ->
    euphorik_protocole:register(JSON, IP);
-% modification du profile
+% Modification du profile.
 traiter_action("set_profile", JSON, _) ->
    euphorik_protocole:profile(JSON);
-% un utilisateur attend un événement (par exemple l'arrivé d'un nouveau message)
+% Un utilisateur attend un événement (par exemple l'arrivée d'un nouveau message).
 traiter_action("wait_event", JSON, _) ->
    euphorik_protocole:wait_event(JSON);
-% un utilisateur envoie un message
+% Un utilisateur envoie un message.
 traiter_action("put_message", JSON, _) ->
    euphorik_protocole:put_message(JSON);
+% Un ekMaster bannie un utilisateur (ip).
 traiter_action("ban", JSON, _) ->
    euphorik_protocole:ban(JSON);
+% Un ekMaster slap un utilisateur.
 traiter_action("slap", JSON, _) ->
    euphorik_protocole:slap(JSON);
-traiter_action("put_troll", JSON, _) ->
-   euphorik_protocole:put_troll(JSON);
-traiter_action("mod_troll", JSON, _) ->
-   euphorik_protocole:mod_troll(JSON);
-traiter_action("del_troll", JSON, _) ->
-   euphorik_protocole:del_troll(JSON);
+% Un ekMaster demande la liste des ips bannies.
 traiter_action("list_banned_ips", JSON, _) ->
    euphorik_protocole:list_banned_ips(JSON);
+% Un ekMaster débannie une ip.
 traiter_action("unban", JSON, _) ->
    euphorik_protocole:unban_ip(JSON).
- 
\ No newline at end of file