01d62812505e0a9bfe1d4c9607972673c301aea8
[euphorik.git] / modules / include / euphorik_bd.hrl
1 % Copyright 2008 Grégory Burri
2 %
3 % This file is part of Euphorik.
4 %
5 % Euphorik is free software: you can redistribute it and/or modify
6 % it under the terms of the GNU General Public License as published by
7 % the Free Software Foundation, either version 3 of the License, or
8 % (at your option) any later version.
9 %
10 % Euphorik is distributed in the hope that it will be useful,
11 % but WITHOUT ANY WARRANTY; without even the implied warranty of
12 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 % GNU General Public License for more details.
14 %
15 % You should have received a copy of the GNU General Public License
16 % along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
17 %
18 % @author GBurri
19
20
21 % Version de la BD
22 -define(VERSION_BD, 2).
23 -define(TABLES, [counter, proprietes, minichat, reponse_minichat, user, ip_table, troll]).
24
25
26 % Pour générer des id
27 -record(counter,
28    {
29       key,
30       value
31    }).
32    
33    
34 % Mémorse toutes les propriétés, entre autre la version des données
35 -record(proprietes,
36    {
37       nom,
38       valeur
39    }).
40
41
42 % décrit un enregistrement d'un message
43 -record(minichat,
44    {
45       id, % integer
46       auteur_id, % -> #user.id
47       date, % erlang:now()
48       pseudo, % chaine de caractère
49       contenu, % chaine de caractère
50       troll_id = undefined, % l'id du troll associé correspondant
51       racine_id = undefined % la racine, par défaut correspond à l'id du message
52    }).
53    
54    
55 % type bag
56 % 'repondant' repond à 'cible'
57 -record(reponse_minichat,
58    {
59       repondant, % -> #minichat.id
60       cible % -> #minichat.id
61    }). 
62
63
64
65 -record(profile, % attention : pas une table !
66    {
67       pseudo = [], % string()
68       email = [], % string()
69       css = [], % string()
70       nick_format = nick, %atom(), peut valoir 'nick', 'login' ou 'nick_login'
71       view_times = true,
72       view_tooltips = true,
73       ostentatious_master = light, % peut valoir invisible, light ou heavy. seulement pour ek_master
74       chat_order = reverse, % peut valoir chrono ou reverse
75       conversations = [] % [{integer(), bool}], la liste des messages correspondant au conversation {racine, reduite?}
76    }).
77 -record(user,
78    {
79       id,
80       cookie, % string()
81       login = [], % string()
82       password = [], % string() (md5)
83       profile = #profile{},
84       date_creation, % erlang:now()
85       date_derniere_connexion, % erlang:now(), est mis à jour lors de n'importe quelle activitée (envoie de message par exemple)
86       indice_flood = 0, % integer() est incrémenté lorsque l'utilisateur envoie trop rapidement des messages.
87       ek_master = false,
88       last_ip = undefined % integer(), undefined si inconnu
89    }).
90
91
92 % identificateur : (ip)
93 -record(ip_table,
94    {
95       ip, % {integer(), integer(), integer(), integer()}
96       ban = undefined, % la date du dernier bannissement
97       ban_duration = 0, % le temps de ban en minute
98       nb_try_register = 0,
99       nb_try_login = 0, % pour l'instant pas utilisé
100       date_last_try_register,
101       date_last_try_login % pour l'instant pas utilisé
102    }).
103    
104    
105 -record(troll,
106    {
107       id,
108       id_user,
109       date_create, % erlang:now()
110       date_post = undefined, % date à laquelle le troll est affiché sur la page principale. undefined initialement puis erlang:now() quand affiché
111       content % chaine de caractère
112    }).
113