MOD cleanage
[euphorik.git] / 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_text/1,
38 restore_text/1,
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 {attributes, record_info(fields, minichat)},
88 {disc_copies, [node()]}
89 ]),
90 mnesia:create_table(reponse_minichat, [
91 {type, bag},
92 {attributes, record_info(fields, reponse_minichat)},
93 {disc_copies, [node()]}
94 ]),
95 mnesia:create_table(user, [
96 {attributes, record_info(fields, user)},
97 {disc_copies, [node()]}
98 ]),
99 mnesia:create_table(ip_table, [
100 {attributes, record_info(fields, ip_table)},
101 {disc_copies, [node()]}
102 ]),
103 mnesia:create_table(troll, [
104 {attributes, record_info(fields, troll)},
105 {disc_copies, [node()]}
106 ]),
107 creer_indexes().
108
109
110 % mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
111 creer_indexes() ->
112 mnesia:add_table_index(minichat, auteur_id),
113 mnesia:add_table_index(minichat, troll_id),
114 mnesia:add_table_index(reponse_minichat, cible),
115 mnesia:add_table_index(user, cookie),
116 mnesia:add_table_index(user, login),
117 mnesia:add_table_index(troll, date_post).
118
119
120 % Connexion à la base de données de yaws sur overnux
121 connect() ->
122 connect(yaws@flynux).
123 connect(Node) ->
124 mnesia:start(),
125 mnesia:change_config(extra_db_nodes, [Node]).
126
127
128 % Efface toutes les données de la base de données.
129 reset() ->
130 mnesia:clear_table(counter),
131 mnesia:clear_table(proprietes),
132 mnesia:clear_table(texte),
133 mnesia:clear_table(user),
134 mnesia:clear_table(reponse_minichat),
135 mnesia:clear_table(minichat),
136 mnesia:clear_table(troll),
137 mnesia:clear_table(ip_table),
138 % crée l'utilisateur root
139 mnesia:transaction(fun() ->
140 mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
141 User = #user{id = 0, profile = #profile{pseudo = "Sys"}, login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true},
142 mnesia:write(User),
143 User
144 end),
145 peupler_texte().
146
147
148 peupler_texte() ->
149 mnesia:transaction(fun() ->
150 mnesia:write(#texte{ id = 10, fr = "Login déjà existant"}),
151 mnesia:write(#texte{ id = 20, fr = "Trop de register (flood)"}),
152 mnesia:write(#texte{ id = 30, fr = "Couple login/pass introuvable"}),
153 mnesia:write(#texte{ id = 40, fr = "Authentification impossible par cookie"}),
154 mnesia:write(#texte{ id = 50, fr = "Impossible de mettre à jour le profile"}),
155 mnesia:write(#texte{ id = 60, fr = "timeout"}),
156 mnesia:write(#texte{ id = 70, fr = "Page inconnue"}),
157 mnesia:write(#texte{ id = 80, fr = "Vous êtes banni pour encore ~s"}),
158 mnesia:write(#texte{ id = 90, fr = "Message vide"}),
159 mnesia:write(#texte{ id = 100, fr = "Impossible d'ajouter un nouveau message. Raison : ~s"}),
160 mnesia:write(#texte{ id = 110, fr = "Utilisateur inconnu"}),
161 mnesia:write(#texte{ id = 120, fr = "Il n'est pas possible de s'auto bannir"}),
162 mnesia:write(#texte{ id = 130, fr = "L'utilisateur est lui même un ekMaster"}),
163 mnesia:write(#texte{ id = 140, fr = "Utilisateur à bannir inconnu"}),
164 mnesia:write(#texte{ id = 150, fr = "Utilisateur inconnu ou non ek master"}),
165 mnesia:write(#texte{ id = 160, fr = "Utilisateur à slaper inconnu"}),
166 mnesia:write(#texte{ id = 170, fr = "Utilisateur inconnu ou non ek master"}),
167 mnesia:write(#texte{ id = 180, fr = "Le nombre de troll maximum par utilisateur est atteint : ~w "}),
168 mnesia:write(#texte{ id = 190, fr = "Le nombre de troll maximum en attente est atteint : ~w "}),
169 mnesia:write(#texte{ id = 200, fr = "Seul les ekMaster peuvent proposer des trolls"}),
170 mnesia:write(#texte{ id = 210, fr = "Vous ne posséder pas ce troll"}),
171 mnesia:write(#texte{ id = 220, fr = "Seul les ekMaster peuvent proposer des trolls"}),
172 mnesia:write(#texte{ id = 230, fr = "Seul les ekMaster peuvent connaitre la liste des ips bannies"})
173 end).
174
175
176 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
177 % et exécute les patchs nécessaires.
178 update() ->
179 case mnesia:dirty_read({proprietes, version}) of
180 [#proprietes{valeur = Version}] ->
181 update(Version);
182 _ ->
183 erreur
184 end.
185
186
187 % Mise à jour de la BD.
188 % attention : il est nécessaire de se trouver dans une transaction.
189 update(?VERSION_BD) -> fini;
190 update(Version) ->
191 case mnesia:backup(fichier_backup(Version)) of
192 ok ->
193 case patch(Version) of
194 ok ->
195 mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
196 update(Version + 1);
197 Erreur ->
198 Erreur
199 end;
200 {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
201 end.
202
203
204 % Applique une modification de la BD pour passer d'une version à la suivante.
205 % crée un backup avant l'application du patch
206 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
207 % 1 -> 2
208 patch(1) ->
209 mnesia:create_table(texte, [
210 {attributes, record_info(fields, texte)},
211 {disc_copies, [node()]}
212 ]),
213 peupler_texte(),
214 % traitement des users
215 mnesia:transform_table(
216 user,
217 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}) ->
218 {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}
219 end,
220 record_info(fields, user),
221 user
222 ),
223 mnesia:transform_table(
224 minichat,
225 fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id}) ->
226 {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id, Id}
227 end,
228 record_info(fields, minichat),
229 minichat
230 ),
231 case mnesia:transaction(
232 fun() ->
233 % met à jour les enfants des racines
234 % 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..
235 Messages = e(q([M || M <- mnesia:table(minichat), euphorik_bd:parents(M#minichat.id) =:= []]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
236 lists:foreach(fun(M) -> patch_1_traiter_message(M, M#minichat.id) end, Messages)
237 end
238 ) of
239 {aborted, Raison} -> {erreur, Raison};
240 {atomic, _} -> ok
241 end.
242
243
244 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
245 % et renvoie "styles/1/euphorik.css"
246 patch1_transforme_css("css" ++ Reste) ->
247 "styles" ++ Reste;
248 patch1_transforme_css(F) ->
249 F.
250
251
252 patch_1_traiter_message(M, Racine) ->
253 % met à jour la racine de chaque message qui répond à M
254 lists:foreach(
255 fun(M2) ->
256 mnesia:write(M2#minichat{racine_id = Racine}),
257 patch_1_traiter_message(M2, Racine)
258 end,
259 euphorik_bd:enfants(M#minichat.id)
260 ).
261
262 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
263 %backup(Nom) ->
264 % mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
265
266
267 % Reviens à une version précédente de la base de données
268 % (les données insérées durant les versions plus récentes sont perdues)
269 %restore(N) ->
270 % mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
271
272
273 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
274 fichier_backup(Version) ->
275 mnesia:system_info(directory) ++ "/backups/" ++ if is_integer(Version) -> "backup" ++ integer_to_list(Version); true -> Version end.
276
277
278 backup_text(_) -> todo.
279 restore_text(File) ->
280 mnesia:stop(),
281 mnesia:delete_schema([node()]),
282 mnesia:start(),
283 case mnesia:load_textfile(File) of
284 {atomic, ok} ->
285 update(),
286 creer_indexes();
287 Erreur ->
288 Erreur
289 end.
290
291
292 toggle_ek_master(User_id) ->
293 euphorik_bd:resultat_transaction(mnesia:transaction(
294 fun() ->
295 Users = e(q([E || E <- mnesia:table(user), E#user.id =:= User_id]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
296 case Users of
297 [User] ->
298 mnesia:write(User#user{ek_master = not User#user.ek_master});
299 _ -> erreur
300 end
301 end
302 )).
303
304
305 % Affiche N user trié par leur date de dernière connexion.
306 % Opt est une liste d'option d'affichage :
307 % * ekmaster : n'affiche que les admins
308 print_users(N, Opt) ->
309 AfficheQueLesEkMaster = lists:any(fun(O) -> O =:= ekmaster end, Opt),
310 euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
311 C = cursor(
312 qlc:keysort(
313 #user.date_derniere_connexion,
314 if AfficheQueLesEkMaster ->
315 q([E || E <- mnesia:table(user), E#user.ek_master =:= true]);
316 true ->
317 q([E || E <- mnesia:table(user)])
318 end,
319 [{order, descending}]
320 ),
321 [{tmpdir, ?KEY_SORT_TEMP_DIR}]
322 ),
323 Users = qlc:next_answers(C, N),
324 lists:foreach(
325 fun(U) ->
326 print_user(U)
327 end,
328 Users
329 ),
330 qlc:delete_cursor(C)
331 end)).
332
333
334 % Affiche tous les users.
335 print_users(Opt) ->
336 print_users(all_remaining, Opt).
337
338 % Affiche tous les users.
339 print_users() ->
340 print_users(all_remaining, []).
341
342 print_user(User) when is_record(User, user) ->
343 #user{id = Id, profile = #profile{pseudo = Pseudo}, login = Login, ek_master = Ek_master, date_derniere_connexion = Date, last_ip = IP} = User,
344 {{Annee, Mois, Jour}, {Heure, Min, _}} = calendar:now_to_local_time(Date),
345 io:format(
346 % id pseudo (login) IP Jour Mois Année Heure Minute
347 "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
348 [
349 Id,
350 if Ek_master -> "*"; true -> "" end ++ Pseudo,
351 Login,
352 euphorik_common:serialize_ip(IP),
353 Jour, Mois, Annee, Heure, Min
354 ]
355 );
356 % Affichage d'un user en fonction de son login
357 print_user(Login) when is_list(Login) ->
358 case euphorik_bd:user_by_login(Login) of
359 {ok, User} ->
360 print_user(User);
361 _ ->
362 {erreur, "Login pas trouvé : " ++ Login}
363 end;
364 % Affichage d'un user en fonction de son id
365 print_user(Id) when is_integer(Id) ->
366 case euphorik_bd:user_by_id(Id) of
367 {ok, User} ->
368 print_user(User);
369 _ ->
370 {erreur, "Id pas trouvé : " ++ integer_to_list(Id)}
371 end.
372