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
  26 -module(euphorik_bd_admin).
  27 -author("Greg Burri <greg.burri@gmail.com>").
  28 -export([
  29    version_bd/0,
  30    create/0,
  31    connect/0,
  32    connect/1,
  33    reset/0,
  34    update/0,
  35
  36    backup/1,
  37    restore/1,
  38    change_node_name/4,
  39
  40    toggle_ek_master/1,
  41    print_users/0,
  42    print_users/1,
  43    print_user/1
  44 ]).
  45 -import(qlc, [e/2, q/1, cursor/2]).
  46 -include("../include/euphorik_bd.hrl").
  47 -include("../include/euphorik_defines.hrl").
  48 -include_lib("stdlib/include/qlc.hrl").
  49
  50
  51 % Renvoie la version courante de la BD.
  52 version_bd() ->
  53    euphorik_bd:resultat_transaction(mnesia:transaction(
  54       fun() ->
  55          mnesia:read({proprietes, version})
  56       end
  57    )).
  58
  59
  60 % Instructions pour créer une nouvelle base :
  61 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
  62 % voir doc/installation.txt
  63 % >l(euphorik_bd).
  64 % >euphorik_bd:create().
  65 create() ->
  66    mnesia:stop(),
  67    mnesia:delete_schema([node()]),
  68    mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
  69    mnesia:start(),
  70    create_tables(),
  71    reset().
  72
  73 create_tables() ->
  74    mnesia:create_table(counter, [
  75       {attributes, record_info(fields, counter)},
  76       {disc_copies, [node()]}
  77    ]),
  78    mnesia:create_table(proprietes, [
  79       {attributes, record_info(fields, proprietes)},
  80       {disc_copies, [node()]}
  81    ]),
  82    mnesia:create_table(texte, [
  83       {attributes, record_info(fields, texte)},
  84       {disc_copies, [node()]}
  85    ]),
  86    mnesia:create_table(minichat, [
  87       {type, ordered_set},
  88       {attributes, record_info(fields, minichat)},
  89       {disc_copies, [node()]}
  90    ]),
  91    mnesia:create_table(reponse_minichat, [
  92       {type, bag},
  93       {attributes, record_info(fields, reponse_minichat)},
  94       {disc_copies, [node()]}
  95    ]),
  96    mnesia:create_table(user, [
  97       {attributes, record_info(fields, user)},
  98       {disc_copies, [node()]}
  99    ]),
 100    mnesia:create_table(ip_table, [
 101       {attributes, record_info(fields, ip_table)},
 102       {disc_copies, [node()]}
 103    ]),
 104    % This table is not used anymore.
 105    mnesia:create_table(troll, [
 106       {attributes, record_info(fields, troll)},
 107       {disc_copies, [node()]}
 108    ]),
 109    creer_indexes().
 110
 111
 112 % mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
 113 creer_indexes() ->
 114    % commence par supprimer les anciens indexes
 115    lists:foreach(fun(T) ->
 116          lists:foreach(fun(P) ->
 117                mnesia:del_table_index(T, P)
 118             end,
 119             mnesia:table_info(T, index)
 120          )
 121       end,
 122       ?TABLES
 123    ),
 124    mnesia:add_table_index(minichat, auteur_id),
 125    mnesia:add_table_index(reponse_minichat, cible),
 126    mnesia:add_table_index(user, cookie),
 127    mnesia:add_table_index(user, login),
 128    mnesia:add_table_index(troll, date_post),
 129    mnesia:add_table_index(troll, id_minichat).
 130
 131
 132 % Connexion à la base de données de yaws sur overnux
 133 connect() ->
 134    connect(yaws@flynux).
 135 connect(Node) ->
 136    mnesia:start(),
 137    mnesia:change_config(extra_db_nodes, [Node]).
 138
 139
 140 % Efface toutes les données de la base de données.
 141 reset() ->
 142    mnesia:clear_table(counter),
 143    mnesia:clear_table(proprietes),
 144    mnesia:clear_table(texte),
 145    mnesia:clear_table(user),
 146    mnesia:clear_table(reponse_minichat),
 147    mnesia:clear_table(minichat),
 148    mnesia:clear_table(troll),
 149    mnesia:clear_table(ip_table),
 150    % crée l'utilisateur root
 151    mnesia:transaction(fun() ->
 152       mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
 153       User = #user{id = 0, profile = #profile{pseudo = "Sys"}, login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true},
 154       mnesia:write(User),
 155       User
 156    end),
 157    peupler_texte().
 158
 159
 160 peupler_texte() ->
 161    mnesia:transaction(fun() ->
 162       mnesia:write(#texte{ id = 10, fr = "Login déjà existant"}),
 163       mnesia:write(#texte{ id = 20, fr = "Trop de register (flood)"}),
 164       mnesia:write(#texte{ id = 30, fr = "Couple login/pass introuvable"}),
 165       mnesia:write(#texte{ id = 40, fr = "Authentification impossible par cookie"}),
 166       mnesia:write(#texte{ id = 50, fr = "Impossible de mettre à jour le profile"}),
 167       mnesia:write(#texte{ id = 60, fr = "timeout"}),
 168       mnesia:write(#texte{ id = 70, fr = "Page inconnue"}),
 169       mnesia:write(#texte{ id = 80, fr = "Vous êtes banni pour encore ~s"}),
 170       mnesia:write(#texte{ id = 90, fr = "Message vide"}),
 171       mnesia:write(#texte{ id = 100, fr = "Impossible d'ajouter un nouveau message. Raison : ~s"}),
 172       mnesia:write(#texte{ id = 110, fr = "Utilisateur inconnu"}),
 173       mnesia:write(#texte{ id = 120, fr = "Il n'est pas possible de s'auto bannir"}),
 174       mnesia:write(#texte{ id = 130, fr = "L'utilisateur est lui même un ekMaster"}),
 175       mnesia:write(#texte{ id = 140, fr = "Utilisateur à bannir inconnu"}),
 176       mnesia:write(#texte{ id = 150, fr = "Utilisateur inconnu ou non ek master"}),
 177       mnesia:write(#texte{ id = 160, fr = "Utilisateur à slaper inconnu"}),
 178       mnesia:write(#texte{ id = 170, fr = "Utilisateur inconnu ou non ek master"}),
 179       mnesia:write(#texte{ id = 230, fr = "Seul les ekMaster peuvent connaitre la liste des ips bannies"})
 180    end).
 181
 182
 183 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
 184 % et exécute les patchs nécessaires.
 185 update() ->
 186    case mnesia:dirty_read({proprietes, version}) of
 187       [#proprietes{valeur = Version}] ->
 188          update(Version);
 189       _ ->
 190          erreur
 191    end.
 192
 193
 194 % Mise à jour de la BD.
 195 % attention : il est nécessaire de se trouver dans une transaction.
 196 update(?VERSION_BD) -> fini;
 197 update(Version) ->
 198    case mnesia:backup(fichier_backup(Version)) of
 199       ok ->
 200          case patch(Version) of
 201             ok ->
 202                mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
 203                update(Version + 1);
 204             Erreur ->
 205                Erreur
 206          end;
 207       {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
 208    end.
 209
 210
 211 % Applique une modification de la BD pour passer d'une version à la suivante.
 212 % crée un backup avant l'application du patch
 213 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
 214 % 1 -> 2
 215 patch(1) ->
 216    % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
 217    % et renvoie "styles/1/euphorik.css"
 218    Transforme_css = fun("css" ++ Reste) ->
 219          "styles" ++ Reste;
 220          (F) -> F
 221    end,
 222    Traiter_message = fun(M, Racine) ->
 223       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
 224          % met à jour la racine de chaque message qui répond à M
 225          lists:foreach(
 226             fun(M3) ->
 227                mnesia:write(M2#minichat{racine_id = Racine}),
 228                F(F, M3)
 229             end,
 230             euphorik_bd:enfants(M#minichat.id)
 231          )
 232       end,
 233       F(F, M)
 234    end,
 235    % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
 236    % et renvoie "styles/1/euphorik.css"
 237    Transforme_css = fun("css" ++ Reste) ->
 238          "styles" ++ Reste;
 239          (F) -> F
 240    end,
 241    Traiter_message = fun(M, Racine) ->
 242       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
 243          % met à jour la racine de chaque message qui répond à M
 244          lists:foreach(
 245             fun(M3) ->
 246                mnesia:write(M2#minichat{racine_id = Racine}),
 247                F(F, M3)
 248             end,
 249             euphorik_bd:enfants(M#minichat.id)
 250          )
 251       end,
 252       F(F, M)
 253    end,
 254    mnesia:create_table(texte, [
 255       {attributes, record_info(fields, texte)},
 256       {disc_copies, [node()]}
 257    ]),
 258    peupler_texte(),
 259    % traitement des users
 260    mnesia:transform_table(
 261       user,
 262       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}) ->
 263             {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}
 264       end,
 265       record_info(fields, user)
 266    ),
 267    mnesia:transform_table(
 268       minichat,
 269       fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id}) ->
 270             {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id, Id}
 271       end,
 272       record_info(fields, minichat)
 273    ),
 274    case mnesia:transaction(
 275       fun() ->
 276          % met à jour les enfants des racines
 277          % 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..
 278          Messages = e(q([M || M <- mnesia:table(minichat), euphorik_bd:parents(M#minichat.id) =:= []]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
 279          lists:foreach(fun(M) -> Traiter_message(M, M#minichat.id) end, Messages)
 280       end
 281    ) of
 282       {aborted, Raison} -> {erreur, Raison};
 283       {atomic, _} -> ok
 284    end;
 285 % 2 -> 3
 286 patch(2) ->
 287    mnesia:transform_table(
 288       troll,
 289       fun({troll, Id_troll, Id_user, Date_create, Date_post, Content}) ->
 290          % recherche le message associé s'il existe
 291          Id_minichat = case e(q([M || M <- mnesia:table(minichat), element(7, M) =:= Id_troll]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]) of
 292             [M] -> element(2, M);
 293             _ -> undefined
 294          end,
 295          {troll, Id_troll, Id_user, Id_minichat, Date_create, Date_post, Content}
 296       end,
 297       record_info(fields, troll)
 298    ),
 299    %mnesia:del_table_index(minichat, troll_id),
 300    mnesia:transform_table(
 301       minichat,
 302       fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, _Troll_id, Racine_id}) ->
 303          {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Racine_id, normal}
 304       end,
 305       record_info(fields, minichat)
 306    ),
 307    mnesia:transaction(fun() ->
 308       % comble les trous entre les id non-contigues
 309       lists:foreach(fun(Id) ->
 310             case mnesia:read({minichat, Id}) of
 311                [] ->
 312                   {ok, #user{profile = Profile}} = euphorik_bd:user_by_id(0),
 313                   mnesia:write(#minichat{id = Id, auteur_id = 0, date = undefined, pseudo = Profile#profile.pseudo, contenu = "Comblement...", racine_id = Id, status = deleted});
 314                _ -> rien
 315             end
 316          end,
 317          lists:seq(1, mnesia:table_info(minichat, size))
 318       ),
 319       % la table troll utilise maintenant son index et pas celui de la table minichat (correction d'un vieux bug)
 320       mnesia:write(#counter{key = troll, value = mnesia:table_info(minichat, size)})
 321    end),
 322    creer_indexes(). % uniquement pour l'indice sur id_minichat de la table troll
 323
 324
 325 % Renvoie le dossier dans lequel les backups sont effectué, ce dossier doit être en écriture.
 326 dossier_backups() ->
 327    mnesia:system_info(directory) ++ "/backups/".
 328
 329
 330 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
 331 fichier_backup(Version) when is_integer(Version) ->
 332    dossier_backups() ++ "backup" ++ integer_to_list(Version).
 333
 334
 335 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
 336 backup(Fichier) ->
 337    mnesia:backup(dossier_backups() ++ Fichier).
 338
 339
 340 % Restaure un backup de la BD.
 341 restore(Fichier) when is_list(Fichier) ->
 342    mnesia:restore(dossier_backups() ++ Fichier, []);
 343 % Reviens à une version précédente de la base de données.
 344 % (les données insérées durant les versions plus récentes sont perdues).
 345 restore(Version) when is_integer(Version) ->
 346    mnesia:restore(fichier_backup(Version), []). % [{default_op, recreate_tables}]).
 347
 348
 349 % Change le nom du noeud d'un backup.
 350 % provient d'ici : http://www.erlang.org/doc/apps/mnesia/Mnesia_chap7.html#6.9
 351 % From : l'ancien nom
 352 % To : le nouveau nom
 353 % Source : le nom du fichier de backup
 354 % Target : le nom du fichier du nouveau backup
 355 change_node_name(From, To, Source, Target) ->
 356     Switch =
 357         fun(Node) when Node == From -> To;
 358            (Node) when Node == To -> throw({error, already_exists});
 359            (Node) -> Node
 360         end,
 361     Convert =
 362         fun({schema, db_nodes, Nodes}, Acc) ->
 363                 {[{schema, db_nodes, lists:map(Switch,Nodes)}], Acc};
 364            ({schema, version, Version}, Acc) ->
 365                 {[{schema, version, Version}], Acc};
 366            ({schema, cookie, Cookie}, Acc) ->
 367                 {[{schema, cookie, Cookie}], Acc};
 368            ({schema, Tab, CreateList}, Acc) ->
 369                 Keys = [ram_copies, disc_copies, disc_only_copies],
 370                 OptSwitch =
 371                     fun({Key, Val}) ->
 372                             case lists:member(Key, Keys) of
 373                                 true -> {Key, lists:map(Switch, Val)};
 374                                 false-> {Key, Val}
 375                             end
 376                     end,
 377                 {[{schema, Tab, lists:map(OptSwitch, CreateList)}], Acc};
 378            (Other, Acc) ->
 379                 {[Other], Acc}
 380         end,
 381     mnesia:traverse_backup(Source, Target, Convert, switched).
 382
 383
 384 % Obsolète
 385 %~ backup_text(File) ->
 386    %~ mnesia:dump_to_textfile(File).
 387 %~ restore_text(File) ->
 388    %~ mnesia:stop(),
 389    %~ mnesia:delete_schema([node()]),
 390    %~ mnesia:start(),
 391    %~ create_tables(),
 392    %~ case mnesia:load_textfile(File) of
 393       %~ {atomic, ok} ->
 394          %~ update(),
 395          %~ creer_indexes();
 396       %~ Erreur ->
 397          %~ Erreur
 398    %~ end.
 399
 400
 401 toggle_ek_master(User_id) ->
 402    euphorik_bd:resultat_transaction(mnesia:transaction(
 403       fun() ->
 404          Users = e(q([E || E <- mnesia:table(user), E#user.id =:= User_id]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
 405          case Users of
 406             [User] ->
 407                mnesia:write(User#user{ek_master = not User#user.ek_master});
 408             _ -> erreur
 409          end
 410       end
 411    )).
 412
 413
 414 % Affiche N user trié par leur date de dernière connexion.
 415 % Opt est une liste d'option d'affichage :
 416 %  * ekmaster : n'affiche que les admins
 417 print_users(N, Opt) ->
 418    AfficheQueLesEkMaster = lists:any(fun(O) -> O =:= ekmaster end, Opt),
 419    euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
 420       C = cursor(
 421          qlc:keysort(
 422             #user.date_derniere_connexion,
 423             if AfficheQueLesEkMaster ->
 424                q([E || E <- mnesia:table(user), E#user.ek_master =:= true]);
 425             true ->
 426                q([E || E <- mnesia:table(user)])
 427             end,
 428             [{order, descending}]
 429          ),
 430          [{tmpdir, ?KEY_SORT_TEMP_DIR}]
 431       ),
 432       Users = qlc:next_answers(C, N),
 433       lists:foreach(
 434          fun(U) ->
 435             print_user(U)
 436          end,
 437          Users
 438       ),
 439       qlc:delete_cursor(C)
 440    end)).
 441
 442
 443 % Affiche tous les users.
 444 print_users(Opt) ->
 445    print_users(all_remaining, Opt).
 446
 447 % Affiche tous les users.
 448 print_users() ->
 449    print_users(all_remaining, []).
 450
 451 print_user(User) when is_record(User, user) ->
 452    #user{id = Id, profile = #profile{pseudo = Pseudo}, login = Login, ek_master = Ek_master, date_derniere_connexion = Date, last_ip = IP} = User,
 453    {{Annee, Mois, Jour}, {Heure, Min, _}} = calendar:now_to_local_time(Date),
 454    io:format(
 455       % id        pseudo     (login)        IP  Jour  Mois   Année  Heure Minute
 456       "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
 457       [
 458          Id,
 459          if Ek_master -> "*"; true -> "" end ++ Pseudo,
 460          Login,
 461          euphorik_common:serialize_ip(IP),
 462          Jour, Mois, Annee, Heure, Min
 463       ]
 464    );
 465 % Affichage d'un user en fonction de son login
 466 print_user(Login) when is_list(Login) ->
 467    case euphorik_bd:user_by_login(Login) of
 468       {ok, User} ->
 469          print_user(User);
 470       _ ->
 471          {erreur, "Login pas trouvé : " ++ Login}
 472    end;
 473 % Affichage d'un user en fonction de son id
 474 print_user(Id) when is_integer(Id) ->
 475    case euphorik_bd:user_by_id(Id) of
 476       {ok, User} ->
 477          print_user(User);
 478       _ ->
 479          {erreur, "Id pas trouvé : " ++ integer_to_list(Id)}
 480    end.
 481