2 % Ce module permet de gérer les données persistantes lié au site d'euphorik.ch.
3 % Il permet d'ajouter des message, de demande les messages sur une page donnée, etc..
4 % Ce module utilise une base mnesia.
19 update_date_derniere_connexion
/1,
26 user_by_login_password
/2,
32 nouveau_message_sys
/1,
41 est_une_reponse_a_user
/2,
42 a_repondu_a_message
/2,
64 resultat_transaction
/1
67 -include("../include/euphorik_bd.hrl").
68 -include("../include/euphorik_defines.hrl").
69 -include_lib("stdlib/include/qlc.hrl").
72 % Instructions pour créer une nouvelle base :
73 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
74 % voir doc/installation.txt
76 % >euphorik_bd:create().
79 mnesia:delete_schema([node()]),
80 mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
85 mnesia:create_table(counter
, [
86 {attributes
, record_info(fields
, counter
)},
87 {disc_copies
, [node()]}
89 mnesia:create_table(minichat
, [
90 {attributes
, record_info(fields
, minichat
)},
92 {disc_copies
, [node()]}
94 mnesia:create_table(reponse_minichat
, [
96 {attributes
, record_info(fields
, reponse_minichat
)},
98 {disc_copies
, [node()]}
100 mnesia:create_table(user
, [
101 {attributes
, record_info(fields
, user
)},
102 {index
, [cookie
, login
]},
103 {disc_copies
, [node()]}
105 mnesia:create_table(ip_table
, [
106 {attributes
, record_info(fields
, ip_table
)},
107 {disc_copies
, [node()]}
109 mnesia:create_table(troll
, [
110 {attributes
, record_info(fields
, troll
)},
111 {index
, [date_post
]},
112 {disc_copies
, [node()]}
116 % Connexion à la base de données de yaws sur overnux
118 connect(yaws@flynux
).
121 mnesia:change_config(extra_db_nodes
, [Node
]).
124 % Efface tous les users, minichat_reponse et minichat.
126 mnesia:clear_table(counter
),
127 mnesia:clear_table(user
),
128 mnesia:clear_table(reponse_minichat
),
129 mnesia:clear_table(minichat
),
130 mnesia:clear_table(troll
),
131 mnesia:clear_table(ip_table
),
132 % crée l'utilisateur root
133 mnesia:transaction(fun() ->
134 User
= #user
{id
= 0, pseudo
= "Sys", login
= "Sys", date_creation
= now(), date_derniere_connexion
= now(), ek_master
= true
},
140 % Ajoute un nouveau user et le renvoie
141 nouveau_user(Pseudo
, Cookie
) ->
143 Id
= nouvel_id(user
),
144 User
= #user
{id
= Id
, cookie
= Cookie
, pseudo
= Pseudo
, date_creation
= now(), date_derniere_connexion
= now()},
148 resultat_transaction(mnesia:transaction(F
)).
151 % Ajoute un nouveau user et le renvoie
152 nouveau_user(Login
, Password
, Cookie
) ->
154 Id
= nouvel_id(user
),
155 User
= #user
{id
= Id
, cookie
= Cookie
, pseudo
= Login
, login
= Login
, password
= Password
, date_creation
= now(), date_derniere_connexion
= now()},
159 resultat_transaction(mnesia:transaction(F
)).
162 % Mise à par Cookie les autres peuvent être undefined ce qui veut dire qu'ils ne seront pas modifié.
163 set_profile(Cookie
, Login
, Password
, Pseudo
, Email
, Css
, Nick_format
, Page_principale
, Conversations
) ->
164 if Nick_format
=:= nick
; Nick_format
=:= login
; Nick_format
=:= nick_login
->
165 resultat_transaction(mnesia:transaction(
167 case user_by_cookie(Cookie
) of
169 case user_by_login(Login
) of
170 {ok
, U
} when Login
=/= [], U#user
.id
=/= User#user
.id
->
173 User_modifie
= User#user
{
174 % TODO : pourquoi ne pas tester avec la valeur "undefined" plutôt qu'avec "is_list" ?
175 % TODO : validation plus strict des données (pas de page négative dans les conv par exemple)
176 login
= if is_list(Login
) -> Login
; true
-> User#user
.login
end,
177 password
= if is_list(Password
) andalso Password
=/= [] -> Password
; true
-> User#user
.password
end,
178 pseudo
= if is_list(Pseudo
) -> Pseudo
; true
-> User#user
.pseudo
end,
179 email
= if is_list(Email
) -> Email
; true
-> User#user
.email
end,
180 css
= if is_list(Css
) -> Css
; true
-> User#user
.css
end,
181 nick_format
= Nick_format
,
182 page_principale
= if is_integer(Page_principale
), Page_principale
> 0 -> Page_principale
; true
-> User#user
.page_principale
end,
183 conversations
= if is_list(Conversations
) -> Conversations
; true
-> User#user
.conversations
end
185 mnesia:write(User_modifie
),
197 % Met à jour la date de la dernière connexion d'un utilisateur à maintenant
198 update_date_derniere_connexion(User_id
) ->
201 case mnesia:wread({user
, User_id
}) of
203 mnesia:write(User#user
{date_derniere_connexion
= now()});
205 mnesia:abort("update_date_derniere_connexion: User inconnu")
211 % Met à jour l'ip d'un user
212 update_ip(User_id
, IP
) ->
215 case mnesia:wread({user
, User_id
}) of
217 mnesia:write(User#user
{last_ip
= IP
});
219 mnesia:abort("update_ip: User inconnu")
225 % Met à jour le pseudo du user
226 update_pseudo_user(UserId
, Pseudo
) ->
229 case mnesia:wread({user
, UserId
}) of
230 [User
] when User#user
.pseudo
=/= Pseudo
->
231 mnesia:write(User#user
{pseudo
= Pseudo
});
233 mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour")
239 % Renvoie tous les users.
241 resultat_transaction(mnesia:transaction(fun() ->
242 qlc:e(qlc:q([E
|| E
<- mnesia:table(user
)]))
246 % Est-ce qu'un utilisateur existe en fonction de son cookie ?
247 % Renvoie {ok, User} ou erreur
248 user_by_cookie(Cookie
) ->
249 resultat_transaction(mnesia:transaction(
251 case qlc:e(qlc:q([E
|| E
<- mnesia:table(user
), E#user
.cookie
=:= Cookie
])) of
252 [User
] -> {ok
, User
};
260 resultat_transaction(mnesia:transaction(
262 case qlc:e(qlc:q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= ID
])) of
263 [User
] -> {ok
, User
};
270 user_by_login(Login
) ->
271 resultat_transaction(mnesia:transaction(
273 Users
= qlc:e(qlc:q([E
|| E
<- mnesia:table(user
), E#user
.login
=:= Login
])),
275 [User
] -> {ok
, User
};
282 toggle_ek_master(User_id
) ->
283 resultat_transaction(mnesia:transaction(
285 Users
= qlc:e(qlc:q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= User_id
])),
288 mnesia:write(User#user
{ek_master
= not User#user
.ek_master
});
295 user_by_login_password(Login
, Password
) ->
296 resultat_transaction(mnesia:transaction(
298 case qlc:e(qlc:q([E
|| E
<- mnesia:table(user
), E#user
.login
=:= Login
, E#user
.password
=:= Password
])) of
299 [User
| _
] -> {ok
, User
};
306 % Renvoie {ok, User} où User est un #user possédant le message donné.
308 resultat_transaction(mnesia:transaction(
310 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
311 [User
| _
] -> {ok
, User
};
318 % Ajoute un message. Repond_A est une liste d'id auquel le message répond
319 % retourne soit l'id du message soit erreur.
320 nouveau_message(Mess
, Auteur_id
, Repond_A
) ->
321 % regarde si les id 'Repond_A' existent
323 Nb_id_trouve
= length(qlc:e(qlc:q([E#minichat
.id
|| E
<- mnesia:table(minichat
), lists:member(E#minichat
.id
, Repond_A
)]))),
324 % est-ce que l'auteur existe ?
325 Auteur
= case qlc:e(qlc:q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= Auteur_id
])) of
327 _
-> throw("L'auteur du message est introuvable")
329 if Nb_id_trouve
=/= length(Repond_A
) -> throw("Un ou plusieurs messages introuvable");
332 % compare les dernière
333 Delta
= delta_date_ms(Auteur#user
.date_derniere_connexion
, now()),
334 Nouvel_indice_flood
= Auteur#user
.indice_flood
+ if Delta
=< ?DUREE_SPAM
-> 2; true
-> -1 end,
335 Auteur_maj
= Auteur#user
{
336 indice_flood
= if Nouvel_indice_flood
> ?INDICE_SPAM_MAX
-> ?INDICE_SPAM_MAX
; Nouvel_indice_flood
< 0 -> 0; true
-> Nouvel_indice_flood
end,
337 date_derniere_connexion
= now()
339 % est-ce que l'auteur à trop floodé ?
340 if Auteur#user
.indice_flood
=/= ?INDICE_SPAM_MAX
, Auteur_maj#user
.indice_flood
=:= ?INDICE_SPAM_MAX
, Delta
=< ?DUREE_BLOCAGE_SPAM
->
341 mnesia:write(Auteur#user
{indice_flood
= Auteur_maj#user
.indice_flood
}),
342 nouveau_message_sys(Auteur#user
.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.");
343 Auteur#user
.indice_flood
=:= ?INDICE_SPAM_MAX
, Delta
=< ?DUREE_BLOCAGE_SPAM
->
346 mnesia:write(Auteur_maj
),
347 Id
= nouvel_id(minichat
),
348 inserer_reponses(Id
, Repond_A
),
349 mnesia:write(#minichat
{id
=Id
, auteur_id
=Auteur#user
.id
, date=now(), pseudo
=Auteur#user
.pseudo
, contenu
=Mess
}),
353 resultat_transaction(mnesia:transaction(F
)).
355 % Définit Id_repondant comme étant la réponse à Ids. Ids est une liste d'id.
356 inserer_reponses(Id_repondant
, [Id_mess
| Reste
]) ->
357 mnesia:write(#reponse_minichat
{repondant
= Id_repondant
, cible
= Id_mess
}),
358 inserer_reponses(Id_repondant
, Reste
);
359 inserer_reponses(_
, []) ->
363 % Permet de créer un message système.
364 % Renvoie l'id du message système
365 nouveau_message_sys(Mess
) ->
366 {ok
, Root
} = user_by_id(0),
369 Id
= nouvel_id(minichat
),
370 mnesia:write(#minichat
{id
=Id
, auteur_id
=0, date=now(), pseudo
=Root#user
.pseudo
, contenu
=Mess
})
375 % Renvoie N messages se trouvant sur la première page
380 % Renvoie N messages se trouvant sur la page P
383 C
= qlc:cursor(qlc:q([E
|| E
<- qlc:keysort(2, mnesia:table(minichat
), [{order
, descending
}])])),
384 if P
> 1 -> qlc:next_answers(C
, N
* (P
- 1));
387 R
= qlc:next_answers(C
, N
),
388 qlc:delete_cursor(C
),
391 resultat_transaction(mnesia:transaction(F
)).
394 % Renvoie les messages manquants pour la page P en sachant qu'il y a N message
395 % par page et que le dernier message que l'on possède est Id
396 messages(Id
, N
, P
) ->
397 lists:filter(fun (M
) -> M#minichat
.id
> Id
end, messages(N
, P
)).
400 % Renvoie {ok, #minichat} (voir #minichat de euphorik_bd.hrl) à partir de son id.
402 case resultat_transaction(mnesia:transaction(
404 qlc:e(qlc:q([E
|| E
<- qlc:keysort(2, mnesia:table(minichat
), [{order
, ascending
}]), Id
=:= E#minichat
.id
]))
412 % Renvoie une liste de message (voir #minichat de euphorik_bd.hrl) à partir d'une liste d'id (Ids).
413 messages_by_ids(Ids
) ->
414 resultat_transaction(mnesia:transaction(
416 % TODO : optimisations ? serait-ce du O(n) ?
417 Query
= qlc:q([E
|| E
<- qlc:keysort(2, mnesia:table(minichat
), [{order
, ascending
}]), lists:any(fun(Id
) -> Id
=:= E#minichat
.id
end, Ids
)]),
423 % Est-ce qu'un message existe ? Renvoie un boolean.
424 % TODO : ya pas plus simple ?
425 message_existe(Id
) ->
426 resultat_transaction(mnesia:transaction(fun() ->
427 length(qlc:e(qlc:q([E#minichat
.id
|| E
<- mnesia:table(minichat
), E#minichat
.id
=:= Id
]))) =:= 1
431 % Renvoie les reponses (utilisé normalement uniquement pendant le debug).
434 qlc:e(qlc:q([E
|| E
<- mnesia:table(reponse_minichat
)]))
436 resultat_transaction(mnesia:transaction(F
)).
439 % Renvoie les messages auquel M_id répond.
441 resultat_transaction(mnesia:transaction(
444 [M
|| E
<- mnesia:table(reponse_minichat
),
445 M
<- mnesia:table(minichat
),
446 E#reponse_minichat
.repondant
=:= M_id
,
447 M#minichat
.id
=:= E#reponse_minichat
.cible
]))
452 % Est-ce que le message Id_mess est une réponse d'une message de Id_user ?
453 est_une_reponse_a_user(Id_user
, Id_mess
) ->
454 case mnesia:transaction(
457 M#minichat
.auteur_id
|| M
<- mnesia:table(minichat
), R
<- mnesia:table(reponse_minichat
),
458 M#minichat
.auteur_id
=:= Id_user
, M#minichat
.id
=:= R#reponse_minichat
.cible
, R#reponse_minichat
.repondant
=:= Id_mess
459 ]), [{unique_all
, true
}])
462 {atomic
, [_
]} -> true
;
467 % Est-ce que Id_user à répondu au message Id_mess
468 a_repondu_a_message(Id_user
, Id_mess
) ->
469 case mnesia:transaction(
472 M#minichat
.auteur_id
|| M
<- mnesia:table(minichat
), R
<- mnesia:table(reponse_minichat
),
473 R#reponse_minichat
.cible
=:= Id_mess
, R#reponse_minichat
.repondant
=:= M#minichat
.id
, M#minichat
.auteur_id
=:= Id_user
474 ]), [{unique_all
, true
}])
477 {atomic
, [_
]} -> true
;
482 % Est-ce que Id_user possède Id_mess ?
483 possede_message(Id_user
, Id_mess
) ->
484 case mnesia:transaction(
486 qlc:e(qlc:q([E#minichat
.auteur_id
|| E
<- mnesia:table(minichat
), E#minichat
.id
=:= Id_mess
]))
489 {atomic
, [Id_user
| []]} -> true
;
495 resultat_transaction(mnesia:transaction(
497 qlc:e(qlc:q([IP
|| IP
<- mnesia:table(ip_table
)]))
502 % Bannie une ip pour un certain temps (en minute).
506 case mnesia:wread({ip_table
, IP
}) of
508 mnesia:write(IP_tuple#ip_table
{ban
= now(), ban_duration
= Duration
});
510 mnesia:write(#ip_table
{ip
= IP
, ban
= now(), ban_duration
= Duration
})
521 % Renvoie soit {true, Temps} où Temps est le temps en minutes pendant lequel le user est encore banni
523 est_banni(User_id
) ->
524 resultat_transaction(mnesia:transaction(
527 {IP#ip_table
.ban
, IP#ip_table
.ban_duration
} ||
528 U
<- mnesia:table(user
),
529 U#user
.id
=:= User_id
,
530 IP
<- mnesia:table(ip_table
),
531 IP#ip_table
.ip
=:= U#user
.last_ip
533 [{Ban
, Ban_duration
}] ->
534 Echeance
= date_plus_minutes(Ban
, Ban_duration
),
536 if Echeance
< Now
-> % l'échéance est passée
539 {true
, trunc(delta_date_ms(Echeance
, Now
) / 1000 / 60)}
548 % Ban est une date tel que retourner par now().
549 % Ban_duration est un temps en minutes.
551 date_plus_minutes(Ban
, Ban_duration
) ->
552 Duration_sec
= Ban_duration
* 60,
553 {MegaSec
, Sec
, MicroSec
} = Ban
,
554 {MegaSec
+ if Sec
+ Duration_sec
>= 1000000 -> 1; true
-> 0 end,(Sec
+ Duration_sec
) rem
1000000, MicroSec
}.
557 % Si deux enregistrements consequtifs de la même IP sont fait en moins d'une seconde alors
558 % ip_table.nb_try_register est incrémenté de 1 sinon il est décrémenté de 1 (jusqu'a 0).
559 % Si ip_table.nb_try_register vaut 5 alors l'ip ne peux plus s'enregistrer pour une heure.
561 resultat_transaction(mnesia:transaction(
563 case qlc:e(qlc:q([I
|| I
<- mnesia:table(ip_table
), I#ip_table
.ip
=:= IP
])) of
565 mnesia:write(#ip_table
{ip
= IP
, date_last_try_register
= now()}),
568 Delta
= delta_date_ms(T#ip_table
.date_last_try_register
, now()),
569 if T#ip_table
.nb_try_register
=:= ?NB_MAX_FLOOD_REGISTER
, Delta
< ?TEMPS_BAN_FLOOD_REGISTER
->
572 mnesia:write(#ip_table
{
574 date_last_try_register
= now(),
575 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
584 % Renvoie tous les trolls.
586 resultat_transaction(mnesia:transaction(
588 qlc:e(qlc:q([T
|| T
<- qlc:keysort(2, mnesia:table(troll
))]))
592 % Renvoie les trolls manquants posté après Last_id.
593 % Si pas de trolls alors attend un événement tel qu'un ajout, une modification ou une suppression.
600 case mnesia:subscribe({table
, troll
, detailed
}) of
604 case resultat_transaction(mnesia:transaction(
606 qlc:e(qlc:q([T
|| T
<- qlc:keysort(2, mnesia:table(troll
)), T#troll
.id
> Last_id
, T#troll
.date_post
=:= undefined
]))
609 [] -> % pas de trolls
610 attend_evenement_troll();
616 attend_evenement_troll() ->
617 % s'il n'y a pas de trolls que l'utilisateur n'a pas connaissance alors on attend un événement
619 {mnesia_table_event
, {write
, troll
, Troll
, [_Old_troll
| _
], _
}} ->
621 {mnesia_table_event
, {write
, troll
, Troll
, [], _
}} ->
623 {mnesia_table_event
, {delete
, troll
, {troll
, Id
}, _
, _
}} ->
626 attend_evenement_troll()
627 after 1000 * 60 * 60 ->
632 % Renvoie l'id du nouveau troll
633 % ou max_troll_reached_per_user si le nombre de troll posté par l'utilisateur max a été atteind
634 % ou max_troll_reached si le nombre de troll posté max a été atteind
636 put_troll(User_id
, Content
) ->
637 resultat_transaction(mnesia:transaction(
639 % control le nombre de troll déjà posté
640 Nb_troll_poste_par_user
= length(qlc:e(qlc:q(
642 E#troll
.id
|| E
<- mnesia:table(troll
),
643 E#troll
.id_user
=:= User_id
,
644 E#troll
.date_post
=:= undefined
647 Nb_troll_poste_total
= length(qlc:e(qlc:q(
649 E#troll
.id
|| E
<- mnesia:table(troll
),
650 E#troll
.date_post
=:= undefined
653 User
= user_by_id(User_id
),
656 if Nb_troll_poste_par_user
>= ?NB_MAX_TROLL_WAITING_BY_USER
->
657 max_troll_reached_per_user
;
658 Nb_troll_poste_total
>= ?NB_MAX_TROLL_WAITING
->
661 Id
= nouvel_id(minichat
),
662 mnesia:write(#troll
{id
= Id
, id_user
= User_id
, date_create
= now(), content
= Content
}),
672 % renvoie ok | erreur
673 mod_troll(Troll_id
, Content
) ->
676 case mnesia:wread({troll
, Troll_id
}) of
677 [Troll
= #troll
{date_post
= undefined
}] ->
678 mnesia:write(Troll#troll
{content
= Content
});
680 mnesia:abort("mod_troll: Troll inconnu ou déjà posté")
686 del_troll(Troll_id
) ->
689 case mnesia:wread({troll
, Troll_id
}) of
690 [#troll
{date_post
= undefined
}] ->
691 mnesia:delete({troll
, Troll_id
});
693 mnesia:abort("mod_troll: Troll inconnu ou déjà posté")
699 troll_by_id(Troll_id
) ->
700 resultat_transaction(mnesia:transaction(
702 case qlc:e(qlc:q([T
|| T
<- mnesia:table(troll
), T#troll
.id
=:= Troll_id
])) of
712 mnesia:transform_table(
715 record_info(fields
, ip_table
),
720 % Renvoie le résultat d'une transaction (en décomposant le tuple fournit)
721 resultat_transaction({_
, T
}) ->
725 % Retourne la difference entre deux timestamp (erlang:now()) en miliseconde
726 delta_date_ms(D1
, D2
) ->
727 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).
730 % Bizarre, cette fonction n'existe pas dans la stdlib.
731 % Pas utilisé mais bon ca me fait de la peine de l'enlever.
735 Neg
when Neg
< 0 -> T
;
736 Pos
when Pos
> 0 -> T
+ 1;
741 % Renvoie un nouvel id pour une table donnée
743 mnesia:dirty_update_counter(counter
, Table
, 1).