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(minichat
, [
83 {attributes
, record_info(fields
, minichat
)},
84 {disc_copies
, [node()]}
86 mnesia:create_table(reponse_minichat
, [
88 {attributes
, record_info(fields
, reponse_minichat
)},
89 {disc_copies
, [node()]}
91 mnesia:create_table(user
, [
92 {attributes
, record_info(fields
, user
)},
93 {disc_copies
, [node()]}
95 mnesia:create_table(ip_table
, [
96 {attributes
, record_info(fields
, ip_table
)},
97 {disc_copies
, [node()]}
99 mnesia:create_table(troll
, [
100 {attributes
, record_info(fields
, troll
)},
101 {disc_copies
, [node()]}
106 % mis à part car lors de la reprise de données avec load_textfile les indexes ne sont pas recréés
108 mnesia:add_table_index(minichat
, auteur_id
),
109 mnesia:add_table_index(minichat
, troll_id
),
110 mnesia:add_table_index(reponse_minichat
, cible
),
111 mnesia:add_table_index(user
, cookie
),
112 mnesia:add_table_index(user
, login
),
113 mnesia:add_table_index(troll
, date_post
).
116 % Connexion à la base de données de yaws sur overnux
118 connect(yaws@flynux
).
121 mnesia:change_config(extra_db_nodes
, [Node
]).
124 % Efface toutes les données de la base de données.
126 mnesia:clear_table(counter
),
127 mnesia:clear_table(proprietes
),
128 mnesia:clear_table(user
),
129 mnesia:clear_table(reponse_minichat
),
130 mnesia:clear_table(minichat
),
131 mnesia:clear_table(troll
),
132 mnesia:clear_table(ip_table
),
133 % crée l'utilisateur root
134 mnesia:transaction(fun() ->
135 mnesia:write(#proprietes
{nom
= version
, valeur
= ?VERSION_BD
}),
136 User
= #user
{id
= 0, profile
= #profile
{pseudo
= "Sys"}, login
= "Sys", date_creation
= now(), date_derniere_connexion
= now(), ek_master
= true
},
142 % Met à jour la bd, compare ?VERSION_BD avec la version dans la table 'proprietes'
143 % et exécute les patchs nécessaires.
145 case mnesia:dirty_read({proprietes
, version
}) of
146 [#proprietes
{valeur
= Version
}] ->
153 % Mise à jour de la BD.
154 % attention : il est nécessaire de se trouver dans une transaction.
155 update(?VERSION_BD
) -> fini
;
157 case mnesia:backup(fichier_backup(Version
)) of
159 case patch(Version
) of
161 mnesia:dirty_write(#proprietes
{nom
= version
, valeur
= Version
+ 1}),
166 {error
, Raison
} -> {error
, lists:flatten(io_lib:format("Erreur de création du backup de la version ~w : ~w", [Version
, Raison
]))}
170 % Applique une modification de la BD pour passer d'une version à la suivante.
171 % crée un backup avant l'application du patch
172 % dans BD/backups nommé "backup<num>" où <num> et le numéro de la version.
175 % traitement des users
176 mnesia:transform_table(
178 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
}) ->
179 {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
}
181 record_info(fields
, user
),
184 mnesia:transform_table(
186 fun({minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Troll_id
}) ->
187 {minichat
, Id
, Auteur_id
, Date
, Pseudo
, Contenu
, Troll_id
, Id
}
189 record_info(fields
, minichat
),
192 case mnesia:transaction(
194 % met à jour les enfants des racines
195 % 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..
196 Messages
= e(q([M
|| M
<- mnesia:table(minichat
), euphorik_bd:parents(M#minichat
.id
) =:= []]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
197 lists:foreach(fun(M
) -> patch_1_traiter_message(M
, M#minichat
.id
) end, Messages
)
200 {aborted
, Raison
} -> {erreur
, Raison
};
205 % Prend un chemin vers la feuille de style de type "css/1/euphorik.css"
206 % et renvoie "styles/1/euphorik.css"
207 patch1_transforme_css("css" ++ Reste
) ->
209 patch1_transforme_css(F
) ->
213 patch_1_traiter_message(M
, Racine
) ->
214 % met à jour la racine de chaque message qui répond à M
217 mnesia:write(M2#minichat
{racine_id
= Racine
}),
218 patch_1_traiter_message(M2
, Racine
)
220 euphorik_bd:enfants(M#minichat
.id
)
223 % crée un backup dont le nom est fournit dans le repertoire backups qui se trouve dans le repertoire de la BD.
225 % mnesia:backup(mnesia:system_info(directory) ++ "/backups/" ++ Nom).
228 % Reviens à une version précédente de la base de données
229 % (les données insérées durant les versions plus récentes sont perdues)
231 % mnesia:restore(fichier_backup(N), [{default_op, recreate_tables}]).
234 % Renvoie le fichier (avec le chemin) correspondant à la version Version, par exemple : "/var/euphorik/BD/backups/backup1"
235 fichier_backup(Version
) ->
236 mnesia:system_info(directory
) ++ "/backups/" ++ if is_integer(Version
) -> "backup" ++ integer_to_list(Version
); true
-> Version
end.
239 backup_text(_
) -> todo
.
240 restore_text(File
) ->
242 mnesia:delete_schema([node()]),
244 case mnesia:load_textfile(File
) of
253 toggle_ek_master(User_id
) ->
254 euphorik_bd:resultat_transaction(mnesia:transaction(
256 Users
= e(q([E
|| E
<- mnesia:table(user
), E#user
.id
=:= User_id
]), [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]),
259 mnesia:write(User#user
{ek_master
= not User#user
.ek_master
});
266 % Affiche N user trié par leur date de dernière connexion.
267 % Opt est une liste d'option d'affichage :
268 % * ekmaster : n'affiche que les admins
269 print_users(N
, Opt
) ->
270 AfficheQueLesEkMaster
= lists:any(fun(O
) -> O
=:= ekmaster
end, Opt
),
271 euphorik_bd:resultat_transaction(mnesia:transaction(fun() ->
274 #user
.date_derniere_connexion
,
275 if AfficheQueLesEkMaster
->
276 q([E
|| E
<- mnesia:table(user
), E#user
.ek_master
=:= true
]);
278 q([E
|| E
<- mnesia:table(user
)])
280 [{order
, descending
}]
282 [{tmpdir
, ?KEY_SORT_TEMP_DIR
}]
284 Users
= qlc:next_answers(C
, N
),
295 % Affiche tous les users.
297 print_users(all_remaining
, Opt
).
299 % Affiche tous les users.
301 print_users(all_remaining
, []).
303 print_user(User
) when is_record(User
, user
) ->
304 #user
{id
= Id
, profile
= #profile
{pseudo
= Pseudo
}, login
= Login
, ek_master
= Ek_master
, date_derniere_connexion
= Date
, last_ip
= IP
} = User
,
305 {{Annee
, Mois
, Jour
}, {Heure
, Min
, _
}} = calendar:now_to_local_time(Date
),
307 % id pseudo (login) IP Jour Mois Année Heure Minute
308 "~4w : ~10.10..s(~10.10..s) ~s ~2w.~2.2.0w.~w - ~2wh~2.2.0w~n",
311 if Ek_master
-> "*"; true
-> "" end ++ Pseudo
,
313 euphorik_common:serialize_ip(IP
),
314 Jour
, Mois
, Annee
, Heure
, Min
317 % Affichage d'un user en fonction de son login
318 print_user(Login
) when is_list(Login
) ->
319 case euphorik_bd:user_by_login(Login
) of
323 {erreur
, "Login pas trouvé : " ++ Login
}
325 % Affichage d'un user en fonction de son id
326 print_user(Id
) when is_integer(Id
) ->
327 case euphorik_bd:user_by_id(Id
) of
331 {erreur
, "Id pas trouvé : " ++ integer_to_list(Id
)}