c15ada1f1910d03b855ef9bb8b2e5c5b628c89c2
[euphorik.git] / modules / erl / euphorik_protocole.erl
1 % coding: utf-8
2 % Copyright 2008 Grégory Burri
3 %
4 % This file is part of Euphorik.
5 %
6 % Euphorik is free software: you can redistribute it and/or modify
7 % it under the terms of the GNU General Public License as published by
8 % the Free Software Foundation, either version 3 of the License, or
9 % (at your option) any later version.
10 %
11 % Euphorik is distributed in the hope that it will be useful,
12 % but WITHOUT ANY WARRANTY; without even the implied warranty of
13 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 % GNU General Public License for more details.
15 %
16 % You should have received a copy of the GNU General Public License
17 % along with Euphorik. If not, see <http://www.gnu.org/licenses/>.
18 %
19 % Ce module gére les différents messages envoyés par le client (javascript) via AJAX.
20 % Les messages donnés ainsi que les réponses sont au format JSON.
21 % @author G.Burri
22
23
24 -module(euphorik_protocole).
25 -export([
26 register/2,
27 login/2,
28 logout/1,
29 profile/1,
30 wait_event/1,
31 put_message/1,
32 ban/1,
33 slap/1,
34 put_troll/1,
35 mod_troll/1,
36 del_troll/1,
37 unban_ip/1,
38 list_banned_ips/1,
39 erreur/1
40 ]).
41 -include("../include/euphorik_bd.hrl").
42 -include("../include/euphorik_defines.hrl").
43
44
45 % Une utilisateur s'enregistre avec un tuple {Login, Password}.
46 register([{login, Login}, {password, Password}], IP) ->
47 Can_register = euphorik_bd:can_register(IP),
48 if Can_register ->
49 case euphorik_bd:user_by_login(Login) of
50 {ok, _} ->
51 erreur("Login déjà existant");
52 _ ->
53 User = euphorik_bd:nouveau_user(Login, Password, generer_cookie()),
54 euphorik_bd:update_ip(User#user.id, IP),
55 json_reponse_login_ok(User)
56 end;
57 true ->
58 erreur_register_flood()
59 end;
60 % Enregistrement sans {Login, Password}
61 register([], IP) ->
62 Can_register = euphorik_bd:can_register(IP),
63 if Can_register ->
64 User = euphorik_bd:nouveau_user("<nick>", generer_cookie()),
65 euphorik_bd:update_ip(User#user.id, IP),
66 json_reponse_login_ok(User);
67 true ->
68 erreur_register_flood()
69 end.
70
71 erreur_register_flood() ->
72 erreur("Trop de register (flood)").
73
74
75 % Un utilisateur se logge (avec un couple {login, mot de passe})
76 login([{login, Login}, {password, Password}], IP) ->
77 loginUser(euphorik_bd:user_by_login_password(Login, Password), IP);
78 % Un utilisateur se logge (avec un cookie)
79 login([{cookie, Cookie}], IP) ->
80 loginUser(euphorik_bd:user_by_cookie(Cookie), IP).
81
82 loginUser({ok, User}, IP) ->
83 euphorik_bd:update_ip(User#user.id, IP),
84 euphorik_bd:update_date_derniere_connexion(User#user.id),
85 json_reponse_login_ok(User);
86 loginUser(_, _) ->
87 % ajoute un délais d'attente
88 timer:sleep(?TEMPS_ATTENTE_ERREUR_LOGIN),
89 erreur("Couple login/pass introuvable").
90
91
92 % Renvoie un string() représentant un cookie en base 36. Il y a 10^32 possibillités.
93 generer_cookie() ->
94 {A1, A2, A3} = now(),
95 random:seed(A1, A2, A3),
96 erlang:integer_to_list(random:uniform(math:pow(10, 32)), 36).
97
98
99 % Un utilisateur se délogge.
100 logout(_) ->
101 do_nothing.
102
103
104 % Modification du profile.
105 profile(
106 [
107 {cookie, Cookie},
108 {login, Login},
109 {password, Password},
110 {nick, Pseudo},
111 {email, Email},
112 {css, Css},
113 {nick_format, Nick_format_str},
114 {view_times, View_times},
115 {view_tooltips, View_tooltips},
116 {conversations, {array, Conversations_json}}
117 ]
118 ) ->
119 % virage des messages qui n'existent pas
120 Conversations = lists:dropwhile(
121 fun(Message_id) ->
122 not euphorik_bd:message_existe(Message_id)
123 end,
124 Conversations_json
125 ),
126 % TODO : pas très beau, mieux vaut construire un #user
127 case euphorik_bd:set_profile(
128 Cookie,
129 Login,
130 Password,
131 Pseudo,
132 Email,
133 Css,
134 list_to_atom(Nick_format_str),
135 View_times,
136 View_tooltips,
137 Conversations) of
138 ok ->
139 json_reponse_ok();
140 login_deja_pris ->
141 erreur("Login déjà pris");
142 _ ->
143 erreur("Impossible de mettre à jour le profile")
144 end.
145
146
147 % Renvoie les messages appropriés.
148 % last_message id et cookie sont facultatifs
149 wait_event([{page, "chat"} | Data]) ->
150 % traitement des inputs
151 Cookie = case lists:keysearch(cookie, 1, Data) of {value, {_, C}} -> C; _ -> inconnu end,
152 Last_message_id = case lists:keysearch(last_message_id, 1, Data) of {value, {_, Id}} -> Id; _ -> 0 end,
153 {value, {_, Message_count}} = lists:keysearch(message_count, 1, Data),
154 Main_page = case lists:keysearch(main_page, 1, Data) of {value, {_, P}} -> P; _ -> 1 end,
155 Troll_id = case lists:keysearch(troll_id, 1, Data) of {value, {_, T}} -> T; _ -> 0 end,
156 {value, {_, {array, Conversations_json}}} = lists:keysearch(conversations, 1, Data),
157 Racines_conversations = lists:map(
158 fun({struct, [{root, Racine}, {page, Page} | Reste]}) ->
159 Last_mess_conv = case Reste of [{last_message_id, L}] -> L; _ -> 0 end,
160 {Racine, Page, Last_mess_conv}
161 end,
162 Conversations_json
163 ),
164 User = case euphorik_bd:user_by_cookie(Cookie) of
165 {ok, U} -> U;
166 _ -> inconnu
167 end,
168 case {mnesia:subscribe({table, minichat, detailed}), mnesia:subscribe({table, troll, detailed})} of
169 {{error, E}, _} -> E;
170 {_, {error, E}} -> E;
171 _ ->
172 % attente d'événements
173 R = wait_event_page_chat(User, Racines_conversations, Message_count, Last_message_id, Main_page, Troll_id),
174 mnesia:unsubscribe({table, minichat, detailed}),
175 mnesia:unsubscribe({table, troll, detailed}),
176 R
177 end;
178 wait_event([{page, "admin"}, {last_troll, Last_troll}]) ->
179 case wait_event_page_admin(Last_troll) of
180 banned_ips_refresh ->
181 {struct,
182 [
183 {reply, "banned_ips_refresh"}
184 ]
185 };
186 {mod, Troll} ->
187 {struct,
188 [
189 {reply, "troll_modified"},
190 {troll_id, Troll#troll.id},
191 {content, Troll#troll.content}
192 ]
193 };
194 {add, Trolls} ->
195 {struct,
196 [
197 {reply, "troll_added"},
198 {trolls, {array,
199 lists:map(
200 fun(T) ->
201 {ok, User} = euphorik_bd:user_by_id(T#troll.id_user),
202 {struct,
203 [
204 {troll_id, T#troll.id},
205 {content, T#troll.content},
206 {author, User#user.pseudo},
207 {author_id, User#user.id}
208 ]
209 }
210 end,
211 Trolls
212 )
213 }}
214 ]
215 };
216 {del, Troll_id} ->
217 {struct,
218 [
219 {reply, "troll_deleted"},
220 {troll_id, Troll_id}
221 ]
222 };
223 _ ->
224 erreur("timeout")
225 end;
226 wait_event(_) ->
227 erreur("Page inconnue").
228
229
230 wait_event_page_chat(User, Racines_conversations, Message_count, Last_message_id, Main_page, Troll_id) ->
231 % est-ce que le troll est à jour ?
232 case euphorik_bd:current_troll() of
233 Current when is_record(Current, troll), Current#troll.id =/= Troll_id ->
234 {struct, [
235 {reply, "new_troll"},
236 {troll_id, Current#troll.id},
237 {message_id, euphorik_bd:message_id_associe(Current#troll.id)},
238 {content, Current#troll.content}
239 ]};
240 _ ->
241 % est-ce qu'il y a des nouveaux messages ?
242 case euphorik_minichat_conversation:conversations(Racines_conversations, Message_count, Last_message_id, Main_page) of
243 vide ->
244 wait_event_bd_page_chat(),
245 wait_event_page_chat(User, Racines_conversations, Message_count, Last_message_id, Main_page, Troll_id);
246 Conversations ->
247 % accrochez-vous ca va siouxer ;)
248 {struct, [
249 {reply, "new_messages"},
250 {conversations, {array,
251 lists:map(
252 fun({Conv, Plus}) ->
253 {struct, [
254 {last_page, not Plus},
255 {messages, {array,
256 lists:map(
257 fun({Mess, Repond_a}) ->
258 Est_proprietaire = User =/= inconnu andalso User#user.id =:= Mess#minichat.auteur_id,
259 A_repondu_a_message = User =/= inconnu andalso euphorik_bd:a_repondu_a_message(User#user.id, Mess#minichat.id),
260 Est_une_reponse_a_user = User =/= inconnu andalso euphorik_bd:est_une_reponse_a_user(User#user.id, Mess#minichat.id),
261 {ok, User_mess } = euphorik_bd:user_by_id(Mess#minichat.auteur_id),
262 {struct, [
263 {id, Mess#minichat.id},
264 {user_id, User_mess#user.id},
265 {date, format_date(Mess#minichat.date)},
266 {system, Mess#minichat.auteur_id =:= 0},
267 {owner, Est_proprietaire},
268 {answered, A_repondu_a_message},
269 {is_a_reply, Est_une_reponse_a_user},
270 {nick, Mess#minichat.pseudo},
271 {login, User_mess#user.login},
272 {content, Mess#minichat.contenu},
273 {root, Mess#minichat.racine_id},
274 {answer_to, {array, lists:map(
275 fun(Id_mess) ->
276 {ok, M} = euphorik_bd:message_by_id(Id_mess),
277 {ok, User_reponse} = euphorik_bd:user_by_mess(M#minichat.id),
278 {struct, [{id, M#minichat.id}, {nick, M#minichat.pseudo}, {login, User_reponse#user.login}]}
279 end,
280 Repond_a
281 )}},
282 {ek_master, User_mess#user.ek_master}
283 ]}
284 end,
285 Conv
286 )
287 }}
288 ]}
289 end,
290 Conversations
291 )
292 }}
293 ]}
294 end
295 end.
296
297
298 % Attend un événement lié à la page 'chat'.
299 wait_event_bd_page_chat() ->
300 receive % attente d'un post
301 {mnesia_table_event, {write, minichat, _Message, [], _}} ->
302 ok;
303 {mnesia_table_event, {write, troll, Troll, [Old_troll | _], _}} when Troll#troll.date_post =/= undefined, Old_troll#troll.date_post == undefined ->
304 ok;
305 {tcp_closed, _} ->
306 exit(normal);
307 _ ->
308 wait_event_bd_page_chat()
309 % 60 minutes de timeout (on ne sais jamais)
310 % Après 60 minutes de connexion, le client doit donc reétablir une connexion
311 after 1000 * 60 * 60 ->
312 timeout
313 end.
314
315
316 % Attent un événement concernant la page admin
317 % Renvoie les trolls manquants posté après Last_id ou banned_ips_refresh.
318 % Si pas de trolls alors attend un événement tel qu'un ajout, une modification ou une suppression.
319 % renvoie :
320 % {mod, Troll}
321 % ou {add, [Trolls]}
322 % ou {del, Troll_id}
323 % ou banned_ips_refresh
324 % ou timeout
325 wait_event_page_admin(Last_id) ->
326 case {mnesia:subscribe({table, troll, detailed}), mnesia:subscribe({table, ip_table, detailed})} of
327 {{error, E}, _ } -> E;
328 {_, {error, E}} -> E;
329 _ ->
330 R = case euphorik_bd:trolls(Last_id) of
331 [] -> % pas de trolls
332 wait_event_page_admin();
333 Trolls ->
334 {add, Trolls}
335 end,
336 mnesia:unsubscribe({table, troll, detailed}),
337 mnesia:unsubscribe({table, ip_table, detailed}),
338 R
339 end.
340
341 wait_event_page_admin() ->
342 % s'il n'y a pas de trolls que l'utilisateur n'a pas connaissance alors on attend un événement
343 receive
344 % cas où un troll est choisit comme courant
345 {mnesia_table_event, {write, troll, Troll, [Old_troll | _], _}}
346 when Old_troll#troll.date_post =:= undefined, Troll#troll.date_post =/= undefined ->
347 {del, Troll#troll.id};
348 {mnesia_table_event, {write, troll, Troll, [_Old_troll | _], _}} ->
349 {mod, Troll};
350 {mnesia_table_event, {write, troll, Troll, [], _}} ->
351 {add, [Troll]};
352 {mnesia_table_event, {delete, troll, {troll, Id}, _, _}} ->
353 {del, Id};
354 {mnesia_table_event, {write, ip_table, IP, [Old_IP | _], _}}
355 when Old_IP#ip_table.ban =/= IP#ip_table.ban; Old_IP#ip_table.ban_duration =/= IP#ip_table.ban_duration ->
356 banned_ips_refresh;
357 {tcp_closed, _} ->
358 exit(normal);
359 _ ->
360 wait_event_page_admin()
361 % 60 minutes de timeout (on ne sais jamais)
362 % Après 60 minutes de connexion, le client doit donc reétablir une connexion
363 after 1000 * 60 * 60 ->
364 timeout
365 end.
366
367
368 % Un utilisateur envoie un message
369 put_message(
370 [
371 {cookie, Cookie},
372 {nick, Nick},
373 {content, Content},
374 {answer_to, {array, Answer_to}}
375 ]
376 ) ->
377 case euphorik_bd:user_by_cookie(Cookie) of
378 {ok, User} ->
379 case euphorik_bd:est_banni(User#user.id) of
380 {true, Temps_restant} ->
381 erreur("Vous êtes banni pour encore " ++ format_minutes(Temps_restant));
382 _ ->
383 Strip_content = string:strip(Content),
384 if Strip_content =:= [] ->
385 erreur("Message vide");
386 true ->
387 % attention : non-atomique (update_pseudo+nouveau_message)
388 euphorik_bd:update_pseudo_user(User#user.id, Nick),
389 case euphorik_bd:nouveau_message(Strip_content, User#user.id, Answer_to) of
390 {erreur, R} -> erreur("Impossible d'ajouter un nouveau message. Raison : " ++ R);
391 _ ->
392 json_reponse_ok()
393 end
394 end
395 end;
396 _ ->
397 erreur("Utilisateur inconnu")
398 end.
399
400
401 % bannissement d'un utilisateur (son ip est bannie)
402 ban(
403 [
404 {cookie, Cookie},
405 {duration, Duration},
406 {user_id, User_id},
407 {reason, Reason}
408 ]) ->
409 % controle que l'utilisateur est un admin
410 case euphorik_bd:user_by_cookie(Cookie) of
411 {ok, User1 = #user{ek_master = true}} ->
412 case euphorik_bd:user_by_id(User_id) of
413 {ok, User1} ->
414 erreur("Il n'est pas possible de s'auto bannir");
415 {ok, User2 = #user{ek_master = false}} ->
416 euphorik_bd:ban(User2#user.last_ip, Duration),
417 euphorik_bd:nouveau_message_sys(lists:flatten(io_lib:format("''~s~s'' est ~s pour ~s.~s",
418 [
419 User2#user.pseudo,
420 if User2#user.login =:= [] -> ""; true -> " (" ++ User2#user.login ++ ")" end,
421 if Duration =< 15 -> "kické"; true -> "banni" end,
422 format_minutes(Duration),
423 if Reason =/= [] -> " - Raison: " ++ Reason; true -> "" end ++ "."
424 ]
425 ))),
426 json_reponse_ok();
427 {ok, _} ->
428 erreur("L'utilisateur est lui même un ekMaster");
429 _ ->
430 erreur("Utilisateur à bannir inconnu")
431 end;
432 _ ->
433 erreur("Utilisateur inconnu ou non ek master")
434 end.
435
436
437 % slapage d'un user (avertissement)
438 slap(
439 [
440 {cookie, Cookie},
441 {user_id, User_id},
442 {reason, Reason}
443 ]) ->
444 % controle que l'utilisateur est un admin
445 case euphorik_bd:user_by_cookie(Cookie) of
446 {ok, User1 = #user{ek_master = true}} ->
447 case euphorik_bd:user_by_id(User_id) of
448 {ok, User1} ->
449 euphorik_bd:nouveau_message_sys(lists:flatten(io_lib:format("~s s'auto slap~s.",
450 [
451 User1#user.pseudo,
452 if Reason =/= [] -> " - Raison: " ++ Reason; true -> "" end
453 ]
454 ))),
455 json_reponse_ok();
456 {ok, User2 = #user{ek_master = false}} ->
457 euphorik_bd:nouveau_message_sys(lists:flatten(io_lib:format("~s se fait slaper par ~s.~s",
458 [
459 User2#user.pseudo,
460 User1#user.pseudo,
461 if Reason =/= [] -> " - Raison: " ++ Reason; true -> "" end ++ "."
462 ]
463 ))),
464 json_reponse_ok();
465 {ok, _} ->
466 erreur("L'utilisateur est lui même un ekMaster");
467 _ ->
468 erreur("Utilisateur à slaper inconnu")
469 end;
470 _ ->
471 erreur("Utilisateur inconnu ou non ek master")
472 end.
473
474
475 put_troll(
476 [
477 {cookie, Cookie},
478 {content, Content}
479 ]
480 ) ->
481 % controle que l'utilisateur est un admin
482 case euphorik_bd:user_by_cookie(Cookie) of
483 {ok, User = #user{ek_master = true}} ->
484 case euphorik_bd:put_troll(User#user.id, Content) of
485 max_troll_reached_per_user ->
486 erreur(lists:flatten(io_lib:format("Le nombre de troll maximum par utilisateur est atteint : ~w ", [?NB_MAX_TROLL_WAITING_BY_USER])));
487 max_troll_reached ->
488 erreur(lists:flatten(io_lib:format("Le nombre de troll maximum en attente est atteint : ~w ", [?NB_MAX_TROLL_WAITING])));
489 _Id ->
490 json_reponse_ok()
491 end;
492 _ ->
493 erreur("Seul les ekMaster peuvent proposer des trolls")
494 end.
495
496
497 mod_troll(
498 [
499 {cookie, Cookie},
500 {troll_id, Troll_id},
501 {content, Content}
502 ]
503 ) ->
504 % controle que l'utilisateur est un admin
505 case euphorik_bd:user_by_cookie(Cookie) of
506 {ok, User = #user{ek_master = true}} ->
507 User_id = User#user.id,
508 case euphorik_bd:troll_by_id(Troll_id) of
509 {ok, #troll{id_user = User_id}} ->
510 euphorik_bd:mod_troll(Troll_id, Content),
511 json_reponse_ok();
512 _ ->
513 erreur("Vous ne posséder pas ce troll")
514 end;
515 _ ->
516 erreur("Seul les ekMaster peuvent proposer des trolls")
517 end.
518
519
520 del_troll(
521 [
522 {cookie, Cookie},
523 {troll_id, Troll_id}
524 ]
525 ) ->
526 % controle que l'utilisateur est un admin
527 case euphorik_bd:user_by_cookie(Cookie) of
528 {ok, User = #user{ek_master = true}} ->
529 User_id = User#user.id,
530 case euphorik_bd:troll_by_id(Troll_id) of
531 {ok, #troll{id_user = User_id}} ->
532 euphorik_bd:del_troll(Troll_id),
533 json_reponse_ok();
534 _ ->
535 erreur("Vous ne posséder pas ce troll")
536 end;
537 _ ->
538 erreur("Seul les ekMaster peuvent proposer des trolls")
539 end.
540
541
542 unban_ip(
543 [
544 {cookie, Cookie},
545 {ip, IP}
546 ]
547 ) ->
548 case euphorik_bd:user_by_cookie(Cookie) of
549 {ok, #user{ek_master = true}} ->
550 euphorik_bd:deban(euphorik_common:unserialize_ip(IP)),
551 json_reponse_ok();
552 _ ->
553 erreur("Seul les ekMaster peuvent connaitre la liste des ips bannies")
554 end.
555
556
557 list_banned_ips(
558 [
559 {cookie, Cookie}
560 ]
561 ) ->
562 case euphorik_bd:user_by_cookie(Cookie) of
563 {ok, #user{ek_master = true}} ->
564 {
565 struct,
566 [
567 {reply, "list_banned_ips"},
568 {list, {array, lists:map(
569 fun({IP, T, Users}) ->
570 {struct,
571 [
572 {ip, euphorik_common:serialize_ip(IP)},
573 {remaining_time, format_minutes(T)},
574 {users, {array, lists:map(
575 fun({Pseudo, Login}) ->
576 {struct,
577 [
578 {nick, Pseudo},
579 {login, Login}
580 ]
581 }
582 end,
583 Users
584 )}}
585 ]
586 }
587 end,
588 euphorik_bd:list_ban()
589 )}}
590 ]
591 };
592 _ ->
593 erreur("Seul les ekMaster peuvent connaitre la liste des ips bannies")
594 end.
595
596
597 % Construit une erreur
598 erreur(Message) ->
599 {
600 struct, [
601 {reply, "error"},
602 {error_message, Message}
603 ]
604 }.
605
606
607 % Formatage de minutes.
608 % par exemple : "1min", "45min", "1h23min", "1jour 2h34min"
609 format_minutes(Min) ->
610 Jours = Min div (60 * 24),
611 Heures = Min rem (60 * 24) div 60,
612 Minutes = Min rem (60),
613 if Jours =/= 0 -> integer_to_list(Jours) ++ " Jour" ++ if Jours > 1 -> "s"; true -> "" end ++ " "; true -> "" end ++
614 if Heures =/= 0 -> integer_to_list(Heures) ++ " heure" ++ if Heures > 1 -> "s"; true -> "" end; true -> "" end ++
615 if Minutes == 0 ->
616 "";
617 true ->
618 " " ++ integer_to_list(Minutes) ++ " minute" ++ if Minutes > 1 -> "s"; true -> "" end
619 end.
620
621
622 % Formatage d'une heure
623 % local_time() -> string
624 format_date(Date) ->
625 DateLocal = calendar:now_to_local_time(Date),
626 DateNowLocal = calendar:local_time(),
627 {{Annee, Mois, Jour}, {Heure, Minute, Seconde}} = DateLocal,
628 {{AnneeNow, _, _}, {_, _, _}} = DateNowLocal,
629 Hier = calendar:date_to_gregorian_days(element(1, DateLocal)) =:= calendar:date_to_gregorian_days(element(1, DateNowLocal)) - 1,
630 lists:flatten(
631 if element(1, DateLocal) =:= element(1, DateNowLocal) ->
632 "";
633 Hier ->
634 "Hier ";
635 Annee =:= AnneeNow ->
636 io_lib:format("~2.10.0B/~2.10.0B ", [Jour, Mois]);
637 true ->
638 io_lib:format("~2.10.0B/~2.10.0B/~B ", [Jour, Mois, Annee])
639 end ++
640 io_lib:format("~2.10.0B:~2.10.0B:~2.10.0B", [Heure, Minute, Seconde])
641 ).
642
643
644 json_reponse_ok() ->
645 {struct, [{reply, "ok"}]}.
646
647
648 json_reponse_login_ok(User) ->
649 {
650 struct, [
651 {reply, "login"},
652 {status, if (User#user.password =/= []) and (User#user.login =/= []) -> "auth_registered"; true -> "auth_not_registered" end},
653 {cookie, User#user.cookie},
654 {id, User#user.id},
655 {nick, User#user.pseudo},
656 {login, User#user.login},
657 {email, User#user.email},
658 {css, User#user.css},
659 {nick_format, atom_to_list(User#user.nick_format)},
660 {view_times, User#user.view_times},
661 {view_tooltips, User#user.view_tooltips},
662 {conversations, {array, User#user.conversations } },
663 {ek_master, User#user.ek_master}
664 ]
665 }.