1TL1 Projet Tchat

Presentation de l'équipe

• Baptiste Bemelmans
• Louis De Wilde
• François Girondin
• Arthur Schamroth

Description du projet

Pour ce projet, nous avons décidé de réaliser un tchat de discussion, du même style que Messenger ou WhatsApp. Nous désirons y implémenter différents services tel qu'un système d'inscription et de connexion, un chat global et un système de discussions privées. L'utilisateur aura également la possibilité de modifier son profil.

Comment installer

-Pour commencer, télécharger le repository complet, et installer Sybase avec SQL anywhere.

-Ensuite, créer une base de données Sybase et un service Web SqlAnywhere, la base de données doit être remplie avec les scripts fournis dans le dossier BackEnd. Cette base doit être dans le dossier parent au dossier backend ( le dossier racine du site). Pour que le site fonctionne correctement, une structure de fichier spécifique est nécésaire, pour ce faire il vous suffit d'extraire le contenu du dossier FrontEnd dans son dossier parent (là où se situe la base de données).

-Démarrer le serveur Web Sybase, et si tout a correctement été mis en place, vous pouvez naviger sur index.html pour découvrir le site ☺

Aspects implémentés

Backend

• Script API rest

  • Procédures

    • Arthur Schamroth - mettreAJour.sql
    • Arthur Schamroth - infos.sql
    • Baptiste Bemelmans - proc_Creation.sql
    • Baptiste Bemelmans - proc_Connexion.sql
    • Baptiste Bemelmans - returnIdCreation.sql
    • François Girondin - proc_addUserToConv.sql
    • François Girondin - proc_getAllConvNames.sql
    • François Girondin - proc_getAllUsers.sql
    • François Girondin - proc_getConvName.sql
    • François Girondin - proc_getPseudo.sql
    • François Girondin - proc_newConv.sql
    • François Girondin - proc_userConvs.sql
    • François Girondin - proc_userToGeneral.sql
    • Louis De Wilde - deleteMsg.sql
    • Louis De Wilde - insertNewMsg.sql
    • Louis De Wilde - proc_ObtenirInfoConv.sql
    • Louis De Wilde - proc_modifConv.sql
    • Louis De Wilde - proc_removeUserFromConv.sql
    • Louis De Wilde - requestChat.sql
    • Louis De Wilde - verifEmail.sql
    • Louis De Wilde - verifPseudo.sql

  • Fonctions

    • Louis De Wilde - userIdconvIdToConvUserId.sql
    • Commun - convNameToConvid.sql
    • Commun - convUserIdToConvId.sql
    • Commun - convUserIdToUserId.sql

  • Services Web

    • Arthur Schamroth - modification.sql
    • Arthur Schamroth - mettreAJour.sql
    • Baptiste Bemelmans - connexion.sql
    • Baptiste Bemelmans - creation.sql
    • Baptiste Bemelmans - redirectionCreation.sql
    • François Girondin - addUserToConv.sql
    • François Girondin - getAllConvNames.sql
    • François Girondin - getAllUsers.sql
    • Francois Girondin - getConvName.sql
    • François Girondin - getPseudo.sql
    • François Girondin - newConv.sql
    • François Girondin - userConvs.sql
    • François Girondin - userToGeneral.sql
    • Louis De Wilde - ObtenirInfoConv.sql
    • Louis De Wilde - UpdateConv.sql
    • Louis De Wilde - chatParticipant.sql
    • Louis De Wilde - deleteMsg.sql
    • Louis De Wilde - newMsg.sql
    • Louis De Wilde - removeUserFromConv.sql
    • Louis De Wilde - updateChat.sql
    • Louis De Wilde - verifEmail.sql
    • Louis De Wilde - verifPseudo.sql
    • Commun - obtenirUserId.sql

• Script Base de données

  • InsertionDonneesMinimales-ConvGeneral.sql
  • creationTable-tb_Identifiants.sql
  • creationTable-tb_chat.sql
  • creationTable-tb_convUsers.sql
  • creationTable-tb_convs.sql

• Script Seveur Web

  • root.sql
  • webservices-procedures-base.sql

Frontend

• JavaScript

  • Arthur Schamroth - modifier.js
  • Baptiste Bemelmans - connexion.js
  • Baptiste Bemelmans - creation.js
  • François Girondin - modConv.js
  • François Girondin - multiConv.js
  • François Girondin - new.js
  • Louis De Wilde - chat.js
  • Louis De Wilde - main.js
  • Louis De Wilde - newUserVerif.js

• CSS

  • Commun - chat.css
  • Commun - customForm.css
  • Commun - index.css
  • Commun - main.css
  • Commun - new.css

• HTML

  • Arthur Schamroth - modificationProfil.html
  • Baptiste Bemelmans - connexion.html
  • Baptiste Bemelmans - creation.html
  • François Girondin - modifConv.html
  • François Girondin - new.html
  • Louis De Wilde - play.html
  • Louis De Wilde - 404.html
  • Louis De Wilde - index.html

Détail API rest

• webService-connexion :

  • Appelle la procédure proc_connexion avec pour paramètre l'email de connexion (emailVerif varchar(55)).
    Il renvoie le mot de passe (mdp varchar(255)) et l'identifiant utilisateur (idUser integer) correspondant à l'email donné.
    Le format du webservice est le JSON.
    Exemple de réponse : [{mdpUser:"password"}, {idUser:701}]

• webService-creation :

  • Appelle la procédure proc_Creation avec pour paramètre l'email (newEmail varchar(55)), le nom (newNom char(55)), le prénom (newPrenom char(55)), le pseudo (newPseudo char(40)) et le mot de passe (newMdpUser varchar(255)).
    Il crée un nouvel utilisateur dans la table des identifiants (tb_Identifiants) avec ces paramètres.
    Le format du webservice est le JSON.
    La fonction ne renvoie rien.

• webService-redirectionCreation :

  • Appelle la procédure returnIdCreation avec pour paramètre l'email de l'utilisateur (emailRecherche varchar(55)).
    Il renvoie l'identifiant (idUser bigint) correspondant à l'email reçu en paramètre.
    Le format du webservice est le JSON.
    Exemple de réponse : [{idUser:701}]

• webService-UpdateConv :

  • Appelle la procédure proc_modifConv avec pour paramètre le nom de la conversation (nouveauNom text), la couleur de la conversation (convColorVar char(6)) et l'identifiant de corrélation conversation-utilisateur (convUserId interger).
    Il met à jour le nom , la couleur de la conversation pour laquelle l'identifiant correspond à celui récupérer grâce à la fonction convUserIdToConvId ayant pour paramètre convUserId qui récupère l'identifiant d'une conversation (IdConv integer) à partir d'un identifiant de corrélation conversation-utilisateur (convUserIdVar integer).
    Le résultat de la procédure est newConvName de type "text".
    Le format du webservice est le RAW.
    Exemple de réponse : nouvNomConv

• webService-verifEmail :

  • Appelle la procédure verifEmail avec pour paramètre l'email (emailVar varchar(55)).
    Il renvoie l'email de tb_Identifiants correspondant à l'email donnée en paramètre.
    Le format du webservice est le RAW.
    Exemple de réponse : mail@email.com

• webService-verifPseudo :

  • Appelle la procédure verifPseudo avec pour paramètre le pseudo (pseudoVar varchar(55)).
    Il renvoie le pseudo de tb_Identifiants correspondant au pseudo donné en paramètre.
    Le format du webservice est le RAW.
    Exemple de réponse : nickName

• webService-updateChat :

  • Description : Recupere les nouveau message d'une conversation.
    

  • Paramètres :

    • IdConvVar Integer (Id de conversation Utilisateur ( lien entre une conversation et un utilisateur))
    • lastId Integer ( dernier Id de message connut)

  • Format de réposes : Json

  • Propriété des élement du tableau:

    • id (number)
    • msgContent (string)
    • pseudo(string)
    • idUser(number)
      *Exemple de reponse: [
      {"id": 579,
      "msgContent": "tt a ete clear c bon ca ",
      "heure": "2020-05-10 15:29:09.068",
      "pseudo": "Co vide nith the",
      "idUSer": 782
      }
      ]

• webService-removeUserFromConv:

  • Description : Retire un utilisateur d'une conversation
  • Paramètres:
    • id Integer(l'Identifiant de l'utilisateur)
    • nom text (nom de la conversation)
  • Format des réposes : none.

• webService ObtenirInfoConv:

  • Description : Récuperes les inforamtion sur une conversation ( id, nom et couleurs)
  • Paramètre :
    • convUserIdVar Interger (Id de conversation Utilisateur ( lien entre une conversation et un utilisateur))
  • Format de réposes : Json
  • Propriétés des élement du tableau :
    • convColor (string) (couleur d'un conversation)
    • convName (string) ( Nom d'une conversation )
    • isAdmin (boolean) ( Si vrai l'utilisateur est administrateur de la conversation)
    • pseudo (string) ( Pseudo de l'utilisateur) *Exemple de reponse: [ {
      "convColor": "vert",
      "idUser": 782,
      "convName": "devs",
      "isAdmin": true,
      "pseudo": "Co vide nith the",
      "idConv": 4
      },
      { "convColor": "vert",
      "idUser": 8015,
      "convName": "devs",
      "isAdmin": false,
      "pseudo": "c",
      "idConv": 4
      } ]

• webService newMSG:

  • Description : insert un nouveau message dans la table tb_chat
  • Paramètres:
    • msgContentVar Varchar ( les contenu d'un msessage)
    • convUserIdVar Interger (Id de conversation Utilisateur ( lien entre une conversation et un utilisateur))
  • Format de réposes : none

• Web Service deleteMsg:

  • Description: supprime un message d'un conversation
  • Paramètre :
    • -msgId Interger
  • Format de réposes : none

• webService chatParticipant :

  • Description : Récupere tout les participants d'une conversation
  • Paramètre :
    • convUserIdVar Integer (Id de conversation Utilisateur ( lien entre une conversation et un utilisateur))
  • Format de réposes: Json
  • Propriété des élement du tableau:
    • participant (string) (pseudo d'un participant a la conversation)
    • isAdmin (boolean) (indique si oui ou nom l'utilisateur est administrateur)
    • convName (string) (Nom De la conversation) *Exemple de reponse:[ {
      "participant": "Co vide nith the",
      "isAdmin": true,
      "convName": "devs"
      },
      { "participant": "c",
      "isAdmin": false,
      "convName": "devs"
      } ]

• Webservice addUserToConv :

  • Description : Ajoute un utilisateur à une conversation
  • Paramètres :
    • userId BIGINT (id de l'utilisateur à ajouter)
    • convName TEXT (nom de la conversation à laquelle ajouter l'utilisateur)
  • Format de réponse : none

• Webservice getAllConvNames :

  • Description : Renvoie le nom de toutes les conversations existantes
  • Paramètres : none
  • Format de réponse : JSON
  • Exemple de réponse : [{id:0,nom:"Général",couleur:"gris"}]

• Webservice getAllUsers :

  • Description : Renvoie le nom et l'id de tous les utilisateurs à l'exception de celui rentré en paramètre, et le nombre de conversations en commun avec celui-ci.
  • Paramètres :
    • id BIGINT (id de l'utilisateur à l'origine de la requête)
  • Format de réponse : JSON
  • Exemple de réponse : [{id:8026,name:"Tommy",commonChats:3},{id:8029,name:"Trololo",commonChats:2}]"

• Webservice getConvName :

  • Description : Renvoie le nom de la conversation dont l'id est entré.
  • Paramètres :
    • id BIGINT (id de la conversation)
  • Format de réponse : RAW
  • Exemple de réponse : "Général"

• Webservice getPseudo :

  • Description : Renvoie le pseudo de l'utilisateur demandé.
  • Paramètres :
    • id BIGINT (id de l'utilisateur dont on veut connaître le pseudo)
  • Format de réponse : RAW
  • Exemple de réponse : "EEEEEEEEH OOOOOH"

• Webservice newConv :

  • Description : Créée une nouvelle conversation, et lui ajoute un admministrateur.
  • Paramètres :
    • nom TEXT (nom de la conversation)
    • couleur CHAR(6) (couleur de la conversation)
    • idAdmin BIGINT (id de l'admin de la conv)
  • Format de réponse : none

• Webservice userConvs :

  • Description : Renvoie toutes les conversations dans lesquelles se trouve l'utilisateur demandé.
  • Paramètres :
    • userId BIGINT (id de l'utilisateur)
  • Format de réponse : JSON
  • Exemple de réponse : [{id:1,nom:"Général",couleur:"gris"},{id:2,nom:"Les devs",couleur:"rouge"}]

• Webservice userToGeneral :

  • Description : Renvoie le convUserId correspondant à l'utilisateur demandé dans le général.
  • Paramètres :
    • userId BIGINT (id de l'utilisateur demandé)
  • Format de réponse : RAW
  • Exemple de réponse : "3"

• Webservice modification :

  • Description : Renvoie les informations(nom, prénom, ...) correspondantes à l'utilisateur.
  • Paramètres :
    • idChoisi integer (id de l'utilisateur)
  • Format de réponse : JSON
  • Exemple de réponse : "15 'beer' 'michou' 'gege' zad@zd.fe' 'Margueritelavache'"

• Webservice mettreAJour :

  • Description : Met la table utilisateur à jour avec les nouvelles données du formulaire.
  • Paramètres :
    • idUtilisateur integer (id de l'utilisateur)
    • nvNom varchar(50) (nom entré dans le formulaire)
    • nvPrenom varchar(50) (prénom entré dans le formulaire)
    • nvMdp varchar(50) (mot de passe entré dans le formulaire)
    • nvMail varchar(50) (adresse mail entré dans le formulaire)
    • nvPseudo varchar(50) (pseudo entré dans le formulaire)
  • Format de réponse : RAW
  • Exemple de réponse : None

Détail DB

• tb_chat

  • Cette table contient les id des messages, l'id de conversation de l'utilisateur, le contenu de chaque message, la date et l'heure d'ajout du message. Voici les différents noms de données présentes dans cette table :
    • idMessage
      • Utilise un id autoincrémenté
    • convUserId
    • msgContent
    • timeOfAdd

• tb_convs

  • Cette table contient l'ensemble des différentes discussions en leur attribuant à chacune un id ainsi qu'une couleur choisie par l'utilisateur. La table est composée de ces différentes colonnes :
    • idConv
      • Utilise un id autoincrémenté
    • convName
    • convColor

• tb_convUsers

  • Cette table contient les membres des différentes conversations crées sur le site. Un id liant l'utilisateur à la conversation est alors cré de façon autoimplémentée. Ainsi qu'une colonne si l'utilisateur est oui ou non administrateur de la conversation. Cette table est ainsi composée de différentes colonnes :
    • convUserId
      • Utilise un id autoincrémenté
    • idUser
    • convId
    • isAdmin

• tb_Identifiants

  • Cette table contient les informations de chaque utilisateur telles que son id, son nom, son prénom, son mot de passe, son adresse mail et son pseudo. La table est composée de ces colonnes :
    • idUser
      • Utilise un id autoincrémenté
    • nom
    • prenom
    • mdpUser
    • email
    • pseudo