2 % Copyright 2008 Grégory Burri
4 % This file is part of Euphorik.
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.
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.
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/>.
19 % Module mettant à disposition tout un tas de fonction pour l'administration de la base de données euphorik comme :
21 % - Mise à jour de la BD
22 % - Backup et restauration
23 % - Copie de la BD à partir d'un autre noeud
28 -module(euphorik_bd_admin
).
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").
52 % Renvoie la version courante de la BD.
54 euphorik_bd:resultat_transaction(mnesia:transaction(
56 mnesia:read({proprietes
, version
})
61 % Instructions pour créer une nouvelle base :
62 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
63 % voir doc/installation.txt
65 % >euphorik_bd:create().
68 mnesia:delete_schema([node()]),
69 mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
75 mnesia:create_table(counter
, [
76 {attributes
, record_info(fields
, counter
)},
77 {disc_copies
, [node()]}
79 mnesia:create_table(proprietes
, [
80 {attributes
, record_info(fields
, proprietes
)},
81 {disc_copies
, [node()]}
83 mnesia:create_table(texte
, [
84 {attributes
, record_info(fields
, texte
)},
85 {disc_copies
, [node()]}
87 mnesia:create_table(minichat
, [
89 {attributes
, record_info(fields
, minichat
)},
90 {disc_copies
, [node()]}
92 mnesia:create_table(reponse_minichat
, [
94 {attributes
, record_info(fields
, reponse_minichat
)},
95 {disc_copies
, [node()]}
97 mnesia:create_table(user
, [
98 {attributes
, record_info(fields
, user
)},
99 {disc_copies
, [node()]}
101 mnesia:create_table(ip_table
, [
102 {attributes
, record_info(fields
, ip_table
)},
103 {disc_copies
, [node()]}
105 mnesia:create_table(troll
, [
106 {attributes
, record_info(fields
, troll
)},
107 {disc_copies
, [node()]}
112 % mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
114 % commence par supprimer les anciens indexes
115 lists:foreach(fun(T
) ->
116 lists:foreach(fun(P
) ->
117 mnesia:del_table_index(T
, P
)
119 mnesia:table_info(T
, index
)
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
).
132 % Connexion à la base de données de yaws sur overnux
134 connect(yaws@flynux
).
137 mnesia:change_config(extra_db_nodes
, [Node
]).
140 % Efface toutes les données de la base de données.
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
},
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
= 180, fr
= "Le nombre de troll maximum par utilisateur est atteint : ~w "}),
180 mnesia:write(#texte
{ id
= 190, fr
= "Le nombre de troll maximum en attente est atteint : ~w "}),
181 mnesia:write(#texte
{ id
= 200, fr
= "Seul les ekMaster peuvent proposer des trolls"}),
182 mnesia:write(#texte
{ id
= 210, fr
= "Vous ne posséder pas ce troll"}),
183 mnesia:write(#texte
{ id
= 220, fr
= "Seul les ekMaster peuvent proposer des trolls"}),
184 mnesia:write(#texte
{ id
= 230, fr
= "Seul les ekMaster peuvent connaitre la liste des ips bannies"})
188 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
189 % et exécute les patchs nécessaires.
191 case mnesia:dirty_read({proprietes
, version
}) of
192 [#proprietes
{valeur
= Version
}] ->
199 % Mise à jour de la BD.
200 % attention : il est nécessaire de se trouver dans une transaction.
201 update(?VERSION_BD
) -> fini
;
203 case mnesia:backup(fichier_backup(Version
)) of
205 case patch(Version
) of
207 mnesia:dirty_write(#proprietes
{nom
= version
, valeur
= Version
+ 1}),
212 {error
, Raison
} -> {error
, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version
, Raison
]))}
216 % Applique une modification de la BD pour passer d'une version à la suivante.
217 % crée un backup avant l'application du patch
218 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
221 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
222 % et renvoie "styles/1/euphorik.css"
223 Transforme_css
= fun("css" ++ Reste
) ->
227 Traiter_message
= fun(M
, Racine
) ->
228 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
229 % met à jour la racine de chaque message qui répond à M
232 mnesia:write(M2#minichat
{racine_id
= Racine
}),
235 euphorik_bd:enfants(M#minichat
.id
)
240 mnesia:create_table(texte
, [
241 {attributes
, record_info(fields
, texte
)},
242 {disc_copies
, [node()]}
245 % traitement des users
246 mnesia:transform_table(
248 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
}) ->
249 {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
}
251 record_info(fields
, user
)
253 mnesia:transform_table(
255 fun({minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Troll_id
}) ->
256 {minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Troll_id
, Id
}
258 record_info(fields
, minichat
)
260 case mnesia:transaction(
262 % met à jour les enfants des racines
263 % 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..
264 Messages
= e(q([M
|| M
<- mnesia:table(minichat
), euphorik_bd:parents(M#minichat
.id
) =:= []]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
265 lists:foreach(fun(M
) -> Traiter_message(M
, M#minichat
.id
) end, Messages
)
268 {aborted
, Raison
} -> {erreur
, Raison
};
273 % première étape : changer le type de la table minichat de set à ordered_set
274 % TODO : trouver un meilleur moyen que de passer par un backup
278 file:delete(dossier_backups() ++ "tmp"),
279 mnesia:transform_table(
281 fun({troll
, Id_troll
, Id_user
, Date_create
, Date_post
, Content
}) ->
282 % recherche le message associé s'il existe
283 Id_minichat
= case e(q([M
|| M
<- mnesia:table(minichat
), element(7, M
) =:= Id_troll
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]) of
284 [M
] -> element(2, M
);
287 {troll
, Id_troll
, Id_user
, Id_minichat
, Date_create
, Date_post
, Content
}
289 record_info(fields
, troll
)
291 %mnesia:del_table_index(minichat, troll_id),
292 mnesia:transform_table(
294 fun({minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, _Troll_id
, Racine_id
}) ->
295 {minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Racine_id
}
297 record_info(fields
, minichat
)
299 creer_indexes(). % uniquement pour l'indice sur id_minichat de la table troll
302 % Renvoie le dossier dans lequel les backups sont effectué, ce dossier doit être en écriture.
304 mnesia:system_info(directory
) ++ "/backups/".
307 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
308 fichier_backup(Version
) when is_integer(Version
) ->
309 dossier_backups() ++ "backup" ++ integer_to_list(Version
).
312 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
314 mnesia:backup(dossier_backups() ++ Fichier
).
317 % Restaure un backup de la BD.
318 restore(Fichier
) when is_list(Fichier
) ->
319 mnesia:restore(dossier_backups() ++ Fichier
, []);
320 % Reviens à une version précédente de la base de données.
321 % (les données insérées durant les versions plus récentes sont perdues).
322 restore(Version
) when is_integer(Version
) ->
323 mnesia:restore(fichier_backup(Version
), []). % [{default_op, recreate_tables}]).
326 % Change le nom du noeud d'un backup.
327 % provient d'ici : http://www.erlang.org/doc/apps/mnesia/Mnesia_chap7.html#6.9
328 % From : l'ancien nom
329 % To : le nouveau nom
330 % Source : le nom du fichier de backup
331 % Target : le nom du fichier du nouveau backup
332 change_node_name(From
, To
, Source
, Target
) ->
334 fun(Node
) when Node
== From
-> To
;
335 (Node
) when Node
== To
-> throw({error
, already_exists
});
339 fun({schema
, db_nodes
, Nodes
}, Acc
) ->
340 {[{schema
, db_nodes
, lists:map(Switch
,Nodes
)}], Acc
};
341 ({schema
, version
, Version
}, Acc
) ->
342 {[{schema
, version
, Version
}], Acc
};
343 ({schema
, cookie
, Cookie
}, Acc
) ->
344 {[{schema
, cookie
, Cookie
}], Acc
};
345 ({schema
, Tab
, CreateList
}, Acc
) ->
346 Keys
= [ram_copies
, disc_copies
, disc_only_copies
],
349 case lists:member(Key
, Keys
) of
350 true
-> {Key
, lists:map(Switch
, Val
)};
354 {[{schema
, Tab
, lists:map(OptSwitch
, CreateList
)}], Acc
};
358 mnesia:traverse_backup(Source
, Target
, Convert
, switched
).
362 %~ backup_text(File) ->
363 %~ mnesia:dump_to_textfile(File).
364 %~ restore_text(File) ->
366 %~ mnesia:delete_schema([node()]),
369 %~ case mnesia:load_textfile(File) of
378 toggle_ek_master(User_id
) ->
379 euphorik_bd:resultat_transaction(mnesia:transaction(
381 Users
= e(q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= User_id
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
384 mnesia:write(User#user
{ek_master
= not User#user
.ek_master
});
391 % Affiche N user trié par leur date de dernière connexion.
392 % Opt est une liste d'option d'affichage :
393 % * ekmaster : n'affiche que les admins
394 print_users(N
, Opt
) ->
395 AfficheQueLesEkMaster
= lists:any(fun(O
) -> O
=:= ekmaster
end, Opt
),
396 euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
399 #user
.date_derniere_connexion
,
400 if AfficheQueLesEkMaster
->
401 q([E
|| E
<- mnesia:table(user
), E#user
.ek_master
=:= true
]);
403 q([E
|| E
<- mnesia:table(user
)])
405 [{order
, descending
}]
407 [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]
409 Users
= qlc:next_answers(C
, N
),
420 % Affiche tous les users.
422 print_users(all_remaining
, Opt
).
424 % Affiche tous les users.
426 print_users(all_remaining
, []).
428 print_user(User
) when is_record(User
, user
) ->
429 #user
{id
= Id
, profile
= #profile
{pseudo
= Pseudo
}, login
= Login
, ek_master
= Ek_master
, date_derniere_connexion
= Date
, last_ip
= IP
} = User
,
430 {{Annee
, Mois
, Jour
}, {Heure
, Min
, _
}} = calendar:now_to_local_time(Date
),
432 % id pseudo (login) IP Jour Mois Année Heure Minute
433 "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
436 if Ek_master
-> "*"; true
-> "" end ++ Pseudo
,
438 euphorik_common:serialize_ip(IP
),
439 Jour
, Mois
, Annee
, Heure
, Min
442 % Affichage d'un user en fonction de son login
443 print_user(Login
) when is_list(Login
) ->
444 case euphorik_bd:user_by_login(Login
) of
448 {erreur
, "Login pas trouvé : " ++ Login
}
450 % Affichage d'un user en fonction de son id
451 print_user(Id
) when is_integer(Id
) ->
452 case euphorik_bd:user_by_id(Id
) of
456 {erreur
, "Id pas trouvé : " ++ integer_to_list(Id
)}