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
).
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").
51 % Renvoie la version courante de la BD.
53 euphorik_bd:resultat_transaction(mnesia:transaction(
55 mnesia:read({proprietes
, version
})
60 % Instructions pour créer une nouvelle base :
61 % $erl -sname yaws -mnesia dir '"/projets/euphorik/BD"'
62 % voir doc/installation.txt
64 % >euphorik_bd:create().
67 mnesia:delete_schema([node()]),
68 mnesia:create_schema([node()]), % nécessaire pour les tables sur disc
74 mnesia:create_table(counter
, [
75 {attributes
, record_info(fields
, counter
)},
76 {disc_copies
, [node()]}
78 mnesia:create_table(proprietes
, [
79 {attributes
, record_info(fields
, proprietes
)},
80 {disc_copies
, [node()]}
82 mnesia:create_table(texte
, [
83 {attributes
, record_info(fields
, texte
)},
84 {disc_copies
, [node()]}
86 mnesia:create_table(minichat
, [
88 {attributes
, record_info(fields
, minichat
)},
89 {disc_copies
, [node()]}
91 mnesia:create_table(reponse_minichat
, [
93 {attributes
, record_info(fields
, reponse_minichat
)},
94 {disc_copies
, [node()]}
96 mnesia:create_table(user
, [
97 {attributes
, record_info(fields
, user
)},
98 {disc_copies
, [node()]}
100 mnesia:create_table(ip_table
, [
101 {attributes
, record_info(fields
, ip_table
)},
102 {disc_copies
, [node()]}
104 mnesia:create_table(troll
, [
105 {attributes
, record_info(fields
, troll
)},
106 {disc_copies
, [node()]}
111 % mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
113 mnesia:add_table_index(minichat
, auteur_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 mnesia:add_table_index(troll
, id_minichat
).
121 % Connexion à la base de données de yaws sur overnux
123 connect(yaws@flynux
).
126 mnesia:change_config(extra_db_nodes
, [Node
]).
129 % Efface toutes les données de la base de données.
131 mnesia:clear_table(counter
),
132 mnesia:clear_table(proprietes
),
133 mnesia:clear_table(texte
),
134 mnesia:clear_table(user
),
135 mnesia:clear_table(reponse_minichat
),
136 mnesia:clear_table(minichat
),
137 mnesia:clear_table(troll
),
138 mnesia:clear_table(ip_table
),
139 % crée l'utilisateur root
140 mnesia:transaction(fun() ->
141 mnesia:write(#proprietes
{nom
= version
, valeur
= ?VERSION_BD
}),
142 User
= #user
{id
= 0, profile
= #profile
{pseudo
= "Sys"}, login
= "Sys", date_creation
= now(), date_derniere_connexion
= now(), ek_master
= true
},
150 mnesia:transaction(fun() ->
151 mnesia:write(#texte
{ id
= 10, fr
= "Login déjà existant"}),
152 mnesia:write(#texte
{ id
= 20, fr
= "Trop de register (flood)"}),
153 mnesia:write(#texte
{ id
= 30, fr
= "Couple login/pass introuvable"}),
154 mnesia:write(#texte
{ id
= 40, fr
= "Authentification impossible par cookie"}),
155 mnesia:write(#texte
{ id
= 50, fr
= "Impossible de mettre à jour le profile"}),
156 mnesia:write(#texte
{ id
= 60, fr
= "timeout"}),
157 mnesia:write(#texte
{ id
= 70, fr
= "Page inconnue"}),
158 mnesia:write(#texte
{ id
= 80, fr
= "Vous êtes banni pour encore ~s"}),
159 mnesia:write(#texte
{ id
= 90, fr
= "Message vide"}),
160 mnesia:write(#texte
{ id
= 100, fr
= "Impossible d'ajouter un nouveau message. Raison : ~s"}),
161 mnesia:write(#texte
{ id
= 110, fr
= "Utilisateur inconnu"}),
162 mnesia:write(#texte
{ id
= 120, fr
= "Il n'est pas possible de s'auto bannir"}),
163 mnesia:write(#texte
{ id
= 130, fr
= "L'utilisateur est lui même un ekMaster"}),
164 mnesia:write(#texte
{ id
= 140, fr
= "Utilisateur à bannir inconnu"}),
165 mnesia:write(#texte
{ id
= 150, fr
= "Utilisateur inconnu ou non ek master"}),
166 mnesia:write(#texte
{ id
= 160, fr
= "Utilisateur à slaper inconnu"}),
167 mnesia:write(#texte
{ id
= 170, fr
= "Utilisateur inconnu ou non ek master"}),
168 mnesia:write(#texte
{ id
= 180, fr
= "Le nombre de troll maximum par utilisateur est atteint : ~w "}),
169 mnesia:write(#texte
{ id
= 190, fr
= "Le nombre de troll maximum en attente est atteint : ~w "}),
170 mnesia:write(#texte
{ id
= 200, fr
= "Seul les ekMaster peuvent proposer des trolls"}),
171 mnesia:write(#texte
{ id
= 210, fr
= "Vous ne posséder pas ce troll"}),
172 mnesia:write(#texte
{ id
= 220, fr
= "Seul les ekMaster peuvent proposer des trolls"}),
173 mnesia:write(#texte
{ id
= 230, fr
= "Seul les ekMaster peuvent connaitre la liste des ips bannies"})
177 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
178 % et exécute les patchs nécessaires.
180 case mnesia:dirty_read({proprietes
, version
}) of
181 [#proprietes
{valeur
= Version
}] ->
188 % Mise à jour de la BD.
189 % attention : il est nécessaire de se trouver dans une transaction.
190 update(?VERSION_BD
) -> fini
;
192 case mnesia:backup(fichier_backup(Version
)) of
194 case patch(Version
) of
196 mnesia:dirty_write(#proprietes
{nom
= version
, valeur
= Version
+ 1}),
201 {error
, Raison
} -> {error
, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version
, Raison
]))}
205 % Applique une modification de la BD pour passer d'une version à la suivante.
206 % crée un backup avant l'application du patch
207 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
210 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
211 % et renvoie "styles/1/euphorik.css"
212 Transforme_css
= fun(F
) ->
214 "css" ++ Reste
-> "styles" ++ Reste
;
218 Traiter_message
= fun(M
, Racine
) ->
219 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
220 % met à jour la racine de chaque message qui répond à M
223 mnesia:write(M2#minichat
{racine_id
= Racine
}),
226 euphorik_bd:enfants(M#minichat
.id
)
231 mnesia:create_table(texte
, [
232 {attributes
, record_info(fields
, texte
)},
233 {disc_copies
, [node()]}
236 % traitement des users
237 mnesia:transform_table(
239 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
}) ->
240 {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
}
242 record_info(fields
, user
),
245 mnesia:transform_table(
247 fun({minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Troll_id
}) ->
248 {minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Troll_id
, Id
}
250 record_info(fields
, minichat
),
253 case mnesia:transaction(
255 % met à jour les enfants des racines
256 % 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..
257 Messages
= e(q([M
|| M
<- mnesia:table(minichat
), euphorik_bd:parents(M#minichat
.id
) =:= []]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
258 lists:foreach(fun(M
) -> Traiter_message(M
, M#minichat
.id
) end, Messages
)
261 {aborted
, Raison
} -> {erreur
, Raison
};
266 mnesia:transform_table(
268 fun({troll
, Id_troll
, Id_user
, Date_create
, Date_post
, Content
}) ->
269 % recherche le message associé s'il existe
270 Id_minichat
= case mnesia:index_read(minichat
, Id_troll
, 7) of
271 [#minichat
{id
= Id
}] -> Id
;
274 {troll
, Id_troll
, Id_user
, Id_minichat
, Date_create
, Date_post
, Content
}
276 record_info(fields
, troll
),
279 mnesia:del_table_index(minichat
, troll_id
),
280 mnesia:transform_table(
282 fun({minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, _Troll_id
, Racine_id
}) ->
283 {minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Racine_id
}
285 record_info(fields
, troll
),
288 creer_indexes(). % uniquement pour l'indice sur id_minichat de la table troll
291 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
293 % mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
296 % Reviens à une version précédente de la base de données
297 % (les données insérées durant les versions plus récentes sont perdues)
299 % mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
302 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
303 fichier_backup(Version
) ->
304 mnesia:system_info(directory
) ++ "/backups/" ++ if is_integer(Version
) -> "backup" ++ integer_to_list(Version
); true
-> Version
end.
307 backup_text(_
) -> todo
.
308 restore_text(File
) ->
310 mnesia:delete_schema([node()]),
312 case mnesia:load_textfile(File
) of
321 toggle_ek_master(User_id
) ->
322 euphorik_bd:resultat_transaction(mnesia:transaction(
324 Users
= e(q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= User_id
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
327 mnesia:write(User#user
{ek_master
= not User#user
.ek_master
});
334 % Affiche N user trié par leur date de dernière connexion.
335 % Opt est une liste d'option d'affichage :
336 % * ekmaster : n'affiche que les admins
337 print_users(N
, Opt
) ->
338 AfficheQueLesEkMaster
= lists:any(fun(O
) -> O
=:= ekmaster
end, Opt
),
339 euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
342 #user
.date_derniere_connexion
,
343 if AfficheQueLesEkMaster
->
344 q([E
|| E
<- mnesia:table(user
), E#user
.ek_master
=:= true
]);
346 q([E
|| E
<- mnesia:table(user
)])
348 [{order
, descending
}]
350 [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]
352 Users
= qlc:next_answers(C
, N
),
363 % Affiche tous les users.
365 print_users(all_remaining
, Opt
).
367 % Affiche tous les users.
369 print_users(all_remaining
, []).
371 print_user(User
) when is_record(User
, user
) ->
372 #user
{id
= Id
, profile
= #profile
{pseudo
= Pseudo
}, login
= Login
, ek_master
= Ek_master
, date_derniere_connexion
= Date
, last_ip
= IP
} = User
,
373 {{Annee
, Mois
, Jour
}, {Heure
, Min
, _
}} = calendar:now_to_local_time(Date
),
375 % id pseudo (login) IP Jour Mois Année Heure Minute
376 "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
379 if Ek_master
-> "*"; true
-> "" end ++ Pseudo
,
381 euphorik_common:serialize_ip(IP
),
382 Jour
, Mois
, Annee
, Heure
, Min
385 % Affichage d'un user en fonction de son login
386 print_user(Login
) when is_list(Login
) ->
387 case euphorik_bd:user_by_login(Login
) of
391 {erreur
, "Login pas trouvé : " ++ Login
}
393 % Affichage d'un user en fonction de son id
394 print_user(Id
) when is_integer(Id
) ->
395 case euphorik_bd:user_by_id(Id
) of
399 {erreur
, "Id pas trouvé : " ++ integer_to_list(Id
)}