modules/erl/euphorik_protocole.erl

   1 % coding: utf-8
   2 % Ce module gére les différents message envoyé par le client (javascript)
   3 % Par exemple le client peut demander les derniers messages du minichat.
   4 % Les messages sont au format XML, la plus part des fonctions accepte un xmlDocument() et renvoie un string()
   5 % qui est la réponse XML.
   6 % Example XML : http://www.erlang.org/doc/apps/xmerl/xmerl_ug.html
   7 % Auteur : G.Burri
   8 % Date : 29.10.2007
   9
  10 -module(euphorik_protocole).
  11 -export([
  12    generation_captcha/1,
  13    nouveau_user_captcha/1,
  14    nouveau_user_login/1,
  15    login/1,
  16    logout/1,
  17    profile/1,
  18    refreshMessage/1,
  19    message/1
  20 ]).
  21 -include_lib("xmerl/include/xmerl.hrl").
  22 -include("../include/euphorik_bd.hrl").
  23 -include("../include/euphorik_defines.hrl").
  24 %-compile(export_all).
  25
  26
  27 % Génère un nouveau captchat dans ?DOSSIER_CAPTCHA
  28 generation_captcha(_) ->
  29    {Mot_crypt, Nom_fichier} = captcha:create(5, ?DOSSIER_CAPTCHA),
  30    simple_xml_to_string(xml_reponse_generation_captcha(?DOSSIER_CAPTCHA_RELATIF "/" ++ Nom_fichier, Mot_crypt)).
  31
  32
  33 % Un nouvel utilisateur doit être créé
  34 % Action est un xmlElement()
  35 nouveau_user_captcha(Action) ->
  36    simple_xml_to_string(
  37       case {xmerl_xpath:string("captchaCrypt", Action), xmerl_xpath:string("captchaInput", Action)} of
  38          {[#xmlElement{content = [#xmlText{value = C1}]}], [#xmlElement{content = [#xmlText{value = C2}]}]} ->
  39             C2_crypt = common:crypt(C2),
  40             if C1 =:= C2_crypt ->
  41                   Cookie = generer_cookie(),
  42                   User = minichat:nouveau_user("Paul", Cookie),
  43                   xml_reponse_login_ok(User);
  44                true ->
  45                   xml_reponse_login_pas_ok("Captcha incorrect")
  46             end;
  47          _ ->
  48             xml_reponse_login_pas_ok("XML malformé")
  49       end
  50    ).
  51
  52 nouveau_user_login(Action) ->
  53    {Login, Password, Login_deja_pris} = case {xmerl_xpath:string("login", Action), xmerl_xpath:string("password", Action)} of
  54       {[#xmlElement{content = [#xmlText{value = L}]}], [#xmlElement{content = [#xmlText{value = P}]}]} ->
  55          {L, P, case minichat:get_user_by_login(L) of {ok, _} -> true; _ -> false end};
  56       _ -> {[], [], false}
  57    end,
  58    simple_xml_to_string(
  59       if Login_deja_pris->
  60             xml_reponse_login_pas_ok("Login déjà pris");
  61          true ->
  62             Cookie = generer_cookie(),
  63             User = minichat:nouveau_user(Login, Password, Cookie),
  64             xml_reponse_login_ok(User)
  65       end
  66    ).
  67
  68
  69 % Un utilisateur se logge
  70 login(Action) ->
  71    case xmerl_xpath:string("cookie", Action) of
  72       [#xmlElement{content = [#xmlText{value = Cookie}]}] ->
  73          loginUser(minichat:get_user_by_cookie(Cookie));
  74       _ ->
  75          case {xmerl_xpath:string("login", Action), xmerl_xpath:string("password", Action)} of
  76             {[#xmlElement{content = [#xmlText{value = Login}]}], [#xmlElement{content = [#xmlText{value = Password}]}]} ->
  77                loginUser(minichat:get_user_by_login_password(Login, Password));
  78          _ ->
  79             simple_xml_to_string(xml_reponse_login_pas_ok("XML malformé"))
  80          end
  81    end.
  82 loginUser({ok, User}) ->
  83    minichat:update_date_derniere_connexion(User#user.id),
  84    simple_xml_to_string(xml_reponse_login_ok(User));
  85 loginUser(_) ->
  86    simple_xml_to_string(xml_reponse_login_pas_ok("Erreur de login")).
  87
  88
  89 % Renvoie un string() représentant un cookie en base 36. Il y a 10^32 possibillités.
  90 generer_cookie() ->
  91    {A1,A2,A3} = now(),
  92    random:seed(A1, A2, A3),
  93    erlang:integer_to_list(random:uniform(math:pow(10, 32)), 36).
  94
  95
  96 % Un utilisateur se délogge.
  97 logout(_) ->
  98    do_nothing.
  99
 100
 101 % Modification du profile.
 102 profile(Action) ->
 103    simple_xml_to_string(
 104       case xmerl_xpath:string("cookie", Action) of
 105          [#xmlElement{content = [#xmlText{value = Cookie}]}] ->
 106             Login = case xmerl_xpath:string("login", Action) of [#xmlElement{content = [#xmlText{value = L}]}] -> L; _ -> undefined end,
 107             Password = case xmerl_xpath:string("password", Action) of [#xmlElement{content = [#xmlText{value = P}]}] -> P; _ -> undefined end,
 108             Pseudo = case xmerl_xpath:string("pseudo", Action) of [#xmlElement{content = [#xmlText{value = P2}]}] -> P2; _ -> Login end,
 109             Email = case xmerl_xpath:string("email", Action) of [#xmlElement{content = [#xmlText{value = E}]}] -> E; _ -> undefined end,
 110             Css = case xmerl_xpath:string("css", Action) of [#xmlElement{content = [#xmlText{value = C}]}] -> C; _ -> undefined end,
 111             case minichat:set_profile(Cookie, Login, Password, Pseudo, Email, Css) of
 112                ok ->
 113                   xml_reponse_profile_ok();
 114                login_deja_pris ->
 115                   xml_reponse_profile_pas_ok("Login déjà pris");
 116                _ ->
 117                   xml_reponse_profile_pas_ok("Impossible de mettre à jour le profile")
 118             end;
 119          _ ->
 120             xml_reponse_profile_pas_ok("XML malformé")
 121       end
 122    ).
 123
 124
 125 % Renvoie les messages appropriés.
 126 refreshMessage(Action) ->
 127    simple_xml_to_string(
 128       case {
 129          xmerl_xpath:string("nombreMessage", Action), % le nombre de message qu'affiche le client
 130          xmerl_xpath:string("page", Action) % la page désiré, la première (les derniers messages) étant la 1
 131          } of
 132          {
 133             [#xmlElement{content = [#xmlText{value = Nb_message_str}]}],
 134             [#xmlElement{content = [#xmlText{value = Page_str}]}]
 135          } ->
 136             Nb_message = list_to_integer(Nb_message_str),
 137             Page = list_to_integer(Page_str),
 138             Dernier_id = case xmerl_xpath:string("dernierMessageId", Action) of % l'id du dernier message que connait le client
 139                [#xmlElement{content = [#xmlText{value = D}]}] -> erlang:list_to_integer(D, 36);
 140                _ -> 0
 141             end,
 142             User = case xmerl_xpath:string("cookie", Action) of
 143                [#xmlElement{content = [#xmlText{value = Cookie}]}] ->
 144                   case minichat:get_user_by_cookie(Cookie) of
 145                      {ok, U} -> U;
 146                      _ -> inconnu
 147                   end;
 148                _ -> inconnu
 149             end,
 150             % accrochez-vous ca va siouxer ;)
 151             Mess = lists:map(
 152                fun(Mess) ->
 153                   Est_proprietaire = User =/= inconnu andalso User#user.id =:= Mess#minichat.auteur_id,
 154                   A_repondu_a_message = User =/= inconnu andalso minichat:a_repondu_a_message(User#user.id, Mess#minichat.id),
 155                   Est_une_reponse_a_user = User =/= inconnu andalso minichat:est_une_reponse_a_user(User#user.id, Mess#minichat.id),
 156                   User_mess = if Mess#minichat.auteur_id =:= 0 -> inconnu; true ->
 157                      {ok, U2} = minichat:get_user_by_id(Mess#minichat.auteur_id),
 158                      U2
 159                   end,
 160                   {message, [{id, erlang:integer_to_list(Mess#minichat.id, 36)}],
 161                      [
 162                         {date, [], [format_date(Mess#minichat.date)]},
 163                         {systeme, [], [atom_to_list(Mess#minichat.auteur_id =:= 0)]},
 164                         {proprietaire, [], [atom_to_list(Est_proprietaire)]},
 165                         {repondu, [], [atom_to_list(A_repondu_a_message)]},
 166                         {reponse, [], [atom_to_list(Est_une_reponse_a_user)]},
 167                         {pseudo, [], [Mess#minichat.pseudo]},
 168                         {login, [], [if User_mess =:= inconnu -> Mess#minichat.pseudo; true -> User_mess#user.login end]},
 169                         {contenu, [], [Mess#minichat.contenu]},
 170                         {repondA, [], xml_repond_a(Mess#minichat.id)}
 171                      ]
 172                   }
 173                end,
 174                get_dernieres_messages(Dernier_id, Nb_message, Page)
 175             ),
 176             [{reponse, [{name, "refreshMessages"}],
 177                % la fonction get_nb_page DOIT être évalué après get_dernieres_messages (merci les effets de bord)
 178                [{nbPage, [], [integer_to_list(minichat:get_nb_page(Nb_message))]} | Mess]
 179             }];
 180          _ ->
 181             [{reponse, [{name, "refreshMessages"}], [{erreur, [], ["erreur"]}]}]
 182       end
 183    ).
 184
 185
 186 % Renvoie les dernies messages, s'il n'y en a pas on effectue une attente.
 187 get_dernieres_messages(Dernier_id, Nb_message, Page) ->
 188    Messages = minichat:messages(Dernier_id, Nb_message, Page),
 189    if Messages =:= [] ->
 190          minichat:attends_nouveau_messages(),
 191          minichat:messages(Dernier_id,  Nb_message, Page);
 192       true ->
 193          Messages
 194    end.
 195
 196 % Prend une liste de xml text node et en resort un string()
 197 % xmerl : "test &amp; test" devient deux fragments de texte : "test " et "& test", il faut donc rassembler les morceaux...
 198 defragmenter(Text_nodes) ->
 199    lists:foldl(fun(Node, Acc) -> #xmlText{value = V} = Node, Acc ++ V end, [], Text_nodes).
 200
 201
 202 % Un utilisateur envoie un message
 203 message(Action) ->
 204    simple_xml_to_string(
 205       case {
 206             xmerl_xpath:string("cookie", Action),
 207             xmerl_xpath:string("pseudo", Action),
 208             xmerl_xpath:string("contenu", Action)
 209          } of
 210          {
 211             [#xmlElement{content = [#xmlText{value = Cookie}]}],
 212             [#xmlElement{content = Pseudo_fragments}],
 213             [#xmlElement{content = Contenu_fragments}]
 214          } ->
 215             case minichat:get_user_by_cookie(Cookie) of
 216                {ok, U} ->
 217                   Pseudo = defragmenter(Pseudo_fragments),
 218                   Contenu = defragmenter(Contenu_fragments),
 219                   % met à jour le pseudo du user
 220                   minichat:update_pseudo_user(U#user.id, Pseudo),
 221                   Reponses = case xmerl_xpath:string("reponses", Action) of
 222                      [#xmlElement{content = C}] ->
 223                         lists:map(
 224                            fun (Reponse) ->
 225                               #xmlElement{attributes = [#xmlAttribute{name = id, value = Id_reponse}]} = Reponse,
 226                               erlang:list_to_integer(Id_reponse, 36)
 227                            end
 228                         , C);
 229                      _ -> []
 230                   end,
 231                   Contenu_strip = string:strip(Contenu),
 232                   if Contenu_strip =:= [] -> xml_reponse_message(pas_ok);
 233                      true ->
 234                         case minichat:nouveau_message(Contenu, U#user.id, Reponses) of
 235                            erreur -> xml_reponse_message(pas_ok);
 236                         _ -> xml_reponse_message(ok)
 237                         end
 238                   end;
 239                _ -> xml_reponse_message(pas_ok)
 240             end;
 241          _ ->
 242             xml_reponse_message(pas_ok)
 243       end
 244    ).
 245
 246
 247 % Formatage d'une heure
 248 % local_time() -> string
 249 format_date(Date) ->
 250    DateLocal = calendar:now_to_local_time(Date),
 251    DateNowLocal = calendar:local_time(),
 252    {{Annee, Mois, Jour}, {Heure, Minute, Seconde}} = DateLocal,
 253    {{AnneeNow, _, _}, {_, _, _}} = DateNowLocal,
 254    Hier = calendar:date_to_gregorian_days(element(1, DateLocal)) =:=  calendar:date_to_gregorian_days(element(1, DateNowLocal)) - 1,
 255    if element(1, DateLocal) =:= element(1, DateNowLocal) ->
 256       "";
 257       Hier ->
 258          "Hier ";
 259       Annee =:= AnneeNow ->
 260          io_lib:format("~2.10.0B/~2.10.0B ", [Jour, Mois]);
 261       true ->
 262          io_lib:format("~2.10.0B/~2.10.0B/~B ", [Jour, Mois, Annee])
 263    end ++
 264    io_lib:format("~2.10.0B:~2.10.0B:~2.10.0B", [Heure, Minute, Seconde]).
 265
 266
 267 %%%%%%%%% <Réponses XML> %%%%%%%%%
 268 simple_xml_to_string(XML) ->
 269     lists:flatten(xmerl:export_simple(XML, xmerl_xml, [{prolog, ["<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n"]}])).
 270
 271
 272 % Construit une réponse positive à un login
 273 % si Enregistre vaut true alors cela veut dire que la personne s'est enregistré (elle possède au moins un login et un password)
 274 xml_reponse_login_ok(User) ->
 275    [{reponse, [{name, "login"}],
 276       [
 277          {statut, [if (User#user.password =/= []) and (User#user.login =/= []) -> "enregistre"; true -> "identifie" end]},
 278          {cookie, [User#user.cookie]},
 279          {id, [erlang:integer_to_list(User#user.id, 36)]},
 280          {pseudo, [User#user.pseudo]},
 281          {login, [User#user.login]},
 282          {email, [User#user.email]},
 283          {css, [User#user.css]}
 284       ]
 285    }].
 286
 287
 288 % Construit un réponse négative à un login
 289 xml_reponse_login_pas_ok(Message) ->
 290    [{reponse, [{name, "login"}],
 291       [
 292          {statut, ["erreur"]},
 293          {information, [Message]}
 294       ]
 295    }].
 296
 297
 298 xml_reponse_profile_ok() ->
 299    [{reponse, [{name, "profile"}],
 300       [
 301          {statut, ["ok"]}
 302       ]
 303    }].
 304
 305
 306 xml_reponse_profile_pas_ok(Message) ->
 307    [{reponse, [{name, "profile"}],
 308       [
 309          {statut, ["pas ok"]},
 310          {information, [Message]}
 311       ]
 312    }].
 313
 314
 315 % Pas utilisé
 316 %~ xml_conversation(Mess_id, Nb) ->
 317    %~ {Mess_id, Conversation} = minichat:conversation(Mess_id, Nb),
 318    %~ xml_conversation(Conversation).
 319 %~ xml_conversation([]) -> [];
 320 %~ xml_conversation(Liste_id) ->
 321    %~ lists:map(
 322       %~ fun({Id, Sous_liste}) ->
 323          %~ {id, [{id, erlang:integer_to_list(Id, 36)}], xml_conversation(Sous_liste)}
 324       %~ end,
 325       %~ Liste_id
 326    %~ ).
 327
 328
 329 % Renvoie un element XML representant une liste de messages auquel le message M_id repond
 330 xml_repond_a(Mess_id) ->
 331    lists:map(
 332       fun(M) ->
 333          {ok, User} = minichat:get_user_by_id(M#minichat.auteur_id),
 334          {id, [{id, erlang:integer_to_list(M#minichat.id, 36)}, {pseudo, M#minichat.pseudo}, {login, User#user.login}], []}
 335       end,
 336       minichat:repond_a(Mess_id)
 337    ).
 338
 339
 340 xml_reponse_message(Ok) ->
 341    [
 342       {reponse, [{name, "message"}],
 343          [
 344             {statut, [], [case Ok of ok -> "ok"; pas_ok -> "pas ok" end]}
 345          ]
 346       }
 347    ].
 348
 349 xml_reponse_generation_captcha(Chemin, Captcha) ->
 350    [
 351       {reponse, [{name, "generationCaptcha"}],
 352          [
 353             {chemin, [], [Chemin]},
 354             {captchaCrypt, [], [Captcha]}
 355          ]
 356       }
 357    ].
 358 %%%%%%%%% </réponses XML> %%%%%%%%%
 359
 360
 361
 362