erl/euphorik_bd_admin.erl

   1 % coding: utf-8
   2 % Copyright 2008 Grégory Burri
   3 %
   4 % This file is part of Euphorik.
   5 %
   6 % Euphorik is free software: you can redistribute it and/or modify
   7 % it under the terms of the GNU General Public License as published by
   8 % the Free Software Foundation, either version 3 of the License, or
   9 % (at your option) any later version.
  10 %
  11 % Euphorik is distributed in the hope that it will be useful,
  12 % but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 % GNU General Public License for more details.
  15 %
  16 % You should have received a copy of the GNU General Public License
  17 % along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
  18 %
  19 % Module mettant à disposition tout un tas de fonction pour l'administration de la base de données euphorik comme :
  20 %  - Création de la BD
  21 %  - Mise à jour de la BD
  22 %  - Backup et restauration
  23 %  - Copie de la BD à partir d'un autre noeud
  24 %
  25 % @author G.Burri
  26
  27 -module(euphorik_bd_admin).
  28 -export([
  29    version_bd/0,
  30    create/0,
  31    connect/0,
  32    connect/1,
  33    reset/0,
  34    update/0,
  35    backup/1,
  36    restore/1
  37 ]).
  38 -import(qlc, [e/2, q/1, cursor/2]).
  39 -include("../include/euphorik_bd.hrl").
  40 -include("../include/euphorik_defines.hrl").
  41 -include_lib("stdlib/include/qlc.hrl").
  42
  43
  44 % Renvoie la version courante de la BD.
  45 version_bd() ->
  46    euphorik_bd:resultat_transaction(mnesia:transaction(
  47       fun() ->
  48          mnesia:read({proprietes, version})
  49       end
  50    )).
  51
  52
  53 % Instructions pour créer une nouvelle base :
  54 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
  55 % voir doc/installation.txt
  56 % >l(euphorik_bd).
  57 % >euphorik_bd:create().
  58 create() ->
  59    mnesia:stop(),
  60    mnesia:delete_schema([node()]),
  61    mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
  62    mnesia:start(),
  63    create_tables(),
  64    reset().
  65
  66 create_tables() ->
  67    mnesia:create_table(counter, [
  68       {attributes, record_info(fields, counter)},
  69       {disc_copies, [node()]}
  70    ]),
  71    mnesia:create_table(proprietes, [
  72       {attributes, record_info(fields, proprietes)},
  73       {disc_copies, [node()]}
  74    ]),
  75    mnesia:create_table(minichat, [
  76       {attributes, record_info(fields, minichat)},
  77       {index, [auteur_id, troll_id]},
  78       {disc_copies, [node()]}
  79    ]),
  80    mnesia:create_table(reponse_minichat, [
  81       {type, bag},
  82       {attributes, record_info(fields, reponse_minichat)},
  83       {index, [cible]},
  84       {disc_copies, [node()]}
  85    ]),
  86    mnesia:create_table(user, [
  87       {attributes, record_info(fields, user)},
  88       {index, [cookie, login]},
  89       {disc_copies, [node()]}
  90    ]),
  91    mnesia:create_table(ip_table, [
  92       {attributes, record_info(fields, ip_table)},
  93       {disc_copies, [node()]}
  94    ]),
  95    mnesia:create_table(troll, [
  96       {attributes, record_info(fields, troll)},
  97       {index, [date_post]},
  98       {disc_copies, [node()]}
  99    ]).
 100
 101
 102 % Connexion à la base de données de yaws sur overnux
 103 connect() ->
 104    connect(yaws@flynux).
 105 connect(Node) ->
 106    mnesia:start(),
 107    mnesia:change_config(extra_db_nodes, [Node]).
 108
 109
 110 % Efface toutes les données de la base de données.
 111 reset() ->
 112    mnesia:clear_table(counter),
 113    mnesia:clear_table(proprietes),
 114    mnesia:clear_table(user),
 115    mnesia:clear_table(reponse_minichat),
 116    mnesia:clear_table(minichat),
 117    mnesia:clear_table(troll),
 118    mnesia:clear_table(ip_table),
 119    % crée l'utilisateur root
 120    mnesia:transaction(fun() ->
 121       mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
 122       User = #user{id = 0, pseudo = "Sys", login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true},
 123       mnesia:write(User),
 124       User
 125    end).
 126
 127
 128 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
 129 % et exécute les patchs nécessaires.
 130 update() ->
 131    case mnesia:dirty_read({proprietes, version}) of
 132       [#proprietes{valeur = Version}] ->
 133          update(Version);
 134       _ ->
 135          erreur
 136    end.
 137
 138
 139 % Mise à jour de la BD.
 140 % attention : il est nécessaire de se trouver dans une transaction.
 141 update(?VERSION_BD) -> fini;
 142 update(Version) ->
 143    case mnesia:backup(fichier_backup(Version)) of
 144       ok ->
 145          case patch(Version) of
 146             ok ->
 147                mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
 148                update(Version + 1);
 149             Erreur ->
 150                Erreur
 151          end;
 152       {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
 153    end.
 154
 155
 156 % Applique une modification de la BD pour passer d'une version à la suivante.
 157 % crée un backup avant l'application du patch
 158 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
 159 % 1 -> 2
 160 patch(1) ->
 161    % traitement des users
 162    mnesia:transform_table(
 163       user,
 164       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}) ->
 165             {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}
 166       end,
 167       record_info(fields, user),
 168       user
 169    ),
 170    mnesia:transform_table(
 171       minichat,
 172       fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id}) ->
 173             {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id, Id}
 174       end,
 175       record_info(fields, minichat),
 176       minichat
 177    ),
 178    case mnesia:transaction(
 179       fun() ->
 180          % met à jour les enfants des racines
 181          % 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..
 182          Messages = e(q([M || M <- mnesia:table(minichat), euphorik_bd:parents(M#minichat.id) =:= []]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
 183          lists:foreach(fun(M) -> patch_1_traiter_message(M, M#minichat.id) end, Messages)
 184       end
 185    ) of
 186       {aborted, Raison} -> {erreur, Raison};
 187       {atomic, _} -> ok
 188    end.
 189 % 2 -> 3
 190 %patch(2) ->
 191
 192
 193 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
 194 % et renvoie "styles/1/euphorik.css"
 195 patch1_transforme_css(["css" | Reste]) ->
 196    ["styles" | Reste];
 197 patch1_transforme_css(F) ->
 198    F.
 199
 200
 201 patch_1_traiter_message(M, Racine) ->
 202    % met à jour la racine de chaque message qui répond à M
 203    lists:foreach(
 204       fun(M2) ->
 205          mnesia:write(M2#minichat{racine_id = Racine}),
 206          patch_1_traiter_message(M2, Racine)
 207       end,
 208       euphorik_bd:enfants(M#minichat.id)
 209    ).
 210
 211 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
 212 backup(Nom) ->
 213    mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
 214
 215
 216 % Reviens à une version précédente de la base de données
 217 % (les données insérées durant les versions plus récentes sont perdues)
 218 restore(N) ->
 219    mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
 220
 221
 222 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
 223 fichier_backup(Version) ->
 224    mnesia:system_info(directory) ++ "/backups/" ++ if is_integer(Version) -> "backup" ++ integer_to_list(Version); true -> Version end.