Global

Methods

Error 404 catcher()

Catche les requêtes en dehors des URL acceptées

Source:

Error 404 handler()

Gère les erreurs 404

Source:
<<<<<<< HEAD =======

getAllVisibleGroups(user) → {Promise}

Renvoie tous les groupes visibles par l'utilisateur user

Cette fonction effectue une requête knex. Elle gère l'arrête de parenté.

Parameters:
Name Type Description
user Object

Objet contenant un attribut uid de type string. User représente l'utilisateur qui a effectué la requête.

Source:
Returns:

Retour de requête knex. Liste de tous les groupes que l'utilisateur a le droit de voire.

Type
Promise

getGroupIfVisible(user, uid) → {Promise}

Renvoie un unique groupe, ssi ce groupe est visible par l'utilisateur

Actuellement, la fonction appelle getAllVisibleGroups et restreint au groupe demandé. Cette fonction peut être implémentée de manière plus efficace et plus chiante.

Parameters:
Name Type Description
user Object

Objet contenant un attribut uid de type string. User représente l'utilisateur qui a effectué la requête.

uid String

uid du groupe que l'on veut voire.

Source:
Returns:

Retour de requête knex. Le groupe demandé, si l'utilisateur a le droit de la voire.

Type
Promise
>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea

idTOL(c0, c1, c2, c3, c4, c5, c6, c7, c8, c9, c10, c11, c12) → {Array.<string>}

Fonction qui interroge le LDAP et retrouve juste les uid des paxs validant les critères de recherche. Première étape vers vrai TOL (Trombino On Line).

<<<<<<< HEAD

Accepte des champs exacts ou incomplets mais pas approximatifs et ne gère pas l'auto-complete. Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande. Il faut l'appeler suivant un schéma TOL(uid).then((res) => { truc avec res });. Aucun bind n'est nécessaire donc pas d'identifiant ou de mot de passe à passer. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma généré à la volée à partir de config.json et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end). MEF Timeout pour des recherches trop vagues.

=======

Accepte des champs exacts ou incomplets mais pas approximatifs et ne gère pas l'auto-complete. Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande. Il faut l'appeler suivant un schéma TOL(uid).then((res) => { truc avec res });. Aucun bind n'est nécessaire donc pas d'identifiant ou de mot de passe à passer. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma généré à la volée à partir de config.json et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end). MEF Timeout pour des recherches trop vagues.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
Name Type Description
c0 string

Prénom

c1 string

Nom

c2 string

Surnom

c3 string

Nationalité

c4 string

Ecole ou université d'origine

c5 string

Promotion

c6 string

Groupe

c7 string

Cours

c8 string

Sport pratiqué

c9 string

Numéro de téléphone

c10 string

Adresse courriel

c11 string

Adresse physique

c12 string

Adresse ip

Source:
Returns:

uids des profils qui "match" les critères proposés.

Type
Array.<string>

Knex API: Get table(table_name)

Effectue une requête pour une table dans la BDD

Parameters:
Name Type Description
table_name string

La table voulue par l'utilisateur.

Source:

listAdmins(gid) → {string}

Fonction qui interroge le LDAP et retrouve la liste des admins d'un groupe.

<<<<<<< HEAD

Cette fonction utilise rechercheLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma listAdmins(...).then((res) => { truc avec res });

=======

Cette fonction utilise requeteLDAP avec un dictionnaire prédéfini dans config.json.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
Name Type Description
gid string

Identifiant du groupe à interroger (le plus souvent nom du groupe en minuscule)

Source:
Returns:

Liste des uid des membres où l'id fournie est membre (noms flat des groupes)

Type
string

listGroups(uid) → {string}

Fonction qui interroge le LDAP et retrouve les groupes dont un individu est membre.

<<<<<<< HEAD

Cette fonction utilise rechercheLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma listGroups(...).then((res) => { truc avec res });

=======

Cette fonction utilise requeteLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma listGroups(...).then((res) => { truc avec res });

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
Name Type Description
uid string

Identifiant de l'individu à interroger (le plus souvent prenom.nom, parfois l'année, supposé valide)

Source:
Returns:

Liste des uid de groupes (noms flat des groupes) où l'id fourni est membre

Type
string

listGroups2(uid) → {string}

Fonction qui interroge le LDAP et retrouve les groupes dont un individu est membre. Assez différente de la précédente en terme d'implémentation, plus lente mais renvoir moins de résultats plus pertinents, probablement plus pérenne.

<<<<<<< HEAD

Cette fonction utilise rechercheLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma listGroups2(...).then((res) => { truc avec res });

=======

Cette fonction utilise requeteLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma listGroups2(...).then((res) => { truc avec res });

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
Name Type Description
uid string

Identifiant de l'individu à interroger (le plus souvent prenom.nom, parfois l'année, supposé valide)

Source:
Returns:

Liste des uid de groupes (noms flat des groupes) où l'id fourni est membre

Type
string

listMembers(gid) → {string}

Fonction qui interroge le LDAP et retrouve la liste des membres d'un groupe.

<<<<<<< HEAD

Cette fonction utilise rechercheLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma listMembers(...).then((res) => { truc avec res });

Parameters:
Name Type Description
gid string

Identifiant du groupe à interroger (le plus souvent nom du groupe en minuscule)

Source:
Returns:

Liste des uid des membres où l'id fournie est membre (noms flat des groupes)

Type
string

modifierLDAP(name, op, mod) → {boolean}

Fonction qui va plonger dans le LDAP et modifier un certain jeu de valeur en argument.

======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
<<<<<<< HEAD

Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande avec ldapjs (voir Client API méthode search). Il faut l'appeler suivant un schéma modifierLDAP(...).then((res) => { truc avec res });. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma prédéfini dans dic et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end).

=======

Cette fonction utilise requeteLDAP avec un dictionnaire prédéfini dans config.json.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
<<<<<<< HEAD ======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea <<<<<<< HEAD ======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Name Type Description
namegid string

DN de l'emplacement de la requête

op string

Deux types ; "replace" ou "add", "add" pouvant rajouter un champ, "replace" sans modification étant une suppression

mod Object

Dictionnaire contenant les attributs à modifier et les modifications

Identifiant du groupe à interroger (le plus souvent nom du groupe en minuscule)

Source:
Returns:
<<<<<<< HEAD

true si la modification s'est bien déroulée, false sinon

=======

Liste des uid des membres où l'id fournie est membre (noms flat des groupes)

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Type
<<<<<<< HEAD boolean ======= string >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
<<<<<<< HEAD

rechercheLDAP(base, filter, filter_dic, attributes) → {Object}

Fonction qui interroge le LDAP selon un protocole spécifié en argument et renvoit les valeurs trouvées.

=======

rens(uid) → {Array.<string>}

Fonction qui interroge le LDAP au sujet d'un uid particulier et qui renvoit toutes ses infos.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea <<<<<<< HEAD

Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande avec ldapjs (voir Client API méthode search). Il faut l'appeler suivant un schéma rechercheLDAP(...).then((res) => { truc avec res });. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma prédéfini dans dic et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end).

======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
<<<<<<< HEAD ======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Name Type Description
base string

DN de l'emplacement de la requête

filter string

Filtre logique de la recherche (format RFC2254)

filter_dic Object

Dictionnaire qui associe les faux champs dans filter aux vraies valeurs pertinentes de la recherche

attributes <<<<<<< HEAD Array.<string> ======= string >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea

Liste des attributs qui figureront dans le résultat final

Identifiant de l'utilisateur

Source:
Returns:
<<<<<<< HEAD

Résultats de la recherche ; soit une liste de valeurs d'attributs, soit une liste de dictionnaires si on veut plus d'un attribut (les clés du dictionnaire sont celles du LDAP)

=======

Informations recueillies ; même quand dans TOL voir config.json.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Type
<<<<<<< HEAD Object ======= Array.<string> >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
<<<<<<< HEAD

rens(uid) → {Array.<string>}

Fonction qui interroge le LDAP au sujet d'un uid particulier et qui renvoit toutes ses infos.

=======

requeteLDAP(base, filter, filter_dic, attributes) → {Array.<string>}

Fonction qui interroge le LDAP selon un protocole bien précis et renvoit les valeurs trouvées.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
<<<<<<< HEAD

Cette fonction utilise rechercheLDAP avec un dictionnaire prédéfini dans config.json. Il faut l'appeler selon un schéma rens(...).then((res) => { truc avec res });

=======

Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande avec ldapjs (voir Client API méthode search). Il faut l'appeler suivant un schéma requeteLDAP(...).then((res) => { truc avec res });. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma prédéfini dans dic et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end).

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
<<<<<<< HEAD ======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea <<<<<<< HEAD ======= >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Name Type Description
uidbase string

DN de l'emplacement de la requête

filter string

Filtre logique de la recherche (format RFC2254)

filter_dic Object

Dictionnaire qui associe les faux champs dans filter aux vraies valeurs pertinentes de la recherche

attributes <<<<<<< HEAD string ======= Array.<string> >>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea

Identifiant de l'utilisateur

Liste des attributs qui figureront dans le résultat final

Source:
Returns:
<<<<<<< HEAD

Informations recueillies ; même quand dans TOL voir config.json.

=======

Résultats de la recherche

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Type
Array.<string>

TOL(c0, c1, c2, c3, c4, c5, c6, c7, c8, c9, c10, c11, c12) → {Array.<string>}

<<<<<<< HEAD

Fonction qui interroge le LDAP et retrouve les paxs validant les critères de recherche. Bien mais vite inutilisable car demande trop au LDAP et renvoie des erreurs de type size limit. Préférer idTOL puis stalk au cas par cas.

=======

Fonction qui interroge le LDAP et retrouve les paxs validant les critères de recherche. Bien mais vite inutilisable car demande trop au LDAP.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
<<<<<<< HEAD

Accepte des champs incomplets mais pas approximatifs et ne gère pas l'auto-complete. Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande. Il faut l'appeler suivant un schéma TOL(uid).then((res) => { truc avec res });. Aucun bind n'est nécessaire donc pas d'identifiant ou de mot de passe à passer. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma généré à la volée à partir de config.json et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end). MEF Timeout pour des recherches trop vagues.

=======

Accepte des champs incomplets mais pas approximatifs et ne gère pas l'auto-complete. Cette fonction utilise une Promise pour être asynchrone ; elle renvoit la promesse d'une réponse puis traite la demande. Il faut l'appeler suivant un schéma TOL(uid).then((res) => { truc avec res });. Aucun bind n'est nécessaire donc pas d'identifiant ou de mot de passe à passer. Cette fonction fait une demande au LDAP qu'elle filtre selon un schéma généré à la volée à partir de config.json et à chaque résultat (event SearchEntry) le met dans une liste, et renvoit la liste à l'issue (event end). MEF Timeout pour des recherches trop vagues.

>>>>>>> 0d37bfa57a7bad303c19ffa3b40a2120b399beea
Parameters:
Name Type Description
c0 string

Prénom

c1 string

Nom

c2 string

Surnom

c3 string

Nationalité

c4 string

Ecole ou université d'origine

c5 string

Promotion

c6 string

Groupe

c7 string

Cours

c8 string

Sport pratiqué

c9 string

Numéro de téléphone

c10 string

Adresse courriel

c11 string

Adresse physique

c12 string

Adresse ip

Source:
Returns:

Informations recueillies ; voir config.json.

Type
Array.<string>