modules/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    toggle_ek_master/1,
  39    print_users/0,
  40    print_users/1,
  41    print_user/1
  42 ]).
  43 -import(qlc, [e/2, q/1, cursor/2]).
  44 -include("../include/euphorik_bd.hrl").
  45 -include("../include/euphorik_defines.hrl").
  46 -include_lib("stdlib/include/qlc.hrl").
  47
  48
  49 % Renvoie la version courante de la BD.
  50 version_bd() ->
  51    euphorik_bd:resultat_transaction(mnesia:transaction(
  52       fun() ->
  53          mnesia:read({proprietes, version})
  54       end
  55    )).
  56
  57
  58 % Instructions pour créer une nouvelle base :
  59 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
  60 % voir doc/installation.txt
  61 % >l(euphorik_bd).
  62 % >euphorik_bd:create().
  63 create() ->
  64    mnesia:stop(),
  65    mnesia:delete_schema([node()]),
  66    mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
  67    mnesia:start(),
  68    create_tables(),
  69    reset().
  70
  71 create_tables() ->
  72    mnesia:create_table(counter, [
  73       {attributes, record_info(fields, counter)},
  74       {disc_copies, [node()]}
  75    ]),
  76    mnesia:create_table(proprietes, [
  77       {attributes, record_info(fields, proprietes)},
  78       {disc_copies, [node()]}
  79    ]),
  80    mnesia:create_table(minichat, [
  81       {attributes, record_info(fields, minichat)},
  82       {index, [auteur_id, troll_id]},
  83       {disc_copies, [node()]}
  84    ]),
  85    mnesia:create_table(reponse_minichat, [
  86       {type, bag},
  87       {attributes, record_info(fields, reponse_minichat)},
  88       {index, [cible]},
  89       {disc_copies, [node()]}
  90    ]),
  91    mnesia:create_table(user, [
  92       {attributes, record_info(fields, user)},
  93       {index, [cookie, login]},
  94       {disc_copies, [node()]}
  95    ]),
  96    mnesia:create_table(ip_table, [
  97       {attributes, record_info(fields, ip_table)},
  98       {disc_copies, [node()]}
  99    ]),
 100    mnesia:create_table(troll, [
 101       {attributes, record_info(fields, troll)},
 102       {index, [date_post]},
 103       {disc_copies, [node()]}
 104    ]).
 105
 106
 107 % Connexion à la base de données de yaws sur overnux
 108 connect() ->
 109    connect(yaws@flynux).
 110 connect(Node) ->
 111    mnesia:start(),
 112    mnesia:change_config(extra_db_nodes, [Node]).
 113
 114
 115 % Efface toutes les données de la base de données.
 116 reset() ->
 117    mnesia:clear_table(counter),
 118    mnesia:clear_table(proprietes),
 119    mnesia:clear_table(user),
 120    mnesia:clear_table(reponse_minichat),
 121    mnesia:clear_table(minichat),
 122    mnesia:clear_table(troll),
 123    mnesia:clear_table(ip_table),
 124    % crée l'utilisateur root
 125    mnesia:transaction(fun() ->
 126       mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
 127       User = #user{id = 0, profile = #profile{pseudo = "Sys"}, login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true},
 128       mnesia:write(User),
 129       User
 130    end).
 131
 132
 133 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
 134 % et exécute les patchs nécessaires.
 135 update() ->
 136    case mnesia:dirty_read({proprietes, version}) of
 137       [#proprietes{valeur = Version}] ->
 138          update(Version);
 139       _ ->
 140          erreur
 141    end.
 142
 143
 144 % Mise à jour de la BD.
 145 % attention : il est nécessaire de se trouver dans une transaction.
 146 update(?VERSION_BD) -> fini;
 147 update(Version) ->
 148    case mnesia:backup(fichier_backup(Version)) of
 149       ok ->
 150          case patch(Version) of
 151             ok ->
 152                mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
 153                update(Version + 1);
 154             Erreur ->
 155                Erreur
 156          end;
 157       {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
 158    end.
 159
 160
 161 % Applique une modification de la BD pour passer d'une version à la suivante.
 162 % crée un backup avant l'application du patch
 163 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
 164 % 1 -> 2
 165 patch(1) ->
 166    % traitement des users
 167    mnesia:transform_table(
 168       user,
 169       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}) ->
 170             {user, Id, Cookie, Login, Password, {profile, Pseudo, Email, patch1_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}
 171       end,
 172       record_info(fields, user),
 173       user
 174    ),
 175    mnesia:transform_table(
 176       minichat,
 177       fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id}) ->
 178             {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id, Id}
 179       end,
 180       record_info(fields, minichat),
 181       minichat
 182    ),
 183    case mnesia:transaction(
 184       fun() ->
 185          % met à jour les enfants des racines
 186          % 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..
 187          Messages = e(q([M || M <- mnesia:table(minichat), euphorik_bd:parents(M#minichat.id) =:= []]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
 188          lists:foreach(fun(M) -> patch_1_traiter_message(M, M#minichat.id) end, Messages)
 189       end
 190    ) of
 191       {aborted, Raison} -> {erreur, Raison};
 192       {atomic, _} -> ok
 193    end.
 194 % 2 -> 3
 195 %patch(2) ->
 196
 197
 198 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
 199 % et renvoie "styles/1/euphorik.css"
 200 patch1_transforme_css(["css" | Reste]) ->
 201    ["styles" | Reste];
 202 patch1_transforme_css(F) ->
 203    F.
 204
 205
 206 patch_1_traiter_message(M, Racine) ->
 207    % met à jour la racine de chaque message qui répond à M
 208    lists:foreach(
 209       fun(M2) ->
 210          mnesia:write(M2#minichat{racine_id = Racine}),
 211          patch_1_traiter_message(M2, Racine)
 212       end,
 213       euphorik_bd:enfants(M#minichat.id)
 214    ).
 215
 216 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
 217 backup(Nom) ->
 218    mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
 219
 220
 221 % Reviens à une version précédente de la base de données
 222 % (les données insérées durant les versions plus récentes sont perdues)
 223 restore(N) ->
 224    mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
 225
 226
 227 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
 228 fichier_backup(Version) ->
 229    mnesia:system_info(directory) ++ "/backups/" ++ if is_integer(Version) -> "backup" ++ integer_to_list(Version); true -> Version end.
 230
 231
 232 toggle_ek_master(User_id) ->
 233    euphorik_bd:resultat_transaction(mnesia:transaction(
 234       fun() ->
 235          Users = e(q([E || E <- mnesia:table(user), E#user.id =:= User_id]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
 236          case Users of
 237             [User] ->
 238                mnesia:write(User#user{ek_master = not User#user.ek_master});
 239             _ -> erreur
 240          end
 241       end
 242    )).
 243
 244
 245 % Affiche N user trié par leur date de dernière connexion.
 246 % Opt est une liste d'option d'affichage :
 247 %  * ekmaster : n'affiche que les admins
 248 print_users(N, Opt) ->
 249    AfficheQueLesEkMaster = lists:any(fun(O) -> O =:= ekmaster end, Opt),
 250    euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
 251       C = cursor(
 252          qlc:keysort(
 253             #user.date_derniere_connexion,
 254             if AfficheQueLesEkMaster ->
 255                q([E || E <- mnesia:table(user), E#user.ek_master =:= true]);
 256             true ->
 257                q([E || E <- mnesia:table(user)])
 258             end,
 259             [{order, descending}]
 260          ),
 261          [{tmpdir, ?KEY_SORT_TEMP_DIR}]
 262       ),
 263       Users = qlc:next_answers(C, N),
 264       lists:foreach(
 265          fun(U) ->
 266             print_user(U)
 267          end,
 268          Users
 269       ),
 270       qlc:delete_cursor(C)
 271    end)).
 272
 273
 274 % Affiche tous les users.
 275 print_users(Opt) ->
 276    print_users(all_remaining, Opt).
 277
 278 % Affiche tous les users.
 279 print_users() ->
 280    print_users(all_remaining, []).
 281
 282 print_user(User) when is_record(User, user) ->
 283    #user{id = Id, profile = #profile{pseudo = Pseudo}, login = Login, ek_master = Ek_master, date_derniere_connexion = Date, last_ip = IP} = User,
 284    {{Annee, Mois, Jour}, {Heure, Min, _}} = calendar:now_to_local_time(Date),
 285    io:format(
 286       % id        pseudo     (login)        IP  Jour  Mois   Année  Heure Minute
 287       "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
 288       [
 289          Id,
 290          if Ek_master -> "*"; true -> "" end ++ Pseudo,
 291          Login,
 292          euphorik_common:serialize_ip(IP),
 293          Jour, Mois, Annee, Heure, Min
 294       ]
 295    );
 296 % Affichage d'un user en fonction de son login
 297 print_user(Login) when is_list(Login) ->
 298    case euphorik_bd:user_by_login(Login) of
 299       {ok, User} ->
 300          print_user(User);
 301       _ ->
 302          {erreur, "Login pas trouvé : " ++ Login}
 303    end;
 304 % Affichage d'un user en fonction de son id
 305 print_user(Id) when is_integer(Id) ->
 306    case euphorik_bd:user_by_id(Id) of
 307       {ok, User} ->
 308          print_user(User);
 309       _ ->
 310          {erreur, "Id pas trouvé : " ++ integer_to_list(Id)}
 311    end.
 312