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,
67 resultat_transaction
/1
70 -import(qlc
, [e
/1, e
/2, q
/1, cursor
/1]).
72 -include("../include/euphorik_bd.hrl").
73 -include("../include/euphorik_defines.hrl").
74 -include_lib("stdlib/include/qlc.hrl").
77 % Instructions pour créer une nouvelle base :
78 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
79 % voir doc/installation.txt
81 % >euphorik_bd:create().
84 mnesia:delete_schema([node()]),
85 mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
90 mnesia:create_table(counter
, [
91 {attributes
, record_info(fields
, counter
)},
92 {disc_copies
, [node()]}
94 mnesia:create_table(minichat
, [
95 {attributes
, record_info(fields
, minichat
)},
97 {disc_copies
, [node()]}
99 mnesia:create_table(reponse_minichat
, [
101 {attributes
, record_info(fields
, reponse_minichat
)},
103 {disc_copies
, [node()]}
105 mnesia:create_table(user
, [
106 {attributes
, record_info(fields
, user
)},
107 {index
, [cookie
, login
]},
108 {disc_copies
, [node()]}
110 mnesia:create_table(ip_table
, [
111 {attributes
, record_info(fields
, ip_table
)},
112 {disc_copies
, [node()]}
114 mnesia:create_table(troll
, [
115 {attributes
, record_info(fields
, troll
)},
116 {index
, [date_post
]},
117 {disc_copies
, [node()]}
121 % Connexion à la base de données de yaws sur overnux
123 connect(yaws@flynux
).
126 mnesia:change_config(extra_db_nodes
, [Node
]).
129 % Efface tous les users, minichat_reponse et minichat.
131 mnesia:clear_table(counter
),
132 mnesia:clear_table(user
),
133 mnesia:clear_table(reponse_minichat
),
134 mnesia:clear_table(minichat
),
135 mnesia:clear_table(troll
),
136 mnesia:clear_table(ip_table
),
137 % crée l'utilisateur root
138 mnesia:transaction(fun() ->
139 User
= #user
{id
= 0, pseudo
= "Sys", login
= "Sys", date_creation
= now(), date_derniere_connexion
= now(), ek_master
= true
},
145 % Ajoute un nouveau user et le renvoie
146 nouveau_user(Pseudo
, Cookie
) ->
148 Id
= nouvel_id(user
),
149 User
= #user
{id
= Id
, cookie
= Cookie
, pseudo
= Pseudo
, date_creation
= now(), date_derniere_connexion
= now()},
153 resultat_transaction(mnesia:transaction(F
)).
156 % Ajoute un nouveau user et le renvoie
157 nouveau_user(Login
, Password
, Cookie
) ->
159 Id
= nouvel_id(user
),
160 User
= #user
{id
= Id
, cookie
= Cookie
, pseudo
= Login
, login
= Login
, password
= Password
, date_creation
= now(), date_derniere_connexion
= now()},
164 resultat_transaction(mnesia:transaction(F
)).
167 % Mise à par Cookie les autres peuvent être undefined ce qui veut dire qu'ils ne seront pas modifié.
168 set_profile(Cookie
, Login
, Password
, Pseudo
, Email
, Css
, Nick_format
, Page_principale
, Conversations
) ->
169 if Nick_format
=:= nick
; Nick_format
=:= login
; Nick_format
=:= nick_login
->
170 resultat_transaction(mnesia:transaction(
172 case user_by_cookie(Cookie
) of
174 case user_by_login(Login
) of
175 {ok
, U
} when Login
=/= [], U#user
.id
=/= User#user
.id
->
178 User_modifie
= User#user
{
179 % TODO : pourquoi ne pas tester avec la valeur "undefined" plutôt qu'avec "is_list" ?
180 % TODO : validation plus strict des données (pas de page négative dans les conv par exemple)
181 login
= if is_list(Login
) -> Login
; true
-> User#user
.login
end,
182 password
= if is_list(Password
) andalso Password
=/= [] -> Password
; true
-> User#user
.password
end,
183 pseudo
= if is_list(Pseudo
) -> Pseudo
; true
-> User#user
.pseudo
end,
184 email
= if is_list(Email
) -> Email
; true
-> User#user
.email
end,
185 css
= if is_list(Css
) -> Css
; true
-> User#user
.css
end,
186 nick_format
= Nick_format
,
187 page_principale
= if is_integer(Page_principale
), Page_principale
> 0 -> Page_principale
; true
-> User#user
.page_principale
end,
188 conversations
= if is_list(Conversations
) -> Conversations
; true
-> User#user
.conversations
end
190 mnesia:write(User_modifie
),
202 % Met à jour la date de la dernière connexion d'un utilisateur à maintenant
203 update_date_derniere_connexion(User_id
) ->
206 case mnesia:wread({user
, User_id
}) of
208 mnesia:write(User#user
{date_derniere_connexion
= now()});
210 mnesia:abort("update_date_derniere_connexion: User inconnu")
216 % Met à jour l'ip d'un user
217 update_ip(User_id
, IP
) ->
220 case mnesia:wread({user
, User_id
}) of
222 mnesia:write(User#user
{last_ip
= IP
});
224 mnesia:abort("update_ip: User inconnu")
230 % Met à jour le pseudo du user
231 update_pseudo_user(UserId
, Pseudo
) ->
234 case mnesia:wread({user
, UserId
}) of
235 [User
] when User#user
.pseudo
=/= Pseudo
->
236 mnesia:write(User#user
{pseudo
= Pseudo
});
238 mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour")
244 % Renvoie tous les users.
246 resultat_transaction(mnesia:transaction(fun() ->
247 e(q([E
|| E
<- mnesia:table(user
)]))
251 % Est-ce qu'un utilisateur existe en fonction de son cookie ?
252 % Renvoie {ok, User} ou erreur
253 user_by_cookie(Cookie
) ->
254 resultat_transaction(mnesia:transaction(
256 case e(q([E
|| E
<- mnesia:table(user
), E#user
.cookie
=:= Cookie
])) of
257 [User
] -> {ok
, User
};
265 resultat_transaction(mnesia:transaction(
267 case e(q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= ID
])) of
268 [User
] -> {ok
, User
};
275 user_by_login(Login
) ->
276 resultat_transaction(mnesia:transaction(
278 Users
= e(q([E
|| E
<- mnesia:table(user
), E#user
.login
=:= Login
])),
280 [User
] -> {ok
, User
};
287 toggle_ek_master(User_id
) ->
288 resultat_transaction(mnesia:transaction(
290 Users
= e(q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= User_id
])),
293 mnesia:write(User#user
{ek_master
= not User#user
.ek_master
});
300 user_by_login_password(Login
, Password
) ->
301 resultat_transaction(mnesia:transaction(
303 case e(q([E
|| E
<- mnesia:table(user
), E#user
.login
=:= Login
, E#user
.password
=:= Password
])) of
304 [User
| _
] -> {ok
, User
};
311 % Renvoie {ok, User} où User est un #user possédant le message donné.
313 resultat_transaction(mnesia:transaction(
315 case e(q([U
|| U
<- mnesia:table(user
), M
<- mnesia:table(minichat
), M#minichat
.id
=:= Id
, M#minichat
.auteur_id
=:= U#user
.id
])) of
316 [User
| _
] -> {ok
, User
};
323 % Ajoute un message. Repond_A est une liste d'id auquel le message répond
324 % retourne soit l'id du message soit erreur.
325 nouveau_message(Mess
, Auteur_id
, Repond_A
) ->
326 % regarde si les id 'Repond_A' existent
328 Nb_id_trouve
= length(e(q([E#minichat
.id
|| E
<- mnesia:table(minichat
), lists:member(E#minichat
.id
, Repond_A
)]))),
329 % est-ce que l'auteur existe ?
330 Auteur
= case e(q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= Auteur_id
])) of
332 _
-> throw("L'auteur du message est introuvable")
334 if Nb_id_trouve
=/= length(Repond_A
) -> throw("Un ou plusieurs messages introuvable");
337 % compare les dernière
338 Delta
= delta_date_ms(Auteur#user
.date_derniere_connexion
, now()),
339 Nouvel_indice_flood
= Auteur#user
.indice_flood
+ if Delta
=< ?DUREE_SPAM
-> 2; true
-> -1 end,
340 Auteur_maj
= Auteur#user
{
341 indice_flood
= if Nouvel_indice_flood
> ?INDICE_SPAM_MAX
-> ?INDICE_SPAM_MAX
; Nouvel_indice_flood
< 0 -> 0; true
-> Nouvel_indice_flood
end,
342 date_derniere_connexion
= now()
344 % est-ce que l'auteur à trop floodé ?
345 if Auteur#user
.indice_flood
=/= ?INDICE_SPAM_MAX
, Auteur_maj#user
.indice_flood
=:= ?INDICE_SPAM_MAX
, Delta
=< ?DUREE_BLOCAGE_SPAM
->
346 mnesia:write(Auteur#user
{indice_flood
= Auteur_maj#user
.indice_flood
}),
347 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.");
348 Auteur#user
.indice_flood
=:= ?INDICE_SPAM_MAX
, Delta
=< ?DUREE_BLOCAGE_SPAM
->
351 mnesia:write(Auteur_maj
),
352 Id
= nouvel_id(minichat
),
353 inserer_reponses(Id
, Repond_A
),
354 mnesia:write(#minichat
{id
=Id
, auteur_id
=Auteur#user
.id
, date=now(), pseudo
=Auteur#user
.pseudo
, contenu
=Mess
}),
358 resultat_transaction(mnesia:transaction(F
)).
360 % Définit Id_repondant comme étant la réponse à Ids. Ids est une liste d'id.
361 inserer_reponses(Id_repondant
, [Id_mess
| Reste
]) ->
362 mnesia:write(#reponse_minichat
{repondant
= Id_repondant
, cible
= Id_mess
}),
363 inserer_reponses(Id_repondant
, Reste
);
364 inserer_reponses(_
, []) ->
368 % Permet de créer un message système.
369 % Renvoie l'id du message système
370 nouveau_message_sys(Mess
) ->
371 {ok
, Root
} = user_by_id(0),
374 Id
= nouvel_id(minichat
),
375 mnesia:write(#minichat
{id
=Id
, auteur_id
=0, date=now(), pseudo
=Root#user
.pseudo
, contenu
=Mess
})
380 % Renvoie N messages se trouvant sur la première page
385 % Renvoie N messages se trouvant sur la page P
388 C
= cursor(q([E
|| E
<- qlc:keysort(2, mnesia:table(minichat
), [{order
, descending
}])])),
389 if P
> 1 -> qlc:next_answers(C
, N
* (P
- 1));
392 R
= qlc:next_answers(C
, N
),
393 qlc:delete_cursor(C
),
396 resultat_transaction(mnesia:transaction(F
)).
399 % Renvoie les messages manquants pour la page P en sachant qu'il y a N message
400 % par page et que le dernier message que l'on possède est Id
401 messages(Id
, N
, P
) ->
402 lists:filter(fun (M
) -> M#minichat
.id
> Id
end, messages(N
, P
)).
405 % Renvoie {ok, #minichat} (voir #minichat de euphorik_bd.hrl) à partir de son id.
407 case resultat_transaction(mnesia:transaction(
409 e(q([E
|| E
<- qlc:keysort(2, mnesia:table(minichat
), [{order
, ascending
}]), Id
=:= E#minichat
.id
]))
417 % Renvoie une liste de message (voir #minichat de euphorik_bd.hrl) à partir d'une liste d'id (Ids).
418 messages_by_ids(Ids
) ->
419 resultat_transaction(mnesia:transaction(
421 % TODO : optimisations ? serait-ce du O(n) ?
422 Query
= q([E
|| E
<- qlc:keysort(2, mnesia:table(minichat
), [{order
, ascending
}]), lists:any(fun(Id
) -> Id
=:= E#minichat
.id
end, Ids
)]),
428 % Est-ce qu'un message existe ? Renvoie un boolean.
429 % TODO : ya pas plus simple ?
430 message_existe(Id
) ->
431 resultat_transaction(mnesia:transaction(fun() ->
432 length(e(q([E#minichat
.id
|| E
<- mnesia:table(minichat
), E#minichat
.id
=:= Id
]))) =:= 1
436 % Renvoie les reponses (utilisé normalement uniquement pendant le debug).
439 e(q([E
|| E
<- mnesia:table(reponse_minichat
)]))
441 resultat_transaction(mnesia:transaction(F
)).
444 % Renvoie les messages auquel M_id répond.
446 resultat_transaction(mnesia:transaction(
449 [M
|| E
<- mnesia:table(reponse_minichat
),
450 M
<- mnesia:table(minichat
),
451 E#reponse_minichat
.repondant
=:= M_id
,
452 M#minichat
.id
=:= E#reponse_minichat
.cible
]))
457 % Est-ce que le message Id_mess est une réponse d'une message de Id_user ?
458 est_une_reponse_a_user(Id_user
, Id_mess
) ->
459 case mnesia:transaction(
462 M#minichat
.auteur_id
|| M
<- mnesia:table(minichat
), R
<- mnesia:table(reponse_minichat
),
463 M#minichat
.auteur_id
=:= Id_user
, M#minichat
.id
=:= R#reponse_minichat
.cible
, R#reponse_minichat
.repondant
=:= Id_mess
464 ]), [{unique_all
, true
}])
467 {atomic
, [_
]} -> true
;
472 % Est-ce que Id_user à répondu au message Id_mess
473 a_repondu_a_message(Id_user
, Id_mess
) ->
474 case mnesia:transaction(
477 M#minichat
.auteur_id
|| M
<- mnesia:table(minichat
), R
<- mnesia:table(reponse_minichat
),
478 R#reponse_minichat
.cible
=:= Id_mess
, R#reponse_minichat
.repondant
=:= M#minichat
.id
, M#minichat
.auteur_id
=:= Id_user
479 ]), [{unique_all
, true
}])
482 {atomic
, [_
]} -> true
;
487 % Est-ce que Id_user possède Id_mess ?
488 possede_message(Id_user
, Id_mess
) ->
489 case mnesia:transaction(
491 e(q([E#minichat
.auteur_id
|| E
<- mnesia:table(minichat
), E#minichat
.id
=:= Id_mess
]))
494 {atomic
, [Id_user
| []]} -> true
;
500 resultat_transaction(mnesia:transaction(
502 e(q([IP
|| IP
<- mnesia:table(ip_table
)]))
507 % Bannie une ip pour un certain temps (en minute).
511 case mnesia:wread({ip_table
, IP
}) of
513 mnesia:write(IP_tuple#ip_table
{ban
= now(), ban_duration
= Duration
});
515 mnesia:write(#ip_table
{ip
= IP
, ban
= now(), ban_duration
= Duration
})
526 % Renvoie soit {true, Temps} où Temps est le temps en minutes pendant lequel le user est encore banni
528 est_banni(User_id
) ->
529 resultat_transaction(mnesia:transaction(
532 {IP#ip_table
.ban
, IP#ip_table
.ban_duration
} ||
533 U
<- mnesia:table(user
),
534 U#user
.id
=:= User_id
,
535 IP
<- mnesia:table(ip_table
),
536 IP#ip_table
.ip
=:= U#user
.last_ip
538 [{Ban
, Ban_duration
}] ->
539 Echeance
= date_plus_minutes(Ban
, Ban_duration
),
541 if Echeance
< Now
-> % l'échéance est passée
544 {true
, trunc(delta_date_ms(Echeance
, Now
) / 1000 / 60)}
553 % Ban est une date tel que retourner par now().
554 % Ban_duration est un temps en minutes.
556 date_plus_minutes(Ban
, Ban_duration
) ->
557 Duration_sec
= Ban_duration
* 60,
558 {MegaSec
, Sec
, MicroSec
} = Ban
,
559 {MegaSec
+ if Sec
+ Duration_sec
>= 1000000 -> 1; true
-> 0 end,(Sec
+ Duration_sec
) rem
1000000, MicroSec
}.
562 % Si deux enregistrements consequtifs de la même IP sont fait en moins d'une seconde alors
563 % ip_table.nb_try_register est incrémenté de 1 sinon il est décrémenté de 1 (jusqu'a 0).
564 % Si ip_table.nb_try_register vaut 5 alors l'ip ne peux plus s'enregistrer pour une heure.
566 resultat_transaction(mnesia:transaction(
568 case e(q([I
|| I
<- mnesia:table(ip_table
), I#ip_table
.ip
=:= IP
])) of
570 mnesia:write(#ip_table
{ip
= IP
, date_last_try_register
= now()}),
573 Delta
= delta_date_ms(T#ip_table
.date_last_try_register
, now()),
574 if T#ip_table
.nb_try_register
=:= ?NB_MAX_FLOOD_REGISTER
, Delta
< ?TEMPS_BAN_FLOOD_REGISTER
->
577 mnesia:write(#ip_table
{
579 date_last_try_register
= now(),
580 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
589 % Renvoie tous les trolls.
591 resultat_transaction(mnesia:transaction(
593 e(q([T
|| T
<- qlc:keysort(2, mnesia:table(troll
))]))
598 % Renvoie les trolls manquants posté après Last_id.
600 resultat_transaction(mnesia:transaction(
601 e(q([T
|| T
<- qlc:keysort(2, mnesia:table(troll
)), T#troll
.id
> Last_id
, T#troll
.date_post
=:= undefined
]))
605 % Renvoie les trolls manquants posté après Last_id.
606 % Si pas de trolls alors attend un événement tel qu'un ajout, une modification ou une suppression.
612 trolls_attente(Last_id
) ->
613 case mnesia:subscribe({table
, troll
, detailed
}) of
617 R
= case resultat_transaction(mnesia:transaction(
619 e(q([T
|| T
<- qlc:keysort(2, mnesia:table(troll
)), T#troll
.id
> Last_id
, T#troll
.date_post
=:= undefined
]))
622 [] -> % pas de trolls
623 attend_evenement_troll();
627 mnesia:unsubscribe({table
, troll
, detailed
}),
631 attend_evenement_troll() ->
632 % s'il n'y a pas de trolls que l'utilisateur n'a pas connaissance alors on attend un événement
634 % cas où un troll est choisit comme courant
635 {mnesia_table_event
, {write
, troll
, Troll
, [Old_troll
| _
], _
}} when Old_troll#troll
.date_post
=:= undefined
, Troll#troll
.date_post
=/= undefined
->
636 {del
, Troll#troll
.id
};
637 {mnesia_table_event
, {write
, troll
, Troll
, [_Old_troll
| _
], _
}} ->
639 {mnesia_table_event
, {write
, troll
, Troll
, [], _
}} ->
641 {mnesia_table_event
, {delete
, troll
, {troll
, Id
}, _
, _
}} ->
644 attend_evenement_troll()
645 after 1000 * 60 * 60 ->
650 % Renvoie l'id du nouveau troll
651 % ou max_troll_reached_per_user si le nombre de troll posté par l'utilisateur max a été atteind
652 % ou max_troll_reached si le nombre de troll posté max a été atteind
654 put_troll(User_id
, Content
) ->
655 resultat_transaction(mnesia:transaction(
657 % control le nombre de troll déjà posté
658 Nb_troll_poste_par_user
= length(e(q(
660 E#troll
.id
|| E
<- mnesia:table(troll
),
661 E#troll
.id_user
=:= User_id
,
662 E#troll
.date_post
=:= undefined
665 Nb_troll_poste_total
= length(e(q(
667 E#troll
.id
|| E
<- mnesia:table(troll
),
668 E#troll
.date_post
=:= undefined
671 User
= user_by_id(User_id
),
674 if Nb_troll_poste_par_user
>= ?NB_MAX_TROLL_WAITING_BY_USER
->
675 max_troll_reached_per_user
;
676 Nb_troll_poste_total
>= ?NB_MAX_TROLL_WAITING
->
679 Id
= nouvel_id(minichat
),
680 mnesia:write(#troll
{id
= Id
, id_user
= User_id
, date_create
= now(), content
= Content
}),
690 % renvoie ok | erreur
691 mod_troll(Troll_id
, Content
) ->
694 case mnesia:wread({troll
, Troll_id
}) of
695 [Troll
= #troll
{date_post
= undefined
}] ->
696 mnesia:write(Troll#troll
{content
= Content
});
698 mnesia:abort("mod_troll: Troll inconnu ou déjà posté")
704 del_troll(Troll_id
) ->
707 case mnesia:wread({troll
, Troll_id
}) of
708 [#troll
{date_post
= undefined
}] ->
709 mnesia:delete({troll
, Troll_id
});
711 mnesia:abort("mod_troll: Troll inconnu ou déjà posté")
717 troll_by_id(Troll_id
) ->
718 resultat_transaction(mnesia:transaction(
720 case e(q([T
|| T
<- mnesia:table(troll
), T#troll
.id
=:= Troll_id
])) of
729 % Renvoie le troll actuel qui se trouve sur la page principale.
730 % Renvois aucun si pas de troll courant.
732 resultat_transaction(mnesia:transaction(
734 % TODO : ya pas moyen de désigner le champs plutot qu'avec un nombre pour le tri ?
735 C
= cursor(q([T
|| T
<- qlc:keysort(5, mnesia:table(troll
), [{order
, descending
}]), T#troll
.date_post
=/= undefined
])),
736 R
= case qlc:next_answers(C
, 1) of
740 qlc:delete_cursor(C
),
746 % Elit un troll au hasard parmis les trolls en attente (leur date_post =:= undefined)
747 % met à jour sa date de post.
748 % renvoie plus_de_trolls si il n'y a aucun troll en attente.
751 random:seed(A1
, A2
, A3
),
754 case e(q([T
|| T
<- mnesia:table(troll
), T#troll
.date_post
=:= undefined
])) of
758 Troll
= lists:nth(random:uniform(length(Trolls
)), Trolls
),
759 Troll2
= Troll#troll
{date_post
= now()},
768 mnesia:transform_table(
771 record_info(fields
, ip_table
),
776 % Renvoie le résultat d'une transaction (en décomposant le tuple fournit)
777 resultat_transaction({_
, T
}) ->
781 % Retourne la difference entre deux timestamp (erlang:now()) en miliseconde
782 delta_date_ms(D1
, D2
) ->
783 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).
786 % Bizarre, cette fonction n'existe pas dans la stdlib.
787 % Pas utilisé mais bon ca me fait de la peine de l'enlever.
791 Neg
when Neg
< 0 -> T
;
792 Pos
when Pos
> 0 -> T
+ 1;
797 % Renvoie un nouvel id pour une table donnée
799 mnesia:dirty_update_counter(counter
, Table
, 1).