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