2 % Copyright 2008 Grégory Burri
4 % This file is part of Euphorik.
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.
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.
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/>.
19 % Ce module permet de gérer les données persistantes lié au site d'euphorik.ch.
20 % Il permet d'ajouter des message, de demande les messages sur une page donnée, etc..
21 % Ce module utilise une base mnesia.
35 update_date_derniere_connexion
/1,
41 user_by_login_password
/2,
43 css_from_user_cookie
/1,
44 is_ek_master_from_cookie
/1,
48 nouveau_message_sys
/1,
60 est_une_reponse_a_user
/2,
61 a_repondu_a_message
/2,
72 resultat_transaction
/1,
73 get_tuples
/3 % must be in a transaction
75 -import(qlc
, [e
/2, q
/1, cursor
/2]).
76 -include("../include/euphorik_bd.hrl").
77 -include("../include/euphorik_defines.hrl").
78 -include_lib("stdlib/include/qlc.hrl").
85 % TODO : généraliser la langue
86 get_texte(Id
, _Lang
= fr
) ->
87 resultat_transaction(mnesia:transaction(fun() ->
88 case mnesia:read({texte
, Id
}) of
89 [#texte
{fr
= Texte
}] -> Texte
;
90 _
-> "Message " ++ integer_to_list(Id
) ++ " unknown"
95 % Ajoute un nouveau user et le renvoie
96 nouveau_user(Cookie
, Profile
) ->
99 User
= #user
{id
= Id
, cookie
= Cookie
, date_creation
= now(), date_derniere_connexion
= now(), profile
= Profile
},
103 resultat_transaction(mnesia:transaction(F
)).
106 % Ajoute un nouveau user et le renvoie
107 nouveau_user(Login
, Password
, Cookie
, Profile
) ->
109 Id
= nouvel_id(user
),
110 User
= #user
{id
= Id
, cookie
= Cookie
, login
= Login
, password
= Password
, date_creation
= now(), date_derniere_connexion
= now(), profile
= Profile#profile
{pseudo
= Login
}},
114 resultat_transaction(mnesia:transaction(F
)).
117 % Définit les données du profile d'une utilisateur.
118 set_profile(Cookie
, Login
, Password
, Profile
) ->
119 resultat_transaction(mnesia:transaction(
121 case user_by_cookie(Cookie
) of
122 {ok
, User_existant
} ->
123 case user_by_login(Login
) of
124 {ok
, U
} when Login
=/= [], U#user
.id
=/= User_existant#user
.id
->
129 login
= if User_existant#user
.login
=:= [] -> Login
; true
-> User_existant#user
.login
end, % on ne peut pas changer de login sauf si on en a pas !
130 password
= if Password
=:= [] -> User_existant#user
.password
; true
-> Password
end,
142 % Met à jour la date de la dernière connexion d'un utilisateur à maintenant
143 update_date_derniere_connexion(User_id
) ->
146 case mnesia:wread({user
, User_id
}) of
148 mnesia:write(User#user
{date_derniere_connexion
= now()});
150 mnesia:abort("update_date_derniere_connexion: User inconnu")
156 % Met à jour l'ip d'un user
157 update_ip(User_id
, IP
) ->
160 case mnesia:wread({user
, User_id
}) of
162 mnesia:write(User#user
{last_ip
= IP
});
164 mnesia:abort("update_ip: User inconnu")
170 % Met à jour le pseudo du user
171 update_pseudo_user(UserId
, Pseudo
) ->
174 case mnesia:wread({user
, UserId
}) of
175 [#user
{profile
= Profile
} = User
] when Profile#profile
.pseudo
=/= Pseudo
->
176 mnesia:write(User#user
{profile
= Profile#profile
{ pseudo
= Pseudo
} });
178 mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour")
184 % Est-ce qu'un utilisateur existe en fonction de son cookie ?
185 % Renvoie {ok, User} ou erreur
186 user_by_cookie(Cookie
) ->
187 resultat_transaction(mnesia:transaction(
189 case mnesia:index_read(user
, Cookie
, #user
.cookie
) of
190 [User
] -> {ok
, User
};
198 resultat_transaction(mnesia:transaction(
200 % case e(q([E || E <- mnesia:table(user), E#user.id =:= ID]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) of
201 % [User] -> {ok, User};
204 case mnesia:read({user
, ID
}) of
205 [User
] -> {ok
, User
};
212 user_by_login(Login
) ->
213 resultat_transaction(mnesia:transaction(
215 Users
= e(q([E
|| E
<- mnesia:table(user
), E#user
.login
=:= Login
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
217 [User
] -> {ok
, User
};
224 % Renvoie une chaine représentant le cookie ou undefined si pas trouvé.
225 css_from_user_cookie(Cookie
) ->
226 case user_by_cookie(Cookie
) of
227 {ok
, #user
{profile
= Profile
}} ->
234 is_ek_master_from_cookie(Cookie
) ->
235 case user_by_cookie(Cookie
) of
236 {ok
, #user
{ek_master
= true
}} -> true
;
241 user_by_login_password(Login
, Password
) ->
242 resultat_transaction(mnesia:transaction(
244 case e(q([E
|| E
<- mnesia:table(user
), E#user
.login
=:= Login
, E#user
.password
=:= Password
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]) of
245 [User
| _
] -> {ok
, User
};
252 % Renvoie {ok, User} où User est un #user possédant le message donné.
254 resultat_transaction(mnesia:transaction(
256 case e(q([U
|| U
<- mnesia:table(user
), M
<- mnesia:table(minichat
), M#minichat
.id
=:= Id
, M#minichat
.auteur_id
=:= U#user
.id
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]) of
257 [User
| _
] -> {ok
, User
};
264 % Ajoute un message. Repond_A est une liste d'id auquel le message répond
265 % retourne soit l'id du message soit {erreur, <raison>}.
266 nouveau_message(Mess
, Auteur_id
, Repond_A_ids
) ->
267 % regarde si les id 'Repond_A' existent
269 Repond_a
= lists:foldr(
270 fun(Repond_a_id
, Acc
) ->
271 case mnesia:read({minichat
, Repond_a_id
}) of
273 _
-> Acc
% le message n'est pas trouvé
279 Racine_id
= case Repond_a
of
282 Une_racine
= M#minichat
.racine_id
,
283 % vérification que tout les messages de Repond_a possède la même racine (même conversation)
284 case lists:all(fun(R
) -> R#minichat
.racine_id
=:= Une_racine
end, Repond_a
) of
288 {erreur
, "Les messages ne font pas partie de la même conversation"}
291 if length(Repond_a
) =/= length(Repond_A_ids
) ->
292 {erreur
, "Un ou plusieurs messages introuvable"};
295 {erreur
, E
} -> {erreur
, E
};
297 % est-ce que l'auteur existe ?
298 case mnesia:wread({user
, Auteur_id
}) of
299 [#user
{profile
= Profile
} = Auteur
] ->
300 % comparaison entre la date du dernier poste et maintenant (gestion du flood)
302 Delta
= euphorik_common:delta_date_ms(Auteur#user
.date_derniere_connexion
, Now
),
303 Nouvel_indice_flood
= Auteur#user
.indice_flood
+ if Delta
=< ?DUREE_SPAM
-> 2; true
-> -1 end,
304 Auteur_maj
= Auteur#user
{
305 indice_flood
= if Nouvel_indice_flood
> ?INDICE_SPAM_MAX
-> ?INDICE_SPAM_MAX
; Nouvel_indice_flood
< 0 -> 0; true
-> Nouvel_indice_flood
end,
306 date_derniere_connexion
= Now
308 % est-ce que l'auteur à trop floodé ?
309 if Auteur#user
.indice_flood
=/= ?INDICE_SPAM_MAX
, Auteur_maj#user
.indice_flood
=:= ?INDICE_SPAM_MAX
, Delta
=< ?DUREE_BLOCAGE_SPAM
->
310 mnesia:write(Auteur#user
{indice_flood
= Auteur_maj#user
.indice_flood
}),
311 nouveau_message_sys("\"" ++ Profile#profile
.pseudo
++ if Auteur#user
.login
=/= [] -> " (" ++ Auteur#user
.login
++ ")"; true
-> "" end ++ "\" est bloqué pour " ++ integer_to_list(trunc(?DUREE_BLOCAGE_SPAM
/ 1000)) ++ " secondes pour cause de flood.");
312 Auteur#user
.indice_flood
=:= ?INDICE_SPAM_MAX
, Delta
=< ?DUREE_BLOCAGE_SPAM
->
313 {erreur
, "Bloqué pour cause de flood"};
315 mnesia:write(Auteur_maj
),
316 Id
= nouvel_id(minichat
),
317 inserer_reponses(Id
, Repond_A_ids
),
318 mnesia:write(#minichat
{
320 auteur_id
= Auteur#user
.id
,
322 pseudo
= Profile#profile
.pseudo
,
324 racine_id
= if Racine_id
=:= undefined
-> Id
; true
-> Racine_id
end
329 {erreur
, "L'auteur du message est introuvable"}
334 resultat_transaction(mnesia:transaction(F
)).
336 % Définit Id_repondant comme étant la réponse à Ids. Ids est une liste d'id.
337 inserer_reponses(Id_repondant
, [Id_mess
| Reste
]) ->
338 mnesia:write(#reponse_minichat
{repondant
= Id_repondant
, cible
= Id_mess
}),
339 inserer_reponses(Id_repondant
, Reste
);
340 inserer_reponses(_
, []) ->
344 % Permet de créer un message système.
345 % Renvoie l'id du message système
346 nouveau_message_sys(Mess
) ->
347 {ok
, #user
{profile
= Profile
}} = user_by_id(0),
348 resultat_transaction(mnesia:transaction(
350 Id
= nouvel_id(minichat
),
351 mnesia:write(#minichat
{id
= Id
, auteur_id
= 0, date = now(), pseudo
= Profile#profile
.pseudo
, contenu
= Mess
, racine_id
= Id
}),
357 % Renvoie N messages se trouvant sur la première page
362 % Renvoie N messages se trouvant sur la page P
363 % TODO FIXME : fonction en O(N * P) !
366 get_tuples(minichat
, mnesia:table_info(minichat
, size) - N
* P
+ 1, N
)
368 resultat_transaction(mnesia:transaction(F
)).
371 get_tuples(Table
, First_id
, N
) ->
374 case mnesia:read({Table
, Id
}) of
380 lists:seq(First_id
, First_id
+ N
- 1)
384 % Renvoie les messages manquants pour la page P en sachant qu'il y a N message
385 % par page et que le dernier message que l'on possède est Id
386 messages(Id
, N
, P
) ->
387 lists:filter(fun (M
) -> M#minichat
.id
> Id
end, messages(N
, P
)).
390 % Renvoie {ok, #minichat} (voir #minichat de euphorik_bd.hrl) à partir de son id.
392 resultat_transaction(mnesia:transaction(
394 case mnesia:read({minichat
, Id
}) of
401 % Renvoie une liste de message (voir #minichat de euphorik_bd.hrl) à partir d'une liste d'id (Ids).
402 % TODO : optimisations ? serait-ce du O(n) ?
403 % Bon de toutes façons on s'en fout c'est pas utilisé :)
404 messages_by_ids(Ids
) ->
405 resultat_transaction(mnesia:transaction(
409 q([E
|| E
<- mnesia:table(minichat
), lists:any(fun(Id
) -> Id
=:= E#minichat
.id
end, Ids
)]),
411 ),[{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
416 % Est-ce qu'un message existe ? Renvoie un boolean.
417 % TODO : ya pas plus simple ?
418 message_existe(Id
) ->
419 resultat_transaction(mnesia:transaction(fun() ->
420 length(e(q([E#minichat
.id
|| E
<- mnesia:table(minichat
), E#minichat
.id
=:= Id
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])) =:= 1
424 % Renvoie les reponses (utilisé normalement uniquement pendant le debug).
427 e(q([E
|| E
<- mnesia:table(reponse_minichat
)]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
429 resultat_transaction(mnesia:transaction(F
)).
432 % Renvoie les messages auquel M_id répond.
434 resultat_transaction(mnesia:transaction(
437 [M
|| R
<- mnesia:table(reponse_minichat
),
438 M
<- mnesia:table(minichat
),
439 R#reponse_minichat
.repondant
=:= M_id
,
440 M#minichat
.id
=:= R#reponse_minichat
.cible
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
445 % Renvoie les message qui repondent à M_id
447 resultat_transaction(mnesia:transaction(
450 [M
|| R
<- mnesia:table(reponse_minichat
),
451 M
<- mnesia:table(minichat
),
452 R#reponse_minichat
.cible
=:= M_id
,
453 M#minichat
.id
=:= R#reponse_minichat
.repondant
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
458 % Renvoie les id des parents d'un message M (les messages auquels répond M)
459 % ordrés du plus petit au plus grand..
460 % On évite d'utiliser qlc pour des raisons de performance
461 % @spec parents_id(integer()) -> [integer()]
463 resultat_transaction(mnesia:transaction(fun() ->
464 case mnesia:read({reponse_minichat
, M_id
}) of
465 Parents
when is_list(Parents
) ->
466 lists:sort(lists:map(
467 fun(#reponse_minichat
{cible
= Cible
}) -> Cible
end,
475 % Renvoie les id des enfants d'un message M (les messages qui répondent à M)
476 % ordrés du plus petit au plus grand.
477 % @spec enfants_id(integer()) -> [integer()]
479 resultat_transaction(mnesia:transaction(fun() ->
480 case mnesia:index_read(reponse_minichat
, M_id
, #reponse_minichat
.cible
) of
481 Enfants
when is_list(Enfants
) ->
482 lists:sort(lists:map(
483 fun(#reponse_minichat
{repondant
= Repondant
}) -> Repondant
end,
491 % Est-ce que le message Id_mess est une réponse d'une message de Id_user ?
492 % On evite d'utiliser qlc (ce qui était fait avant) pour des raisons de performance.
493 est_une_reponse_a_user(Id_user
, Id_mess
) ->
494 resultat_transaction(mnesia:transaction(
496 case mnesia:read({reponse_minichat
, Id_mess
}) of
500 fun(#reponse_minichat
{cible
= Cible
}) ->
501 case mnesia:read({minichat
, Cible
}) of
502 [#minichat
{auteur_id
= Id_user
}] -> true
;
513 % Est-ce que Id_user à répondu au message Id_mess
514 % On evite d'utiliser qlc (ce qui était fait avant) pour des raisons de performance.
515 a_repondu_a_message(Id_user
, Id_mess
) ->
516 resultat_transaction(mnesia:transaction(
518 case mnesia:index_read(reponse_minichat
, Id_mess
, #reponse_minichat
.cible
) of
522 fun(#reponse_minichat
{repondant
= Reponse
}) ->
523 case mnesia:read({minichat
, Reponse
}) of
524 [#minichat
{auteur_id
= Id_user
}] -> true
;
535 % Est-ce que Id_user possède Id_mess ?
536 possede_message(Id_user
, Id_mess
) ->
537 case mnesia:transaction(
539 e(q([E#minichat
.auteur_id
|| E
<- mnesia:table(minichat
), E#minichat
.id
=:= Id_mess
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
542 {atomic
, [Id_user
| []]} -> true
;
547 % renvoie la liste des ip bannies
548 % liste de {ip, temps_restant(en minutes), Users} ou Users est une liste de {pseudo, login}
549 % TODO : déterminer la complexité de cette fonction. (Il n'y a pas d'index sur #user.last_ip)
551 resultat_transaction(mnesia:transaction(
557 euphorik_common:delta_date_minute(date_plus_minutes(IP#ip_table
.ban
, IP#ip_table
.ban_duration
), Now
),
558 e(q([{Profile#profile
.pseudo
, U#user
.login
} || #user
{profile
= Profile
} = U
<- mnesia:table(user
), U#user
.last_ip
=:= IP#ip_table
.ip
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
560 IP
<- mnesia:table(ip_table
),
561 if IP#ip_table
.ban
=:= undefined
-> false
; true
-> date_plus_minutes(IP#ip_table
.ban
, IP#ip_table
.ban_duration
) > Now
end
562 ])), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}])
567 % Bannie une ip pour un certain temps (en minute).
571 case mnesia:wread({ip_table
, IP
}) of
573 mnesia:write(IP_tuple#ip_table
{ban
= now(), ban_duration
= Duration
});
575 mnesia:write(#ip_table
{ip
= IP
, ban
= now(), ban_duration
= Duration
})
586 % Renvoie soit {true, Temps} où Temps est le temps en minutes pendant lequel le user est encore banni
588 est_banni(User_id
) ->
589 resultat_transaction(mnesia:transaction(
592 {IP#ip_table
.ban
, IP#ip_table
.ban_duration
} ||
593 U
<- mnesia:table(user
),
594 U#user
.id
=:= User_id
,
595 IP
<- mnesia:table(ip_table
),
596 IP#ip_table
.ip
=:= U#user
.last_ip
597 ]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]) of
598 [{Ban
, Ban_duration
}] ->
599 Echeance
= date_plus_minutes(Ban
, Ban_duration
),
601 if Echeance
< Now
-> % l'échéance est passée
604 {true
, euphorik_common:delta_date_minute(Echeance
, Now
)}
613 % Ban est une date tel que retourner par now().
614 % Ban_duration est un temps en minutes.
616 date_plus_minutes(Ban
, Ban_duration
) ->
617 Duration_sec
= Ban_duration
* 60,
618 {MegaSec
, Sec
, MicroSec
} = Ban
,
619 {MegaSec
+ if Sec
+ Duration_sec
>= 1000000 -> 1; true
-> 0 end,(Sec
+ Duration_sec
) rem
1000000, MicroSec
}.
622 % Si deux enregistrements consequtifs de la même IP sont fait en moins d'une seconde alors
623 % ip_table.nb_try_register est incrémenté de 1 sinon il est décrémenté de 1 (jusqu'a 0).
624 % Si ip_table.nb_try_register vaut 5 alors l'ip ne peux plus s'enregistrer pour une heure.
626 resultat_transaction(mnesia:transaction(
628 case e(q([I
|| I
<- mnesia:table(ip_table
), I#ip_table
.ip
=:= IP
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]) of
630 mnesia:write(#ip_table
{ip
= IP
, date_last_try_register
= now()}),
633 Delta
= euphorik_common:delta_date_ms(T#ip_table
.date_last_try_register
, now()),
634 if T#ip_table
.nb_try_register
=:= ?NB_MAX_FLOOD_REGISTER
, Delta
< ?TEMPS_BAN_FLOOD_REGISTER
->
637 mnesia:write(T#ip_table
{
639 date_last_try_register
= now(),
640 nb_try_register
= T#ip_table
.nb_try_register
+ if Delta
< ?TEMPS_FLOOD_REGISTER
-> 1; T#ip_table
.nb_try_register
> 0 -> -1; true
-> 0 end
649 % Renvoie le résultat d'une transaction (en décomposant le tuple fournit)
650 resultat_transaction({_
, T
}) ->
654 % Renvoie un nouvel id pour une table donnée
656 mnesia:dirty_update_counter(counter
, Table
, 1).