X-Git-Url: http://git.euphorik.ch/?p=euphorik.git;a=blobdiff_plain;f=modules%2Ferl%2Feuphorik_bd_admin.erl;fp=modules%2Ferl%2Feuphorik_bd_admin.erl;h=84fe459ad407507f52a8a187fa403bee09ae65a2;hp=e5c20bcda2abcab6c3cc69a4895f08e8669c1ecf;hb=808fb60f6c10dfcaccee94c6a49f768de84dc2ef;hpb=5d9992368bb386d2e606ae037c5478fe10ac70e8

diff --git a/modules/erl/euphorik_bd_admin.erl b/modules/erl/euphorik_bd_admin.erl
index e5c20bc..84fe459 100644
--- a/modules/erl/euphorik_bd_admin.erl
+++ b/modules/erl/euphorik_bd_admin.erl
@@ -16,12 +16,9 @@
 % You should have received a copy of the GNU General Public License
 % along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
 %
-% Module mettant à disposition tout un tas de fonction pour l'administration de la base de données euphorik comme :
-%  - Création de la BD
-%  - Mise à jour de la BD
-%  - Backup et restauration
-%  - Copie de la BD à partir d'un autre noeud
-
+% Some functions to manage the database like creating, updating, backuping etc.
+%
+% @author G.Burri
 
 -module(euphorik_bd_admin).
 -author("Greg Burri <greg.burri@gmail.com>").
@@ -42,13 +39,14 @@
    print_users/1,
    print_user/1
 ]).
+
 -import(qlc, [e/2, q/1, cursor/2]).
+
 -include("../include/euphorik_bd.hrl").
 -include("../include/euphorik_defines.hrl").
 -include_lib("stdlib/include/qlc.hrl").
 
-
-% Renvoie la version courante de la BD.
+% Return the current version of the DB.
 version_bd() ->
    euphorik_bd:resultat_transaction(mnesia:transaction(
       fun() ->
@@ -56,12 +54,11 @@ version_bd() ->
       end
    )).
 
-
-% Instructions pour créer une nouvelle base :
-% $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
-% voir doc/installation.txt
-% >l(euphorik_bd).
-% >euphorik_bd:create().
+% Create a the database. Warning: it will delete all existent data.
+% Example:
+%  $erl -sname yaws -mnesia dir '"/projects/euphorik/DB"'
+%  >l(euphorik_admin).
+%  >euphorik_bd:create().
 create() ->
    mnesia:stop(),
    mnesia:delete_schema([node()]),
@@ -106,12 +103,11 @@ create_tables() ->
       {attributes, record_info(fields, troll)},
       {disc_copies, [node()]}
    ]),
-   creer_indexes().
+   create_indexes().
 
-
-% mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
-creer_indexes() ->
-   % commence par supprimer les anciens indexes
+% Create all the needed indexes on the tables.
+create_indexes() ->
+   % Delete all existing indexes.
    lists:foreach(fun(T) ->
          lists:foreach(fun(P) ->
                mnesia:del_table_index(T, P)
@@ -128,16 +124,14 @@ creer_indexes() ->
    mnesia:add_table_index(troll, date_post),
    mnesia:add_table_index(troll, id_minichat).
 
-
-% Connexion à la base de données de yaws sur overnux
+% To connect to an remote database node.
 connect() ->
-   connect(yaws@flynux).
+   connect(yaws@x220).
 connect(Node) ->
    mnesia:start(),
    mnesia:change_config(extra_db_nodes, [Node]).
 
-
-% Efface toutes les données de la base de données.
+% Remove all data.
 reset() ->
    mnesia:clear_table(counter),
    mnesia:clear_table(proprietes),
@@ -147,17 +141,16 @@ reset() ->
    mnesia:clear_table(minichat),
    mnesia:clear_table(troll),
    mnesia:clear_table(ip_table),
-   % crée l'utilisateur root
+   % Create the root user.
    mnesia:transaction(fun() ->
-      mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
+      mnesia:write(#proprietes{nom = version, valeur = ?DB_VERSION}),
       User = #user{id = 0, profile = #profile{pseudo = "Sys"}, login = "Sys", date_creation = erlang:timestamp(), date_derniere_connexion = erlang:timestamp(), ek_master = true},
       mnesia:write(User),
       User
    end),
-   peupler_texte().
-
+   populate_text().
 
-peupler_texte() ->
+populate_text() ->
    mnesia:transaction(fun() ->
       mnesia:write(#texte{ id = 10, fr = "Login déjà existant"}),
       mnesia:write(#texte{ id = 20, fr = "Trop de register (flood)"}),
@@ -168,7 +161,7 @@ peupler_texte() ->
       mnesia:write(#texte{ id = 70, fr = "Page inconnue"}),
       mnesia:write(#texte{ id = 80, fr = "Vous êtes banni pour encore ~s"}),
       mnesia:write(#texte{ id = 90, fr = "Message vide"}),
-      mnesia:write(#texte{ id = 100, fr = "Impossible d'ajouter un nouveau message. Raison : ~s"}),
+      mnesia:write(#texte{ id = 100, fr = "Impossible d'ajouter un nouveau message. Cause : ~s"}),
       mnesia:write(#texte{ id = 110, fr = "Utilisateur inconnu"}),
       mnesia:write(#texte{ id = 120, fr = "Il n'est pas possible de s'auto bannir"}),
       mnesia:write(#texte{ id = 130, fr = "L'utilisateur est lui même un ekMaster"}),
@@ -179,32 +172,26 @@ peupler_texte() ->
       mnesia:write(#texte{ id = 230, fr = "Seul les ekMaster peuvent connaitre la liste des ips bannies"})
    end).
 
-
-% Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
-% et exécute les patchs nécessaires.
+% Update the database to the latest version (?DB_VERSION).
 update() ->
    case mnesia:dirty_read({proprietes, version}) of
       [#proprietes{valeur = Version}] ->
          update(Version);
       _ ->
-         erreur
+         error
    end.
-
-
-% Mise à jour de la BD.
-% attention : il est nécessaire de se trouver dans une transaction.
-update(?VERSION_BD) -> fini;
+update(?DB_VERSION) -> finished;
 update(Version) ->
-   case mnesia:backup(fichier_backup(Version)) of
+   case mnesia:backup(backup_file_path(Version)) of
       ok ->
          case patch(Version) of
             ok ->
                mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
                update(Version + 1);
-            Erreur ->
-               Erreur
+            Error ->
+               Error
          end;
-      {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
+      {error, Message} -> {error, lists:flatten(io_lib:format("Error: unable to create a backup file prior updating the database to the version ~w: ~w", [Version, Message]))}
    end.
 
 
@@ -255,7 +242,7 @@ patch(1) ->
       {attributes, record_info(fields, texte)},
       {disc_copies, [node()]}
    ]),
-   peupler_texte(),
+   populate_text(),
    % traitement des users
    mnesia:transform_table(
       user,
@@ -279,7 +266,7 @@ patch(1) ->
          lists:foreach(fun(M) -> Traiter_message(M, M#minichat.id) end, Messages)
       end
    ) of
-      {aborted, Raison} -> {erreur, Raison};
+      {aborted, Cause} -> {error, Cause};
       {atomic, _} -> ok
    end;
 % 2 -> 3
@@ -319,7 +306,7 @@ patch(2) ->
       % la table troll utilise maintenant son index et pas celui de la table minichat (correction d'un vieux bug)
       mnesia:write(#counter{key = troll, value = mnesia:table_info(minichat, size)})
    end),
-   creer_indexes(). % uniquement pour l'indice sur id_minichat de la table troll
+   create_indexes(). % uniquement pour l'indice sur id_minichat de la table troll
 
 
 % Renvoie le dossier dans lequel les backups sont effectué, ce dossier doit être en écriture.
@@ -328,7 +315,7 @@ dossier_backups() ->
 
 
 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
-fichier_backup(Version) when is_integer(Version) ->
+backup_file_path(Version) when is_integer(Version) ->
    dossier_backups() ++ "backup" ++ integer_to_list(Version).
 
 
@@ -343,7 +330,7 @@ restore(Fichier) when is_list(Fichier) ->
 % Reviens à une version précédente de la base de données.
 % (les données insérées durant les versions plus récentes sont perdues).
 restore(Version) when is_integer(Version) ->
-   mnesia:restore(fichier_backup(Version), []). % [{default_op, recreate_tables}]).
+   mnesia:restore(backup_file_path(Version), []). % [{default_op, recreate_tables}]).
 
 
 % Change le nom du noeud d'un backup.
@@ -380,24 +367,6 @@ change_node_name(From, To, Source, Target) ->
         end,
     mnesia:traverse_backup(Source, Target, Convert, switched).
 
-
-% Obsolète
-%~ backup_text(File) ->
-   %~ mnesia:dump_to_textfile(File).
-%~ restore_text(File) ->
-   %~ mnesia:stop(),
-   %~ mnesia:delete_schema([node()]),
-   %~ mnesia:start(),
-   %~ create_tables(),
-   %~ case mnesia:load_textfile(File) of
-      %~ {atomic, ok} ->
-         %~ update(),
-         %~ creer_indexes();
-      %~ Erreur ->
-         %~ Erreur
-   %~ end.
-
-
 toggle_ek_master(User_id) ->
    euphorik_bd:resultat_transaction(mnesia:transaction(
       fun() ->
@@ -405,7 +374,7 @@ toggle_ek_master(User_id) ->
          case Users of
             [User] ->
                mnesia:write(User#user{ek_master = not User#user.ek_master});
-            _ -> erreur
+            _ -> error
          end
       end
    )).
@@ -468,7 +437,7 @@ print_user(Login) when is_list(Login) ->
       {ok, User} ->
          print_user(User);
       _ ->
-         {erreur, "Login pas trouvé : " ++ Login}
+         {error, "Login pas trouvé : " ++ Login}
    end;
 % Affichage d'un user en fonction de son id
 print_user(Id) when is_integer(Id) ->
@@ -476,6 +445,6 @@ print_user(Id) when is_integer(Id) ->
       {ok, User} ->
          print_user(User);
       _ ->
-         {erreur, "Id pas trouvé : " ++ integer_to_list(Id)}
+         {error, "Id pas trouvé : " ++ integer_to_list(Id)}
    end.