Cleaning...
[euphorik.git] / modules / include / euphorik_bd.hrl
index 7ffeae4..1fc17a2 100755 (executable)
-% Auteur : GBurri
-% Version 2
-
-% Pour générer des id\r
+% coding: utf-8\r
+% Copyright 2008 Grégory Burri\r
+%\r
+% This file is part of Euphorik.\r
+%\r
+% Euphorik is free software: you can redistribute it and/or modify\r
+% it under the terms of the GNU General Public License as published by\r
+% the Free Software Foundation, either version 3 of the License, or\r
+% (at your option) any later version.\r
+%\r
+% Euphorik is distributed in the hope that it will be useful,\r
+% but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+% GNU General Public License for more details.\r
+%\r
+% You should have received a copy of the GNU General Public License\r
+% along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.\r
+%\r
+% @author GBurri\r
+\r
+\r
+% Version de la BD\r
+-define(VERSION_BD, 3).\r
+-define(TABLES, [counter, proprietes, minichat, reponse_minichat, user, ip_table, troll]).\r
+\r
+\r
+% Pour générer des id\r
 -record(counter,\r
    {\r
       key,\r
       value\r
    }).\r
 \r
-% décrit un enregistrement d'un message\r
--record(minichat,
+\r
+% Mémorse toutes les propriétés, entre autre la version des données\r
+-record(proprietes,\r
+   {\r
+      nom,\r
+      valeur\r
+   }).\r
+\r
+\r
+% Contient tous les textes que peut envoyer le serveur vers client.\r
+-record(texte,\r
+   {\r
+      id,\r
+      fr\r
+   }).\r
+\r
+\r
+% décrit un enregistrement d'un message\r
+-record(minichat,\r
    {\r
       id, % integer\r
-      auteur_id, % -> user.id
-      date, % erlang:now()
-      pseudo, % chaine de caractère
-      contenu % chaine de caractère
+      auteur_id, % -> #user.id\r
+      date, % erlang:timestamp()\r
+      pseudo, % chaine de caractère\r
+      contenu, % chaine de caractère\r
+      racine_id = undefined, % la racine, par défaut correspond à l'id du message\r
+      status = normal % can be equal to normal, censored or deleted\r
    }).\r
-   
-   \r
+\r
+\r
 % type bag\r
-% 'repondant' repond à 'cible'\r
+% 'repondant' repond à 'cible'\r
 -record(reponse_minichat,\r
    {\r
-      repondant, % -> minichat.id\r
-      cible % -> minichat.id\r
-   }). \r
-
+      repondant, % -> #minichat.id\r
+      cible % -> #minichat.id\r
+   }).\r
+\r
+\r
+-record(profile, % attention : pas une table !\r
+   {\r
+      pseudo = [], % string()\r
+      email = [], % string()\r
+      css = [], % string()\r
+      nick_format = nick, %atom(), peut valoir 'nick', 'login' ou 'nick_login'\r
+      view_times = true,\r
+      view_tooltips = true,\r
+      ostentatious_master = light, % peut valoir invisible, light ou heavy. seulement pour ek_master\r
+      chat_order = reverse, % peut valoir chrono ou reverse\r
+      conversations = [] % [{integer(), bool}], la liste des messages correspondant au conversation {racine, reduite?}\r
+   }).\r
+\r
 \r
 -record(user,\r
    {\r
       id,\r
       cookie, % string()\r
-      pseudo = [], % string()
-      login = [], % string()
-      password = [], % string() (md5)
-      email = [], % string()\r
-      date_creation, % erlang:now()\r
-      date_derniere_connexion, % erlang:now(), est mis à jour lors de n'importe quelle activitée (envoie de message par exemple)\r
-      css = [], % string()
-      indice_flood = 0 % integer() est incrémenté lorsque l'utilisateur envoie trop rapidement des messages.\r
-   }). 
-   
-   
\ No newline at end of file
+      login = [], % string()\r
+      password = [], % string() (md5)\r
+      profile = #profile{},\r
+      date_creation, % erlang:timestamp()\r
+      date_derniere_connexion, % erlang:timestamp(), est mis à jour lors de n'importe quelle activitée (envoie de message par exemple)\r
+      indice_flood = 0, % integer() est incrémenté lorsque l'utilisateur envoie trop rapidement des messages.\r
+      ek_master = false,\r
+      last_ip = undefined % integer(), undefined si inconnu\r
+   }).\r
+\r
+\r
+% identificateur : (ip)\r
+-record(ip_table,\r
+   {\r
+      ip, % {integer(), integer(), integer(), integer()}\r
+      ban = undefined, % la date du dernier bannissement\r
+      ban_duration = 0, % le temps de ban en minute\r
+      nb_try_register = 0,\r
+      nb_try_login = 0, % pour l'instant pas utilisé\r
+      date_last_try_register,\r
+      date_last_try_login % pour l'instant pas utilisé\r
+   }).\r
+\r
+\r
+-record(troll,\r
+   {\r
+      id,\r
+      id_user,\r
+      id_minichat = undefined, % l'id du message associé\r
+      date_create, % erlang:timestamp()\r
+      date_post = undefined, % date à laquelle le troll est affiché sur la page principale. undefined initialement puis erlang:timestamp() quand affiché\r
+      content % chaine de caractère\r
+   }).\r