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