MOD cleanage euphorik.js (attention un début du code pour la gestion des pages traine)
[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 -module(euphorik_bd_admin).
28 -export([
29 version_bd/0,
30 create/0,
31 connect/0,
32 connect/1,
33 reset/0,
34 update/0,
35 backup/1,
36 restore/1,
37
38 toggle_ek_master/1,
39 print_users/0,
40 print_users/1,
41 print_user/1
42 ]).
43 -import(qlc, [e/2, q/1, cursor/2]).
44 -include("../include/euphorik_bd.hrl").
45 -include("../include/euphorik_defines.hrl").
46 -include_lib("stdlib/include/qlc.hrl").
47
48
49 % Renvoie la version courante de la BD.
50 version_bd() ->
51 euphorik_bd:resultat_transaction(mnesia:transaction(
52 fun() ->
53 mnesia:read({proprietes, version})
54 end
55 )).
56
57
58 % Instructions pour créer une nouvelle base :
59 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
60 % voir doc/installation.txt
61 % >l(euphorik_bd).
62 % >euphorik_bd:create().
63 create() ->
64 mnesia:stop(),
65 mnesia:delete_schema([node()]),
66 mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
67 mnesia:start(),
68 create_tables(),
69 reset().
70
71 create_tables() ->
72 mnesia:create_table(counter, [
73 {attributes, record_info(fields, counter)},
74 {disc_copies, [node()]}
75 ]),
76 mnesia:create_table(proprietes, [
77 {attributes, record_info(fields, proprietes)},
78 {disc_copies, [node()]}
79 ]),
80 mnesia:create_table(minichat, [
81 {attributes, record_info(fields, minichat)},
82 {disc_copies, [node()]}
83 ]),
84 mnesia:create_table(reponse_minichat, [
85 {type, bag},
86 {attributes, record_info(fields, reponse_minichat)},
87 {disc_copies, [node()]}
88 ]),
89 mnesia:create_table(user, [
90 {attributes, record_info(fields, user)},
91 {disc_copies, [node()]}
92 ]),
93 mnesia:create_table(ip_table, [
94 {attributes, record_info(fields, ip_table)},
95 {disc_copies, [node()]}
96 ]),
97 mnesia:create_table(troll, [
98 {attributes, record_info(fields, troll)},
99 {disc_copies, [node()]}
100 ]),
101 creer_indexes().
102
103
104 % mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
105 creer_indexes() ->
106 mnesia:add_table_index(minichat, auteur_id),
107 mnesia:add_table_index(minichat, troll_id),
108 mnesia:add_table_index(reponse_minichat, cible),
109 mnesia:add_table_index(user, cookie),
110 mnesia:add_table_index(user, login),
111 mnesia:add_table_index(troll, date_post).
112
113
114 % Connexion à la base de données de yaws sur overnux
115 connect() ->
116 connect(yaws@flynux).
117 connect(Node) ->
118 mnesia:start(),
119 mnesia:change_config(extra_db_nodes, [Node]).
120
121
122 % Efface toutes les données de la base de données.
123 reset() ->
124 mnesia:clear_table(counter),
125 mnesia:clear_table(proprietes),
126 mnesia:clear_table(user),
127 mnesia:clear_table(reponse_minichat),
128 mnesia:clear_table(minichat),
129 mnesia:clear_table(troll),
130 mnesia:clear_table(ip_table),
131 % crée l'utilisateur root
132 mnesia:transaction(fun() ->
133 mnesia:write(#proprietes{nom = version, valeur = ?VERSION_BD}),
134 User = #user{id = 0, profile = #profile{pseudo = "Sys"}, login = "Sys", date_creation = now(), date_derniere_connexion = now(), ek_master = true},
135 mnesia:write(User),
136 User
137 end).
138
139
140 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
141 % et exécute les patchs nécessaires.
142 update() ->
143 case mnesia:dirty_read({proprietes, version}) of
144 [#proprietes{valeur = Version}] ->
145 update(Version);
146 _ ->
147 erreur
148 end.
149
150
151 % Mise à jour de la BD.
152 % attention : il est nécessaire de se trouver dans une transaction.
153 update(?VERSION_BD) -> fini;
154 update(Version) ->
155 case mnesia:backup(fichier_backup(Version)) of
156 ok ->
157 case patch(Version) of
158 ok ->
159 mnesia:dirty_write(#proprietes{nom = version, valeur = Version + 1}),
160 update(Version + 1);
161 Erreur ->
162 Erreur
163 end;
164 {error, Raison} -> {error, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version, Raison]))}
165 end.
166
167
168 % Applique une modification de la BD pour passer d'une version à la suivante.
169 % crée un backup avant l'application du patch
170 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
171 % 1 -> 2
172 patch(1) ->
173 % traitement des users
174 mnesia:transform_table(
175 user,
176 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}) ->
177 {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}
178 end,
179 record_info(fields, user),
180 user
181 ),
182 mnesia:transform_table(
183 minichat,
184 fun({minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id}) ->
185 {minichat, Id, Auteur_id, Date, Pseudo, Contenu, Troll_id, Id}
186 end,
187 record_info(fields, minichat),
188 minichat
189 ),
190 case mnesia:transaction(
191 fun() ->
192 % met à jour les enfants des racines
193 % 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..
194 Messages = e(q([M || M <- mnesia:table(minichat), euphorik_bd:parents(M#minichat.id) =:= []]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
195 lists:foreach(fun(M) -> patch_1_traiter_message(M, M#minichat.id) end, Messages)
196 end
197 ) of
198 {aborted, Raison} -> {erreur, Raison};
199 {atomic, _} -> ok
200 end.
201
202
203 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
204 % et renvoie "styles/1/euphorik.css"
205 patch1_transforme_css("css" ++ Reste) ->
206 "styles" ++ Reste;
207 patch1_transforme_css(F) ->
208 F.
209
210
211 patch_1_traiter_message(M, Racine) ->
212 % met à jour la racine de chaque message qui répond à M
213 lists:foreach(
214 fun(M2) ->
215 mnesia:write(M2#minichat{racine_id = Racine}),
216 patch_1_traiter_message(M2, Racine)
217 end,
218 euphorik_bd:enfants(M#minichat.id)
219 ).
220
221 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
222 backup(Nom) ->
223 mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
224
225
226 % Reviens à une version précédente de la base de données
227 % (les données insérées durant les versions plus récentes sont perdues)
228 restore(N) ->
229 mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
230
231
232 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
233 fichier_backup(Version) ->
234 mnesia:system_info(directory) ++ "/backups/" ++ if is_integer(Version) -> "backup" ++ integer_to_list(Version); true -> Version end.
235
236
237 toggle_ek_master(User_id) ->
238 euphorik_bd:resultat_transaction(mnesia:transaction(
239 fun() ->
240 Users = e(q([E || E <- mnesia:table(user), E#user.id =:= User_id]), [{tmpdir, ?KEY_SORT_TEMP_DIR}]),
241 case Users of
242 [User] ->
243 mnesia:write(User#user{ek_master = not User#user.ek_master});
244 _ -> erreur
245 end
246 end
247 )).
248
249
250 % Affiche N user trié par leur date de dernière connexion.
251 % Opt est une liste d'option d'affichage :
252 % * ekmaster : n'affiche que les admins
253 print_users(N, Opt) ->
254 AfficheQueLesEkMaster = lists:any(fun(O) -> O =:= ekmaster end, Opt),
255 euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
256 C = cursor(
257 qlc:keysort(
258 #user.date_derniere_connexion,
259 if AfficheQueLesEkMaster ->
260 q([E || E <- mnesia:table(user), E#user.ek_master =:= true]);
261 true ->
262 q([E || E <- mnesia:table(user)])
263 end,
264 [{order, descending}]
265 ),
266 [{tmpdir, ?KEY_SORT_TEMP_DIR}]
267 ),
268 Users = qlc:next_answers(C, N),
269 lists:foreach(
270 fun(U) ->
271 print_user(U)
272 end,
273 Users
274 ),
275 qlc:delete_cursor(C)
276 end)).
277
278
279 % Affiche tous les users.
280 print_users(Opt) ->
281 print_users(all_remaining, Opt).
282
283 % Affiche tous les users.
284 print_users() ->
285 print_users(all_remaining, []).
286
287 print_user(User) when is_record(User, user) ->
288 #user{id = Id, profile = #profile{pseudo = Pseudo}, login = Login, ek_master = Ek_master, date_derniere_connexion = Date, last_ip = IP} = User,
289 {{Annee, Mois, Jour}, {Heure, Min, _}} = calendar:now_to_local_time(Date),
290 io:format(
291 % id pseudo (login) IP Jour Mois Année Heure Minute
292 "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
293 [
294 Id,
295 if Ek_master -> "*"; true -> "" end ++ Pseudo,
296 Login,
297 euphorik_common:serialize_ip(IP),
298 Jour, Mois, Annee, Heure, Min
299 ]
300 );
301 % Affichage d'un user en fonction de son login
302 print_user(Login) when is_list(Login) ->
303 case euphorik_bd:user_by_login(Login) of
304 {ok, User} ->
305 print_user(User);
306 _ ->
307 {erreur, "Login pas trouvé : " ++ Login}
308 end;
309 % Affichage d'un user en fonction de son id
310 print_user(Id) when is_integer(Id) ->
311 case euphorik_bd:user_by_id(Id) of
312 {ok, User} ->
313 print_user(User);
314 _ ->
315 {erreur, "Id pas trouvé : " ++ integer_to_list(Id)}
316 end.
317