% coding: utf-8
% Copyright 2008 Grégory Burri
%
% This file is part of Euphorik.
%
% Euphorik is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% Euphorik is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
%
% 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.


-module(euphorik_bd).
-author("Greg Burri <greg.burri@gmail.com>").
-export([
   % texte :
   get_texte/1,
   get_texte/2,

   % users :
   nouveau_user/2,
   nouveau_user/4,
   set_profile/4,
   update_date_derniere_connexion/1,
   update_ip/2,
   update_pseudo_user/2,
   user_by_cookie/1,
   user_by_id/1,
   user_by_login/1,
   user_by_login_password/2,
   user_by_mess/1,
   css_from_user_cookie/1,
   is_ek_master_from_cookie/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,
   parents/1,
   enfants/1,
   parents_id/1,
   enfants_id/1,
   est_une_reponse_a_user/2,
   a_repondu_a_message/2,
   possede_message/2,

   % ip :
   list_ban/0,
   ban/2,
   deban/1,
   est_banni/1,
   can_register/1,

   % utiles :
   resultat_transaction/1,
   get_tuples/3 % must be in a transaction
]).
-import(qlc, [e/2, q/1, cursor/2]).
-include("../include/euphorik_bd.hrl").
-include("../include/euphorik_defines.hrl").
-include_lib("stdlib/include/qlc.hrl").


get_texte(Id) ->
   get_texte(Id, fr).


% TODO : généraliser la langue
get_texte(Id, _Lang = fr) ->
   resultat_transaction(mnesia:transaction(fun() ->
      case mnesia:read({texte, Id}) of
         [#texte{fr = Texte}] -> Texte;
         _ -> "Message " ++ integer_to_list(Id) ++ " unknown"
      end
   end)).


% Ajoute un nouveau user et le renvoie
nouveau_user(Cookie, Profile) ->
   F = fun() ->
      Id = nouvel_id(user),
      User = #user{id = Id, cookie = Cookie, date_creation = erlang:timestamp(), date_derniere_connexion = erlang:timestamp(), profile = Profile},
      mnesia:write(User),
      User
   end,
  resultat_transaction(mnesia:transaction(F)).


% Ajoute un nouveau user et le renvoie
nouveau_user(Login, Password, Cookie, Profile) ->
   F = fun() ->
      Id = nouvel_id(user),
      User = #user{id = Id, cookie = Cookie, login = Login, password = Password, date_creation = erlang:timestamp(), date_derniere_connexion = erlang:timestamp(), profile = Profile#profile{pseudo = Login}},
      mnesia:write(User),
      User
   end,
  resultat_transaction(mnesia:transaction(F)).


% Définit les données du profile d'une utilisateur.
set_profile(Cookie, Login, Password, Profile) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         case user_by_cookie(Cookie) of
            {ok, User_existant} ->
               case user_by_login(Login) of
                  {ok, U} when Login =/= [], U#user.id =/= User_existant#user.id ->
                     login_deja_pris;
                  _ ->
                     mnesia:write(
                        User_existant#user{
                           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 !
                           password = if Password =:= [] -> User_existant#user.password; true -> Password end,
                           profile = Profile
                        }
                     ),
                     ok
               end;
            _ -> erreur
         end
      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 = erlang:timestamp()});
            _ ->
               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{profile = Profile} = User] when Profile#profile.pseudo =/= Pseudo ->
               mnesia:write(User#user{profile = Profile#profile { pseudo = Pseudo } });
            _ ->
               mnesia:abort("update_pseudo_user: User inconnu ou pseudo deja à jour")
          end
      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() ->
         case mnesia:index_read(user, Cookie, #user.cookie) of
            [User] -> {ok, User};
            _ -> erreur
         end
      end
   )).


user_by_id(ID) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
%         case e(q([E || E <- mnesia:table(user), E#user.id =:= ID]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) of
%            [User] -> {ok, User};
%            _ -> erreur
%         end
         case mnesia:read({user,  ID}) of
            [User] -> {ok, User};
            _ -> erreur
         end
      end
   )).


user_by_login(Login) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         Users = e(q([E || E <- mnesia:table(user), E#user.login =:= Login]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
         case Users of
            [User] -> {ok, User};
            _ -> erreur
         end
      end
   )).


% Renvoie une chaine représentant le cookie ou undefined si pas trouvé.
css_from_user_cookie(Cookie) ->
   case user_by_cookie(Cookie) of
      {ok, #user{profile = Profile}} ->
         Profile#profile.css;
      _ ->
         undefined
   end.


is_ek_master_from_cookie(Cookie) ->
   case user_by_cookie(Cookie) of
      {ok, #user{ek_master = true}} -> true;
      _ -> false
   end.


user_by_login_password(Login, Password) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         case e(q([E || E <- mnesia:table(user), E#user.login =:= Login, E#user.password =:= Password]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) 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 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
            [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, <raison>}.
nouveau_message(Mess, Auteur_id, Repond_A_ids) ->
   % regarde si les id 'Repond_A' existent
   F = fun() ->
      Repond_a = lists:foldr(
         fun(Repond_a_id, Acc) ->
            case mnesia:read({minichat, Repond_a_id}) of
               [M] -> [M | Acc];
               _ -> Acc % le message n'est pas trouvé
            end
         end,
         [],
         Repond_A_ids
      ),
      Racine_id = case Repond_a of
         [] -> undefined;
         [M | _] ->
            Une_racine = M#minichat.racine_id,
            % vérification que tout les messages de Repond_a possède la même racine (même conversation)
            case lists:all(fun(R) -> R#minichat.racine_id =:= Une_racine end, Repond_a) of
               true ->
                  Une_racine;
               _ ->
                  {erreur, "Les messages ne font pas partie de la même conversation"}
            end
      end,
      if length(Repond_a) =/= length(Repond_A_ids) ->
            {erreur, "Un ou plusieurs messages introuvable"};
         true ->
            case Racine_id of
               {erreur, E} -> {erreur, E};
               _ ->
                  % est-ce que l'auteur existe ?
                  case mnesia:wread({user, Auteur_id}) of
                     [#user{profile = Profile} = Auteur] ->
                        % comparaison entre la date du dernier poste et maintenant (gestion du flood)
                        Now = erlang:timestamp(),
                        Delta = euphorik_common: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("\"" ++ 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.");
                           Auteur#user.indice_flood =:= ?INDICE_SPAM_MAX, Delta =< ?DUREE_BLOCAGE_SPAM ->
                              {erreur, "Bloqué pour cause de flood"};
                           true ->
                              mnesia:write(Auteur_maj),
                              Id = nouvel_id(minichat),
                              inserer_reponses(Id, Repond_A_ids),
                              mnesia:write(#minichat{
                                 id = Id,
                                 auteur_id = Auteur#user.id,
                                 date = Now,
                                 pseudo = Profile#profile.pseudo,
                                 contenu = Mess,
                                 racine_id = if Racine_id =:= undefined -> Id; true -> Racine_id end
                              }),
                              Id
                        end;
                     _ ->
                        {erreur, "L'auteur du message est introuvable"}
                  end
            end
      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, #user{profile = Profile}} = user_by_id(0),
   resultat_transaction(mnesia:transaction(
      fun() ->
         Id = nouvel_id(minichat),
         mnesia:write(#minichat{id = Id, auteur_id = 0, date = erlang:timestamp(), pseudo = Profile#profile.pseudo, contenu = Mess, racine_id = Id}),
         Id
      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
% TODO FIXME : fonction en O(N * P) !
messages(N, P) ->
   F = fun() ->
      get_tuples(minichat, mnesia:table_info(minichat, size) - N * P + 1, N)
   end,
   resultat_transaction(mnesia:transaction(F)).


get_tuples(Table, First_id, N) ->
   lists:foldr(
      fun(Id, Acc) ->
         case mnesia:read({Table, Id}) of
            [T] -> [T | Acc];
            _ -> Acc
         end
      end,
      [],
      lists:seq(First_id, First_id + N - 1)
   ).


% 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) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         case mnesia:read({minichat, Id}) of
            [M] -> {ok, M};
            _ -> erreur
         end
      end
   )).

% Renvoie une liste de message (voir #minichat de euphorik_bd.hrl) à partir d'une liste d'id (Ids).
% TODO : optimisations ? serait-ce du O(n) ?
% Bon de toutes façons on s'en fout c'est pas utilisé :)
messages_by_ids(Ids) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         e(qlc:keysort(
            #minichat.id,
            q([E || E <- mnesia:table(minichat), lists:any(fun(Id) -> Id =:= E#minichat.id end, Ids)]),
            [{order, ascending}]
         ),[{tmpdir, ?KEY_SORT_TEMP_DIR}])
      end
   )).


% Est-ce qu'un message existe ? Renvoie un boolean.
% TODO : ya pas plus simple ?
message_existe(Id) ->
   resultat_transaction(mnesia:transaction(fun() ->
      length(e(q([E#minichat.id || E <- mnesia:table(minichat), E#minichat.id =:= Id]), [{tmpdir, ?KEY_SORT_TEMP_DIR}])) =:= 1
   end)).


% Renvoie les reponses (utilisé normalement uniquement pendant le debug).
reponses() ->
   F = fun() ->
      e(q([E || E <- mnesia:table(reponse_minichat)]), [{tmpdir, ?KEY_SORT_TEMP_DIR}])
   end,
   resultat_transaction(mnesia:transaction(F)).


% Renvoie les messages auquel M_id répond.
parents(M_id) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         e(q(
            [M || R <- mnesia:table(reponse_minichat),
            M <- mnesia:table(minichat),
            R#reponse_minichat.repondant =:= M_id,
            M#minichat.id =:= R#reponse_minichat.cible]), [{tmpdir, ?KEY_SORT_TEMP_DIR}])
      end
   )).


% Renvoie les message qui repondent à M_id
enfants(M_id) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         e(q(
            [M || R <- mnesia:table(reponse_minichat),
            M <- mnesia:table(minichat),
            R#reponse_minichat.cible =:= M_id,
            M#minichat.id =:= R#reponse_minichat.repondant]), [{tmpdir, ?KEY_SORT_TEMP_DIR}])
      end
   )).


% Renvoie les id des parents d'un message M (les messages auquels répond M)
% ordrés du plus petit au plus grand..
% On évite d'utiliser qlc pour des raisons de performance
% @spec parents_id(integer()) -> [integer()]
parents_id(M_id) ->
   resultat_transaction(mnesia:transaction(fun() ->
      case mnesia:read({reponse_minichat, M_id}) of
         Parents when is_list(Parents) ->
            lists:sort(lists:map(
               fun(#reponse_minichat{cible = Cible}) -> Cible end,
               Parents
            ));
         _ -> []
      end
   end)).


% Renvoie les id des enfants d'un message M (les messages qui répondent à M)
% ordrés du plus petit au plus grand.
% @spec enfants_id(integer()) -> [integer()]
enfants_id(M_id) ->
   resultat_transaction(mnesia:transaction(fun() ->
      case mnesia:index_read(reponse_minichat, M_id, #reponse_minichat.cible) of
         Enfants when is_list(Enfants) ->
            lists:sort(lists:map(
               fun(#reponse_minichat{repondant = Repondant}) -> Repondant end,
               Enfants
            ));
         _ -> []
      end
   end)).


% Est-ce que le message Id_mess est une réponse d'une message de Id_user ?
% On evite d'utiliser qlc (ce qui était fait avant) pour des raisons de performance.
est_une_reponse_a_user(Id_user, Id_mess) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         case mnesia:read({reponse_minichat, Id_mess}) of
            [] -> false;
            Cibles ->
               lists:any(
                  fun(#reponse_minichat{cible = Cible}) ->
                     case mnesia:read({minichat, Cible}) of
                        [#minichat{auteur_id = Id_user}] -> true;
                        _ -> false
                     end
                  end,
                  Cibles
               )
         end
      end
   )).


% Est-ce que Id_user à répondu au message Id_mess
% On evite d'utiliser qlc (ce qui était fait avant) pour des raisons de performance.
a_repondu_a_message(Id_user, Id_mess) ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         case mnesia:index_read(reponse_minichat, Id_mess, #reponse_minichat.cible) of
            [] -> false;
            Reponses ->
               lists:any(
                  fun(#reponse_minichat{repondant = Reponse}) ->
                     case mnesia:read({minichat, Reponse}) of
                        [#minichat{auteur_id = Id_user}] -> true;
                        _ -> false
                     end
                  end,
                  Reponses
               )
         end
      end
   )).


% Est-ce que Id_user possède Id_mess ?
possede_message(Id_user, Id_mess) ->
   case mnesia:transaction(
            fun() ->
               e(q([E#minichat.auteur_id || E <- mnesia:table(minichat), E#minichat.id =:= Id_mess]), [{tmpdir, ?KEY_SORT_TEMP_DIR}])
            end
         ) of
      {atomic, [Id_user | []]} -> true;
      _ -> false
   end.


% renvoie la liste des ip bannies
% liste de {ip, temps_restant(en minutes), Users} ou Users est une liste de {pseudo, login}
% TODO : déterminer la complexité de cette fonction. (Il n'y a pas d'index sur #user.last_ip)
list_ban() ->
   resultat_transaction(mnesia:transaction(
      fun() ->
         Now = erlang:timestamp(),
         e(qlc:keysort(1, q([
            {
               IP#ip_table.ip,
               euphorik_common:delta_date_minute(date_plus_minutes(IP#ip_table.ban, IP#ip_table.ban_duration), Now),
               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}])
            } ||
            IP <- mnesia:table(ip_table),
            if IP#ip_table.ban =:= undefined -> false; true -> date_plus_minutes(IP#ip_table.ban, IP#ip_table.ban_duration) > Now end
         ])), [{tmpdir, ?KEY_SORT_TEMP_DIR}])
      end
   )).


% Bannie une ip pour un certain temps (en minute).
ban(IP, Duration) ->
   mnesia:transaction(
      fun() ->
         case mnesia:wread({ip_table, IP}) of
            [IP_tuple] ->
               mnesia:write(IP_tuple#ip_table{ban = erlang:timestamp(), ban_duration = Duration});
            _ ->
               mnesia:write(#ip_table{ip = IP, ban = erlang:timestamp(), 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 e(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
         ]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) of
            [{Ban, Ban_duration}] ->
               Echeance = date_plus_minutes(Ban, Ban_duration),
               Now = erlang:timestamp(),
               if Echeance < Now -> % l'échéance est passée
                     false;
                  true ->
                     {true, euphorik_common:delta_date_minute(Echeance, Now)}
               end;
            _ ->
               false
         end
      end
   )).


% Ban est une date tel que retourner par erlang:timestamp().
% 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 e(q([I || I <- mnesia:table(ip_table), I#ip_table.ip =:= IP]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) of
            [] ->
               mnesia:write(#ip_table{ip = IP, date_last_try_register = erlang:timestamp()}),
               true;
            [T] ->
               Delta = euphorik_common:delta_date_ms(T#ip_table.date_last_try_register, erlang:timestamp()),
               if T#ip_table.nb_try_register =:= ?NB_MAX_FLOOD_REGISTER, Delta < ?TEMPS_BAN_FLOOD_REGISTER ->
                     false;
                  true ->
                     mnesia:write(T#ip_table{
                        ip = IP,
                        date_last_try_register = erlang:timestamp(),
                        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
   )).


% Renvoie le résultat d'une transaction (en décomposant le tuple fournit)
resultat_transaction({_, T}) ->
   T.


% Renvoie un nouvel id pour une table donnée
nouvel_id(Table) ->
   mnesia:dirty_update_counter(counter, Table, 1).