MOD avancement dans la Grande Restructuration
[euphorik.git] / modules / erl / euphorik_bd_admin.erl
diff --git a/modules/erl/euphorik_bd_admin.erl b/modules/erl/euphorik_bd_admin.erl
new file mode 100644 (file)
index 0000000..b683cc5
--- /dev/null
@@ -0,0 +1,224 @@
+% 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 :\r
+%  - Création de la BD\r
+%  - Mise à jour de la BD\r
+%  - Backup et restauration\r
+%  - Copie de la BD à partir d'un autre noeud\r
+%
+% @author G.Burri
+
+-module(euphorik_bd_admin).
+-export([
+   version_bd/0,\r
+   create/0,\r
+   connect/0,\r
+   connect/1,\r
+   reset/0,
+   update/0,
+   backup/1,
+   restore/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
+   )).\r
+   \r
+\r
+% Instructions pour créer une nouvelle base : \r
+% $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'\r
+% voir doc/installation.txt\r
+% >l(euphorik_bd).\r
+% >euphorik_bd:create().\r
+create() ->\r
+   mnesia:stop(),\r
+   mnesia:delete_schema([node()]),\r
+   mnesia:create_schema([node()]), % nécessaire pour les tables sur disc\r
+   mnesia:start(),\r
+   create_tables(),\r
+   reset().\r
+   \r
+create_tables() ->\r
+   mnesia:create_table(counter, [\r
+      {attributes, record_info(fields, counter)},\r
+      {disc_copies, [node()]}\r
+   ]),\r
+   mnesia:create_table(proprietes, [\r
+      {attributes, record_info(fields, proprietes)},\r
+      {disc_copies, [node()]}\r
+   ]),\r
+   mnesia:create_table(minichat, [\r
+      {attributes, record_info(fields, minichat)},\r
+      {index, [auteur_id, troll_id]},\r
+      {disc_copies, [node()]}\r
+   ]),\r
+   mnesia:create_table(reponse_minichat, [\r
+      {type, bag},\r
+      {attributes, record_info(fields, reponse_minichat)},\r
+      {index, [cible]},\r
+      {disc_copies, [node()]}\r
+   ]),\r
+   mnesia:create_table(user, [\r
+      {attributes, record_info(fields, user)},\r
+      {index, [cookie, login]},\r
+      {disc_copies, [node()]}\r
+   ]),\r
+   mnesia:create_table(ip_table, [\r
+      {attributes, record_info(fields, ip_table)},\r
+      {disc_copies, [node()]}\r
+   ]),\r
+   mnesia:create_table(troll, [\r
+      {attributes, record_info(fields, troll)},\r
+      {index, [date_post]},\r
+      {disc_copies, [node()]}\r
+   ]).\r
+   \r
+   \r
+% Connexion à la base de données de yaws sur overnux\r
+connect() ->\r
+   connect(yaws@flynux).\r
+connect(Node) ->\r
+   mnesia:start(),\r
+   mnesia:change_config(extra_db_nodes, [Node]).\r
+\r
+\r
+% Efface toutes les données de la base de données.\r
+reset() ->\r
+   mnesia:clear_table(counter),\r
+   mnesia:clear_table(proprietes),\r
+   mnesia:clear_table(user),\r
+   mnesia:clear_table(reponse_minichat),\r
+   mnesia:clear_table(minichat),\r
+   mnesia:clear_table(troll),\r
+   mnesia:clear_table(ip_table),\r
+   % crée l'utilisateur root\r
+   mnesia:transaction(fun() ->\r
+      mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),\r
+      User = #user{id = 0, pseudo = "Sys", login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true},\r
+      mnesia:write(User),\r
+      User\r
+   end).\r
+   
+
+% 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) ->
+   % 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, Pseudo, Login, Password, Email, Date_creation, Date_derniere_connexion, patch1_transforme_css(Css), Nick_format, View_times, View_tooltips, light, reverse, Indice_flood, lists:map(fun({R, _}) -> {R, false} end, Conversations), Ek_master, Last_ip}
+      end,
+      record_info(fields, user),
+      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),
+      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) -> patch_1_traiter_message(M, M#minichat.id) end, Messages)
+      end
+   ) of
+      {aborted, Raison} -> {erreur, Raison};
+      {atomic, _} -> ok
+   end.
+% 2 -> 3
+%patch(2) ->
+
+
+% Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
+% et renvoie "styles/1/euphorik.css"
+patch1_transforme_css(["css" | Reste]) ->
+   ["styles" | Reste];
+patch1_transforme_css(F) ->
+   F.
+
+   
+patch_1_traiter_message(M, Racine) ->
+   % met à jour la racine de chaque message qui répond à M
+   lists:foreach(
+      fun(M2) ->
+         mnesia:write(M2#minichat{racine_id = Racine}),
+         patch_1_traiter_message(M2, Racine)
+      end,
+      euphorik_bd:enfants(M#minichat.id)
+   ).
+
+% crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
+backup(Nom) ->
+   mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
+   
+
+% 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(N) ->
+   mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
+
+
+% Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
+fichier_backup(Version) -> 
+   mnesia:system_info(directory) ++ "/backups/" ++ if is_integer(Version) -> "backup" ++ integer_to_list(Version); true -> Version end.