% 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/>.
%
% Module mettant à disposition tout un tas de fonction pour l'administration de la base de données euphorik comme :
%  - Création de la BD
%  - Mise à jour de la BD
%  - Backup et restauration
%  - Copie de la BD à partir d'un autre noeud


-module(euphorik_bd_admin).
-author("Greg Burri <greg.burri@gmail.com>").
-export([
   version_bd/0,
   create/0,
   connect/0,
   connect/1,
   reset/0,
   update/0,

   backup/1,
   restore/1,
   change_node_name/4,

   toggle_ek_master/1,
   print_users/0,
   print_users/1,
   print_user/1
]).
-import(qlc, [e/2, q/1, cursor/2]).
-include("../include/euphorik_bd.hrl").
-include("../include/euphorik_defines.hrl").
-include_lib("stdlib/include/qlc.hrl").


% Renvoie la version courante de la BD.
version_bd() ->
   euphorik_bd:resultat_transaction(mnesia:transaction(
      fun() ->
         mnesia:read({proprietes, version})
      end
   )).


% 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(),
   reset().

create_tables() ->
   mnesia:create_table(counter, [
      {attributes, record_info(fields, counter)},
      {disc_copies, [node()]}
   ]),
   mnesia:create_table(proprietes, [
      {attributes, record_info(fields, proprietes)},
      {disc_copies, [node()]}
   ]),
   mnesia:create_table(texte, [
      {attributes, record_info(fields, texte)},
      {disc_copies, [node()]}
   ]),
   mnesia:create_table(minichat, [
      {type, ordered_set},
      {attributes, record_info(fields, minichat)},
      {disc_copies, [node()]}
   ]),
   mnesia:create_table(reponse_minichat, [
      {type, bag},
      {attributes, record_info(fields, reponse_minichat)},
      {disc_copies, [node()]}
   ]),
   mnesia:create_table(user, [
      {attributes, record_info(fields, user)},
      {disc_copies, [node()]}
   ]),
   mnesia:create_table(ip_table, [
      {attributes, record_info(fields, ip_table)},
      {disc_copies, [node()]}
   ]),
   % This table is not used anymore.
   mnesia:create_table(troll, [
      {attributes, record_info(fields, troll)},
      {disc_copies, [node()]}
   ]),
   creer_indexes().


% mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
creer_indexes() ->
   % commence par supprimer les anciens indexes
   lists:foreach(fun(T) ->
         lists:foreach(fun(P) ->
               mnesia:del_table_index(T, P)
            end,
            mnesia:table_info(T, index)
         )
      end,
      ?TABLES
   ),
   mnesia:add_table_index(minichat, auteur_id),
   mnesia:add_table_index(reponse_minichat, cible),
   mnesia:add_table_index(user, cookie),
   mnesia:add_table_index(user, login),
   mnesia:add_table_index(troll, date_post),
   mnesia:add_table_index(troll, id_minichat).


% 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]).


% Efface toutes les données de la base de données.
reset() ->
   mnesia:clear_table(counter),
   mnesia:clear_table(proprietes),
   mnesia:clear_table(texte),
   mnesia:clear_table(user),
   mnesia:clear_table(reponse_minichat),
   mnesia:clear_table(minichat),
   mnesia:clear_table(troll),
   mnesia:clear_table(ip_table),
   % crée l'utilisateur root
   mnesia:transaction(fun() ->
      mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
      User = #user{id = 0, profile = #profile{pseudo = "Sys"}, login = "Sys", date_creation = erlang:timestamp(), date_derniere_connexion = erlang:timestamp(), ek_master = true},
      mnesia:write(User),
      User
   end),
   peupler_texte().


peupler_texte() ->
   mnesia:transaction(fun() ->
      mnesia:write(#texte{ id = 10, fr = "Login déjà existant"}),
      mnesia:write(#texte{ id = 20, fr = "Trop de register (flood)"}),
      mnesia:write(#texte{ id = 30, fr = "Couple login/pass introuvable"}),
      mnesia:write(#texte{ id = 40, fr = "Authentification impossible par cookie"}),
      mnesia:write(#texte{ id = 50, fr = "Impossible de mettre à jour le profile"}),
      mnesia:write(#texte{ id = 60, fr = "timeout"}),
      mnesia:write(#texte{ id = 70, fr = "Page inconnue"}),
      mnesia:write(#texte{ id = 80, fr = "Vous êtes banni pour encore ~s"}),
      mnesia:write(#texte{ id = 90, fr = "Message vide"}),
      mnesia:write(#texte{ id = 100, fr = "Impossible d'ajouter un nouveau message. Raison : ~s"}),
      mnesia:write(#texte{ id = 110, fr = "Utilisateur inconnu"}),
      mnesia:write(#texte{ id = 120, fr = "Il n'est pas possible de s'auto bannir"}),
      mnesia:write(#texte{ id = 130, fr = "L'utilisateur est lui même un ekMaster"}),
      mnesia:write(#texte{ id = 140, fr = "Utilisateur à bannir inconnu"}),
      mnesia:write(#texte{ id = 150, fr = "Utilisateur inconnu ou non ek master"}),
      mnesia:write(#texte{ id = 160, fr = "Utilisateur à slaper inconnu"}),
      mnesia:write(#texte{ id = 170, fr = "Utilisateur inconnu ou non ek master"}),
      mnesia:write(#texte{ id = 230, fr = "Seul les ekMaster peuvent connaitre la liste des ips bannies"})
   end).


% Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
% et exécute les patchs nécessaires.
update() ->
   case mnesia:dirty_read({proprietes, version}) of
      [#proprietes{valeur = Version}] ->
         update(Version);
      _ ->
         erreur
   end.


% Mise à jour de la BD.
% attention : il est nécessaire de se trouver dans une transaction.
update(?VERSION_BD) -> fini;
update(Version) ->
   case mnesia:backup(fichier_backup(Version)) of
      ok ->
         case patch(Version) of
            ok ->
               mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
               update(Version + 1);
            Erreur ->
               Erreur
         end;
      {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
   end.


% Applique une modification de la BD pour passer d'une version à la suivante.
% crée un backup avant l'application du patch
% dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
% 1 -> 2
patch(1) ->
   % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
   % et renvoie "styles/1/euphorik.css"
   Transforme_css = fun("css" ++ Reste) ->
         "styles" ++ Reste;
         (F) -> F
   end,
   Traiter_message = fun(M, Racine) ->
      F = fun(F, M2) -> % seul moyen à ma connaissance pour faire de la récursion dans une lambda fonction, voir : http://www.nabble.com/Auto-generated-functions-td15279499.html
         % met à jour la racine de chaque message qui répond à M
         lists:foreach(
            fun(M3) ->
               mnesia:write(M2#minichat{racine_id = Racine}),
               F(F, M3)
            end,
            euphorik_bd:enfants(M#minichat.id)
         )
      end,
      F(F, M)
   end,
   % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
   % et renvoie "styles/1/euphorik.css"
   Transforme_css = fun("css" ++ Reste) ->
         "styles" ++ Reste;
         (F) -> F
   end,
   Traiter_message = fun(M, Racine) ->
      F = fun(F, M2) -> % seul moyen à ma connaissance pour faire de la récursion dans une lambda fonction, voir : http://www.nabble.com/Auto-generated-functions-td15279499.html
         % met à jour la racine de chaque message qui répond à M
         lists:foreach(
            fun(M3) ->
               mnesia:write(M2#minichat{racine_id = Racine}),
               F(F, M3)
            end,
            euphorik_bd:enfants(M#minichat.id)
         )
      end,
      F(F, M)
   end,
   mnesia:create_table(texte, [
      {attributes, record_info(fields, texte)},
      {disc_copies, [node()]}
   ]),
   peupler_texte(),
   % traitement des users
   mnesia:transform_table(
      user,
      fun({user, Id, Cookie, Pseudo, Login, Password, Email, Date_creation, Date_derniere_connexion, Css, Nick_format, View_times, View_tooltips, Indice_flood, _Page_principale, Conversations, Ek_master, Last_ip}) ->
            {user, Id, Cookie, Login, Password, {profile, Pseudo, Email, Transforme_css(Css), Nick_format, View_times, View_tooltips, light, reverse, lists:map(fun({R, _}) -> {R, false} end, Conversations)}, Date_creation, Date_derniere_connexion, Indice_flood, Ek_master, Last_ip}
      end,
      record_info(fields, user)
   ),
   mnesia:transform_table(
      minichat,
      fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id}) ->
            {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id, Id}
      end,
      record_info(fields, minichat)
   ),
   case mnesia:transaction(
      fun() ->
         % met à jour les enfants des racines
         % idéalement : utiliser un cursor mais je crois qu'il n'est pas possible de faire des modifs en itérant en même temps avec un cursor, a voir..
         Messages = e(q([M || M <- mnesia:table(minichat), euphorik_bd:parents(M#minichat.id) =:= []]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
         lists:foreach(fun(M) -> Traiter_message(M, M#minichat.id) end, Messages)
      end
   ) of
      {aborted, Raison} -> {erreur, Raison};
      {atomic, _} -> ok
   end;
% 2 -> 3
patch(2) ->
   mnesia:transform_table(
      troll,
      fun({troll, Id_troll, Id_user, Date_create, Date_post, Content}) ->
         % recherche le message associé s'il existe
         Id_minichat = case e(q([M || M <- mnesia:table(minichat), element(7, M) =:= Id_troll]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) of
            [M] -> element(2, M);
            _ -> undefined
         end,
         {troll, Id_troll, Id_user, Id_minichat, Date_create, Date_post, Content}
      end,
      record_info(fields, troll)
   ),
   %mnesia:del_table_index(minichat, troll_id),
   mnesia:transform_table(
      minichat,
      fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, _Troll_id, Racine_id}) ->
         {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Racine_id, normal}
      end,
      record_info(fields, minichat)
   ),
   mnesia:transaction(fun() ->
      % comble les trous entre les id non-contigues
      lists:foreach(fun(Id) ->
            case mnesia:read({minichat, Id}) of
               [] ->
                  {ok, #user{profile = Profile}} = euphorik_bd:user_by_id(0),
                  mnesia:write(#minichat{id = Id, auteur_id = 0, date = undefined, pseudo = Profile#profile.pseudo, contenu = "Comblement...", racine_id = Id, status = deleted});
               _ -> rien
            end
         end,
         lists:seq(1, mnesia:table_info(minichat, size))
      ),
      % la table troll utilise maintenant son index et pas celui de la table minichat (correction d'un vieux bug)
      mnesia:write(#counter{key = troll, value = mnesia:table_info(minichat, size)})
   end),
   creer_indexes(). % uniquement pour l'indice sur id_minichat de la table troll


% Renvoie le dossier dans lequel les backups sont effectué, ce dossier doit être en écriture.
dossier_backups() ->
   mnesia:system_info(directory) ++ "/backups/".


% Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
fichier_backup(Version) when is_integer(Version) ->
   dossier_backups() ++ "backup" ++ integer_to_list(Version).


% crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
backup(Fichier) ->
   mnesia:backup(dossier_backups() ++ Fichier).


% Restaure un backup de la BD.
restore(Fichier) when is_list(Fichier) ->
   mnesia:restore(dossier_backups() ++ Fichier, []);
% Reviens à une version précédente de la base de données.
% (les données insérées durant les versions plus récentes sont perdues).
restore(Version) when is_integer(Version) ->
   mnesia:restore(fichier_backup(Version), []). % [{default_op, recreate_tables}]).


% Change le nom du noeud d'un backup.
% provient d'ici : http://www.erlang.org/doc/apps/mnesia/Mnesia_chap7.html#6.9
% From : l'ancien nom
% To : le nouveau nom
% Source : le nom du fichier de backup
% Target : le nom du fichier du nouveau backup
change_node_name(From, To, Source, Target) ->
    Switch =
        fun(Node) when Node == From -> To;
           (Node) when Node == To -> throw({error, already_exists});
           (Node) -> Node
        end,
    Convert =
        fun({schema, db_nodes, Nodes}, Acc) ->
                {[{schema, db_nodes, lists:map(Switch,Nodes)}], Acc};
           ({schema, version, Version}, Acc) ->
                {[{schema, version, Version}], Acc};
           ({schema, cookie, Cookie}, Acc) ->
                {[{schema, cookie, Cookie}], Acc};
           ({schema, Tab, CreateList}, Acc) ->
                Keys = [ram_copies, disc_copies, disc_only_copies],
                OptSwitch =
                    fun({Key, Val}) ->
                            case lists:member(Key, Keys) of
                                true -> {Key, lists:map(Switch, Val)};
                                false-> {Key, Val}
                            end
                    end,
                {[{schema, Tab, lists:map(OptSwitch, CreateList)}], Acc};
           (Other, Acc) ->
                {[Other], Acc}
        end,
    mnesia:traverse_backup(Source, Target, Convert, switched).


% Obsolète
%~ backup_text(File) ->
   %~ mnesia:dump_to_textfile(File).
%~ restore_text(File) ->
   %~ mnesia:stop(),
   %~ mnesia:delete_schema([node()]),
   %~ mnesia:start(),
   %~ create_tables(),
   %~ case mnesia:load_textfile(File) of
      %~ {atomic, ok} ->
         %~ update(),
         %~ creer_indexes();
      %~ Erreur ->
         %~ Erreur
   %~ end.


toggle_ek_master(User_id) ->
   euphorik_bd:resultat_transaction(mnesia:transaction(
      fun() ->
         Users = e(q([E || E <- mnesia:table(user), E#user.id =:= User_id]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
         case Users of
            [User] ->
               mnesia:write(User#user{ek_master = not User#user.ek_master});
            _ -> erreur
         end
      end
   )).


% Affiche N user trié par leur date de dernière connexion.
% Opt est une liste d'option d'affichage :
%  * ekmaster : n'affiche que les admins
print_users(N, Opt) ->
   AfficheQueLesEkMaster = lists:any(fun(O) -> O =:= ekmaster end, Opt),
   euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
      C = cursor(
         qlc:keysort(
            #user.date_derniere_connexion,
            if AfficheQueLesEkMaster ->
               q([E || E <- mnesia:table(user), E#user.ek_master =:= true]);
            true ->
               q([E || E <- mnesia:table(user)])
            end,
            [{order, descending}]
         ),
         [{tmpdir, ?KEY_SORT_TEMP_DIR}]
      ),
      Users = qlc:next_answers(C, N),
      lists:foreach(
         fun(U) ->
            print_user(U)
         end,
         Users
      ),
      qlc:delete_cursor(C)
   end)).


% Affiche tous les users.
print_users(Opt) ->
   print_users(all_remaining, Opt).

% Affiche tous les users.
print_users() ->
   print_users(all_remaining, []).

print_user(User) when is_record(User, user) ->
   #user{id = Id, profile = #profile{pseudo = Pseudo}, login = Login, ek_master = Ek_master, date_derniere_connexion = Date, last_ip = IP} = User,
   {{Annee, Mois, Jour}, {Heure, Min, _}} = calendar:now_to_local_time(Date),
   io:format(
      % id        pseudo     (login)        IP  Jour  Mois   Année  Heure Minute
      "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
      [
         Id,
         if Ek_master -> "*"; true -> "" end ++ Pseudo,
         Login,
         euphorik_common:serialize_ip(IP),
         Jour, Mois, Annee, Heure, Min
      ]
   );
% Affichage d'un user en fonction de son login
print_user(Login) when is_list(Login) ->
   case euphorik_bd:user_by_login(Login) of
      {ok, User} ->
         print_user(User);
      _ ->
         {erreur, "Login pas trouvé : " ++ Login}
   end;
% Affichage d'un user en fonction de son id
print_user(Id) when is_integer(Id) ->
   case euphorik_bd:user_by_id(Id) of
      {ok, User} ->
         print_user(User);
      _ ->
         {erreur, "Id pas trouvé : " ++ integer_to_list(Id)}
   end.