X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=modules%2Ferl%2Feuphorik_bd.erl;h=87dab2f44520c8b064d4d26eaa678aa1c8e4bbd5;hp=56a659ad1e950a9135c814c7aa6ef4428b341ae9;hb=01922222ac686c2507052c0cc1d755495145d154;hpb=288706fac9732d0dbf55fc9e3291e2dda69f1fcd diff --git a/modules/erl/euphorik_bd.erl b/modules/erl/euphorik_bd.erl index 56a659a..87dab2f 100755 --- a/modules/erl/euphorik_bd.erl +++ b/modules/erl/euphorik_bd.erl @@ -1,79 +1,610 @@ -% Module de création de la base de données euphorik. -% Auteur : G.Burri -% Date : 14.10.2007 +% coding: utf-8 +% Ce module permet de gérer les données persistantes lié au site d'euphorik.ch. +% Il permet d'ajouter des message, de demande les messages sur une page donnée, etc.. +% Ce module utilise une base mnesia. +% @author G.Burri -module(euphorik_bd). --export([create/0, create_tables/0, vers_version2/0, vers_version3/0, peupler/0, tester/0]). +-export([ + % gestion : + create/0, + connect/0, + connect/1, + reset/0, + + % users : + nouveau_user/2, + nouveau_user/3, + set_profile/9, + update_date_derniere_connexion/1, + update_ip/2, + update_pseudo_user/2, + users/0, + user_by_cookie/1, + user_by_id/1, + user_by_login/1, + user_by_login_password/2, + user_by_mess/1, + toggle_ek_master/1, + + % messages : + nouveau_message/3, + nouveau_message_sys/1, + messages/1, + messages/2, + messages/3, + message_by_id/1, + messages_by_ids/1, + message_existe/1, + reponses/0, + repond_a/1, + est_une_reponse_a_user/2, + a_repondu_a_message/2, + possede_message/2, + + % ip : + ip_table/0, + ban/2, + deban/1, + est_banni/1, + can_register/1, + + % versions : + update_version/1, + + % utiles : + resultat_transaction/1 +]). --include("../include/euphorik_bd.hrl"). +-include("../include/euphorik_bd.hrl"). +-include("../include/euphorik_defines.hrl"). +-include_lib("stdlib/include/qlc.hrl"). -% Instructions pour créer une nouvelle base : +% Instructions pour créer une nouvelle base : % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"' +% voir doc/installation.txt % >l(euphorik_bd). -% >euphorik_bd:create(). -create() -> - mnesia:stop(), - mnesia:delete_schema([node()]), - mnesia:create_schema([node()]), % nécessaire pour les tables sur disc - mnesia:start(), - create_tables(). - - -create_tables() -> - mnesia:create_table(counter, [ - {attributes, record_info(fields, counter)}, - {disc_copies, [node()]} - ]), +% >euphorik_bd:create(). +create() -> + mnesia:stop(), + mnesia:delete_schema([node()]), + mnesia:create_schema([node()]), % nécessaire pour les tables sur disc + mnesia:start(), + create_tables(), + reset(). +create_tables() -> + mnesia:create_table(counter, [ + {attributes, record_info(fields, counter)}, + {disc_copies, [node()]} + ]), mnesia:create_table(minichat, [ {attributes, record_info(fields, minichat)}, {index, [auteur_id]}, {disc_copies, [node()]} - ]), - mnesia:create_table(reponse_minichat, [ - {type, bag}, - {attributes, record_info(fields, reponse_minichat)}, - {index, [cible]}, - {disc_copies, [node()]} - ]), - mnesia:create_table(user, [ + ]), + mnesia:create_table(reponse_minichat, [ + {type, bag}, + {attributes, record_info(fields, reponse_minichat)}, + {index, [cible]}, + {disc_copies, [node()]} + ]), + mnesia:create_table(user, [ {attributes, record_info(fields, user)}, - {index, [cookie, login]}, - {disc_copies, [node()]} + {index, [cookie, login]}, + {disc_copies, [node()]} + ]), + mnesia:create_table(ip_table, [ + {attributes, record_info(fields, ip_table)}, + {disc_copies, [node()]} + ]), + mnesia:create_table(troll, [ + {attributes, record_info(fields, troll)}, + {disc_copies, [node()]} ]). + + +% Connexion à la base de données de yaws sur overnux +connect() -> + connect(yaws@flynux). +connect(Node) -> + mnesia:start(), + mnesia:change_config(extra_db_nodes, [Node]). -vers_version2() -> - mnesia:transform_table( - user, - fun({user, Id, Cookie, Pseudo, Date_creation, Date_derniere_connexion, Css}) -> - {user, Id, Cookie, Pseudo, "", "", "", Date_creation, Date_derniere_connexion, Css} - end, - record_info(fields, user), - user +% Efface tous les users, minichat_reponse et minichat. +reset() -> + mnesia:clear_table(counter), + mnesia:clear_table(user), + mnesia:clear_table(reponse_minichat), + mnesia:clear_table(minichat), + mnesia:clear_table(ip_table), + % crée l'utilisateur root + mnesia:transaction(fun() -> + User = #user{id = 0, pseudo = "Sys", login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true}, + mnesia:write(User), + User + end). + + +% Ajoute un nouveau user et le renvoie +nouveau_user(Pseudo, Cookie) -> + F = fun() -> + Id = nouvel_id(user), + User = #user{id = Id, cookie = Cookie, pseudo = Pseudo, date_creation = now(), date_derniere_connexion = now()}, + mnesia:write(User), + User + end, + resultat_transaction(mnesia:transaction(F)). + + +% Ajoute un nouveau user et le renvoie +nouveau_user(Login, Password, Cookie) -> + F = fun() -> + Id = nouvel_id(user), + User = #user{id = Id, cookie = Cookie, pseudo = Login, login = Login, password = Password, date_creation = now(), date_derniere_connexion = now()}, + mnesia:write(User), + User + end, + resultat_transaction(mnesia:transaction(F)). + + +% Mise à par Cookie les autres peuvent être undefined ce qui veut dire qu'ils ne seront pas modifié. +set_profile(Cookie, Login, Password, Pseudo, Email, Css, Nick_format, Page_principale, Conversations) -> + if Nick_format =:= nick; Nick_format =:= login; Nick_format =:= nick_login -> + resultat_transaction(mnesia:transaction( + fun() -> + case user_by_cookie(Cookie) of + {ok, User} -> + case user_by_login(Login) of + {ok, U} when User#user.login =/= [], U#user.id =/= User#user.id -> + login_deja_pris; + _ -> + User_modifie = User#user{ + % TODO : pourquoi ne pas tester avec la valeur "undefined" plutôt qu'avec "is_list" ? + % TODO : validation plus strict des données (pas de page négative dans les conv par exemple) + login = if is_list(Login) -> Login; true -> User#user.login end, + password = if is_list(Password) andalso Password =/= [] -> Password; true -> User#user.password end, + pseudo = if is_list(Pseudo) -> Pseudo; true -> User#user.pseudo end, + email = if is_list(Email) -> Email; true -> User#user.email end, + css = if is_list(Css) -> Css; true -> User#user.css end, + nick_format = Nick_format, + page_principale = if is_integer(Page_principale), Page_principale > 0 -> Page_principale; true -> User#user.page_principale end, + conversations = if is_list(Conversations) -> Conversations; true -> User#user.conversations end + }, + mnesia:write(User_modifie), + ok + end; + _ -> erreur + end + end + )); + true -> + erreur + end. + + +% Met à jour la date de la dernière connexion d'un utilisateur à maintenant +update_date_derniere_connexion(User_id) -> + mnesia:transaction( + fun() -> + case mnesia:wread({user, User_id}) of + [User] -> + mnesia:write(User#user{date_derniere_connexion = now()}); + _ -> + mnesia:abort("update_date_derniere_connexion: User inconnu") + end + end + ). + + +% Met à jour l'ip d'un user +update_ip(User_id, IP) -> + mnesia:transaction( + fun() -> + case mnesia:wread({user, User_id}) of + [User] -> + mnesia:write(User#user{last_ip = IP}); + _ -> + mnesia:abort("update_ip: User inconnu") + end + end + ). + + +% Met à jour le pseudo du user +update_pseudo_user(UserId, Pseudo) -> + mnesia:transaction( + fun() -> + case mnesia:wread({user, UserId}) of + [User] when User#user.pseudo =/= Pseudo -> + mnesia:write(User#user{pseudo = Pseudo}); + _ -> + mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour") + end + end ). + -vers_version3() -> - mnesia:transform_table( - user, - fun({user, Id, Cookie, Pseudo, Login, Password, Email, Date_creation, Date_derniere_connexion, Css}) -> - {user, Id, Cookie, Pseudo, Login, Password, Email, Date_creation, Date_derniere_connexion, Css, 0} +% Renvoie tous les users. +users() -> + resultat_transaction(mnesia:transaction(fun() -> + qlc:e(qlc:q([E || E <- mnesia:table(user)])) + end)). + + +% Est-ce qu'un utilisateur existe en fonction de son cookie ? +% Renvoie {ok, User} ou erreur +user_by_cookie(Cookie) -> + resultat_transaction(mnesia:transaction( + fun() -> + Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.cookie =:= Cookie])), + case Users of + [User] -> {ok, User}; + _ -> erreur + end + end + )). + + +user_by_id(ID) -> + resultat_transaction(mnesia:transaction( + fun() -> + Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.id =:= ID])), + case Users of + [User] -> {ok, User}; + _ -> erreur + end + end + )). + + +user_by_login(Login) -> + resultat_transaction(mnesia:transaction( + fun() -> + Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.login =:= Login])), + case Users of + [User] -> {ok, User}; + _ -> erreur + end + end + )). + + +toggle_ek_master(User_id) -> + resultat_transaction(mnesia:transaction( + fun() -> + Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.id =:= User_id])), + case Users of + [User] -> + mnesia:write(User#user{ek_master = not User#user.ek_master}); + _ -> erreur + end + end + )). + + +user_by_login_password(Login, Password) -> + resultat_transaction(mnesia:transaction( + fun() -> + Users = qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.login =:= Login, E#user.password =:= Password])), + case Users of + [User] -> {ok, User}; + _ -> erreur + end + end + )). + + +% Renvoie {ok, User} où User est un #user possédant le message donné. +user_by_mess(Id) -> + resultat_transaction(mnesia:transaction( + fun() -> + case qlc:e(qlc:q([U || U <- mnesia:table(user), M <- mnesia:table(minichat), M#minichat.id =:= Id, M#minichat.auteur_id =:= U#user.id])) of + [User] -> {ok, User}; + _ -> erreur + end + end + )). + + +% Ajoute un message. Repond_A est une liste d'id auquel le message répond +% retourne soit l'id du message soit erreur. +nouveau_message(Mess, Auteur_id, Repond_A) -> + % regarde si les id 'Repond_A' existent + F = fun() -> + Nb_id_trouve = length(qlc:e(qlc:q([E#minichat.id || E <- mnesia:table(minichat), lists:member(E#minichat.id, Repond_A)]))), + % est-ce que l'auteur existe ? + Auteur = case qlc:e(qlc:q([E || E <- mnesia:table(user), E#user.id =:= Auteur_id])) of + [A] -> A; + _ -> throw("L'auteur du message est introuvable") + end, + if Nb_id_trouve =/= length(Repond_A) -> throw("Un ou plusieurs messages introuvable"); + true -> ok end, - record_info(fields, user), - user + % compare les dernière + Delta = delta_date_ms(Auteur#user.date_derniere_connexion, now()), + Nouvel_indice_flood = Auteur#user.indice_flood + if Delta =< ?DUREE_SPAM -> 2; true -> -1 end, + Auteur_maj = Auteur#user{ + indice_flood = if Nouvel_indice_flood > ?INDICE_SPAM_MAX -> ?INDICE_SPAM_MAX; Nouvel_indice_flood < 0 -> 0; true -> Nouvel_indice_flood end, + date_derniere_connexion = now() + }, + % est-ce que l'auteur à trop floodé ? + if Auteur#user.indice_flood =/= ?INDICE_SPAM_MAX, Auteur_maj#user.indice_flood =:= ?INDICE_SPAM_MAX, Delta =< ?DUREE_BLOCAGE_SPAM -> + mnesia:write(Auteur#user{indice_flood = Auteur_maj#user.indice_flood}), + nouveau_message_sys(Auteur#user.pseudo ++ "(" ++ Auteur#user.login ++ ") est bloqué pour " ++ integer_to_list(trunc(?DUREE_BLOCAGE_SPAM / 1000)) ++ " secondes pour cause de flood.."); + Auteur#user.indice_flood =:= ?INDICE_SPAM_MAX, Delta =< ?DUREE_BLOCAGE_SPAM -> + erreur; + true -> + mnesia:write(Auteur_maj), + Id = nouvel_id(minichat), + inserer_reponses(Id, Repond_A), + mnesia:write(#minichat{id=Id, auteur_id=Auteur#user.id, date=now(), pseudo=Auteur#user.pseudo, contenu=Mess}), + Id + end + end, + resultat_transaction(mnesia:transaction(F)). + +% Définit Id_repondant comme étant la réponse à Ids. Ids est une liste d'id. +inserer_reponses(Id_repondant, [Id_mess | Reste]) -> + mnesia:write(#reponse_minichat{repondant = Id_repondant, cible = Id_mess}), + inserer_reponses(Id_repondant, Reste); +inserer_reponses(_, []) -> + ok. + + +% Permet de créer un message système. +% Renvoie l'id du message système +nouveau_message_sys(Mess) -> + {ok, Root} = user_by_id(0), + mnesia:transaction( + fun() -> + Id = nouvel_id(minichat), + mnesia:write(#minichat{id=Id, auteur_id=0, date=now(), pseudo=Root#user.pseudo, contenu=Mess}) + end ). - + + +% Renvoie N messages se trouvant sur la première page +messages(N) -> + messages(N, 1). + + +% Renvoie N messages se trouvant sur la page P +messages(N, P) -> + F = fun() -> + C = qlc:cursor(qlc:q([E || E <- qlc:keysort(2, mnesia:table(minichat), [{order, descending}])])), + if P > 1 -> qlc:next_answers(C, N * (P - 1)); + true -> ok + end, + R = qlc:next_answers(C, N), + qlc:delete_cursor(C), + lists:reverse(R) + end, + resultat_transaction(mnesia:transaction(F)). + + +% Renvoie les messages manquants pour la page P en sachant qu'il y a N message +% par page et que le dernier message que l'on possède est Id +messages(Id, N, P) -> + lists:filter(fun (M) -> M#minichat.id > Id end, messages(N, P)). + + +% Renvoie {ok, #minichat} (voir #minichat de euphorik_bd.hrl) à partir de son id. +message_by_id(Id) -> + case resultat_transaction(mnesia:transaction( + fun() -> + qlc:e(qlc:q([E || E <- qlc:keysort(2, mnesia:table(minichat), [{order, ascending}]), Id =:= E#minichat.id])) + end + )) of + [M] -> {ok, M}; + _ -> erreur + end. + + +% Renvoie une liste de message (voir #minichat de euphorik_bd.hrl) à partir d'une liste d'id (Ids). +messages_by_ids(Ids) -> + resultat_transaction(mnesia:transaction( + fun() -> + % TODO : optimisations ? serait-ce du O(n) ? + Query = qlc:q([E || E <- qlc:keysort(2, mnesia:table(minichat), [{order, ascending}]), lists:any(fun(Id) -> Id =:= E#minichat.id end, Ids)]), + qlc:e(Query) + end + )). + + +% Est-ce qu'un message existe ? Renvoie un boolean. +% TODO : ya pas plus simple ? +message_existe(Id) -> + resultat_transaction(mnesia:transaction(fun() -> + length(qlc:e(qlc:q([E#minichat.id || E <- mnesia:table(minichat), E#minichat.id =:= Id]))) =:= 1 + end)). + + +% Renvoie les reponses (utilisé normalement uniquement pendant le debug). +reponses() -> + F = fun() -> + qlc:e(qlc:q([E || E <- mnesia:table(reponse_minichat)])) + end, + resultat_transaction(mnesia:transaction(F)). + + +% Renvoie les messages auquel M_id répond. +repond_a(M_id) -> + resultat_transaction(mnesia:transaction( + fun() -> + qlc:e(qlc:q( + [M || E <- mnesia:table(reponse_minichat), + M <- mnesia:table(minichat), + E#reponse_minichat.repondant =:= M_id, + M#minichat.id =:= E#reponse_minichat.cible])) + end + )). + + +% Est-ce que le message Id_mess est une réponse d'une message de Id_user ? +est_une_reponse_a_user(Id_user, Id_mess) -> + case mnesia:transaction( + fun() -> + qlc:e(qlc:q([ + M#minichat.auteur_id || M <- mnesia:table(minichat), R <- mnesia:table(reponse_minichat), + M#minichat.auteur_id =:= Id_user, M#minichat.id =:= R#reponse_minichat.cible, R#reponse_minichat.repondant =:= Id_mess + ]), [{unique_all, true}]) + end + ) of + {atomic, [_]} -> true; + _ -> false + end. -% exemple de peuplage de la BD, utilisé pour les tests -peupler() -> + +% Est-ce que Id_user à répondu au message Id_mess +a_repondu_a_message(Id_user, Id_mess) -> + case mnesia:transaction( + fun() -> + qlc:e(qlc:q([ + M#minichat.auteur_id || M <- mnesia:table(minichat), R <- mnesia:table(reponse_minichat), + R#reponse_minichat.cible =:= Id_mess, R#reponse_minichat.repondant =:= M#minichat.id, M#minichat.auteur_id =:= Id_user + ]), [{unique_all, true}]) + end + ) of + {atomic, [_]} -> true; + _ -> false + end. + + +% Est-ce que Id_user possède Id_mess ? +possede_message(Id_user, Id_mess) -> + case mnesia:transaction( + fun() -> + qlc:e(qlc:q([E#minichat.auteur_id || E <- mnesia:table(minichat), E#minichat.id =:= Id_mess])) + end + ) of + {atomic, [Id_user | []]} -> true; + _ -> false + end. + + +ip_table() -> + resultat_transaction(mnesia:transaction( + fun() -> + qlc:e(qlc:q([IP || IP <- mnesia:table(ip_table)])) + end + )). + + +% Bannie une ip pour un certain temps (en minute). +ban(IP, Duration) -> mnesia:transaction( fun() -> - mnesia:write({minichat, now(), "Pierre", "Salut tout le monde"}), - mnesia:write({minichat, now(), "Paul", "Salut à toi !"}) + case mnesia:wread({ip_table, IP}) of + [IP_tuple] -> + mnesia:write(IP_tuple#ip_table{ban = now(), ban_duration = Duration}); + _ -> + mnesia:write(#ip_table{ip = IP, ban = now(), ban_duration = Duration}) + end end ). + + +% Débanni une ip +deban(IP) -> + ban(IP, 0). + + +% Renvoie soit {true, Temps} où Temps est le temps en minutes pendant lequel le user est encore banni +% ou false. +est_banni(User_id) -> + resultat_transaction(mnesia:transaction( + fun() -> + case qlc:e(qlc:q([ + {IP#ip_table.ban, IP#ip_table.ban_duration} || + U <- mnesia:table(user), + U#user.id =:= User_id, + IP <- mnesia:table(ip_table), + IP#ip_table.ip =:= U#user.last_ip + ])) of + [{Ban, Ban_duration}] -> + Echeance = date_plus_minutes(Ban, Ban_duration), + Now = now(), + if Echeance < Now -> % l'échéance est passée + false; + true -> + {true, trunc(delta_date_ms(Echeance, Now) / 1000 / 60)} + end; + _ -> + false + end + end + )). + + +% Ban est une date tel que retourner par now(). +% Ban_duration est un temps en minutes. +% retourne une date. +date_plus_minutes(Ban, Ban_duration) -> + Duration_sec = Ban_duration * 60, + {MegaSec, Sec, MicroSec} = Ban, + {MegaSec + if Sec + Duration_sec >= 1000000 -> 1; true -> 0 end,(Sec + Duration_sec) rem 1000000, MicroSec}. + + +% Si deux enregistrements consequtifs de la même IP sont fait en moins d'une seconde alors +% ip_table.nb_try_register est incrémenté de 1 sinon il est décrémenté de 1 (jusqu'a 0). +% Si ip_table.nb_try_register vaut 5 alors l'ip ne peux plus s'enregistrer pour une heure. +can_register(IP) -> + resultat_transaction(mnesia:transaction( + fun() -> + case qlc:e(qlc:q([I || I <- mnesia:table(ip_table), I#ip_table.ip =:= IP])) of + [] -> + mnesia:write(#ip_table{ip = IP, date_last_try_register = now()}), + true; + [T] -> + Delta = delta_date_ms(T#ip_table.date_last_try_register, now()), + if T#ip_table.nb_try_register =:= ?NB_MAX_FLOOD_REGISTER, Delta < ?TEMPS_BAN_FLOOD_REGISTER -> + false; + true -> + mnesia:write(#ip_table{ + ip = IP, + date_last_try_register = now(), + 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 + }), + true + end + end + end + )). + + +update_version(1) -> + mnesia:transform_table( + ip_table, + fun() -> null end, + record_info(fields, ip_table), + ip_table + ). + + +% Renvoie le résultat d'une transaction (en décomposant le tuple fournit) +resultat_transaction({_, T}) -> + T. + + +% Retourne la difference entre deux timestamp (erlang:now()) en miliseconde +delta_date_ms(D1, D2) -> + 1000000000 * abs(element(1, D1) - element(1, D2)) + 1000 * abs(element(2, D1) - element(2, D2)) + trunc(abs(element(3, D1) - element(3, D2)) / 1000). + + +% Bizarre, cette fonction n'existe pas dans la stdlib. +% Pas utilisé mais bon ca me fait de la peine de l'enlever. +ceiling(X) -> + T = trunc(X), + case (X - T) of + Neg when Neg < 0 -> T; + Pos when Pos > 0 -> T + 1; + _ -> T + end. - -tester() -> - ok. +% Renvoie un nouvel id pour une table donnée +nouvel_id(Table) -> + mnesia:dirty_update_counter(counter, Table, 1). + \ No newline at end of file