+
+ Auteur: Benjamin Renard
+ (brenard@easter-eggs.com /
+ brenard@zionetrix.net)
+
+Site web: https://ldapsaisie.org/doc/
+Repo: https://gitlab.easter-eggs.com/ee/ldapsaisie
+Easter-eggs
+
LdapSaisie est une application web d'administration d'annuaire LDAP développée en PHP/Javascript. +Cette application a pour but d'abstraire la complexité d'un annuaire par l'intermédiraire d'une +interface d'administration simple et intuitive. L'application a été concue avec pour objectif +premier une modularité maximum, ce qui permet l'extention ou l'adaptation facile de l'application +par l'intermédiaire de modules, d'extentions et de greffons. Cette application peut être utilisée +pour administrer le système d'information basé sur l'annuaire LDAP et également en paralèlle pour +permettre aux utilisateurs d'avoir accès aux données les concernants et éventuellement de les +modifier.
+De part sa modularité, LdapSaisie est facilement extensible. Cependant, voici une liste +non-exhaustive de ses fonctionnalités :
+Gestion d'un grand nombre de types d'attributs :
+Relation à d'autres objets de l'annuaire/ Exemple : membres d'un groupe, parrain d'un + utilisateur, ... (valeur clé paramétrable)
+Note
+Chaque type d'attribut à des fonctionnalités qui lui sont propres et qui rendent plus facile +et agréable l'utilisation de l'interface (génération automatique de mot de passe, génération +des valeurs d'un champ à partir d'autres, ...).
+.htaccess fourni avec l'application et il est donc nécessaire
+ d'autoriser une telle configuration à ce niveau via la directive AllowOverride devant inclure à
+ minima FileInfo.tmp. En cas
+ d'installation à partir du paquet Debian, ce dossier est remplacé par un lien symbolique vers
+ le dossier /var/cache/ldapsaisie/.magic_quotes_gpc et register_globals à off. L'outil CLI de PHP
+ est par ailleurs nécessaire pour l'utilisation des outils CLI fournis avec l'application (fourni
+ par le paquet php-cli dans Debian).php-ldap dans Debian)php5-mhash dans Debian Lenny, intégré à php-common dans les
+ versions supérieurs)pear install pecl/json sur RedHat, intégré au paquet php5-common
+ précédement)php-net-ldap2 dans Debian ou
+ pear install net_ldap2)php-mbstring depuis Debian Stretch, intégré au paquet
+ php-common dans Debian)smarty3 dans Debian)php-console-table dans Debian)php-mail et php-mail-mime dans Debian)ftp (nécessaire pour le
+ fonctionnement du LSaddon FTP, paquet php-ftp
+ dans Debian)php-phpseclib dans Debian)Warning
+La librairie Net_LDAP2 oblige le fait que la racine DSE +de l'annuaire soit lisible en anonyme sinon la connexion à l'annuaire échouera systématiquement.
+Note
+Cette documentation est écrite à l'aide du langage Markdown et est mis en forme pour une
+consultation en ligne à l'aide de mkdocs et son thème
+mkdocs-material. Le dépendances pour construire
+cette documentation sont listées dans le fichier doc/requirements.txt et sont installables à
+l'aide de la commande pip install -r doc/requirements.txt.
L'installation à partir du paquet Debian peut être réalisée soit en téléchargeant manuellement le
+paquet, soit en déclarant le dépôt APT suivant dans votre fichier /etc/apt/sources.list :
Il ne vous restera ensuite plus qu'a installer le paquet ldapsaisie avec la commande suivante :
Le fichier /etc/ldapsaisie/apache.conf est un example de configuration du serveur web Apache. La
+configuration du logiciel ce fera ensuite dans le dossier /etc/ldapsaisie/local/.
Le dépôt Git peut être récupéré anonymement en utilisant la commande suivante :
+ +La racine web de l'application se trouvera alors dans le dossier /ldapsaisie/src/public_html/.
Toutes les nuits, un snapshot de l'arbre Git est réalisé et est téléchargeable au format tar.gz à +l'adresse suivante :
+doc/
Les fichiers sources de la documentation (Markdown & configuration Mkdocs).
+lsexample/
Les fichiers relatifs à l'annuaire d'exemple.
+src/
Les sources de l'application.
+public_html/
La racine web de l'application : celle-ci ne contient que les fichiers .htaccess et
+index.php qui configure et déclenche la réécriture d'URL.
conf/
Contient les fichiers de configuration.
+LSobjects/
Configuration des LSobjects.
+LSaddons/
Configuration des LSaddons.
+LSauth/
Configuration des LSauthMethod.
+includes/
Contient les fichiers des ressources.
+addons/
Les addons au projet.
+class/
Les fichiers de définition des classes PHP.
+js/
Les fichiers Javascript.
+libs/
Les librairies utilisées.
+lang/
Les fichiers d'internationalisation.
+templates/
Les fichiers template de l'interface. Il y a un sous-dossier par template.
+css/
Les fichiers css de l'interface. Il y a un sous-dossier par template CSS.
+images/
Les images de l'interface. Il y a un sous-dossier par template d'image.
+local/
Les fichiers personnalisés de l'installation.
+tmp/
Les fichiers temporaires (y compris le cache des templates).
+Cette section décrit les différentes étapes de l'installation de LdapSaisie. Deux méthodes +d'installation sont présentées ici, l'une à partir des sources du projet et l'autre à partir du +paquet Debian.
+Dans ce tutoriel, nous partirons du principe que vous avez pleinement la main sur votre serveur
+(installation de nouveau paquet et configuration de votre serveur web). Nous partons également du
+principe que votre annuaire LDAP est déjà en place. Nous utiliserons pour cette exemple de mise en
+oeuvre l'annuaire correspondant au schéma et à la configuration présente dans les sources du projet
+dans le dossier lsexample.
La première étape consiste à installer le locigiel en tant que tel. Pour cela, référez vous au +chapitre Téléchargement.
+En cas d'installation à partir du paquet Debian, la configuration du logiciel se fera dans le
+dossier /etc/ldapsaisie/local/. Les fichiers placés dans ce dossier prévaleront toujours aux
+fichiers fournis par le paquet Debian, vous permettant facilement de modifier un composant existant
+ou dans écrire de nouveaux. Ainsi, pour modifier un fichier CSS par exemple, il vous suffira de le
+placer dans le dossier /etc/ldapsaisie/local/css/.
Pour une installation à partir du code source, il vous faut cloner le dépôt Git du projet dans le
+dossier /var/www/ldapsaisie. Pour cela il vous faut avoir installés les outils de Git contenu,
+dans Debian, dans le paquet git-core. Le dépôt Git doit ensuite être récupéré anonymement en
+utilisant la commande suivante :
Note
+Pour que cette commande se déroule correctement, vous devez avoir accès au port TCP 443 du
+serveur gitlab.easter-eggs.com. En cas de problème vérifiez votre parefeu.
La suite des opérations se déroulera donc maintenant dans le dossier /var/www/ldapsaisie. Pour
+avoir plus de détails sur les élements qu'on retrouve dans ce dossier, vous pouvez consulter
+la section concernée. Nous allons nous instérésser plus particulièrement :
upgradeFromGit.sh permettant la mise à jour de votre repos tout en concervant les
+ adaptations que nous ferons pour l'usage d'LdapSaisie adapté à notre annuaire ;config.local dans lequel seront stockés vos fichiers et vos adaptations de
+ l'application ;src/public_html qui correspond à la futur racine du site web de l'application.Le principe de l'adaptation est ici de mettre vos fichiers personnalisés dans le dossier
+config.local, de les déclarer dans votre fichier config.local/local.sh contenant la liste des
+fichiers devant être installés. Le fichier local.sh est la source de configuration du script
+upgradeFromGit.sh. Il faut donc dans un premier temps créer votre fichier local.sh en copiant le
+fichier d'example local.sh.example. Ce fichier est un script bash déclarant les variables de
+configurations suivantes :
LOCAL_FILES
La liste des chemins des fichiers à installer dans l'arboressence du site. Cette élément doivent +être séparés par des espaces ou des retour à la liste. Exemple :
+ +LOG_FILE
Nom du fichier de log des mises à jour.
+THEME
Le nom du theme à installer (facultatif et non traité dans ce tutoriel).
+Note
+Il est possible d'utiliser dans ce fichier de configuration la variable bash $ROOT_DIR
+correspondant au chemin du dossier d'installation, c'est à dire dans notre exemple
+/var/www/ldapsaisie.
La deuxième étape concerne la configuration globale de l'application : Cette partie est
+principalement contenue dans le fichier src/conf/config.inc.php (ou
+/etc/ldapsaisie/local/conf/config.inc.php en cas d'installation à partir du paquet Debian). En cas
+d'installation à partir du code source, il faut donc dans un premier temps copier ce fichier dans le
+dossier config.local et le déclarer dans la liste des fichiers à déployer lors des mises à jour
+(variable LOCAL_FILES dans le fichier local.sh). Il s'agit en particulier dans ce fichier de
+configurer la connexion à votre annuaire. Vous pouvez vous inspirer du fichier d'exemple fourni et
+pour plus de détails, reportez-vous à la section concernée.
Note
+Notez qu'il est possible de passer l'application en mode debug ce qui peut être utile par la +suite.
+La troisième étape concerne la configuration des types de +LSobjects : Chaque type d'objet manipulé par +LdapSaisie doit correspondre avec un type de LSobject.
+Création du fichier de classe (optionnel) : Ce fichier contient la déclaration de la classe PHP
+ correspondant au type de LSobject. Cette classe étend la classe LSldapObject qui contient pour
+ ainsi dire toute les méthodes et proprités nécessaires pour les types de LSobject simples. Si
+ votre type de LSobject nécessite des méthodes ou propriétés particulières, vous pouvez implémenter
+ cette classe. À défaut, une classe vierge d'adaptation sera automatiquement déclarée.
Les fichiers des classes sont contenus dans le dossier /includes/class/ et portent les noms
+composés de la manière suivante :
Configurer vos LSobject : Cette partie est certainement la plus longue et consiste à déclarer
+ l'ensemble des informations relatives aux types des objets LDAP manipulés. Les fichiers d'exemples
+ fournis vous seront alors d'une aide précieuse. Basez vous sur l'un de pour créer le votre. Pour
+ cela le fichier de configuration du type d'LSobjet LSpeople est le plus complet et est un bon
+ point de départ. Pour plus de détails sur les élements de configuration de ce fichier,
+ reportez-vous à la section concernée.
Configurer si nécessaire les relations entre les objets appelés LSrelations. Les + relations les plus simples (via un attribut de liaison) pourront être implémentées à l'aide d'un + simple paramètrage. Pour des relations, plus complexes, il sera possible d'implémenter des + méthodes personnalisées pour les gérer. Pour plus de détails, reportez-vous à + la section concernée.
+Note
+Pour avoir un exemple de fichier de classe PHP implémentant des methodes de gestion de
+LSrelations complexes, vous pouvez consulter le fichier de classe LSgroup.
Important
+En cas d'installation à partir du code source, pensez à déclarer les fichiers que vous venez de
+créer dans la variable LOCAL_FILES du fichier local.sh. Exemple pour le type d'LSobjet
+portant comme nom LSexample :
Note
+Vous pouvez également personnaliser l'interface : Il est possible de personnaliser à votre goût +l'interface en écrivant votre template ou en modifiant simplement les fichiers CSS. Une partie +de cette documentation concernera bientôt cette problématique. Patience...
+En cas d'installation à partir du code source, une dernière étape à ce niveau consiste à lancer le
+script upgradeFromGit.sh pour qu'il installe les fichiers que vous venez de créer. Ce script est
+conçu pour dire tout ce qu'il fait donc en cas de problème vous devriez rapidement comprendre où
+cela coince. Dans tout les cas, n'hésitez pas à poser vos questions à la communauté sur la liste
+ldapsaisie-users@lists.ldapsaisie.org.
Cette section de la documentation détaille la procédure de mise à jour d'une installation existante +et regroupe des informations pratiques et utiles pour des montées de versions spécifiques entraînant +par exemple une perte de rétrocompatibilité de la configuration.
Lors d’une installation par paquet Debian, la mise à jour est grandement facilité par le packaging :
+Il vous suffit de mettre à jour le paquet ldapsaisie :
Une fois l’application mise à jour, prêté attention aux nouveautés et point de vigilances décrite +dans la section suivante.
+Lors d’une installation par à partir des sources, le script upgradeFromGit.sh permet d’automatiser
+la mise à jour, à condition que vous ayez suivi la procédure d’installation à ce sujet.
Ce script s’occupera alors de :
+working-tree Git des liens symboliques des fichiers locaux (et éventuellement du
+ thème) mis en place lors d’une précédente exécution ;working-tree Git via un git pull de la mise à jour ;vim -d) ;MO (traduction) et de déclencher dans ce cas un
+ rechargement du serveur web pour prise en compte ;Une fois l’application mise à jour, prêté attention aux nouveautés et point de vigilances décrite +dans la section suivante.
Cette mise à jour majeure apporte de nombreuses nouveautés auxquelles il est important de prêter +attention. Cette section ne parlera pas particulièrement de ces nouveautés, mais vous pouvez +consulter le fichier +debian/ldapsaisie.NEWS +pour cela. Cette section listera en outre les points de vigilances à avoir et les adaptations à +apporter sur votre configuration et votre code personnalisé.
+ConsoleTable avec pour valeur par défaut sous Debian
+ /usr/share/php/Console/Table.phppublic_root_url avec pour valeur par défaut sous Debian /ldapsaisie$GLOBALS['defaultCSSfiles'] : il est nécessaire de modifier les URLs des fichiers
+ listés : seul le nom du fichier doit rester, sa localisation sera détectée automatiquement. Par
+ exemple, $GLOBALS['defaultCSSfiles'] = array('../light-blue.css'); devient
+ $GLOBALS['defaultCSSfiles'] = array('light-blue.css');.les paramètres authObjectType, authObjectFilter et authObjectTypeAttrPwd sont remplacés par
+ le tablau LSobjects dans le paramètre LSauth.
Par exemple:
+'authObjectType' => 'LSpeople',
+'authObjectFilter' => '(|(uid=%{user})(mail=%{user}))',
+'authObjectTypeAttrPwd' => 'userPassword',
+Devient:
+ +$GLOBALS['defaultJSscripts'], à savoir un "R" manquant.$GLOBALS['defaultJSscripts']. Seul doit y demeurer vos propres fichiers. Voici la
+ liste des fichiers concernés et qui n'ont plus à être inclus via ce paramètre :- mootools-core.js
+ - mootools-more.js
+ - functions.js
+ - LSdefault.js
+ - LSinfosBox.js
Note
+Les fichiers light-*.css ont été retravaillés pour tous hériter du fichier light-blue.css
+qui défini les couleurs de l'interface au travers des variables. Ainsi, il est très simple
+d'ajuster ce thème à vos couleurs. Si cela vous intéresse, vous pouvez prendre exemple sur les
+autres fichiers light-*.css.
Au passage, ce thème a été retravaillé pour prendre en compte la mise en forme d'un maximum de
+composants de l'application tout en profitant du côté responsive de l'interface apporter par
+cette mise à jour. Si vous avez un thème personnalisé, il est conseillé de regarder si celui-ci
+ne pourrait pas tirer partie du fichier light-blue.css en le surchargeant. À minima, vous
+pouvez analyser les évolutions de ce fichier pour identifier les modifications intéressantes à
+reporter sur votre thème personnel.
light-*.css autre que le fichier light-blue.css, vous devez
+ désormais également charger ce dernier en premier.corriger les URL des images : url(../../images/default/find.png) devient url(../image/find).
+ Pour identifier les fichiers CSS concernés, vous pouvez utiliser les commandes suivantes :
fatal_error (fichier base.css) : #fatal_error devient #errorLSsession :: redirect() devient LSurl :: redirect(). Pour identifier les fichiers CSS
+ concernés, vous pouvez utiliser la commande suivante :
Les méthodes de gestion des Javascript et CSS additionels ont été migrées de la classe LSsession
+ vers la classe LStemplate :
LSsession :: addJSscript() devient LStemplate :: addJSscript().
Par ailleurs le paramètre $path disparait et la méthode addLibJSscript a été ajoutée pour
+permettre spécifiquement l'inclusion des fichiers Javascript des librairies. Voici quelques
+exemples d'utilisation et leur équivalent à présent:
LSsession :: addJSscript('../../local/includes/js/LSformElement_eetelephone.js');
+ devient LStemplate :: addJSscript('LSformElement_eetelephone.js');LSsession :: addJSscript('../../local/includes/js/LSformElement_eetelephone.js');
+ devient LStemplate :: addJSscript('LSformElement_eetelephone.js');LSsession :: addJSscript('click-to-dial_view.js', 'local/includes/js/'); devient
+ LStemplate :: addJSscript('click-to-dial_view.js');LSsession :: addJSscript('Picker.js',LS_LIB_DIR.'arian-mootools-datepicker/');
+ devient LStemplate :: addLibJSscript('arian-mootools-datepicker/Picker.js');LSsession :: addJSconfigParam() devient LStemplate :: addJSconfigParam().LSsession :: addHelpInfos() devient LStemplate :: addHelpInfo().LSsession :: addCssFile() devient LStemplate :: addCssFile().
Par ailleurs le paramètre $path disparait et la méthode addLibCssFile à été ajoutée pour
+permettre spécifiquement l'inclusion des fichiers CSS des librairies. Voici quelques exemples
+d'utilisation et leur équivalent à présent:
LSsession :: addCssFile('test.css', '../../local/css/'); devient
+ LStemplate :: addCssFile('test.css');. Doit donc être conservé, que le nom du fichier CSS,
+ pas de chemin vers celui-ci.LSsession :: addCssFile('datepicker_vista.css',LS_LIB_DIR.'arian-mootools-datepicker/datepicker_vista/');
+ devient
+ LStemplate :: addLibCssFile('arian-mootools-datepicker/datepicker_vista/datepicker_vista.css');Pour identifier les fichiers concernés, vous pouvez utiliser les commandes suivantes :
+grep -Er 'LSsession *:: *(addJSscript|addLibJSscript|addJSconfigParam|addHelpInfos|addCssFile|addLibCssFile) *\(' /etc/ldapsaisie/local/
+grep -Er '(LSsession|LStemplate) *:: *addJSscript\(.*local' /etc/ldapsaisie/local/
+grep -Er '(LSsession|LStemplate) *:: *addJSscript\(.*\.\.\/' /etc/ldapsaisie/local/
+grep -Er '(LSsession|LStemplate) *:: *addCssFile\(.*local' /etc/ldapsaisie/local/
+grep -Er '(LSsession|LStemplate) *:: *addCssFile\(.*\.\.\/' /etc/ldapsaisie/local/
+LSlog vs LSdebug : L’utilisation de LSdebug est dépriorisée en faveur de LSlog. Ce dernier
+ ajoute désormais la notion de logger, permettant d’identifier la source des logs. Ce mécanisme
+ permet la configuration d’un niveau de log spécifique pour un logger donné, ainsi que la mise en
+ place de filtres au niveau des handers pour ne logger par exemple que certains loggers, ou à
+ l’inverse en exclure d’autres.
log_debug, log_info, …). À défaut, il est
+ possible d’utiliser la classe LSlog_staticLoggerClass qui facilite l’implémentation.Pour vos LSaddons : il est conseillé d’utiliser un
+ logger LSaddon_[addon] dédié. Le logger peut facilement être récupéré de la manière
+ suivante :
Cette méthode retourne une référence au logger et il est possible d’appeler directement une +méthode de log, par exemple :
+ +Le cas des fichiers top.tpl et bottom.tpl
devient :
+ +Note
+Pages à l’état connecté uniquement (incluant le menu, l’entête…).
+Fichiers avec entête HTML :
+ +devient :
+ +Au besoin, si vous avez besoin :
+de remplacer les fichiers CSS chargés par défaut (base.css par exemple) : ajouter le block
+ css :
{block name="css"}
+ <link rel="stylesheet" type="text/css" href="{css name='custom.css'}" media="screen" title="Normal" />
+ {include file='ls:css.tpl'}
+{/block}
+Note
+Ce block contient tous les CSS, y compris ceux gérés par LSsession :: addCssFile().
+Pensez à ajouter {include file='ls:css.tpl'} pour conserver ces derniers.
d’ajouter des infos dans <head> : ajouter le block head (vide par défaut) :
d’ajouter des fichiers Javascript personnalisés : ajouter le block js (vide par défaut):
Note
+Ce block sera ajouté APRÈS les autres fichiers Javascript chargés (ceux par défaut et ceux
+ajoutés via LSsession :: addJSscript().
Autres fichiers remplacés :
+blank.tpl remplacé par base.tplempty.tpl remplacé par base_connected.tplaccueil.tpl remplacé par homepage.tplPour identifier les fichiers concernés, vous pouvez utiliser la commande suivante :
+ +Vérifier les modifications des fichiers templates fourni avec l’application et que vous auriez +personnalisé. Pour cela, vous pouvez utiliser la commande suivante :
+for i in $( ls /etc/ldapsaisie/local/templates/* )
+do
+ default_file="/usr/share/ldapsaisie/templates/default/$( basename "$i" )"
+ [ ! -e "$default_file" ] && continue
+ vi -d $default_file $i
+done
+Note
+Une attention particulière doit être porté aux fichiers login.tpl et recoverpassword.tpl qui
+ont particulièrement changés.
../../images/default/find.png devient ../image/find
Pour identifier les fichiers concernés, vous pouvez utiliser les commandes suivantes :
+grep -Er 'images' /etc/ldapsaisie/local/templates
+grep -Er '\.(png|gif|jpg)' /etc/ldapsaisie/local/templates
+{$LSsession_css} et {$LSsession_js} :Note
+Ceci est déjà géré si vous étendez bien vos templates du fichier base.tpl (pour les pages
+non-connectées) ou base_connected.tpl (pour les pages connectées).
{$LSsession_css} doit être remplacé par {include file='ls:css.tpl'}{$LSsession_js} doit être remplacé par {include file='ls:js.tpl'}view.php :
view.php?LSobject=LSpeople devient object/LSpeopleview.php?LSobject=LSpeople&dn=$dn devient object/LSpeople/$dnaddon_view.php : addon_view.php?LSaddon=ee&view=copyContract devient addon/ee/copyContractindex_ajax.php :
global_search.php : global_search.php?refresh devient search?refreshindex.php : index.php?LSsession_recoverPassword devient index?LSsession_recoverPasswordcreate.php : create.php?LSobject=LSpeople devient object/LSpeople/createmodify.php : modify.php?LSobject=LSpeople&dn=$dn devient object/LSpeople/$dn/modifyimport.php : import.php?LSobject=LSpeople devient object/LSpeople/importremove.php : remove.php?LSobject=LSpeople&dn=$dn devient object/LSpeople/$dn/remove
Avec validation : remove.php?LSobject=LSpeople&dn=$dn&valid devient
+object/LSpeople/$dn/remove?valid
select.php : select.php?LSobject=LSpeople devient object/LSpeople/selectcustom_action.php :
+ custom_action.php?LSobject=LSpeople&dn=$dn&customAction=$customAction
+ devient object/LSpeople/$dn/customAction/$customAction
Avec validation :
+custom_action.php?LSobject=LSpeople&dn=$dn&customAction=$customAction&valid
+devient object/LSpeople/$dn/customAction/$customAction?valid
custom_search_action.php :
+ custom_search_action.php?LSobject=LSpeople&customAction=$customAction
+ devient object/LSpeople/customAction/$customAction
Avec validation :
+custom_search_action.php?LSobject=LSpeople&customAction=$customAction&valid
+devient object/LSpeople/customAction/$customAction?valid
Pour identifier les fichiers concernés, vous pouvez utiliser la commande suivante :
+La configuration du projet est située principalement dans le dossier conf/. Les exceptions seront
+détaillées par la suite.
Warning
+Toute la configuration du projet se fait par l'intermédiaire de fichiers définissant des +variables PHP dont les valeurs sont utilisées par le programme. Ceci signifie que la syntaxe de +ces fichiers doit être valide avec l'interpréteur PHP utilisé.
+La plus grande partie de la configuration globale se trouve dans le fichier config.inc.php.
// Variables globales
+$GLOBALS['LSconfig'] = array(
+ // Variables globales
+);
+
+// Variables et constantes indépendantes
+$var1 = 'val1'
+$var2 = 'val2'
+...
+define('CONST1','val1')
+define('CONST2','val2')
+...
+Smarty
Chemin vers le moteur de template Smarty.
+ +public_root_url
URL publique de la racine web de l'application. Il peut s'agir d'une URL relative bien qu'une URL
+absolue soit préférable, notament pour éviter l'auto-détection de celle-ci lorsque nécessaire
+(lien dans un e-mail par exemple. Par défaut : /.)
Important
+Il est indispensable que ce paramètre soit configuré en adéquation avec votre environement +pour que l'application fonctionne correctement (notament en cas en cas de déploiement dans un +sous-dossier ou encore dans le cadre d'un accès à l'application au travers un +reverse-proxy).
+lang
Paramètre utilisé pour l'internationalisation : code de la langue (fr_FR ou en_US)
encoding
Encodage de caractère (UTF8)
ldap_servers
Configuration des serveurs LDAP. +Voir section concernée.
+Important
+Les variables globales suivantes ont une action globale, mais non-prioritaire sur le +comportement de l'application. Il peux être redéfini pour chacun des serveurs LDAP.
+cacheLSprofiles
Activation/Désactivation de la mise en cache des profils des utilisateurs connectés +(LSprofiles).
+Valeurs possibles : True ou False
Valeur recommandée : True
Valeur par défaut : False
cacheSubDn
Activation/Désactivation de la mise en cache des niveaux de connexion +(subDn) dans l'annuaire.
+Valeurs possibles : True ou False
Valeur recommandée : True
Valeur par défaut : False
cacheSearch
Activation/Désactivation de la mise en cache du résultat des recherches dans l'annuaire.
+Valeurs possibles : True ou False
Valeur recommandée : True
Valeur par défaut : False
globalSearch
Activation/Désactivation de la recherche globale dans l'annuaire.
+Valeurs possibles : True ou False
Valeur par défaut : True
keepLSsessionActive
Activation/Désactivation du maintient de la LSsession active.
+Valeurs possibles : True ou False
Valeur par défaut : False
LS_THEME
Constante déterminant le nom du theme utilisé.
+Valeur par défaut : default
+LS_TEMPLATES_DIR
Constante déterminant le chemin du dossier des templates.
+Valeur par défaut : templates
+LS_IMAGES_DIR
Constante déterminant le chemin du dossier des images.
+Valeur par défaut : images
+LS_CSS_DIR
Constante déterminant le chemin du dossier des CSS.
+Valeur par défaut : css
+LSdebug
Variable booléenne déterminant si le débogage à l'écran est activé.
+$GLOBALS['LSlog']
Variable permettant de configurer la journalisation de l'application. +Voir section concernée.
+NB_LSOBJECT_LIST
Constante déterminant le nombre d'objet affichés par page de résultat de recherche.
+NB_LSOBJECT_LIST_SELECT
Constante déterminant le nombre d'objet affichés par page de résultat de recherche dans une +fenêtre LSselect.
+$GLOBALS['NB_LSOBJECT_LIST_CHOICES']
Variable permettant de configurer la liste des choix proposés à l'utilisateur pour le nombre +maximum d'objets affichés par page de résultat de recherche.
+MAX_SEND_FILE_SIZE
Constante déterminant la taille maximale d'un fichier envoyé à travers les formulaires.
+$GLOBALS['defaultJSscripts']
Tableau déterminant les fichiers Javascript à charger sur toute les pages.
+$GLOBALS['defaultCSSfiles']
Tableau déterminant les fichiers CSS à charger sur toute les pages. Ces fichiers seront chargés +dans l'ordre et en dernier permettant de surcharger tous paramètres de style.
+Cette section décrit le tableau de configuration des différents serveurs LDAP utilisés par +l'application. Ce tableau contient lui même un tableau par serveur LDAP.
+$GLOBALS['LSconfig'] = array(
+ ...
+ 'ldap_servers' => array(
+ array (
+ 'name' => [nom de l'annuaire],
+ 'ldap_config'=> array(
+ // Définition des paramètres de connexion à l'annuaire
+ ),
+ 'useUserCredentials' => [boolean],
+ 'useAuthzProxyControl' => [boolean],
+ 'LSauth' => array (
+ 'method' => [LSauth method],
+ 'api_method' => [LSauth method],
+ 'LSobjects' => array(
+ '[object type 1]',
+ '[object type 2]' => array(
+ 'filter' => '[LDAP filter]',
+ 'filter_function' => [callable],
+ 'password_attribute' => '[attribute name]',
+ 'web_access' => [booléen],
+ 'api_access' => [booléen],
+ )
+ )
+ ),
+ 'LSprofiles' => array (
+ // Définition des LSprofiles
+ ),
+ 'cacheLSprofiles' => [boolean],
+ 'cacheSearch' => [boolean],
+ 'globalSearch' => [boolean],
+ 'LSaccess' => array (
+ [Type LSobject 1],
+ [Type LSobject 2],
+ ...
+ ),
+ 'subDn' => array(
+ // Définition des sous-niveaux de l'annuaire
+ ),
+ 'subDnLabel' => [nom des sous-niveaux],
+ 'recoverPassword' => array(
+ // Définition des paramètres de configuration de la récupération de mot de passe
+ ),
+ 'defaultView' => [view],
+ 'emailSender' => [email],
+ 'keepLSsessionActive' => [booléen]
+ )
+ ...
+);
+...
+name
Le nom d'affichage de ce serveur Ldap (utilisé lorsque plusieurs serveur LDAP sont déclarés).
+ldap_config
Informations de connexion au serveur LDAP. Ces informations sont structurées selon les attentes de +la librairie Net_LDAP2. +Plus d'informations
+useUserCredentials
Booléen définissant si il faut utiliser les identifiants de l'utilisateur pour se connecter à +l'annuaire (false par défaut). Si cette option est activée, la connexion à l'annuaire LDAP sera +établie avec la configuration fournie dans le paramètre ldap_config en écrasant les informations +de connexion (binddn et bindpwd) par ceux de l'utilisateur. Si l'utilisateur n'est pas encore +connecté, la connexion sera étalie sans modifier la configuration fournie.
+useAuthzProxyControl
Booléen définissant si, lorsqu'on utilise les identifiants de l'utilisateur pour se connecter à +l'annuaire, il faut utiliser une authentification via proxy authorization. Dans ce cas, les +identifiants de l'utilisateur ne seront pas, à proprement parlé, utilisés pour se connecter à +l'annuaire, mais une demande de proxy authorization en tant que l'utilisateur connecté sera +faites à l'aide des identifiants de l'application. Ce mode nécessite une configuration +particulière au niveau de l'annuaire pour autoriser le compte de l'application à faire des +demandes de proxy authorization en tant que les autres utilisateurs de l'annuaire.
+LSprofiles
Définition des profils d'utilisateurs se connectant à l'annuaire. +Voir la section concernée.
+LSauth
Ce tableau défini les paramètres d'authentification à l'application.
+method
Nom de la méthode d'authentification
+LSauthMethod. Exemple : pour
+utiliser la classe LSauthMethod_HTTP, la valeur de ce paramètre sera HTTP.
+Paramètre facultatif, méthode par défaut : basic.
api_method
Nom de la méthode d'authentification
+LSauthMethod à utilisée lors
+d'une connexion à l'API. Exemple : pour utiliser la classe LSauthMethod_HTTP, la valeur
+de ce paramètre sera HTTP. Paramètre facultatif, méthode par défaut : HTTP.
Warning
+Toutes les LSauthMethod ne +supportent pas forcément le mode API.
+LSobjects
Tableau listant les types LSobjects pouvant se +connecter à l'application. Les valeurs de ce tableau peuvent être un nom de type d'objet ou bien +tableau détaillant les paramètres de connexion de ce type d'objet.
+filter
LSformat du filtre de recherche de l'utilisateur à sa
+connexion. Ce format sera composé avec l'identifiant fourni par l'utilisateur. Cela peut par
+exemple permettre à l'utilisateur de se connecter en fournissant son login ou son email comme
+identifiant. Exemple de valeur : (|(uid=%{user})(mail=%{user})).
+Paramètre facultatif, filtre par défaut composé à l'aide de l'attribut RDN.
filter_function
Callable (au sens PHP) utilisé pour filtrer les utilisateurs trouvés dans l'annuaire à
+partir des autres paramètres : cette fonction, si elle est définie, sera appelée pour chaque
+utilisateur trouvé, avec pour unique paramètre, une référence à l'objet LDAP correspondant
+(LSldapObject). Cette méthode devra alors retourner true ou false pour respectivement
+autoriser ou interdire l'accès à l'application à l'utilisateur.
Note
+Si un utilisateur est exclus par cette méthode et qu'aucun autre utilisateur correspondant +n'a été trouvé dans l'annuaire, une page d'erreur sera affichée et indiquera que l'accès à +l'application est refusée.
+password_attribute
Nom de l'attribut stockant le mot de passe de ce type
+d'LSobject.
+Paramètre facultatif, valeur par défaut : userPassword.
Note
+C'est cet attribut de l'utilisateur qui sera modifié par la fonctionnalité de récupération +de mot de passe.
+web_access
Permet de définir si ce type d'objet à le droit d'utiliser l'interface web (facultatif, par
+défaut : True).
api_access
Permet de définir si ce type d'objet à le droit d'utiliser l'API (facultatif, par défaut :
+False).
allow_multi_match
Booléen permettant de définir si un doublon d'identifiant utilisateur est autorisé. Si c'est le
+cas et lorsqu'un identifiant fourni par l'utilisateur a sa connexion a permi de trouver plus
+d'un utilisateur possible correspondant, l'application tentera de déterminer lequel de ces
+utilisateurs correspond à la tentative d'authentification. La méthodologie employée dépendra de
+la LSauthMethod configurée. Par
+exemple, la LSauthMethod basic
+tentera de s'identifier avec le mot de passe. Dans tous cas, si cette méthode n'a pas permis
+d'identifier un seul utilisateur, l'authentification échoura. Paramètre facultatif, valeur par
+défaut : False.
cacheLSprofiles
Activation/Désactivation de la mise en cache des LSprofiles +des utilisateurs connectés à ce serveur.
+Valeur par défaut : valeur de la variable globale du même nom
+cacheSearch
Activation/Désactivation de la mise en cache du résultat des recherches sur ce serveur.
+Valeur par défaut : valeur de la variable globale du même nom
+globalSearch
Activation/Désactivation de la recherche globale sur ce serveur en particulier. Par défaut, la
+valeur du paramètre global globalSearch est utilisée.
Valeur par défaut : valeur de la variable globale du même nom
+Définition des types d'LSobjects devant +apparaître dans le menu de l'interface.
+Important
+Ce paramètre n'est utilisé que pour les annuaires n'ayant pas de sous-niveaux +(subDn).
+subDn
Définition des sous-niveaux de connexion à l'annuaire. +Voir section concernée.
+Important
+Ce paramètre remplace le paramètre LSaccess dans le cas d'un annuaire +multi-niveaux.
+subDnLabel
Définition du label utilisé pour qualifier les sous-niveaux de connexion.
+Important
+Ce paramètre est utile uniquement dans le cas d'un annuaire multi-niveaux.
+recoverPassword
Définition des paramètres de la récupération de mot de passe. +Voir la section concernée.
+defaultView
Définition de la vue par défaut de l'application. Par défaut, une page blanche est affichée et il +est possible de définir à l'aide de ce paramètre la vue qui s'affichera. Ce paramètre peut prendre +comme valeur :
+SELF pour la vue Mon compte[addon]::[viewId] pour afficher cette vueemailSender
Adresse mail utilisée par LdapSaisie pour envoyer des e-mails en relation avec cet annuaire. Cette +adresse est celle utilisée par défaut. L'adresse utilisée peut également être configurée dans le +contexte de configuration du module devant envoyer des e-mails.
+keepLSsessionActive
Activation/Désactivation du maintient de la LSsession active.
+Valeurs possibles : True ou False
Valeur par défaut : valeur de la variable globale du même nom
+Cette section décrit la manière dont sont définis les profils d'utilisateurs se connectant à +l'interface appelés LSprofile. Il est possible d'attribuer un profil à l'utilisateur connecté sur +tout ou partie de l'annuaire LDAP.
+Il existe des profils d'utilisateurs par défaut, non liée à la configuration de l'application:
+user
Tous les utilisateurs connectés à l'utilisateur. Ce LSprofile est valide sur l'ensemble de +l'annuaire.
+self
L'utilisateur connecté sur son objet correspondant dans l'annuaire. Ce LSprofile est utile pour +donner des droits à l'utilisateur sur lui-même.
+nom du type de l'objet connecté
Un LSprofile du nom du type d'objet utilisateur connecté est automatiquement ajouté à
+l'utilisateur. Ainsi, si l'utilisateur connecté est un
+LSobject LSpeople par exemple, il aura le
+LSprofile LSpeople sur tous l'annuaire. Ce LSprofile est utile pour donner des droits à tous
+un type d'objets pouvant se connecter à l'application (par exemple, tous les utilisateurs
+applicatifs).
Il est possible de définir autant de profils d'utilisateurs que l'on souhaite. Pour chaque profil +d'utilisateur personnalisé, il faudra définir dans quelles parties de l'annuaire ce profil existe +(Exemple : les admistrateurs de groupes existent uniquement dans la branche de l'annuaire stockant +les groupes). Enfin pour chaque partie de l'annuaire, il faudra définir la manière d'identifier si +l'utilisateur qui se connecte appartient à ce profil.
+'LSprofile' => array (
+ [nom d'un LSprofile] => array (
+ [label] => [label du LSprofile],
+ [basedn] => [dn utilisateur],
+ [autre basedn] => array (
+ [dn d'un utilisateur] => NULL,
+ [autre dn] => array ( // via un listage de l'attribut d'un objet
+ 'attr' => [nom de l'attribut clé de l'objet],
+ 'attr_value' => [format de la valeur de l'attribut clé],
+ 'LSobject' => [nom du type LSobject de l'objet]
+ )
+ ),
+ 'LSobjects' => array ( // via une liste d'objet sur lequel l'utilisateur a des pouvoirs
+ [nom du LSobject] => array (
+ 'attr' => [nom de l'attribut clé],
+ 'attr_value' => [format de la valeur de l'attribut clé],
+ // ou
+ 'filter' => [format du filtre de recherche],
+
+ 'basedn' => [basedn de recherche],
+ 'params' => [configuration de la recherche]
+ ),
+ [nom quelconque] => array (
+ 'filters' => array(
+ array(
+ 'LSobject' => [nom du LSobject],
+ 'attr' => [nom de l'attribut clé],
+ 'attr_value' => [format de la valeur de l'attribut clé],
+ // ou
+ 'filter' => [format du filtre de recherche],
+
+ 'basedn' => [basedn de recherche],
+ 'params' => [configuration de la recherche]
+ ),
+ ),
+ ),
+ ...
+ )
+ ),
+ ...
+),
+...
+Le paramètre LSprofiles est un tableau associatif contenant, en valeur clé, le nom d'un
+LSprofile et en valeur associée, la configuration nécessaire pour déterminer si l'utilisateur
+connecté appartient à ce LSprofile pour tout ou partie de l'annuaire.
Dans chaque configuration de LSprofile, il est possible d'identifier l'appartenance ou non de +l'utilisateur connecté de deux manières :
+Pour une branche de l'annuaire donnée (basedn) : en listant les utilisateurs appartenant à ce + LSprofile pour tous les objets de la branche. Il sera possible de lister les utilisateurs dont + on connait le DN ou de lister les utilisateurs appartenant à une liste stockée dans l'annuaire + (par exemple la liste des membres d'un groupe).
+Liste des DNs d'utilisateurs :
+'LSprofile' => array (
+ [nom du LSprofile] => array (
+ [basedn] => [dn utilisateur],
+ // ou si plusieurs DNs
+ [autre basedn] => array (
+ [dn d'un utilisateur] => NULL,
+ [dn d'un utilisateur 2] => NULL
+ ),
+ ...
+ ),
+ ...
+),
+...
+Explication : Pour un LSprofile et un basedn donnés, on définit l'utilisateur appartenant au +LSprofile en donnant son DN. Si on souhaite lister plusieurs utilisateurs, on utilise un +tableau associatif dans lequel les clés sont les DNs des utilisateurs et les valeurs associées +sont toutes NULL.
+Liste d'utilisateurs stockée dans l'annuaire :
+'LSprofile' => array (
+ [nom du LSprofile] => array (
+ [basedn] => array (
+ [DN d'un object] => array (
+ 'attr' => [nom de l'attribut clé de l'objet],
+ 'attr_value' => [format de la valeur de l'attribut clé],
+ 'LSobject' => [nom du type LSobject de l'objet]
+ )
+ ),
+ ...
+),
+...
+Explication : Pour un LSprofile et un basedn donnés, on liste les utilisateurs du
+LSprofile référencés dans l'attribut attr de l'object de type LSobject et selon le format
+de valeur décrit dans attr_value.
Pour un type de LSobject donné : en listant les objets pour lesquels l'utilisateur aura les + droits du LSprofile. Il sera possible, à travers une recherche paramétrable dans l'annuaire, de + lister les objets pour lesquels l'utilisateur appartiendra au LSprofile.
+'LSprofile' => array (
+ [nom d'un LSprofile] => array (
+ 'LSobjects' => array ( // via un liste d'objet pour lequel l'utilisateur
+ // appartient au LSprofile
+ [nom du LSobject] => array (
+ 'attr' => [nom de l'attribut clé],
+ 'attr_value' => [format de la valeur de l'attribut clé],
+ // or
+ 'filter' => [format du filtre de recherche],
+
+ 'basedn' => [format du basedn de recherche],
+ 'params' => [configuration de la recherche]
+ ),
+ array (
+ 'filters' => array(
+ array(
+ 'LSobject' => [nom du LSobject],
+ 'attr' => [nom de l'attribut clé],
+ 'attr_value' => [format de la valeur de l'attribut clé],
+ // ou
+ 'filter' => [format du filtre de recherche],
+
+ 'basedn' => [format du basedn de recherche],
+ 'params' => [configuration de la recherche]
+ ),
+ ),
+ ),
+ ...
+ )
+ ),
+ ...
+),
+...
+Explications : Dans la configuration d'un LSprofile, la valeur clé LSobjects signifie qu'on +est dans un cas de la délégation de droits sur des types d'LSobject. Dans ce tableau associatif, +il est possible de définir un ou plusieurs types de LSobject pour lesquels on délègue des droits +via des recherches simples ou enchaînées. Le fonctionnement simple consiste à partir de l'objet de +l'utilisateur et à générer un filtre et une base de recherche sur un type de LSobject. Le +fonctionnement enchainée consiste à faire un première recherche à partir de l'objet de +l'utilisateur puis à recommencer à partir des objets trouvés en construisant une liste de filtres +de recherche pour chaque objet qui seront combinés via l'opérateur booléen ou. Dans le cadre +d'un fonctionnement enchainée, la base de recherche est toujours générer à partir de l'objet de +l'utilisateur connecté.
+Pour configurer une délégation de type simple on mettra le nom du LSobject dans la clé du tableau +et dans la valeur un tableau définissant la recherche. Il est possible de ne pas utiliser la clé +du tableau comme nom du LSobject grâce à la clé de configuration LSobject.
+Pour configurer une délégation de type enchaîné on pourra utiliser n'importe quelle valeur unique +pour la clé du tableau et pour la valeur un tableau contenant une unique clé filters. La valeur +associée à cette clé est celle d'une délégation de type simple où la clé LSobject est devenue +obligatoire.
+Cette configuration contient les paramètres d'une ou plusieurs recherches dans l'annuaire en +considérant que l'utilisateur connecté aura les droits du LSprofile sur les objets retournés. Les +paramètres de la recherche sont :
+LSobject
C'est le nom du LSobject recherché. (Paramètre facultatif pour +une délégation de type simple)
+attr
Nom de l'attribut des LSobjets contenant une valeur clé qui +permettra d'identifier l'utilisateur comme ayant droit.
+attr_value
Le format de la valeur clé prise par l'attribut attr. Ce format est composé à partir des
+données de l'objet de l'utilisateur connecté. Voir le paragraphe
+Format paramètrable pour plus d'informations sur
+l'écriture du format.
filter
Ce paramètre remplace les paramètres attr et attr_value. Il est possible ici d'écrire
+directement le format paramètrable du filtre recherche dans l'annuaire. Ce filtre sera
+automatiquement agrémenté des conditions sur l'attribut objectclass. Voir le paragraphe
+Format paramètrable pour plus d'informations sur
+l'écriture du format.
basedn
C'est le format paramétrable du basedn de la recherche généré à partir de l'utilisateur +connecté. Il est possible ainsi de la limiter sur les LSojects d'une branche précise de +l'annuaire. Voir le paragraphe Format paramètrable pour +plus d'informations sur l'écriture du format. (Paramètre facultatif)
+params
C'est un tableau associatif contenant les paramètres étendus de la recherche. Voir le paragraphe +Paramètres étendus des recherches dans l'annuaire +pour plus de détails. (Paramètre facultatif)
+Par ailleurs, il est possible d'attribuer un label plus explicite à chaque LSprofile à l'aide de
+la clé label. Ce label sera utilisé pour faire référence au LSprofile lorsque nécéssaire.
+(Paramètre facultatif)
Cette section décrit la manière de définir des sous-niveaux de connexion à l'annuaire (subDn). Le +concept de sous-niveau de connexion sert à déclarer les niveaux logiques de l'annuaire. Par exemple, +dans un annuaire dans lequel sont stockés des objets concernant plusieurs organisations et que +celles-ci se distinguent grâce à la présence d'une séparation dans l'arbre, il sera alors possible +de définir des sous-niveaux de connexion pour chacune des organisations.
+Exemple d'arborescence d'annuaire utilisant le concept de sous-niveaux correspondant à des sociétés :
+|- o=ls
+| |- ou=companies
+| | |- ou=company1
+| | | |- ou=people
+| | | |- ou=groups
+| | |- ou=company2
+| | | |- ou=people
+| | | |- ou=groups
+| |- ou=people
+| |- ou=groups
+Explications : Il est possible dans cet exemple de définir des sous-niveaux de connexion +correspondants aux sociétés. Dans chacune de ces sociétés, on retrouve les OU correspondant au +type d'LSobjets. Lors de la connexion à l'interface, l'utilisateur devra choisir dans quel +sous-niveau de l'annuaire il souhaite se connecter. Une fois connecté, l'utilisateur manipulera +uniquement les objets du sous-niveau de l'annuaire dans lequel il se trouve. Il lui sera également +possible de changer de sous-niveau de connexion à travers l'interface : une liste déroulante est +disponible pour cela dans le menu.
+Il existe deux manières de déclarer des sous-niveaux de connexion à l'annuaire :
+Pour chacune de ces méthodes on définira également les types d'LSobjets qui sont présents dans +cette branche de l'annuaire.
+'subDn' => array(
+ // Déclaration manuelle
+ '[Nom du sous-niveau]' => array(
+ 'dn' => '[basedn du sous-niveau]',
+ 'nologin' => true, // Désactive la connection dans ce subDn
+ 'LSobjects' => array( // Liste des types d'LSobjets présents dans le sous-niveau
+ [LSobject1],
+ [LSobject2],
+ ...
+ )
+ ),
+ // Liste de LSobjets
+ 'LSobject' => array(
+ '[type d'LSobject]' => array( // le type d'LSobjet à lister
+ 'basedn' => '[basedn]', // Le basedn de la recherche
+ 'displayValue' => '[format]', // Format du nom des sous-niveaux
+ 'nologin' => true, // Désactive la connection dans ces subDn
+ 'onlyAccessible' => True, // Pour que seul les LSobjet accessible à l'utilisateur soit listé
+ 'LSobjects' => array( // Liste des types d'LSobjets présents dans les sous-niveaux
+ [LSobject1],
+ [LSobject2],
+ ...
+ )
+ )
+ )
+),
+...
+Cette section décrit la manière de configurer la récupération de mot de passe par les utilisateurs. +Le mécanisme de récupération de mot de passe fonctionne en deux parties :
+Dans un premier lieu, l'utilisateur ayant perdu son mot de passe accède à l'interface de
+ récupération à partir de la page de connexion. L'interface lui demande de saisir son identifiant
+ et éventuellement de sélectionner le serveur LDAP concerné. Une fois ces informations saisies, une
+ recherche de l'utilisateur est effectuée dans l'annuaire et si celui-ci est trouvé, la valeur de
+ l'attribut recoveryHashAttr de l'objet est alors redéfinie avec une valeur aléatoire.
Un mail est ensuite envoyé à l'utilisateur en utilisant la première valeur de l'attribut
+mailAttr comme adresse. Ce mail est formé à partir des paramètres du tableau associatif
+recoveryHashMail.
+Celui-ci doit contenir le sujet du mail dans subject et le corps du message dans msg. Ces deux
+informations sont des formats paramètrables composés avec,
+comme valeur clé, l'URL de retour à laquelle l'utilisateur devra se rendre pour accèder à la
+seconde étape de la récupération de son mot de passe.
L'utilisateur doit donc se rendre sur l'interface par l'intermédiaire de l'URL qui lui aura été
+ fournie dans le mail de l'étape précédente. Cette URL contient la valeur de l'attribut
+ recoveryHashAttr précédement définie. A partir de cette information, une recherche est effectuée
+ dans l'annuaire pour retrouver l'utilisateur correspondant.
Si l'utilisateur est retrouvé, un nouveau mot de passe lui est généré en utilisant les paramètres
+de configuration éventuellement définis dans la configuration HTML de l'attribut "mot de passe".
+Pour avoir plus d'information sur ces paramètres, consulter la documentation du type d'attribut
+HTML
+LSattr_html_password.
+L'attribut recoveryHashAttr est quant à lui supprimé.
Ensuite, un mail est composé à partir des paramètres du tableau associatif newPasswordMail et
+est envoyé à l'utilisateur. Ce tableau doit contenir le sujet du mail dans subject et le corps
+du message dans msg. Ces deux informations sont des
+formats paramètrables composés avec, comme valeur clé, le
+nouveau mot de passe de l'utilisateur.
'recoverPassword' => array(
+ 'mailAttr' => '[attribut mail]',
+ 'recoveryHashAttr' => '[attribut hash]',
+ 'recoveryEmailSender' => '[adresse mail utilisée par LdapSaisie pour l'envoi des mails]',
+ 'recoveryHashMail' => array( // 1er mail : avec l'URL pour l'accès à la 2nde partie
+ 'subject' => '[sujet du mail]',
+ 'msg' => "[message contenant le mot clé %{url}]"
+ ),
+ 'newPasswordMail' => array( // 2nd mail : avec le mot de passe
+ 'subject' => '[sujet du mail]',
+ 'msg' => "[message contenant le mot clé %{mdp}]"
+ )
+),
+...
+Cette section décrit le tableau de configuration de la journalisation de l'application.
+$GLOBALS['LSlog'] = array(
+ 'enable' => [booléen],
+ 'level' => '[niveau]',
+ 'log_errors_context' => [booléen],
+ 'log_errors_context_with_args' => [booléen],
+ 'log_errors_context_args_max_length' => [entier],
+ 'handlers' => array(
+ '[handler 1]',
+ array (
+ 'handler' => [handler 2],
+ 'enabled' => [booléen],
+ 'level' => '[niveau]',
+ 'loggers' => array('logger1', [...]),
+ 'excluded_loggers' => array('logger2', [...]),
+ 'format' => '[LSformat]',
+ 'cli_format' => '[LSformat]',
+ 'datetime_prefix' => [booléen],
+ 'datetime_format' => '[format date()]',
+ // Autres paramètres propre à ce handler
+ [...]
+ ),
+ [...]
+ ),
+ 'loggers' => array (
+ 'logger1' => array (
+ 'level' => 'DEBUG',
+ ),
+ 'logger2' => array (
+ 'enabled' => false,
+ ),
+ [...]
+ );
+);
+...
+enable
Booléen permatant d'activer ou désactiver complètement la journalisation. Par défaut : False
level
Ce paramètre défini le niveau minimum de la journalisation : tous les messages des niveaux +inférieurs ne seront pas inclus dans le journal de l'application. Les niveaux de journalisation +gérés par l'application sont (dans l'ordre du plus petit au plus grand) :
+TRACEDEBUGINFOWARNINGERRORFATALlog_errors_context
Booléen permatant de définir si le contexte (=backtrace) doit être inclus lors de la +journalisation d'une erreurs.
+log_errors_context_with_args
Booléen permatant de définir si les arguments des méthodes/fonctions appelées doivent être
+inclus lors de la journalisation du contexte des erreurs.
+Note : ce paramètre n'as aucun effet si le paramètre log_errors_context n'est pas activé.
log_errors_context_args_max_length
Ce paramètre permet de définir à partir de quelle longueur les arguments des méthodes/fonctions
+appelées et journalisés seront tronqués (par défaut : 1000). Note : pour désactiver le
+troncage, mettre ce paramètre à zéro.
handlers
Tableau permettant de configurer les handlers de la journalisation. Chaque handler gère les +messages journalisés d'une manière qui lui est propre.
+Plusieurs handlers peuvent être configurés en même temps (y compris plusieurs handlers du même +type).
+Ce tableau peut contenir simplement le nom du type de handler à utiliser ou bien des tableaux +configurant un à un chacun des handlers. Dans ce second cas, la structure de la configuration +d'un handler est la suivante :
+array(
+ 'handler' => [type],
+ 'level' => '[niveau]',
+ 'loggers' => array('logger1', [...]),
+ 'excluded_loggers' => array('logger2', [...]),
+ 'format' => '[LSformat]',
+ 'cli_format' => '[LSformat]',
+ 'datetime_prefix' => [booléen],
+ 'datetime_format' => '[format date()]',
+ // Autres paramètres propre à ce handler
+ [...]
+)
+...
+handler
Type du handler (voir ci-dessous).
+level
Ce paramètre défini le niveau minimum de la journalisation spécifique à cet handler. Si ce
+paramètre est omis, le niveau global sera utilisé. Les valeurs possibles de ce paramètre sont
+les mêmes que pour le paramètre $GLOBALS['LSlog']['level'].
enabled
Booléen permettant d'activer ou désactiver cet handler (paramètre facultatif, par défaut :
+True).
loggers
Liste exhautive des composants dont les messages doivent être traités par ce handler (paramètre +facultatif, par défaut : tous les composants).
+excluded_loggers
Liste exhautive des composants dont les messages ne doivent pas être traités par ce handler +(paramètre facultatif, par défaut : aucun composant).
+format
LSformat des messages de cet journalisé par ce handler. Ce +format est composé à partir des informations décritent ci-dessous. Par défaut :
+%{requesturi} - %{remoteaddr} - %{ldapservername} - %{authuser} - %{logger} - %{level} - %{message}
+level
Le niveau du message.
+message
Le message.
+logger
Le composant ayant déchenché cette journalisation.
+clibinpath
Le nom du script ayant déclenché cette jounalisation (uniquement en cas d'exécution en ligne +de commande).
+requesturi
L'URL de la page courante (uniquement dans un contexte Web).
+remoteaddr
L'adresse IP du client (uniquement dans un contexte Web).
+ldapservername
Le nom du serveur LDAP courant.
+authuser
Le DN de l'utilisateur connecté (uniquement dans un contexte Web).
+cli_format
LSformat des messages de cet journalisé par ce handler dans
+le cas d'une exécution en ligne de commande. Ce format est composé à partir des même
+informations que le paramètre format (voir ci-dessus). Par défaut :
+
datetime_format
Booléen permettant de définir si le message doit être préfixé de la date et heure courante. La +valeur par défaut dépends de l'handler (en règle général, toujours actif sauf lorsque le canal +de journalisation l'ajoute déjà).
+datetime_format
Format de la date et heure lorsque celle-ci est ajoutée en préfixe du message (voir paramètre
+datetime_format). Le format correspond à celui attendu par la function date() de
+PHP. Consultez la documentation officielle pour
+plus de détails (Par défaut : Y/m/d H:i:s).
Il existe plusieurs types d'handlers gérés par l'application :
+file
Journalisation dans un simple fichier texte. Le chemin du fichier peut être configuré via le
+paramètre path. Si ce paramètre est omis, le chemin du fichier par défaut est soit la
+valeur de la variable $GLOBALS['LSlog']['filename'] (pour la rétro-compatibilité avec les
+anciennes versions d'LdapSaisie) ou à défaut : tmp/LS.log.
syslog
Journalisation via le service syslog. Il est possible de configurer une priorité
+systématique pour les messages journalisés. À défaut, la priorité sera déterminée
+automatiquement en fonction du niveau du message. Les valeurs
+possibles de ce paramètre sont : EMERG, ALERT, CRITICAL,ERROR, WARNING, NOTICE, INFO, DEBUG
system
Journalisation via le gestionnaire d'erreurs PHP. Cet handler utilise la fonction
+PHP error_log. Pour plus d'informations sur comment configurer le
+gestionnaire d'erreurs PHP, consulter la
+documentation officielle.
email
Journalisation via l'envoi d'un email : chaque message journalisé déclenchera l'envoi d'un email
+au destinataire configuré. L'adresse email du destinataire peut-être configurée via le paramètre
+recipient.
Note
+Il est conseillé d'utiliser ce type d'handler avec un niveau minimum de journalisation
+important (FATAL recommandé) pour ne pas déclencher un nombre trop important d'envois
+d'emails.
loggers
Tableau permettant de configurer la journalisation composant par composant. Chaque composant peut
+avoir son propre logger ce qui permet alors, par exemple, de configurer le niveau de log
+spécifiquement pour ce composant.
Le nom des composant correspond en général au nom de la classe PHP correspondante, ou bien encore +le nom d'une commande (lors d'une exécution en ligne de commande).
+Note
+Par défaut, le nom du composant ayant déclenché un message journalisé est affiché juste avant +le niveau de log.
+enabled
Booléen permettant de désactiver complètement les logs du composant (par défaut: True).
level
Niveau de log spécifique pour ce composant (par défaut: le niveau de log global).
+Un format paramétrable est une chaîne de caractères contenant des mots clés formés comme dans +l'exemple suivant :
+ +Le nom du mot clé peut contenir des lettres de "a" à "z", de "A" à "Z" et des chiffres de 0 à 9. Ces +mots clés seront remplacés par les valeurs passées en paramètres et liées au contexte d'utilisation. +Les paramètres :A et :B permettent d'extraire une partie de la chaîne complète avant la +substitution.
+Le paramètre A correspond, lorsque B n'est pas défini, au nombre maximum de caractères à
+extraire de la chaîne de substitution. A doit être un entier dont le signe influ, comme expliqué
+ci-dessous :
A est positif, les A premiers caractères de la chaîne de substitution seront extraits.A est négatif, les |A| derniers caractères de la chaîne de substitution seront extraits.Lorsque le paramètre B est défini, A correspond au rang du premier caractère à partir duquel la
+chaîne de substitution sera découpée et B le nombre maximum de caractères à extraire. Le signe de
+B influera comme expliqué dans le premier cas. Si B vaut zéro, la totalité de la longeur de la
+chaîne sera retournée en tenant compte de A pour le rang du premier caractère.
Il existe par ailleurs des paramètres permettant de modifier la valeur de substitution avant son +utilisation :
+Important
+Lorsque qu'une seule valeur clé est disponible pour la substitution, le nom du mot clé n'importe +pas. Tous les mots clés trouvés dans le format seront remplacés par cette seule valeur.
+Les paramètres des recherches sont ceux supportés par +Net_LDAP2. Ces paramètres sont passés sous la forme d'un +tableau associatif. Les paramètres supportés sont détaillés ci-dessous :
+| Nom | +Description | +Valeur par défaut | +
|---|---|---|
scope |
+Définition de l'étendue de la recherche : +
|
+sub |
+
sizelimit |
+Le nombre maximum d'entrées retournées par la recherche. | +0 (illimité) |
+
timelimit |
+Le délai d'attente maximum de la réponse du serveur en secondes. | +0 (illimité) |
+
attrsonly |
+Si vrai, seuls les noms des atttributs seront retournés. | +false |
+
attributes |
+Tableau contenant les noms des attributs que les entrées retournées peuvent contenir et que l'on souhaite récupérer. | +array()(tous) |
+
Pour plus d'information sur le sujet, vous pouvez consulter la documentation officiel du projet +Net_LDAP2.
Cette partie décrit la manière de configurer les différents types de LSobjets manipulés par +LdapSaisie.
+La configuration des LSobjects est stockée dans le dossier /conf/LSobjects. Dans ce dossier, on
+retrouve un fichier par type d'LSobject, nommé de la manière suivante :
Ce fichier contient la déclaration de la configuration du type d'LSobject qui est stocké dans la
+variable globale $GLOBALS['LSobjects']['[nom du type d'LSobject]'].
$GLOBALS['LSobjects']['[nom du type d'LSobject]'] = array (
+ 'objectclass' => array(
+ 'objetclass1',
+ 'objetclass2',
+ ...
+ ),
+ 'filter' => '[filtre LDAP]',
+
+ 'rdn' => 'attr1',
+
+ 'LSaddons' => [LSaddon(s)],
+
+ 'container_dn' => 'ou=people',
+ 'generate_container_dn' => '[callable]',
+ 'container_auto_create' => array(
+ // Information des configurations pour la création du conteneur du type d'LSobjet
+ // lors de la création nouveau subDn
+ ),
+
+ 'disable_creation' => [boolean]',
+
+ 'before_modify' => 'function1',
+ 'after_modify' => 'function2',
+ 'after_create' => 'function3',
+ 'after_delete' => 'function4',
+
+ 'label' => 'objet1',
+ 'display_name_format' => '[format]',
+ 'displayAttrName' => '[booleen]',
+
+ //Custom Actions
+ 'customActions' => array (
+ // Configuration des customActions pour ce type d'objet
+ ),
+
+ // LSrelation
+ 'LSrelation' => array(
+ // Configuration des LSrelations entre ce type d'objet et les autres
+ ),
+
+ // LSform
+ 'LSform' => array (
+ // Configuration des formulaires de l'objet
+ ), // fin LSform
+
+ // LSsearch
+ 'LSsearch' => array (
+ // Configuration des recherches de l'objet
+ ), // fin LSsearch
+
+ 'globalSearch' => [booleen],
+ 'globalSearch_extraDisplayedColumns' => [booleen],
+
+ // ioFormat
+ 'ioFormat' => array (
+ // Configuration des formats d'import/export de l'objet
+ ),
+
+ // Attributs
+ 'attrs' => array (
+ // Configuration des attributs du type d'LSobjet
+ )
+);
+...
+objectclass
La liste des objectclass des objets.
+filter
Filtre de recherche LDAP applicable à tout les objets de ce type et qui sera utilisé lors de +chaque recherche de ce type d'objet.
+rdn
Nom de l'attribut correspondant au RDN des objets LDAP.
+LSaddons
LSaddon(s) dont le type d'objet dépend. Ce peut être un tableau de chaînes de caractères ou une +simpe chaîne de caractères correspondant au(x) nom(s) du/des LSaddon(s) en dépendance.
+container_dn
Elément pour construire le basedn de stockage de ce type d'objet. Par exemple, si le basedn de
+l'annuaire est o=ls et que les objets utilisateurs sont stockés dans la branche de l'annuaire
+ou=people,o=ls, alors container_dn devra valoir ou=people.
Lorsque l'annuaire possède des subDn, les
+objets seront cherchés dans le basedn résultant de la concaténation du paramètre container_dn,
+d'une virgule et du basedn correspondant au
+subDn courant.
generate_container_dn
Callable (au sens PHP), utilisé pour générer la valeur du paramètre container_dn
+dynamiquement. Ce callable prend en paramètre l'objet LSobject à
+créer et retourne la valeur du paramètre container_dn.
container_auto_create
Tableau associatif contenant les paramètres de configuration nécessaires à la création des
+container_dn dans les nouveaux objets utilisés comme
+subDn.
+Voir la section concernée.
disable_creation
Booléen permetant de desactiver la creation de ce type d'objet de manière globale.
+before_modify
Chaîne de caractères (ou tableau de chaine de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées avant la modification d'un objet. +Voir la section concernée.
+after_modify
Chaîne de caractères (ou tableau de chaine de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées après la modification d'un objet. +Voir la section concernée.
+after_create
Chaîne de caractères (ou tableau de chaine de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées après la création d'un objet. +Voir la section concernée.
+after_delete
Chaîne de caractères (ou tableau de chaine de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées après la suppression d'un objet. +Voir la section concernée.
+label
Nom générique au pluriel qualifiant le type d'objet. Exemple : Utilisateurs.
+display_name_format
Format paramètrable du nom des objets composés à +partir des valeurs d'affichage des attributs de l'objet.
+displayAttrName
Booléen définissant si le nom des attributs doit être affiché en préfixe de leur message d'aide
+(paramètre help_info).
customActions
Tableau associatif contenant les paramètres de configuration des +customActions. +Voir la section concernée.
+LSrelation
Tableau associatif contenant les paramètres de configuration des +LSrelations. Voir la section concernée.
+LSform
Tableau associatif contenant les paramètres de configuration des LSforms des +LSobjects. Voir la section concernée.
+LSsearch
Tableau associatif contenant les paramètres de configuration des recherches de +LSobject de ce type dans l'annuaire. +Voir la section concernée.
+globalSearch
Inclure ou non ce type d'objet dans le résultat des recherches globales (Par défaut : True).
globalSearch_extraDisplayedColumns
Afficher ou non les colonnes supplémentaires pour ce type d'objet dans le résultat des recherches
+globales (Par défaut : True). Pour plus de détails les colonnes supplémentaires,
+voir la section dédiée.
ioFormat
Tableau associatif contenant les paramètres de configuration des formats de fichiers +d'import/export de ce type d'LSobject. +Voir la section concernée.
+attrs
Tableau associatif contenant les paramètres de configuration des attributs des objets. +Voir la section concernée.
+Cette section décrit les options de configuration des attributs des
+LSobjects. Les attributs sont définis dans le tableau
+associatif attrs de la configuration des LSobjects. Dans ce
+tableau, les clé les noms des attributs et les valeurs liés sont la configuration des attributs.
Warning
+Contrairement à ce qui existe dans le standard LDAP, les noms des attributs sont sensibles à la +casse. Il faut que le nom des attributs dans LdapSaisie soient scrupuleusement les mêmes que +ceux retourné par Net_LDAP2
+'attrs' => array (
+ /* ----------- start -----------*/
+ 'attr1' => array (
+ 'label' => '[label de l'attr1',
+ 'displayAttrName' => '[booleen]',
+ 'help_info' => '[Message d'aide sur l'attribut attr1]',
+ 'help_info_in_view' => '[booleen]',
+ 'ldap_type' => 'ldaptype1',
+ 'ldap_options' => array(
+ // Options LDAP liées au type LDAP de l'attribut
+ ),
+ 'html_type' => 'htmltype1',
+ 'html_options' => array(
+ // Options HTML liées au type HTML de l'attribut
+ ),
+ 'no_value_label' => '[No set value label]',
+ 'multiple' => 0,
+ 'required' => 1,
+ 'generate_function' => 'fonction1',
+ 'generate_value_format' => '[LSformat]',
+ 'default_value' => 'valeur1',
+ 'set_default_value_on_creation_if_empty' => [booleen],
+ 'force_generation_if_empty' => [booleen],
+ 'check_data' => array (
+ // Régle de vérification syntaxique des données saisies
+ ),
+ 'validation' => array (
+ // Règle de vérification d'intégrité des données saisies
+ ),
+ 'rights' => array(
+ 'LSprofile1' => 'droit1',
+ 'LSprofile2' => 'droit2',
+ ...
+ ),
+ 'view' => 1,
+ 'form' => array (
+ 'create' => 1,
+ 'modify' => 0,
+ ...
+ ),
+ 'dependAttrs' => array(
+ // Attributs en dépendance
+ ),
+ 'onDisplay' => 'fonction2'
+
+ 'before_modify' => 'function1',
+ 'after_modify' => 'function2'
+ ),
+ /* ----------- end -----------*/
+ ...
+);
+...
+label
Le label de l'attribut.
+displayAttrName
Booléen définissant si le nom de l'attribut doit être affiché en préfixe du message d'aide
+(paramètre help_info).
help_info
Message d'aide qui sera affiché dans une bulle d'aide à côté du nom de l'attribut dans les +formulaires.
+help_info_in_view
Booléen définissant si le message d'aide doit être affiché sur la vue de visualisation de l'objet.
+Valeurs possibles : 0 ou 1
+Valeur par défaut : 0
+ldap_type
Le type LDAP de l'attribut (facultatif, par défaut: +LSattr_ldap_ascii). +Voir la section concernée.
+ldap_options
Tableau associatif contenant les paramètres de configuration du type LDAP de l'attribut. +Voir la section concernée.
+html_type
Le type HTML de l'attribut (facultatif, par défaut: + LSattr_html_text). +Voir la section concernée.
+html_options
Tableau associatif contenant les paramètres de configuration du type HTML de l'attribut. +Voir la section concernée.
+no_value_label
Label affiché lorsque l'attribut n'a pas de valeur (facultatif).
+multiple
Booléen définissant si cet attribut peut stocker plusieurs valeurs.
+Valeurs possibles : 0 ou 1
+Valeur par défaut : 0
+required
Booléen définissant si cet attribut doit obligatoirement être défini.
+Valeurs possibles : 0 ou 1
+Valeur par défaut : 0
+generate_function
Nom de la fonction permettant de générer la valeur de l'attribut. Cette fonction sera éxecutée, en +passant en premier paramètre, l'objet LSobject courant.
+generate_value_format
LSformat permettant la génération de l'attribut.
+Note
+Cette méthode de génération est utilisée uniquement si aucune fonction de génération de la
+valeur n'est définie (paramètre generate_function).
default_value
Valeur par défaut de l'attribut.
+Warning
+Il doit s'agir de la valeur telque retournée par le formulaire web. Ainsi, par exemple dans le
+cas d'un attribut booléen, les valeurs possibles sont yes ou no.
Note
+Cette valeur est également utilisée dans le cadre de la génération automatique de la valeur de +l'attribut si aucune autre méthode n'est disponible (via une fonction ou un +LSformat).
+set_default_value_on_creation_if_empty
Booléen permettant de définir si la valeur de l'attribut doit être initialisée avec sa valeur par +défaut à la création de l'objet si aucune autre valeur n'as été fournie dans le contexte de +création (par défaut : 1).
+force_generation_if_empty
Booléen permettant de définir si la valeur de l'attribut doit être générée si elle est vide, que +ce soit à la création ou la modification de l'objet (par défaut : 0).
+Warning
+Si la génération échoue, cela bloquera l'action. Par ailleurs, cette génération est
+prioritaire sur l'utilisation de la valeur par défaut de l'attribut induit par le paramètre
+set_default_value_on_creation_if_empty.
check_data
Tableau associatif contenant les règles de vérification syntaxique des données de l'attribut. +Voir la section concernée.
+validation
Tableau associatif contenant les règles de vérification d'intégrité des données de l'attribut. +Voir la section concernée.
+rights
Tableau associatif dont les clés sont les noms des
+LSprofiles ayant des droits sur cet
+attribut et les valeurs associées sont les droits correspondants. La valeur des droits d'un
+LSprofile peut être r pour le droit de
+lecture ou w pour le droit de lecture-écriture. Par défaut, un
+LSprofile n'a aucun droit.
view
Booléen définissant si l'attribut est, ou non, affiché lors de la visualisation des objets du type +courant.
+Valeurs possibles : 0 ou 1
+Valeur par défaut : 0
+form
Tableau associatif dont les clés sont les noms des LSforms et les valeurs
+associées la définition de l'affichage dans ce LSform. Si cette valeur vaut
+0, alors l'attribut sera lecture-seule et si cette valeur vaut 1, cet attribut sera affiché
+en lecture-écriture.
dependAttrs
Tableau associatif listant les attributs dépendants de celui-ci. Les attributs listés ici seront
+regénérés lors de chaque modification de l'attribut courant. Cette génération sera effectuée avec
+la fonction définie dans le paramètre generate_function de l'attribut.
onDisplay
Nom ou liste de nom des fonctions retournant les valeurs d'affichages de l'attribut. Si c'est une +liste, chacune des fonctions seront executée les unes après les autres. Ces fonctions seront +éxecutées, en passant en premier paramètre, le tableau des valeurs de l'objet.
+before_modify
Chaîne de caractères (ou tableau de chaine de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées avant toutes modifications de la valeur de l'attribut. +Voir la section concernée
+after_modify
Chaîne de caractères (ou tableau de chaine de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées après toutes modifications de la valeur de l'attribut. +Voir la section concernée
+Cette section décrit les options propres à chacun des types d'attributs LDAP supportés par +LdapSaisie.
Ce type est utilisé pour la gestion des attributs dont la valeur est une chaine de caractère. Ce +type est le type par défaut.
Ce type est utilisé pour la gestion des attributs dont la valeur est une booléen. On attend ici par +booléen, tout attribut ne pouvant prendre que deux valeurs pré-définies correspond pour l'un à Oui +et l'autre à Non
+'ldap_options' => array (
+ 'true_value' => '[valeur correspondant à Vrai]',
+ 'false_value' => '[valeur correspondant à Faux]'
+),
+...
+true_value
La valeur de l'attribut correspondant à Vrai. (Par défaut : TRUE)
false_value
La valeur de l'attribut correspondant à False. (Par défaut : FALSE)
Important
+Les valeurs possibles pour le paramètre default_value sont yes et no.
Ce type est utilisé pour la gestion des attributs composites dont les valeurs respectent le format
+suivant : [key1=value1][key2=value2][...]
Ce type d'attribut LDAP sera utilisé pour convertir la valeur en son équivalent JSON pour pouvoir
+être traité à l'aide du type d' attribut HTML
+LSattr_html_jsonCompositeAttribute.
Ce type est utilisé pour la gestion des attributs dont la valeur est une date.
+Note
+Au sein d'LdapSaisie, les dates manipulées au travers ce type d'attribut LDAP, sont au format +timestamp. Il s'agit donc de nombres entiers correpondants au nombre de secondes depuis le 1 +janvier 1970.
+Le type d'attribut HTML utilisé conjointement avec ce type d'attribut LDAP devra être prévu pour +recevoir et fournir des dates au format timestamp, comme c'est le cas pour le type d'attribut +HTML date.
+'ldap_options' => array (
+ 'timestamp' => [Booléen], // Si la date est stockée au format timestamp
+ 'formats' => array(
+ '[Format de stockage principal]', // Par défaut : "YmdHisO"
+ '[Formats de stockage alternatifs]', // Par défaut : "YmdHis.vO" & "YmdHis.uO"
+ [...]
+ ),
+ 'timezone' => '[Fuseau horaire]', // Default : "UTC"
+),
+...
+timestamp
Booléen définissant si la date est stockée sous la forme d'un timestamp Unix (nombre de secondes +depuis le 1er janvier 1970 à 00:00:00 UTC).
+Si timestamp est vrai, LdapSaisie ne tient pas compte du paramètre format.
formats
Formats de stockage de la date dans l'annuaire. Ces formats sont composés à partir des motifs clés
+gérés par la fonction date() de PHP. Pour plus d'information, consulter
+la documentation officielle. Plusieurs formats peuvent être définis,
+mais en cas de stockage d'une nouvelle valeur, se sera le premier format défini qui sera utilisé.
Note
+La valeur par défaut est ["YmdHisO", "YmdHis.vO", "YmdHis.uO"], correspondant à la syntaxe
+Generalized Time (sans et avec les milli-secondes ou micro-secondes) telle que définie dans
+la RFC4517.
+Exemples : 20091206230506Z (=2009/12/06 23:05:66 UTC), 20190613143537+0200
+(=2019/06/13 14:35:37 UTC+0200) ou 20230818121005.307+0200
+(=2023/08/18 12:10:05.307 UTC+0200).
Warning
+Si vous exploitez un attribut stockant une date incluant les milli-secondes ou les
+micro-secondes, ce type d'attribut LDAP sera capable de gérer l'interpratation des valeurs
+stockées, en outre le type d'attribut
+LSattr_html_date, s'appuyant sur les
+méthodes standards strftime() et strptime(), ne permettra pas aujourd'hui leur saisie et
+affichage.
timezone
Fuseau horaire de stockage des dates dans l'annuaire LDAP. Les valeurs possibles sont documentées
+dans la documentation officielle de PHP. (Par défaut : UTC)
Ce type est utilisé pour la gestion des attributs dont la valeur est une image. Pour le moment, +aucun traitement particulier n'est appliqué pour le stockage.
Ce type est utilisé pour la gestion des attributs dont la valeur est une date dont la timezone +doit être ignorée. Côté LDAP, les dates seront stockées au format UTC étant donnée que la syntaxe +LDAP exige une timezone, cependant celle-ci sera complètement ignorée. Ce type peut-être utilisé +à la place du type LSattr_ldap_date.
+'ldap_options' => array (
+ 'format' => '[Format de stockage]', // Default : "%Y%m%d%H%M%SZ"
+),
+...
+format
Format de stockage de la date dans l'annuaire. Ce format est composé à partir des motifs clés
+gérés par la fonction strftime() de PHP. Pour plus d'information, consulter
+la documentation officielle.
Note
+La valeur par défaut est %Y%m%d%H%M%SZ, correspondant à la syntaxe Generalized Time (sans
+les micro-secondes) telle que définie dans la RFC4517.
+Exemple : 20091206230506Z (=2009/12/06 23:05:66 UTC).
Ce type est utilisé pour la gestion des attributs dont la valeur est un nombre. Pour le moment, +aucun traitement particulier est n'appliqué pour le stockage.
Ce type est utilisé pour la gestion des attributs dont la valeur est un mot de passe.
+'ldap_options' => array (
+ 'encode' => '[Type d'encodage du mot de passe]',
+ 'encode_function' => '[Nom de la fonction d'encodage]',
+ 'verify_function' => '[Nom de la fonction de vérification]',
+ 'no_random_crypt_salt' => '[Booléen]', // Désactivation de l'utilisation d'une salt aléatoire
+ 'wildcardPassword' => '[mot de passe(s) en clair]',
+ 'encodedWildcardPassword' => '[mot de passe(s) encodé(s)]'
+),
+...
+encode
Nom du type d'encodage du mot de passe utilisé. Les types d'encodages supportés sont les +suivants :
+argon2 (ou argon2i, PHP >= 7.2)argon2id (PHP >= 7.3)md5cryptcryptext_desblowfishshasha256sha512sshassha256ssha512smd5md5clearNote
+Valeur par défaut : md5crypt
Important
+Si le type d'encodage est inconnu, ou qu'il n'est pas supporté par le serveur web, un message +d'erreur alertera l'utilisateur et le mot de passe sera stocké en clair.
+encode_function
Nom d'une function qui sera utilisée afin d'encoder le mot de passe. Cette fonction recevra deux
+paramètres : le LSldapObject et le mot de passe en clair.
verify_function
Nom d'une function qui sera utilisée afin de valider un mot de passe soumis par l'utilisateur par
+rapport à celui stocké dans l'annuaire. Cette fonction recevra trois paramètres : le
+LSldapObject,le mot de passe en clair et le mot de passe hashé. Si ce paramètre est omis et que
+le paramètre encode_function est défini, le mot de passe à tester sera encodé à nouveau à l'aide
+de la fonction encode_function et le résultat sera comparé avec le mot de passe stocké dans
+l'annuaire.
no_random_crypt_salt
Désactivation de l'utilisation d'une salt générée aléatoirement au profit de l'utilisation des
+deux premiers caractères du mot de passe. Ce paramètre impacte uniquement le type de cryptage
+crypt.
wildcardPassword
Mot de passe (ou tableau de mot de passe) qui sera ajouté systématiquement, en plus du mot de +passe choisi. Il sera encodé de la même manière que pour le mot de passe choisi avant +enregistrement.
+encodedWildcardPassword
Mot de passe (ou tableau de mot de passe) qui sera ajouté systématiquement, en plus du mot de
+passe choisi. Contrairement à la directive wildcardPassword, le mot de passe ne sera pas encodé
+avant enregistrement.
Note
+Cette directive peut cohabiter avec sa cousine wildcardPassword. Les mot de passes contenus
+dans les deux directives seront alors ajoutés.
Ce type est utilisé pour la gestion des attributs dont la valeur est construite sur le modèle de
+l'attribut standard postalAddress, c'est à dire dont les lignes sont séparées à l'aide du
+caractère de délimiteur $.
Lors de la lecture des valeurs de ce type d'attribut dans l'annuaire, les caractères $ seront
+remplacés par des caractères \n et, à l'inverse, lors de l'écriture des valeurs de ce type
+d'attribut dans l'annuaire, les caractères \n seront remplacés par des caractères $.
Ce type est utilisé pour la gestion de l'attribut standard pwdHistory. Cet attribut, accessible en +lecture uniquement, stocke dans un format prédéfini l'historique des mots de passe d'une utilisateur +avec pour chaque entrée :
+Ce type d'attribut LDAP permettra de convertir la valeur en son équivalent JSON pour pouvoir être
+traité à l'aide du type d'attribut HTML
+LSattr_html_jsonCompositeAttribute.
Exemple de valeur de l'attribut pwdHistory :
+20201202144718Z#1.3.6.1.4.1.1466.115.121.1.40#105#{SSHA512}XDSiR6Sh6W7gyVIk6Rr2OUv8rNPr+0rHF99d9lcirE/TnnEdkjkncIi5iPubErL5lpfgh8gXLgSfmqvmFcMqXLToC25xIqyk
+Exemple de valeur tranformée :
+{"time":1606920438,"syntaxOID":"1.3.6.1.4.1.1466.115.121.1.40","length":105,"hashed_password":"{SSHA512}XDSiR6Sh6W7gyVIk6Rr2OUv8rNPr+0rHF99d9lcirE/TnnEdkjkncIi5iPubErL5lpfgh8gXLgSfmqvmFcMqXLToC25xIqyk"}
+Exemple de configuration complète de l'attribut :
+'pwdHistory' => array (
+ 'label' => 'Passwords in history',
+ 'ldap_type' => 'pwdHistory',
+ 'html_type' => 'jsonCompositeAttribute',
+ 'html_options' => array (
+ 'components' => array (
+ 'time' => array (
+ 'label' => 'Date added to history',
+ 'type' => 'text',
+ 'required' => true,
+ 'multiple' => false,
+ ),
+ 'syntaxOID' => array (
+ 'label' => 'Syntax OID',
+ 'type' => 'text',
+ 'required' => true,
+ 'multiple' => false,
+ ),
+ 'length' => array (
+ 'label' => 'Length',
+ 'type' => 'text',
+ 'required' => true,
+ 'multiple' => false,
+ ),
+ 'hashed_password' => array (
+ 'label' => 'Hashed password',
+ 'type' => 'text',
+ 'required' => true,
+ 'multiple' => false,
+ ),
+ ),
+ ),
+ 'no_value_label' => 'History is empty.',
+ 'multiple' => 1,
+ 'rights' => array(
+ 'admin' => 'r',
+ ),
+ 'view' => 1,
+),
+La date et heure de l'ajout du mot de passe dans l'historique est convertie dans un format lisible.
+Par défaut, ce format est AAAA/MM/JJ HH:MM:SS, mais il peut aussi est personnalisé via le
+paramètre date_format. Ce format est composé à partir des motifs clés gérés par la fonction
+date() de PHP. Pour plus d'information, consulter
+la documentation officielle.
Note
+La valeur par défaut est YmdHisO, correspondant à la syntaxe Generalized Time telle que
+définie dans la RFC4517 et prévu par le
+Draft-behera-ldap-password-policy
+spécifiant cet attribut standard.
Ce type est prévu pour gérer l'attribut sambaAcctFlags du schéma Samba, qui au travers d'une seule +et unique valeur, respectant un format prévu, liste l'ensemble des drapeaux actifs d'un compte +Samba. Il transforme l'unique valeur de l'attribut LDAP en une liste de drapeaux actuellement +activés sur le compte. Il est conçu pour être utilisé conjointement avec le type d'attribut HTML +LSattr_html_sambaAcctFlags.
Ce type est prévu pour gérer l'attribut shadowExpire du schéma POSIX, qui une stocke une date sous
+la forme d'un entier correspondant au nombre de jours depuis le premier 1er 1970. Il est prévu pour
+être utilisé conjointement avec le type d'attribut HTML
+LSattr_html_date.
Note
+Malgrés son nom, ce type d'attribut LDAP peux être utilisé pour d'autres attributs stockant ce
+même format de date, tel-que l'attribut shadowLastChange.
Cette section décrit les options propres à chacun des types d'attributs HTML supportés par +LdapSaisie.
Ce type est utilisé pour la gestion des attributs dont la valeur est un booléen.
+La valeur retournée est l'une des chaînes de caractères suivantes :
+yes pour Vraino pour Falsetrue_label
Label affiché pour désigner la valeur True.
false_label
Label affiché pour désigner la valeur False.
Note
+Pour le moment, les attributs à valeurs multiples ne sont pas gérés.
+Note
+Pour maîtriser les valeurs stockées dans l'annuaire, il faut coupler ce type d'attribut HTML +avec le type d'attribut LDAP boolean
+Important
+La définition de la valeur par défaut d'un attribut utilisant ce type HTML (paramètre
+default_value), doit se faire à l'aide des valeurs yes ou no.
Ce type est utilisé pour la gestion des attributs dont la valeur est une date. L'outil de sélection +de date MooTools-DatePicker est utilisé pour la +sélection graphique de la date et de l'heure.
+'html_options' => array (
+ 'format' => '[Format d'affichage de la date]',
+ 'time' => '[Booleen pour le choix ou non de l heure]',
+ 'manual' => '[Booleen pour l edition manuelle ou non]',
+ 'showNowButton' => '[Booleen]',
+ 'showTodayButton' => '[Booleen]',
+ 'style' => '[Nom du style utilise]',
+ 'special_values' => array (
+ '[value]' => '[label]',
+ [...]
+ ),
+),
+...
+format
Format d'affichage de la date dans le champ de saisie. Ce format est composé à partir des motifs +clés suivants :
+| Mot clé | +Valeur de substitution | +Exemple de valeur | +
|---|---|---|
%a |
+Nom abrégé du jour de la semaine | +De Sun à Sat | +
%A |
+Nom complet du jour de la semaine | +De Sunday à Saturday | +
%b |
+Nom du mois, abrégé, suivant la locale | +De Jan à Dec | +
%B |
+Nom complet du mois, suivant la locale | +De January à December | +
%c |
+Date et heure préférées, basées sur la locale | +Exemple : Tue Feb 5 00:45:10 2009 pour le 5 Février 2009 à 12:45:10 AM | +
%d |
+Jour du mois en numérique, sur 2 chiffres (avec le zéro initial) | +De 01 à 31 | +
%e |
+Jour du mois, avec un espace précédant le premier chiffre. L'implémentation Windows est différente, voyez après pour plus d'informations. | +De 1 à 31 | +
%H |
+L'heure, sur 2 chiffres, au format 24 heures | +De 00 à 23 | +
%I |
+Heure, sur 2 chiffres, au format 12 heures | +De 01 à 12 | +
%j |
+Jour de l'année, sur 3 chiffres avec un zéro initial | +001 à 366 | +
%m |
+Mois, sur 2 chiffres | +De 01 (pour Janvier) à 12 (pour Décembre) | +
%M |
+Minute, sur 2 chiffres | +De 00 à 59 | +
%p |
+'AM' ou 'PM', en majuscule, basé sur l'heure fournie | +Exemple : AM pour 00:31, PM pour 22:23 | +
%s |
+Timestamp de l'époque Unix (identique à la fonction time()) | +Exemple : 305815200 pour le 10 Septembre 1979 08:40:00 AM | +
%S |
+Seconde, sur 2 chiffres | +De 00 à 59 | +
%T |
+Identique à "%H:%M:%S" Exemple : 21:34:17 pour 09:34:17 PM | ++ |
%U |
+Numéro de la semaine de l'année donnée, en commençant par le premier Lundi comme première semaine | +13 (pour la 13ème semaine pleine de l'année) | +
%w |
+Représentation numérique du jour de la semaine | +De 0 (pour Dimanche) à 6 (pour Samedi) | +
%y |
+L'année, sur 2 chiffres | +Exemple : 09 pour 2009, 79 pour 1979 | +
%Y |
+L'année, sur 4 chiffres | +Exemple : 2038 | +
%z |
+Soit le décalage horaire depuis UTC, ou son abréviation (suivant le système d'exploitation) | +Exemple : -0500 ou EST pour l'heure de l'Est | +
%Z |
+Le décalage horaire ou son abréviation NON fournie par %z (suivant le système d'exploitation) | +Exemple : -0500 ou EST pour l'heure de l'Est | +
%% |
+Le caractère de pourcentage ("%") | +--- | +
Note
+La valeur par défaut est %d/%m/%Y, %T. Exemple : 23/04/2009, 23:03:04
+time
Booléen définissant si l'outil de sélection permetra ou non le choix de l'heure en plus de la date
+manual
Booléen autorisant ou non l'édition manuelle du champs. Si ce paramètre vaut False, la sélection
+se fera uniquement à l'aide de l'outil graphique
showNowButton
Booléen définissant si le bouton Maintenant est affiché ou non. Par défaut, il est affiché.
+showTodayButton
Booléen définissant si le bouton Aujourd'hui est affiché ou non. Par défaut, il est affiché.
+style
Nom du style d'affichage de l'outil de sélection. Les valeurs possibles sont par défaut :
+defaultdashboardvistajquiNote
+La création de nouveau thème est possible. Pour plus d'information, consulter +l'aide de l'outil de sélection de date.
+special_values
Tableau listant les valeurs spéciales que peut prendre l'attribut. Dans ce tableau associatif, la +clé doit correspondre à la valeur de l'attribut (telle que fournie par +l'attribut LDAP) et la valeur associée au +label associé.
+Ces valeurs spéciales seront proposées à l'utilisateur sous la forme de cases à cocher dans le +formulaire. Elles peuvent permettre par exemple de données une signification particulière au zéro +pour un attribut LDAP stockant un timestamp.
+Ce type est utilisé pour la gestion des attributs dont la valeur est une clef publique GPG. Il +permet dans l'interface, d'avoir un affichage adapté à ce type de donnée.
Ce type est utilisé pour la gestion des attributs dont la valeur est une image. Pour le moment, les +attributs à valeurs multiples ne sont pas gérés.
Ce type est utilisé pour la gestion des attributs dont les valeurs sont des dictionnaires de valeurs +encodées aux formats JSON.
+Exemple de valeur gérée :
+ +Le principe est que ces dictionnaires contienent plusieurs composants référencés par leur clé et +stockant une valeur dont le type peut être un texte libre ou bien être issue d'une liste déroulante +configurable selon le même principe que le type d'attribut +LSattr_html_select_list.
+'html_options' => array (
+ 'components' => array (
+ '[clé composant 1]' => array (
+ 'label' => '[Label du composant]',
+ 'help_info' => '[Message d'aide sur le composant]',
+ 'type' => '[Type de la valeur stocké]',
+ 'required' => [Booléen],
+ 'multiple' => [Booléen],
+ 'check_data' => => array (
+ // Régle de vérification syntaxique des données saisies
+ ),
+ ),
+ '[clé composant 2]' => array (
+ 'label' => '[Label du composant 2]',
+ 'type' => 'select_list',
+ 'required' => [Booléen],
+ 'options' => array (
+ [Configuration équivalente à un attribut LSattr_html_select_list]
+ )
+ ),
+ [...]
+ ),
+ 'fullWidth' => [booléen],
+),
+...
+components
Tableau associatif obligatoire contenant en valeur clé, l'identifiant des composants, +correspondant à la clé dans le dictionnaire JSON, et en valeurs associés, la configuration du +composant.
+label
Le label du composant.
+help_info
Message d'aide sur le composant (affiché uniquement en mode édition).
+type
Le type de valeur du composant. Les types possibles sont text ou select_list pour
+respectivement soit une valeur saisie librement, soit une valeur sélectionnée parmis une liste
+déroulante.
options
Dans le cadre d'un composant de type select_list, cela correspond à la configuration de la
+liste déroulante. Cette configuration utilise la même syntaxe de configuration que celle du type
+d'attribut LSattr_html_select_list et son
+paramètre html_options.
multiple
Booléen définissant si ce composant peut stocker plusieurs valeurs (Par défaut : False).
required
Booléen définissant si ce composant doit obligatoirement être défini (Par défaut : False).
check_data
Tableau associatif contenant les règles de vérification syntaxique des données du composant. Ces +règles sont configurables de la même manière que les celles des valeurs attributs. +Voir la section concernée.
+fullWidth
Booléen permettant de définir si l'affichage dans le formulaire doit se faire sur toute la largeur
+disponible de la page (Par défaut : False).
Ce type est utilisé pour la gestion des attributs dont la valeur est prefixé d'un label et qui
+respecte le format suivant : [label]valeur.
'html_options' => array(
+ 'labels' => array ( // Liste des labels possible
+ 'label1' => 'Libellé label1',
+ 'label2' => 'Libellé label2',
+ [...]
+ ),
+ 'translate_labels' => [booléen],
+),
+...
+labels
Tableau associatif obligatoire contenant en valeur clé, le label utilisé dans la valeur stockée
+et en valeur associée, le valeur d'affichage du label.
translate_labels
Booléen permettant d'activer/désactiver la traduction des labels (Par défaut : True).
Ce type est utilisé pour la gestion des attributs dont la valeur est une adresse e-mail. En plus +d'un affichage adapté, il offre la possibilité d'envoyer des mails directement depuis l'interface de +l'application.
+ +disableMailSending
Désactive l'envoi de mail depuis l'interface pour cet attribut.
+Note
+Ceci ne désactive pas pour autant le lien HTML de type mailto:. Pour cela, utilisez plutôt +le type d'attribut HTML text.
+Important
+Ce type d'attribut HTML est dérivé du type text. Il +profite donc de toutes les fonctionnalités d'un champ de ce type (autogénération, ...).
+Ce type est utilisé pour la gestion des attributs dont la valeur est le chemin d'une maildir. +Typiquement, ce type attribut HTML est utile dans le cas de l'attribut mailbox utilisé par +maildrop pour stocker le chemin des boites mails. Ce type d'attribut offre la possibilité de gérér +un niveau de l'attribut et à travers les déclencheurs gérés par LdapSaisie la création, la +modification et ou la suppression de la boite mails. +Le LSaddon +maildir est utilisé pour manipuler la boite +mail à distance.
+Note
+Actuellement, cet LSaddon ne gérant que l'accès via FTP +au serveur distant, l'API d'accès via FTP est attaquée directement.
+'html_options' => array (
+ 'LSform' => array (
+ '[LSform1]' => [booléen],
+ '[LSform2]' => [booléen],
+ ...
+ ),
+ 'remoteRootPathRegex' => "[Expression régulière pour matcher le dossier à créer]",
+ 'archiveNameFormat' => "[LSformat du chemin/nom du fichier une fois archiver]"
+ ),
+...
+LSform
Tableau associatif obligatoire contenant en valeur clé le nom des LSforms +dans lesquels la fonctionnalité de modification de la boite mail sera présente. Les valeurs +attachées sont des booléens définissant si la modification est active par défaut.
+remoteRootPathRegex
Expression régulière (compatible Perl) facultative dont le but est de matcher dans la valeur +complète du chemin distant de la maildir, le chemin de la maildir à créer une fois connecté +sur le serveur.
+Exemple : Si le chemin complet de la maildir est /home/vmail/user, mais que l'utilisateur FTP
+lorsqu'il se connecte arrive directement dans /home/vmail, et faut définir le paramètre
+remoteRootPathRegex de la manière suivante :
archiveNameFormat
LSformat du nom du dossier de la maildir une
+fois archivée. Si ce format est défini, le dossier ne sera pas supprimé mais déplacé ou rénommé.
+Le format sera construit avec pour seul mot clé, le nom de l'ancien dossier. Exemple : Si le
+dossier de la maildir est /home/vmail/user et le paramètre archiveNameFormat vaut
+%{old}.bckp, le dossier sera renommé en /home/vmail/user.bckp.
Important
+Ce format est interprété après application de la routine liée au paramètre
+remoteRootPathRegex. Ainsi, dans l'exemple précédent, si le paramètre remoteRootPathRegex
+tronquait uniquement le nom du dossier final, c'est à dire user, le format une fois
+interprété donnerai user.bckp.
Ce type est utilisé pour la gestion des attributs dont la valeur est le quota d'une boite mail. Le +format de la valeur générée correspondant au format attendu par le serveur de mail +Courier] par défaut. Exemple : 50000000S correspond à un quota de +50Mio.
+ +suffix
Chaine de caractères suffixant la valeur du quota (Par défaut : S).
Ce type est utilisé pour la gestion des attributs dont la valeur est un mot de passe.
+'html_options' => array(
+ 'isLoginPassword' => [booleen],
+ 'generationTool' => [booleen],
+ 'autoGenerate' => [booleen],
+ 'length' => [nombre de caractères],
+ 'chars' => array ( // Caractères que peut contenir le mot de passe
+ array( // Liste caractère avec un nombre mininum d'apparition supérieur à 1
+ 'nb' => [nb caractères],
+ 'chars' => '[liste de caractères possibles]'
+ ),
+ '[autre liste de caractères possibles]', // Liste caractère avec un nombre
+ // d'apparitions égal à 1
+ ...
+ ),
+ 'use_pwgen' => [booléen], // Utiliser pwgen pour la génération du mot de passe
+ 'pwgen_path' => "/path/to/pwgen",
+ 'pwgen_opts' => "[options à passer à pwgen]",
+ 'verify' => [booléen], // Activation de l'outil de vérification du mot de passe
+ 'viewHash' => [booléen], // Activation de l'outil de visualisation du mot de passe haché
+ 'confirmChange' => [booléen], // Activation de la confirmation en cas de changement du mot de passe
+ 'confirmChangeQuestion' => "[LSformat]", // LSformat de la question de confirmation du changement du mot de passe
+ 'mail' => array( // Configuration de l'envoi du mot de passe par mail
+ 'subject' => "[LSformat du sujet du mail]",
+ 'msg' => "[LSformat du message du mail]",
+ 'mail_attr' => 'mail', // Attribut mail de l'objet
+ 'get_mail_attr_function' => '[function]', // Fonction retournant l'attribut mail de l'objet
+ 'send' => 1, // Activation par défaut de l'envoi du mot de passe
+ 'ask' => 1, // Laisser le choix à l'utilisateur
+ 'canEdit' => 1, // Activation de l'édition du LSformat du message par l'utilisateur
+ 'checkDomain' => false, // Désactivation de la vérification du domaine de l'adresse email
+ 'domain' => '[nom de domaine]', // Nom de domaine obligatoire lors de la validation de l'adresse email
+ )
+),
+...
+isLoginPassword
Booléen définissant si le mot de passe est celui utilisé par l'utilisateur pour se logguer à
+l'annuaire LDAP. Si c'est le cas, pour vérifier si le mot de passe correspond avec un autre, une
+tentative de connexion de l'utilisateur à l'annuaire sera faite. (Par défaut : False)
generationTool
Booléen définissant si l'outil de génération de mot de passe est activé.
+autoGenerate
Active la génération automatique du mot de passe lorsque l'attribut n'a encore aucune valeur de
+définie. Il faut également que l'outil de génération soit activé (generationTool).
length
Nombre de caractères que devront contenir les mots de passe générés.
+chars
Tableau contenant une liste de listes de caractères possibles pour composer le mot de passe. Dans +chacune de ces listes, au moins un caractère sera utilisé dans le nouveau mot de passe. Il est +possible de définir un nombre supérieur de caractères d'une liste devant apparaître dans les mots +de passe générés en spécifiant un tableau associatif dont la clé nb associra le nombre entier de +caractères et la clé chars la liste de caractères. Une liste de caractères est un chaîne.
+use_pwgen
Booléen définissant si la commande pwgen doit être utilisé pour générer le mot de passe.
pwgen_path
Chemin d'accès au binaire pwgen. (Par défaut : pwgen).
pwgen_opts
Options à passer à la commande pwgen.
verify
Booléen définissant si l'outil de vérification du mot de passe est activé. Si celui-ci est activé, +l'utilisateur pourra entrer un mot de passe dans le champ et cliquer sur un bouton qui lancera une +procédure de vérification du mot de passe via un test de connexion à l'annuaire.
+viewHash
Booléen définissant si l'utilisateur aura accès à la fonctionnalité de visualisation du mot de +passe haché.
+confirmInput
Booléen définissant si un second champ mot de passe sera affiché dans le formulaire pour que +l'utilisateur confirme la saisie du nouveau mot de passe.
+confirmInputError
LSformat du message d'erreur affiché à +l'utilisateur si le mot de passe saisie dans le champs de confirmation ne correspond pas au +nouveau mot de passe. Paramètre facultatif.
+confirmChange
Booléen définissant si l'utilisateur devra confirmer le changement de ce mot de passe. Lorsque +cette fonctionnalité est activée, l'utilisateur verra apparaître une popup de confirmation à la +validation du formulaire s'il a saisi un nouveau mot de passe.
+confirmChangeQuestion
LSformat de la question posée à l'utilisateur +en cas de changement du mot de passe et si la fonctionnalité est activée. Il sera composé à l'aide +du label de l'attribut. Paramètre facultatif.
+clearView
Booléen définissant si l'utilisateur pourra voir le mot de passe en clair par défaut (y comris en +mode visualisation uniquement).
+clearEdit
Booléen définissant si l'utilisateur éditera le mot de passe au travers un champs HTML de type +text et donc lisible ou au travers un champs HTML de type password.
+mail
Paramètres de configuration de l'envoi par mail du mot de passe à l'utilisateur. Lorsque cet outil +est activé, lors de la modification/création du mot de passe, l'utilisateur pourra recevoir un +mail lui spécifiant son nouveau mot de passe.
+send
Booléen définissant si l'envoi du mot de passe est activé par défaut.
+ask
Booléen définissant si on laisse le choix à l'utilisateur d'activer ou non l'envoi du mot de +passe par mail.
+canEdit
Booléen définissant si on laisse la possibilité à l'utilisateur d'éditer le +LSformat du message et du sujet.
+subject
LSformat du sujet du mail. Ce format sera +composé avec la valeur du nouveau mot de passe de l'utilisateur.
+msg
LSformat du message du mail. Ce format sera +composé avec les informations de l'object LDAP, y compris le mot clé %{password} correspondant +à la valeur du nouveau mot de passe de l'utilisateur.
+mail_attr
Le nom de l'attribut listant les mails possibles de l'utilisateur. Par défaut, la première
+valeur de l'attribut sera utilisée comme adresse mail destinatrice. Cet attribut peut également
+être un tableau de plusieurs noms d'attributs. Dans ce cas, la première valeur correcte sera
+retenue. Si canEdit est activé, l'utilisateur pourra choisir l'adresse mail destinatrice parmi
+la liste des valeurs de l'attribut.
get_mail_attr_function
Nom de la fonction (ou callable au sens PHP) qui sera utilisé pour récupérer le nom de
+l'attribut listant les mails possibles de l'utilisateur. Cette fonction prendra en paramètre,
+l'objet LSformElement courant et devra retourner une valeur équivalente au paramètre de
+configuration mail_attr. Si ce paramètre est défini, il prévalera toujours sur le paramètre
+mail_attr.
bcc
Mettre en BCC un mail systématiquement (ou plusieurs en les séparant par des virgules).
+headers
Un tableau de type clé/valeur ou la clé est le nom d'un header à ajouter au mail et la valeur +est la valeur de l'header en question.
+checkDomain
Booléen définissant si le domaine de l'adresse mail doit être validée. *Paramètre facultatif,
+par défaut: True
domain
Nom de domaine obligatoire lors de la validation de l'adresse mail. Ce paramètre peut être une +simple chaine correspondant au domaine ou un tableau listant plusieurs domaines valides. +Paramètre facultatif, par défaut tous les domaines sont acceptés.
+Ce type est utilisé pour la gestion des attributs du type de l'attribut standard postalAddress. +Ce type d'attribut permet d'afficher, en plus de l'adresse, un lien composé à partir d'informations +de l'objet permettant par exemple d'afficher un lien vers une carte géocalisant l'adresse postale.
+Par défaut, le lien ajouté sera un lien de recherche de l'adresse postale générée à partir de la
+valeur de l'attribut (en remplaçant les retours à la ligne (\n) par des espaces) via le service
+Nominatim d'OpenStreetMap.
Note
+Dans le cadre du fonctionnement par défaut et pour maîtriser les valeurs stockées dans +l'annuaire, il faut coupler ce type d'attribut HTML avec le type d'attribut LDAP +postaladdress
+'html_options' => array(
+ 'map_url_pattern_format' => '[LSformat]',
+ 'map_url_pattern_generate_function' => '[callable]',
+ 'map_url_format' => '[LSformat]',
+),
+...
+map_url_pattern_format
Ce LSformat doit permettre de générer la valeur +de l'adresse postale qui sera insérée dans l'URL du lien ajouté dans l'interface.
+map_url_pattern_generate_function
Ce paramètre permet de définir une fonction qui sera utilisée à la place du paramètre
+map_url_pattern_format pour générer la valeur de l'adresse postale qui sera insérée dans l'URL
+du lien ajouté dans l'interface. Cette fonction prendra en paramètre l'objet LSformElement
+courant et devra retourner une chaîne de caractères correspondant à l'adresse postale à insérer
+dans le lien de l'interface. Par défaut, la fonction
+LSformElement_postaladdress__generate_pattern est utilisée.
map_url_format
Ce LSformat doit permettre de générer l'URL du
+lien ajouté dans l'interface. Il sera composé avec les informations de l'objet LDAP, y compris le
+mot clé %{pattern} correspondant à la valeur de l'adresse postale générée à l'aide des
+paramètres précédents. Par défaut, la format suivant sera utilisé :
+http://nominatim.openstreetmap.org/search.php?q=%{pattern}
Ce type est dérivé du type LSattr_html_textarea et
+permet simplement que lors de l'affichage de la valeur, celle-ci soit affichée en respectant les
+retours à la ligne et en utilisant une police de caractères monospace. Cela reproduit l'affichage
+d'une balise HTML pre.
Ce type est utilisé pour la gestion des attributs dont la valeur est l'URL d'un flux RSS. Il propose +directement dans l'interface, la possibilité d'accèder au flux RSS.
+Important
+Ce type d'attribut HTML est dérivé du type text. Il +profite donc de toutes les fonctionnalités d'un champ de ce type (autogénération, ...).
+Ce type est prévu pour gérer l'attribut sambaAcctFlags du schéma Samba, qui au travers d'une seule +et unique valeur, respectant un format prévu, liste l'ensemble des drapeaux actifs d'un compte +Samba. Il est conçu pour être utilisé conjointement avec le type d'attribut LDAP +LSattr_ldap_sambaAcctFlags.
+Pour définir la valeur par défaut de cet attribut, il faut définir paramètre default_value comme
+un tableau des drapeaux telque prévu par Samba :
- U
Compte utilisateur standard
+- W
Compte de poste de travail approuvé
+- S
Compte de serveur approuvé
+- I
Compte de domaine approuvé
+- M
Compte de connexion Majority Node Set (MNS)
+- H
Dossier personnel requis
+- N
Compte sans mot de passe
+- X
Le mot de passe n'expire jamais
+- D
Compte désactivé
+- T
Copie temporaire d'un autre compte
+- L
Compte automatiquement bloqué
+Note
+Ce type d'attribut est implémenté en dérivant le type LSattr_html_select_box dont les valeurs
+possibles sont pré-configurées (paramètre possible_values). Même si cela n'est pas forcément
+utiles, les autres paramètres du type parent restent utilisables.
Ce type est identique au type LSattr_html_select_list excepté qu'il utilise en lieu et place d'une
+balise HTML select, plusieurs balises HTML input de type checkbox en cas de valeurs multiples
+ou de type radio en cas de valeur unique. Les paramètres de configuration de la classe
+LSattr_html_select_list sont tous hérités et fonctionnent donc de la même manière. Par ailleurs,
+ce type dispose également de paramètres qui lui sont propre (voir ci-dessous).
inline
Booléen définissant si les valeurs possibles doivent être affichées sur une même ligne ou non +(Faux par défaut).
+Ce type est utilisé pour la gestion des attributs dont les valeurs font partie d'une liste statique +ou dynamique. Il est possible de lister des valeurs statiques et également des références à d'autres +LSobjects. La référence à un objet correspond à une +valeur clé, référente à un objet précis, qui peut être soit la valeur d'un de ses attributs, soit +son DN.
+'html_options' => array (
+ 'possible_values' => array (
+ '[LSformat de la valeur clé]' => '[LSformat du nom d'affichage]',
+ ...
+ 'OTHER_OBJECT' => array (
+ 'object_type' => '[Type d'LSobject]',
+ 'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
+ 'value_attribute' => '[Nom de l'attribut clé]',
+ 'values_attribute' => '[Nom de l'attribut clé multi-valeur]',
+ 'filter' => '[Filtre de recherche des LSobject]',
+ 'scope' => '[Scope de la recherche]',
+ 'basedn' => '[Basedn de la recherche]',
+ 'onlyAccessible' => '[Booléen]'
+ ),
+ 'OTHER_ATTRIBUTE' => '[attr]',
+ // Or :
+ 'OTHER_ATTRIBUTE' => array(
+ '[attr1]' => '[label1]',
+ '[attr2]' => '[label2]',
+ [...]
+ ),
+ // Or :
+ 'OTHER_ATTRIBUTE' => array(
+ 'attr' => [attr],
+ 'json_component_key' => '[Composant JSON clé]',
+ 'json_component_label' => '[Composant JSON label]',
+ ),
+ array (
+ 'label' => '[LSformat du nom du groupe de valeurs]',
+ 'possible_values' => array (
+ '[LSformat de la valeur clé]' => '[LSformat du nom d'affichage]',
+ ...
+ 'OTHER_OBJECT' => array (
+ ...
+ )
+ )
+ )
+ ),
+ 'get_possible_values' => [callable],
+ 'translate_labels' => [booléen],
+ 'sort' => [Booléen],
+ 'sortDirection' => '[ASC|DESC]'
+),
+...
+possible_values
Tableau associatif obligatoire contenant en valeur clé le +LSformat des valeurs clés prisent par +l'attribut et en valeurs associées, le LSformat +des noms d'affichage de ces valeurs. Ces LSformats +sont composés à partir des valeurs de l'objet courant (attributs, dn, ...).
+Si la valeur clé est égale à OTHER_OBJECT, une liste
+d'LSobject sera insérée dans la liste des valeurs
+possibles. La valeur associée est alors un tableau associatif dont les valeurs clés sont les noms
+des paramètres de configuration de la recherche de ces
+LSobjects et les valeurs associées, les valeurs des
+paramètres.
Il est possible de regrouper des valeurs de l'attribut en plaçant leur déclaration dans un
+sous-tableau. Ce sous-tableau devra contenir la clé label dont la valeur associé sera le
+LSformat du nom du groupe de valeurs. Ce
+LSformat est composé à partir des valeurs de
+l'objet courant (attributs, dn, ...). Une seconde clé possible_values regroupera les valeurs
+possibles du groupe. Comme pour le tableau principal, la clé OTHER_OBJECT permet d'imcorporer
+une liste d'LSobject.
object_type
Nom du type d'LSobject en référence.
+display_name_format
LSformat du nom d'affichage des objets lors +de leur sélection.
+value_attribute
Nom de l'attribut des LSobjects en référence servant
+de valeur clé et permettant de les identifier (Exemple : dn ou uid).
values_attribute
Nom de l'attribut des LSobjects en référence servant
+de catalogue de valeurs. Dans ce mode, la valeur n'a pas de label et est affichée directement
+dans l'interface. Ce paramètre peut-être utilisé en complément ou non du paramètre
+value_attribute.
filter
Filtre falcultatif de la recherche des LSobjets. Il sera dans tous les cas agrémenté des valeurs +des objectclass du type d'LSobject.
+scope
Scope falcultatif de la recherche des LSobjets.
+basedn
Basedn falcultatif de la recherche des LSobjets.
+onlyAccessible
Booléen falcultatif définissant si seul les LSobjets auxquels l'utilisateur connecté à accès +doivent être considérés comme sélectionnables (Faux par défaut).
+Si la valeur clé est égale à OTHER_ATTRIBTE, une liste de valeur possible sera composée à l'aide
+des valeurs d'un (ou plusieurs) autre attribut de l'objet courant. La valeur associée peut être
+alors :
attr dont les valeurs seront
+ utilisées comme valeurs possibles. Cet attribut peut-être du type
+ LSattr_html_jsonCompositeAttribute.
+ Il sera alors possible d'utiliser les valeurs d'un composant en particulier en le référençant à
+ l'aide de la clé json_component_key. Il est également possible de référencer un autre
+ composant à l'aide de la clé json_component_label et dont les valeurs seront utilisées comme
+ valeurs affichées lors de la sélection. À défaut, les valeurs affichées seront identiques à
+ celles stockées.get_possible_values
Paramètre permettant de spécifier un callable qui sera utilisé pour lister les valeurs possibles +de l'attribut. Il recevra en paramètres les informations suivantes:
+$options
Les options HTML de l'attribut.
+$name
Le nom de l'attribut.
+&$ldapObject
Une référence à l'objet LSldapObject.
La valeur de retour attendue est un tableau associatif des valeurs possibles de l'attribut avec la +valeur que prendra l'attribut en tant que clé et le label correspondant en tant que valeur. Tout +autre retour sera considéré comme un échec et déclenchera une erreur.
+Il est également possible de regrouper des valeurs possibles de l'attribut: pour cela, le tableau
+retourné devra lui-même contenir un tableau associatif contenant la label traduit du groupe sous
+la clé label et les valeurs possibles du groupe sous la clé possible_values.
Les valeurs retournées pourront être combinées avec les autres valeurs possibles configurées de
+l'attribut. La prise en charge du tri des valeurs possibles est assurée par la fonction appelante
+sauf dans le cas des sous-groupes de valeurs possibles. Dans ce cas, la méthode
+LSattr_html_select_list :: _sort() pourra être utilisée pour trier les valeurs du sous-groupe :
+cette méthode accepte en paramètre une référence du tableau des valeurs possibles ainsi que les
+options HTML de l'attribut.
Si la traduction des labels des valeurs possibles de l'attribut est activées (voir ci-dessous), +celle-ci doit être prise en charge par la fonction configurée.
+translate_labels
Booléen permettant d'activer/désactiver la traduction des labels (Par défaut : True).
sort
Booléen définissant si les valeurs possibles doivent être triées ou non (Vrai par défaut). Le trie +est effectué sur les libellés des valeurs possibles.
+sortDirection
Mot clé déterminant le sens du trie des valeurs possibles.
+Valeurs possibles : ASC ou DESC (ASC par défaut).
Ce type est utilisé pour la gestion des attributs dont les valeurs sont des références à d'autres +LSobjects. Chaque référence à un objet correspond à une +valeur prise par l'attribut. Les valeurs clés référant à un +LSobject sont soit la valeur d'un de leurs attributs, +soit leur DN.
+'html_options' => array (
+ selectable_object => array (
+ array (
+ 'object_type' => '[Type d'LSobject selectionnable]',
+ 'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
+ 'value_attribute' => '[Nom de l'attribut clé des LSobjects]',
+ 'filter' => '[Filtre de recherche]',
+ 'onlyAccessible' => '[Booléen]'
+ ),
+ [...]
+ ),
+ 'ordered' => [Booléen],
+ 'sort' => [Booléen],
+ 'sortDirection' => '[ASC|DESC]'
+),
+...
+selectable_object
Tableau dont chaque valeur correspond à un tableau associatif spécifiant un type +d'LSobject sélectionnable. Pour chaque type d'objet +sélectionnable, les paramètres suivants doivent être renseignés :
+object_type
Nom du type d'LSobject en référence +(Paramètre obligatoire).
+display_name_format
LSformat du nom d'affichage des objets lors +de leur sélection (Paramètre facultatif).
+value_attribute
Nom de l'attribut des LSobjects en référence servant
+de valeur clé et permettant de les identifier (Paramètre obligatoire, exemples : dn ou uid).
filter
Filtre de recherche qui sera ajouter au filtre par défaut lors de la sélection des objets +(Paramètre facultatif).
+onlyAccessible
Booléen définissant si seul les LSobjets auxquels l'utilisateur connecté à accès doivent être
+considérés comme sélectionnables (Paramètre facultatif, par défaut: False).
ordered
Booléen définissant si la liste des objets choisis doit être ordonnable ou non (Paramètre
+facultatif, par défaut: False). Cela aura pour effet d'activer une fonctionnalité dynamique de
+l'interface permettant de remonter ou descendre dans la liste les objets choisis.
Note
+Cette fonctionnalité désactive automatiquement le trie des objets à l'affichage.
+sort
Booléen définissant si la liste des objets choisis doit être triée ou non (Paramètre facultatif,
+par défaut: True). Le trie est effectué sur les libellés des objets choisis.
sortDirection
Mot clé déterminant le sens du trie des objets choisis.
+Valeurs possibles : ASC ou DESC (ASC par défaut).
Ce type est utilisé pour la gestion des attributs dont la valeur est une clef publique SSH. Il +permet dans l'interface, d'avoir un affichage adapté à ce type de donnée.
Ce type est utilisé pour la gestion des attributs dont la valeur est un numéro de téléphone. Lors de
+l'affichage, un lien hypertexte avec une URI de type tel:~~ est affiché.
Important
+Ce type d'attribut HTML est dérivé du type text. Il +profite donc de toutes les fonctionnalités d'un champ de ce type (autogénération, ...).
+Ce type est utilisé pour la gestion des attributs dont la valeur est une chaîne de caractères devant +être affichée dans un champ input HTML de type text.
+'html_options' => array(
+ 'generate_value_format' => '[LSformat pour la génération de la valeur]',
+ 'autoGenerateOnCreate' => [booléen],
+ 'autoGenerateOnModify' => [booléen],
+ 'withoutAccent' => [booleen],
+ 'replaceSpaces' => "[chaîne de remplacement]",
+ 'upperCase' => [booleen],
+ 'lowerCase' => [booleen],
+
+ // Autocomplétion
+ 'autocomplete' => array (
+ 'object_type' => '[Type d'LSobject]', // facultatif (voir ci-dessous)
+ 'value_attributes' => array (
+ '[attr1]',
+ '[attr2]',
+ [...]
+ ),
+ 'filter' => '[filtre LDAP]',
+ 'basedn' => '[base DN spécifique]',
+ 'scope' => '[scope de recherche]',
+ 'displayFormat' => '[LSformat]',
+ 'onlyAccessible' => [booléen],
+ ),
+
+),
+...
+generate_value_format
LSformat de la valeur utilisée pour la +génération automatique de celle-ci à partir des informations saisies dans le formulaire. Les +valeurs clefs du format sont les noms des attributs de l'objet. Seuls les attributs affichés au +moins en lecture seule dans le formulaire peuvent être utilisés dans le format. Une seule valeur +par attribut sera utilisée pour la génération : celle du premier champ (dans l'ordre d'apparition +dans le formulaire).
+Important
+Seuls les éléments du formulaire de type HTML input, select ou textarea peuvent être +utilisés.
+autoGenerateOnCreate
Activation de la génération automatique lorsque celui-ci est vide au moment du chargement du
+formulaire (par défaut : False).
autoGenerateOnModify
Activation de la génération automatique lors de chaque modification de la valeur des champs du
+formulaire lié (par défaut : False).
withoutAccent
Activation de la suppression des accents dans la chaîne de caractères générée automatiquement
+(par défaut : False).
withoutAccent
Activation du remplacement des accents dans la chaîne de caractères générée automatiquement. La
+valeur de remplacement est celle du paramètre (par défaut : False).
upperCase
Activation de la mise en majuscule de la valeur générée automatiquement (par défaut : False).
lowerCase
Activation de la mise en minuscule de la valeur générée automatiquement (par défaut : False).
autocomplete
Paramètrage de l'autocomplétion des valeurs saisies : on paramètre ici la recherche des valeurs +possibles de l'attribut dans l'annuaire qui peut se faire :
+value_attributes correspondant.Les paramètres associés à ces deux cas de figure sont décrits ci-dessous :
+object_type
Le type d'LSobject recherché.
+value_attributes
Le(s) nom de l'attribut stockant les valeurs possibles recherchées. Il peut s'agir d'une chaîne +de caractères ou d'un tableau s'il y a plusieurs attributs.
+pattern_filter
Le LSformat du filtre de recherche à partir
+du mot clé recherché. Ce paramètre est facultatif et utile que dans le cas d'une recherche sans
+type d'LSobject précis. S'il est défini, ce
+LSformat sera composé à l'aide du mot clé
+recherché. À défaut, le filtre de recherche sera composé à l'aide des différents
+value_attributes configurés.
filter
Un filtre de recherche facultatif venant en plus de celui calculé automatiquement à partir du +mot clé de recherche.
+basedn
Le basedn de la recherche. Paramètre facultatif.
+scope
Le scope de la recherche. Paramètre facultatif, par défaut : sub.
display_name_format
Le LSformat d'affichage des objets trouvés.
+Ce paramètre est facultatif et par défaut, il s'agira du format d'affichage propre au type
+d'LSobject (si défini) et à défaut, la valeur
+possible trouvée sera affichée. Si est configuré, ce
+LSformat sera composé à l'aide des valeurs
+brutes des attributs des objets correspondants avec en plus la valeur possible trouvée dans le
+mot clé value.
Ce type est utilisé pour la gestion des attributs dont la valeur est une chaine de caractères trop +longue pour être saisie dans un champs HTML imput de type text et est plus adapté à un champ +HTML textarea.
Ce type est utilisé pour la gestion des attributs dont la valeur est une URL. Il propose directement +dans l'interface, la possibilité d'accèder au site ou encore de l'ajouter dans ses favoris +(lorsque le navigateur le supporte).
+Important
+Ce type d'attribut HTML est dérivé du type text. Il +profite donc de toutes les fonctionnalités d'un champ de ce type (autogénération, ...).
+Ce type est utilisé pour la gestion des attributs dont la valeur est un entier auxquel un facteur
+peut s'appliquer (par exemple : Kilo, Méga, ...).
'html_options' => array(
+ 'units' => array (
+ '[facteur1]' => '[label unit1]',
+ '[facteur2]' => '[label unit2]',
+ [...]
+ ),
+ 'translate_labels' => [booléen],
+ 'nb_decimals' => [number of decimals],
+ 'dec_point' => '[decimals point]',
+ 'thousands_sep' => '[thousands separator]',
+ 'store_integer' => [booléen],
+ 'round_down' => [booléen],
+ )
+),
+...
+units
Tableau associatif dont la clé est un entier correspondant au facteur et la valeur est le label de
+l'unité. (Par exemple : 1 => Octet, 1024 => Kilo-octet, ...).
translate_labels
Booléen permettant d'activer/désactiver la traduction des labels (Par défaut : True).
nb_decimals
Le nombre de décimals à afficher en cas de nombre non-entier (Par défaut : 2).
dec_point
Le caractère à utiliser comme séparateur de décimal (Par défaut, une virgule).
+thousands_sep
Le caractère à utiliser comme séparateur de milliers (Par défaut, un espace).
+store_integer
Booléen permettant d'activer/désactiver le stockage de valeurs entières (Par défaut : True).
round_down
Booléen permettant d'arrondir à l'entier inférieur (et non à l'entier supérieur par défaut) en cas +de stockage de valeurs entières.
+Ce type est utilisé pour la gestion des attributs dont la valeur est du code HTML et dont l'édition +doit être fait à l'aide d'un éditeur WYSIWYG. La librairie TinyMCE +est utilisée pour cela.
+ +Ce type est utilisé pour la gestion des attributs dont la valeur est une adresse XMPP. Il propose +directement dans l'interface, la possibilité de lancer une fenêtre de dialogue avec l'interlocuteur +de son client XMPP préféré.
+Note
+Cette fonctionnalité n'est supporté uniquement par les navigateurs web supportant les URI de
+type xmpp://.
Important
+Ce type d'attribut HTML est dérivé du type text. Il +profite donc de toutes les fonctionnalités d'un champ de ce type (autogénération, ...).
+Cette section décrit la manière de configuer des règles de vérification syntaxique sur les données +des attributs. Ces règles seront utilisées pour vérifier que les valeurs saisies par un utilisateur +dans un formulaire sont correctes.
+'check_data' => array (
+ '[regle1]' => array(
+ 'msg' => "[Message d'erreur]",
+ 'params' => array(
+ // Paramètres de la règle
+ )
+ ),
+ ...
+),
+...
+Le paramètre check_data est un tableau associatif dont les clés sont les noms des règles de
+vérification syntaxique actives et les valeurs associées sont des tableaux associatifs contenant les
+paramètres des règles.
msg
Le message d'erreur à afficher lors que la règle n'est pas respectée (optionnel).
+params
Tableau associatif contenant les paramètres de la règle. Les paramètres possibles sont propres à +chaque type de règle. Les clès sont les noms des paramètres et les valeurs associés, les valeurs +des paramètres.
+Cette règle vérifie que la valeur est une chaîne de caractères composée uniquement de lettres +non-accuentées, en minuscule ou en majuscule et/ou de chiffres.
+withAccents
Si le paramètre est à true, les lettres accentuées seront acceptées.
+Cette règle vérifie que la valeur saisie est correcte en utilisant une fonction personnalisée. Cette
+fonction devra prendre en paramètres la valeur à valider, le tableau des paramètres de la règle
+ainsi qu'un pointeur sur l'objet LSformElement. Sur la base de ses informations, elle devra
+valider la valeur et retourner True si la valeur est valide et False sinon.
callable
Le nom de la fonction (ou tout autre callable au sens PHP) de validation.
Cette règle vérifie que la valeur saisie est bien une date et qu'elle respecte un format précis.
+format
Format de la date à respecter. Ce format doit être compatible avec la fonction strftime() de
+PHP. Voir la documentation de la fonction
special_values
Tableau listant les valeurs spéciales que peut prendre l'attribut. Dans ce tableau, seules les +valeurs sont utilisées et les clés n'ont pas d'importance. Ces valeurs spéciales n'auront pas +forcément besoin de respecter le format attendu.
+Cette règle vérifie que la valeur saisie ne correspond pas à un des mots de passe stockés dans +d'autres attributs du même objet.
+Important
+Les autres attributs doivent utiliser le type d'attribut LDAP +LSattr_ldap_password.
+otherPasswordAttributes
La liste des autres attributs dont les mots de passe doivent être différent.
+Cette règle vérifie que la valeur saisie est bien une adresse e-mail. Il est possible de vérifier si +elle appartient bien à un domaine en particulier ou encore de vérifier si le domaine existe et qu'il +possède un serveur de mail(MX).
+domain
Nom de domaine obligatoire. Ce paramètre peut être une simple chaine correspondant au domaine ou +un tableau listant plusieurs domaines possibles.
+checkDomain
Booléen définissant si le domaine de l'adresse mail doit être validée.
+Cette règle vérifie que la valeur est un fichier dont la taille en octets respecte les limites +passées en paramètre.
+minSize
Taille minimum.
+maxSize
Taille maximum.
+Cette règle vérifie que la valeur est une clé publique GPG. Pour cela, la clé est importée dans un +keyring GnuPG.
Cette règle vérifie que la valeur est bien un fichier et que le type mime de celui-ci est bien une
+image. Cette règle utilise la règle mimetype en spécifiant si l'utilisateur ne le fait pas que le
+type mime doit respecter la regex suivante : /image\/.*/
Important
+Cette règle est une simple interface à la règle mimetype, il est donc possible de passer +d'autres paramètres propres à ce type.
+Cette règle vérifie que la valeur est une image dont la taille en pixels respecte les limites +passées en paramètre.
+minWidth
Largeur minimum.
+maxWitdh
Largeur maximum.
+minHeight
Hauteur minimum.
+maxHeight
Hauteur maximum.
+Cette règle vérifie que la valeur saisie fait partie d'une liste de valeurs autorisées +(ou interdites).
+possible_values
Tableau listant les valeurs autorisées.
+reverse
Booléen permettant d'inverser la logique de validation : si reverse est vrai, la valeur testée
+sera acceptée si elle ne fait pas partie des valeurs possibles (Paramètre facultatif, par défaut :
+False).
Cette règle vérifie que la valeur saisie est un entier. Les paramètres permettent de spécifier +éventuellement si la valeur doit être positive ou négative et également de borner les valeurs +valides.
+positive
Booléen définissant si la valeur doit être positive.
+negative
Booléen définissant si la valeur doit être negative.
+min
Valeur minimale (supérieur ou égale).
+max
Valeur maximale (inférieur ou égale).
+Cette règle vérifie que la valeur est une URI de recherche LDAP valide, c'est à dire, par exemple,
+ldaps://ldap.example.com:636/o=example?attr1,attr2?one?(gidNumber=100)
Cette vérification commence par découper la valeur à l'aide du sépérateur ? et elle s'assure
+ensuite :
Paramêtres de configuration :
+check_resolving_ldap_host
Si l'hôte du serveur LDAP est spécifié et qu'il s'agit d'un nom de domaine valide, un tentative de
+résolution DNS sera également faite (optionnel, par défaut : True).
host_required
Booléen détermintant si une erreur est relevée en cas d'absence de l'hôte LDAP. (optionnel,
+par défaut : False)
basedn_required
Booléen détermintant si une erreur est relevée en cas d'absence de base de recherche. (optionnel,
+par défaut : False)
scope_required
Booléen détermintant si une erreur est relevée en cas d'absence de portée de recherche.
+(optionnel, par défaut : True)
attr_required
Booléen détermintant si une erreur est relevée en cas d'absence d'attribut recherché. (optionnel,
+par défaut : False)
max_attrs_count
Nombre maximum d'attribut recherchés. (optionnel, par défaut : pas de limite)
+filter_required
Booléen détermintant si une erreur est relevée en cas d'absence de filtre de recherche.
+(optionnel, par défaut : False)
Cette règle vérifie que la valeur est une chaîne de caractères composée uniquement de lettres +non-accuentées, en minuscule ou en majuscule.
Cette règle vérifie que la valeur saisie est une chaine de caractères dont la longueur est inférieur +ou égale à la valeur passées en paramètre.
+limit
Limite supérieur (ou égale) de la longueur de la chaîne de caratères.
+Cette règle vérifie que la valeur est bien un fichier et que le type mime de celui-ci est correct. +Il est possible de vérifier si le type mime fait partie d'une liste ou encore s'il valide une +expression régulière.
+mimeType
Type mime obligatoire. Ce paramètre peut être une simple chaine correspondant au type mime ou un +tableau listant plusieurs possibilités.
+mimeTypeRegEx
Expression régulière que doit respecter le type mime.
+Cette règle vérifie que la valeur saisie est une chaine de caractères dont la longueur est supérieur +ou égale à la valeur passée en paramètre.
+limit
Limite inférieure (ou égale) de la longueur de la chaîne de caratères.
+Cette régle vérifie que la valeur est une valeur numérique non nulle.
Cette régle vérifie que la valeur est une chaîne de caractères ne contenant pas de signe de
+ponctuation. Les caractères suivants sont actuellement exclus :
+( ) . \ / \ * \ ^ \ ? # ! @ $ % + = , " ' > < ~ [ ] { }
Cette règle vérifie que le nombre de valeurs de l'attribut est comprise entre les limites passées en +paramètre.
+min
Nombre minimum de valeurs (paramètre optionnel).
+max
Nombre maximum de valeurs (paramètre optionnel).
+Cette régle vérifie que la valeur est une valeur numérique.
Cette règle vérifie que la valeur est un mot de passe respectant la politique de sécurité définie +par les paramètres de la règle.
+minlength
Longueur minimale du mot de passe.
+maxlength
Longueur maximale du mot de passe.
+prohibitedValues
Tableau de valeurs interdites.
+regex
Expression(s) régulière(s) que doit respecter le mot de passe. Ce paramètre peut être une +expression régulière au format PCRE ou un tableau d'expressions +régulières.
+minValidRegex
Le nombre minimum d'expression régulière qui doivent être validées pour que le mot de passe soit +considéré comme correct. Ce paramètre est optionnel, par défaut, toutes les expressions régulières +doivent être validées.
+Cette règle vérifie que la valeur saisie est une chaine de caractères dont la longueur est comprise +entre deux valeurs passées en paramètre.
+limits
Tableau contenant deux valeurs, la première étant la limite inférieure ou égale et la seconde la +limite supérieure ou égale.
+Cette règle vérifie que la valeur saisie respecte bien l'expression régulière passée en paramètre.
+regex
L'expression régulière devant être respectée. Cette expression régulière doit être au format +PCRE.
+Cette régle vérifie que la valeur n'est pas une chaîne de caractères de longueur nulle.
Cette règle vérifie que la valeur est une clé publique SSH.
+Cette vérification utilise tout d'abord une expression régulière pour valider la forme syntaxique de
+la clé publique (ssh-[type] [clé au format base64] [commentaire]) puis tente de décoder la partie
+en base64 de la clé pour vérifier qu'il s'agit bien d'une chaine de caractères.
Cette régle vérifie que la valeur est un numéro de téléphone français. Celui-ci doit respecter
+l'expression regulière suivante : /^(01|02|03|04|05|06|08|09)[0-9]{8}$/
Cette règle vérifie la sécurité d'un mot de passe en utilisant la librairie +ZxcvbnPhp. Cette librairie s'appuie sur un ensemble +de vérifications permettant de déterminer à quel point le mot de passe choisi est commun, prévisible +et plus globalement, estime en combien de temps il pourra être cassé par une personne malveillante. +Sur la base de l'analyse du mot de passe saisi, des conseils seront donnés à l'utilisateur pour le +guider dans le choix d'un mot de passe sûre.
+Warning
+La librairie ZxcvbnPhp n'est compatible qu'avec PHP 7 et supérieur.
minScore
Le score minimal pour que le mot de passe soit accepté. Il doit s'agir d'un entier compris entre +0 (le plus faible) et 4 (le plus sécurisé). Paramètre facultatif valant 4 par défaut.
+minGuessesLog10
Permet de définir le logarithme en base 10 du nombre minimum estimé de tentative pour deviner le
+mot de passe. Par exemple, si minGuessesLog10 est égal à 6, cela signifie que le mot de passe
+ne sera accepté que si Zxcvbn estime qu'il faut au moins 1 million (10^6) de tentatives pour le
+deviner. Paramètre facultatif valant 10 par défaut.
userDataAttrs
Liste d'attributs de l'objet dont les valeurs seront passées à la librairie Zxcvbn qui les
+considérera comme associés à l'utilisateur. Ainsi, par exemple, si l'utilisateur utilise son nom
+de famille ou encore son prénom dans son mot de passe, la librairie pourra lui indiqué que cela ne
+le protège que peut des attaques ciblées. Paramètre facultatif, mais il est fortement conseillé de
+renseigner un maximum d'attributs contenant des informations personnelles relatives à l'utilisteur.
banPersonalInfo
Booléen permettant d'interdire toutes utilisations d'informations personnelles dans le choix du mot +de passe. Paramètre facultatif et vrai par défaut.
+showWarning
Booléen définissant si les messages d'alertes retournés par la librairie Zxcvbn doivent être
+affichés à l'utilisateur. Paramètre facultatif et vrai par défaut.
showSuggestions
Booléen définissant si les messages de suggestions retournés par la librairie Zxcvbn doivent
+être affichés à l'utilisateur. Paramètre facultatif et vrai par défaut.
customDictionaries
Tableau associatif permettant de configurer des dictionnaires personnalisés : les clés contiennent +le nom de la collection de dictionnaires et les valeurs associées, le chemin vers un fichier JSON +contenant la collection de dictionnaires. Ces fichiers doivent contenir un objet racine dont les + clés sont des chaînes de caractères correspondant au nom des dictionnaires et les valeurs +associés sont des listes de mots en minuscule triées par ordre décroissant de fréquence +d'utilisation.
+Exemple:
+ +banDictionaries
Ce paramètre permet d'interdire tous mots issues de certains dictionnaires. Il s'agit d'un
+tableau devant contenir les noms des dictionaires interdits. La librairie Zxcvbn fournis
+les dictionnaires suivant :
us_tv_and_film : les mots les plus courrament utilisés dans les séries et films américainspasswords : les mot de passse les plus courrament utilisésmale_names : les prénoms masculins les plus courrantfemale_names : les prénoms féminins les plus courrantsurnames : les nom de familles les plus courrant aux États Unisenglish_wikipedia : les mots les plus courrament utilisés dans les articles en anglais de
+ Wikipédiafrench_wikipedia : les mots les plus courrament utilisés dans les articles en français de
+ Wikipédiauser_inputs : les informations personnelles fournis lors de la validation du mot de passe
Note : lister ce dictionnaire dans se paramètre à le même effet que le paramètre
+banPersonalInfo documenté ci-dessus.
Vous pouvez également lister ici tout dictionnaires personnalisés que vous auriez ajouté grâce
+au paramètre customDictionaries.
zxcvbn_autoload_path
Le chemin vers le fichier de chargement automatique des classes de la librairie ZxcvbnPhp. Ce
+paramètre est facultatif et vaut par défaut Zxcvbn/autoload.php, ce qui est adapté si vous
+utiliser le paquet Debian php-zxcvbn disponible sur le dépôt Debian du projet LdapSaisie.
Cette section décrit la manière de configurer des règles de vérification d'intégrité sur les données +des attributs. Il est possible de valider la valeur de l'attribut par l'intermédiraire de la +vérification de résultat d'une recherche paramètrable dans l'annuaire ou encore d'appeler une +fonction de votre choix pour effectuer la vérification voulue.
+Une telle règle permet de vérifier si les valeurs des attributs n'entrent pas en conflit avec +d'autres objets de l'annuaire. Ce test peut également permetre de vérifier si les valeurs devant +faire référence à d'autres objets de l'annuaire sont correctes.
+'validation' => array (
+ ...
+ array(
+ 'msg' => "[LSformat du message d'erreur]",
+ 'filter' => '[LSformat du filtre de la recherche]',
+ 'object_type' => '[Type d'LSobject recherché]',
+ 'basedn' => '[BaseDn de la recherche]',
+ 'scope' => '[Scope de la recherche]',
+ 'result' => '[Résultat positif de la recherche]',
+ 'except_current_object' => '[Exclure l'objet courant]'
+ ),
+ ...
+),
+...
+msg
LSformat du message d'erreur à afficher lorsque la +validation échoue. Ce format est construit avec les valeurs du +LSobject.
+filter
LSformat du filtre de la recherche. Ce format peut
+être construit avec toutes les valeurs du LSobject (attributs, DN, ...) et également avec la
+valeur à valider en utilisant pour mot clé %{val}.
object_type
Le nom du type d'LSobject recherché. Si un type est spécifié, le filtre de la recherche sera une
+combinaison de celui du paramètre filter et du filtre composé à partir des objectClass du type
+d'LSobject. Paramètre facultatif.
basedn
Le basedn de la recherche (Paramètre facultatif, par défaut : racine de l'annuaire).
+scope
Le scope de la recherche (Paramètre facultatif, par défaut : sub).
result
Le résultat de la recherche : si result vaut zéro, la recherche ne devra retourner aucun objet
+pour que la validation soit réussie. Sinon, la recherche devra retourner au moins un objet.
except_current_object
Booléen définissant si l'objet courrant doit être exclu du résultat de la recherche. Ce paramètre
+n'est évalué quand cas de création (formulaire create).
Il est possible d'effectuer la validation de l'attribut par l'exécution d'une fonction de votre
+choix. Il lui sera passé en paramètre une référence à l'objet LSldapObject courant. Si la fonction
+ne retourne pas true, la validation échouera.
'validation' => array (
+ ..
+ array(
+ 'msg' => "[LSformat du message d'erreur]",
+ 'function' => '[Nom de la fonction de validation]'
+ ),
+ ...
+),
+...
+msg
LSformat du message d'erreur à afficher lorsque la +validation échoue. Ce format est construit avec les valeurs du +LSobject.
+function
Le nom de la fonction à exécuter. Si cette fonction n'existe pas, un message d'erreur sera affiché +et la validation échouera.
+Cette section décrit la manière de paramétrer des déclencheurs afin que LdapSaisie exécute durant +ses processus, et à des moments bien précis des traitements d'un +LSattributes, des fonctions que vous pourrez développer vous +même. De plus, le résultat de l'exécution de vos fonctions pourra influer sur le déroulement des +processus.
+Actuellement, les évènements suivant sont gérés :
+| Nom | +Description | +Bloquant | +
|---|---|---|
before_create |
+Avant la création du LSobject, lorsque l'attribut a au moins une valeur. | +Oui | +
after_create |
+Après la création du LSobject, lorsque l'attribut a au moins une valeur. | +Non | +
before_modify |
+Avant la modification de la valeur de l'attribut. | +Oui | +
after_modify |
+Après la modification de la valeur de l'attribut. | +Non | +
before_delete |
+Avant la suppression du LSobject contenant l'attribut. | +Oui | +
after_delete |
+Après la suppression du LSobject contenant l'attribut. | +Non | +
Note
+Si un événement est dit bloquant, lors de l'exécution des actions liées, si une des fonctions
+retourne false, le processus s'arrêtera.
La configuration des déclencheurs se fait dans la définition des
+LSattributes. Par exemple, pour définir les fonctions à
+exécuter après la modification de la valeur de l'attribut mail du type de
+LSobject LSpeople, c'est à dire lors de leur évenement
+after_modify, il faut définir la variable suivante :
Cette variable peut contenir soit une chaine de caractères correspondant au nom de la fonction à +exécuter, soit un tableau de chaînes de caractères correspondant aux noms des fonctions à exécuter.
+Une fonction exécuté par un déclencheur d'un LSattribute se déclare de la manière suivante :
+/*
+ * Ma fonction à exécuter lors de l'évènement [event]
+ *
+ * Paramètre :
+ * - $object : Le LSobject contenant le LSattribute sur lequel l'évenement
+ * survient
+ *
+ * Valeurs retournées :
+ * - True : Tout s'est bien passé
+ * - False : Une erreur est survenue ou la fonction souhaite bloquer le
+ * processus lors d'un évènement bloquant.
+ */
+function maFonction ($object) {
+
+ // Actions
+
+}
+Cette fonction doit prendre pour seul paramètre, le LSobject contenant le LSattribute sur lequel
+l'évenement survient et doit retourner soit True si tout s'est bien passé, soit False en cas de
+problème. Dans le cas d'un événement bloquant, si la fonction retourne False, le processus est
+arrêté.
Cette section décrit la manière de configurer la création automatique des conteneurs des LSobjets.
+Si le basedn correspondant à la branche de stockage des LSobjects
+n'existe pas, LdapSaisie tentera de le créer à partir de la configuration de la variable
+$GLOBALS['LSobjects']['[nom du type d'LSobject]']['container_auto_create'].
$GLOBALS['LSobjects']['[nom du type d'LSobject]']['container_auto_create'] = array (
+ 'objectclass' => array(
+ 'objectclass1',
+ 'objectclass2',
+ ...
+ ),
+ 'attrs' => array(
+ 'attr1' => 'val1',
+ 'attr2' => array(
+ 'val2',
+ 'val3',
+ ...
+ ),
+ ...
+ )
+);
+objectclass
La liste des objectclass de l'objet conteneur.
+attrs
Un tableau associatif dont les clés sont les noms des attributs de l'objet conteneur à définir et +dont les valeurs associées sont la/les valeur(s) de ces attributs.
+Cette section décrit la manière de paramétrer des déclencheurs afin que LdapSaisie exécute durant +ses processus, et à des moments bien précis des traitements d'un +LSobject, des fonctions que vous pourrez développer vous même. De +plus, le résultat de l'exécution de vos fonctions pourra influer sur le déroulement des processus.
+Actuellement, les évenements suivant sont gérés :
+| Nom | +Description | +Bloquant | +
|---|---|---|
before_create |
+Avant la création du LSobject. | +Oui | +
after_create |
+Après la création du LSobject. | +Non | +
before_modify |
+Avant la modification du LSobject | +Oui | +
after_modify |
+Après la modification du LSobject | +Non | +
before_rename |
+Avant de renommer le LSobject | +Oui | +
after_rename |
+Après avoir renommé le LSobject | +Non | +
before_delete |
+Avant la suppression du LSobject | +Oui | +
after_delete |
+Après la suppression du LSobject | +Non | +
Note
+Si un événement est dit bloquant, lors de l'exécution des actions liées, si une des fonctions
+retourne false, le processus s'arrêtera.
La configuration des déclencheurs se fait dans la définition des types
+d'LSobjects. Par exemple, pour définir les fonctions à exécuter
+après la modification des LSobjects de type LSpeople, c'est à dire lors de leur évènement
+after_modify, il faut définir la variable suivante :
Cette variable peut contenir soit une chaine de caractères correspondant au nom de la fonction à +exécuter, soit un tableau de chaînes de caractères correspondant aux noms des fonctions à exécuter.
+Une fonction exécuté par un déclencheur d'un LSobject se déclare de la manière suivante :
+/*
+ * Ma fonction à exécuter lors de l'evenement [event]
+ *
+ * Paramètre :
+ * - $object : Le LSobject sur lequel l'évènement survient
+ *
+ * Valeurs retournées :
+ * - True : Tout s'est bien passé
+ * - False : Une erreur est survenue ou la fonction souhaite bloquer le
+ * processus lors d'un évènement bloquant.
+ */
+function maFonction ($object) {
+
+ // Actions
+
+}
+Cette fonction doit prendre pour seul paramètre, le LSobject sur lequel l'évènement survient et doit
+retourner soit True si tout s'est bien passé, soit False en cas de problème. Dans le cas d'un
+événement bloquant, si la fonction retourne False, le processus est arrêté.
Cette section décrit la manière de configurer les actions personnalisées exécutables sur les +LSobjects appelées customActions.
+$GLOBALS['LSobjects']['[nom du type d'LSobject]']['customActions'] = array (
+ 'action1' => array(
+ 'label' => '[label l'action]',
+ 'hideLabel' => '[booléen]',
+ 'helpInfo' => '[label d'aide]',
+ 'icon' => '[nom de l'icône de l'action]',
+ 'function' => '[fonction à exécuter]',
+ 'question_format' => '[LSformat de la question de confirmation]',
+ 'onSuccessMsgFormat' => '[LSformat du message à afficher en cas de succès de l'action]',
+ 'disableOnSuccessMsg' => '[booléen]',
+ 'noConfirmation' => '[booléen]',
+ 'redirectToObjectList' => '[booléen]',
+ 'noRedirect' => '[booléen]',
+ 'accessMethods' => array(
+ 'web',
+ 'api',
+ ),
+ 'rights' => array(
+ 'LSprofile1',
+ 'LSprofile2',
+ ...
+ )
+ )
+);
+label
Le label de l'action.
+hideLabel
Cache le label dans le bouton de l'action.
+helpInfo
Le label du message d'aide qui sera affiché au survole du bouton de l'action.
+icon
Nom de l'îcone à afficher dans le bouton de l'action. Ce nom correspond au nom du fichier de
+l'image (sans l'extention) qui devra se trouver dans le dossier
+src/images/[nom du theme d'images]/ ou dans le dossier src/local/images.
function
Le nom de la fonction à exécuter qui implémente l'action personnalisée Cette fonction prendra en
+seule paramètre le LSobject sur lequel l'action devra être
+exécutée et retournera True en cas de succès ou False en cas d'échec d'exécution de la fonction.
question_format
Le LSformat de la question de confirmation +d'exécution de l'action. Ce LSformat sera composé à +l'aide du nom de l'objet.
+onSuccessMsgFormat
Le LSformat du message à afficher en cas de succès +d'exécution de l'action. Ce LSformat sera composé à +l'aide du nom de l'objet.
+disableOnSuccessMsg
Booléen permetant de désactiver le message afficher en cas de succès d'exécution de l'action.
+noConfirmation
Booléen permetant de désactiver la confirmation de l'exécution de l'action.
+redirectToObjectList
Booléen permetant de rediriger l'utilisateur vers la liste des objets plutôt que sur la fiche de +l'objet après l'execution de l'action.
+noRedirect
Booléen permetant de désactiver la redirection de l'utilisateur après l'execution de l'action. +Cela permet à la fonction de définir son propre fichier de template de retour et donc d'afficher +une page personnalisable.
+rights
Tableau contenant la liste des noms des +LSprofiles ayant le droit d'exécuter cette +action.
+accessMethods
Tableau permetant de restreindre les moyens d'accès possibles à cette action. Par défaut, tous les
+moyens d'accès possibles sont autorisés. Valeurs possibles : web pour les accès via l'interface
+web et api pour les accès via l'API.
Une fonction implémentant une customAction se déclare de la manière suivante :
+/*
+ * Ma fonction implémentant ma customAction
+ *
+ * Paramètre :
+ * - $object : Le LSobject sur lequel mon action doit être exécutée
+ *
+ * Valeurs retournées :
+ * - True : Tout s'est bien passé
+ * - False : Une erreur est survenue
+ * - Cas particulier pour une exécution via l'API : un tableau des données
+ * à retourner. Exemple :
+ * ["success" => true, "extra_info1" => "...", "extra_info2" => "..."]
+ */
+function maFonction ($object) {
+
+ // Actions
+
+}
+Cette fonction doit prendre pour seul paramètre, le LSobject sur
+lequel l'action personnalisée doit être exécutée et doit retourner soit True si tout s'est bien
+passé, soit False en cas de problème.
Une customAction pourra également être appelé via l'API. Dans ce cas, il est possible de
+retourner un tableau associatif et non un simple booléen. Le résultat retourné sera alors
+fusionné avec les données retournées par la requête. Ce tableau devra contenir à minima la clé
+success qui indiquera via un booléen si l'exécution est un succès ou non. Il est possible de
+détecter si la méthode est appelée via l'API en appelant la méthode
+LSsession :: get('api_mode'). Vous pouvez prendre exemple sur le code de la méthode
+showTechInfo() fournie par le LSaddon showTechInfo.
Note
+Ces fonctions sont le plus couramment définies au sein d' +LSaddon.
+Cette section décrit la manière de configurer les relations entre les +LSobjects appelées LSrelation.
+Dans le cadre d'une liaison dîte simple, c'est à dire une liaison au travers la valeur d'un +attribut qui fera directement référence à un autre objet (DN ou la première valeur d'un attribut +de référence), pourra être configurée simplement en spécifiant l'attribut de liaison et le type de +valeur qu'il contient. Dans le cas d'une liaison plus complexe, il sera possible de développer vous +même des méthodes de mise en relation.
+$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSrelation'] = array (
+ 'relation1' => array(
+ 'label' => '[label de la relation]',
+ 'emptyText' => "[texte affiché si aucune relation avec d'autres objets
+ n'existe pour l'objet courant]",
+ 'LSobject' => '[le type d'LSobjet en relation]',
+ 'display_name_format' => '[LSformat du nom d'affichage des LSobjet en relation]',
+ 'canEdit_attribute' => '[nom d'attribut]',
+
+ // Liaison simple
+ 'linkAttribute' => '[attribut de liaison]',
+ 'linkAttributeValue' => '[valeur de l'attribut de liaison]',
+ 'linkAttributeOtherValues' => array('[autres valeurs possible de l'attribut de liaison]', [...]),
+
+ // Liaison complexe
+ 'list_function' => '[méthode1]',
+ 'getkeyvalue_function' => '[methode2]',
+ 'update_function' => '[methode3]',
+ 'remove_function' => '[methode4]',
+ 'rename_function' => '[methode5]',
+ 'canEdit_function' => '[methode6]',
+
+ 'rights' => array(
+ 'LSprofile1' => 'r',
+ 'LSprofile2' => 'w',
+ ...
+ )
+ )
+);
+label
Le label de la relation.
+emptyText
Le texte à afficher pour décrire le fait que l'objet courant n'a aucune relation d'établie avec +d'autres LSobjects. Exemple (au sujet d'un utilisateur) : +N'appartient à aucun groupe.
+LSobject
Le type d'LSobject en relation avec le type courant. +(Facultatif en cas de liaison complexe)
+display_name_format
LSformat du nom d'affichage des objets en relation.
+canEdit_attribute
Le nom de l'attibut du type d'LSobject en relation devant être
+éditable par l'utilisateur pour que celui-ci puisse modifier la relation. Dans le cadre d'une
+relation simple, celui-ci peut, si nécessaire, être différent du paramètre linkAttribute.
linkAttribute
Dans le cadre d'une relation simple, il s'agit de l'attribut de liaison du type +d'LSobject en relation avec le type courant, c'est à dire +l'attribut dans lequel on retrouve une valeur en relation avec l'objet courant. +(Facultatif en cas de liaison complexe)
+linkAttributeValue
Dans le cadre d'une relation simple, il s'agit du type de valeur prisent par l'attribut de liaison
+du type d'LSobject en relation avec le type courant. Il peut
+s'agir du mot clé dn si l'attribut de liaison contient le DN de l'objet courant ou bien le nom
+d'un attribut du type d'objet courant dont la première valeur sera stockée par l'attribut de
+liaison. (Facultatif en cas de liaison complexe)
linkAttributeOtherValues
Dans le cadre d'une relation simple, il s'agit d'autres types de valeur possiblement prisent par
+l'attribut en plus de celui défini par le paramètre linkAttributeValue. Ce paramètre ne sert
+qu'a détecter des liaisons établies à l'aide de valeurs autres que celle relative au paramètre
+linkAttributeValue : en cas de nouvelle liaison, c'est la valeur associée à ce dernier qui sera
+utilisée pour établir la liaison. (Facultatif en cas de liaison complexe)
list_function
La méthode de la classe du type d'LSobject en relation, +permettant de lister les objets de ce type en relation avec l'objet courant. +(Facultatif en cas de liaison simple)
+getkeyvalue_function
La méthode de la classe du type d'LSobject en relation, +permettant d'obtenir la valeur clé à stocker pour établir la relation entre l'objet courant et +d'autres objets du type concerné. (Facultatif en cas de liaison simple)
+update_function
La méthode de la classe du type d'LSobject en relation, +permettant de mettre à jour les relations existantes entre l'objet courant et les objets du type +concerné. Cette liste d'objets en relation est établie par l'utilisateur à travers l'interface. +(Facultatif en cas de liaison simple)
+remove_function
La méthode de la classe du type d'LSobject en relation +permettant de supprimer une relation existante entre l'objet courant et un objet du type concerné. +(Facultatif en cas de liaison simple)
+rename_function
La méthode de la classe du type d'LSobject en relation +permettant d'effectuer les actions nécessaires lorsque l'objet courant est renommé dans le but +de maintenir les valeurs clés permettant d'établir les relations entre l'objet courant et les +objets en relation avec lui. (Facultatif en cas de liaison simple)
+canEdit_function
La méthode de la classe du type d'LSobject en relation +permettant de vérifier que l'utilisateur à le droit de modifier la relation avec un objet +en particulier. (Facultatif en cas de liaison simple)
+rights
Tableau associatif dont les clés sont les noms des
+LSprofiles ayant des droits sur cette
+relation et dont les valeurs associées sont les droits correspondants. La valeur des droits d'un
+LSprofile peut être r pour le droit de
+lecture ou w pour le droit de lecture-écriture.Par défaut, un
+LSprofile n'a aucun droit.
Cette section décrit la manière de paramétrer les formulaires d'LdapSaisie pour un type +LSobject donné. Pour chaque type +d'LSobject, il faut configurer plusieurs formulaires +correspondant aux vues gérées par LdapSaisie (création, modification, ...). Les formulaires se +configurent par plusieurs biais :
+Via la configuration au niveau de chaque type d'LSobject : il + y est possible de définir le comportement globale du formulaire comme la validation via Ajax ou + encore la disposition logique des attributs dans le formulaire.
+$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSform'] = array (
+ 'ajaxSubmit' => [booléen],
+ 'layout' => array (
+ // Configuration de la disposition logique des attributs
+ ),
+ 'dataEntryForm' => array (
+ // Configuration des masques de saisie
+ )
+
+);
+ajaxSubmit
Booléen définissant si le formulaire sera envoyé via une requête Ajax plutôt qu'à travers un
+rafraîchissement de la page. Par défaut : True.
layout
Tableau contenant la configuration de l'affichage du formulaire : il est possible de définir la +disposition des attributs dans le formulaire en les regroupant dans des onglets et en les +faisant apparaître dans un ordre logique. +Voir la section concernée.
+dataEntryForm
Tableau contenant la configuration des masques de saisie : il est possible de définir des +masques de saisie pour faire en sorte que lors de la création d'un objet, seul un certain nombre +d'élements soit demandé à l'utilisateur. +Voir la section concernée.
+La configuration des layout se situe dans la configuration des
+LSobjects, dans la variable layout
+($GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSform']['layout']). Cette variable est un
+tableau associatif dont la clé est l'identifiant de l'onglet et dont la valeur associée est la
+configuration de l'onglet.
$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSform']['layout'] = array (
+ 'onglet1' => array(
+ 'label' => '[label de l'onglet]',
+ 'img' => 1, // Valeur possible 1 ou 0
+ 'args' => array (
+ 'arg1',
+ 'arg2',
+ ...
+ )
+ ),
+ ...
+);
+label
Le label de l'onglet.
+img
Affiche ou non l'image d'un éventuel attribut de type HTML +LSattr_html_image.
+args
Tableau associatif contenant une liste ordonnée des attributs qui apparaîtront dans l'onglet.
+Important
+Lorsqu'un layout est défini, celui-ci est "suivi à la lettre" pour l'affichage du +LSform. Ainsi, si un attribut est défini dans la configuration de l'objet comme +présent dans le LSform courant, mais que celui-ci n'est pas présent dans le layout, +il ne sera pas du tout affiché.
+La configuration des masques de saisie (dataEntryForm) se situe dans la configuration des
+LSobjects, dans la variable dataEntryForm
+($GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSform']['dataEntryForm']). Cette variable est
+un tableau associatif dont la clé est l'identifiant du masque de saisie et dont la valeur associée
+est sa configuration.
$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSform']['dataEntryForm'] = array (
+ 'masque1' => array(
+ 'label' => '[label du masque de saisie]',
+ 'disabledLayout' => [booleen],
+ 'displayedElements' => array (
+ 'attr1',
+ 'attr2',
+ ...
+ ),
+ 'defaultValues' => array (
+ 'attr3' => [value],
+ 'attr4' => [value],
+ ...
+ ),
+ 'requiredAllAttributes' => [booleen],
+ 'requiredAttributes' => array (
+ 'attr1',
+ 'attr2',
+ ...
+ ),
+ 'forceGeneration' => array (
+ 'attr1',
+ 'attr2',
+ ...
+ ),
+ ),
+ ...
+);
+label
Le label du masque de saisie.
+disabledLayout
Active ou non les layouts pour ce masque de saisie.
+displayedElements
Tableau contenant la liste des attributs qui devront être saisie dans le masque de saisie.
+defaultValues
Tableau associatif contenant la liste des valeurs par défaut des attributs. Les valeurs multiples +sont possibles en utilisant des tableaux.
+Important
+Les valeurs seront vue comme des valeurs retournées par le formulaire et non comme des valeurs
+des attribus LDAP eux-même. Ainsi et par exemple, un attribut traité comme un booléen dans un
+formulaire pourra prendre comme valeur par défaut yes ou no.
requiredAttributes
Tableau contenant la liste des attributs obligatoires du masque de saisie. Cette liste d'attributs +obligatoires viendra en complément de la configuration des attributs. Il est ainsi possible de +rendre des attributs obligatoires durant la saisie d'un masque tout en les laissant facultatif le +reste du temps.
+requiredAllAttributes
Si ce parametre vaut True, tout les attributs du masque de saisie seront tous obligatoires de la
+même manière qu'avec le paramètre requiredAttributes.
forceGeneration
Tableau contenant la liste des attributs dont la génération sera forcée lors de la validation du +formation.
+Cette section décrit la manière de paramétrer les recherches dans l'annuaire pour un type +d'LSobject donné.
+La configuration des LSsearch se situe dans la configuration des
+LSobjects, dans la variable LSsearch
+($GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSsearch']).
$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSsearch'] = array (
+ 'attrs' => array(
+ 'attr1',
+ 'attr2',
+ ...
+ 'attr3' => array(
+ 'searchLSformat' => '[LSformat]',
+ 'approxLSformat' => '[LSformat]',
+ ),
+ ...
+ ),
+ 'params' => array(
+ // Paramètres de la recherche
+ 'pattern' => '[string]',
+ 'sizelimit' => [integer],
+ 'recursive' => [boolean],
+ 'approx' => [boolean],
+ 'withoutCache' => [boolean],
+ 'onlyAccessible' => [boolean],
+ // Paramètres de tri
+ 'sortBy' => [displayName|subDn],
+ 'sortDirection' => [ASC|DESC],
+ 'sortlimit' => [integer],
+ // Paramètre d'affichage
+ 'displayFormat' => [LSformat],
+ 'nbObjectsByPage' => [integer],
+ 'nbObjectsByPageChoices' => array([integer], [integer], ...),
+ 'validPatternRegex' => '[regex]'
+ ),
+ 'predefinedFilters' => array(
+ 'filter1' => 'label filter1',
+ 'filter2' => 'label filter2'
+ ),
+ 'extraDisplayedColumns' => array(
+ 'col1' => array(
+ 'label' => 'label column 1',
+ 'LSformat' => '[LSformat]'
+ ),
+ 'col2' => array(
+ 'label' => 'label column 2',
+ 'generateFunction' => '[fonction de génération]',
+ 'additionalAttrs' => array('[attr1]', '[attr2]', ...),
+ 'escape' => [booléen],
+ ),
+ 'col3' => array(
+ 'label' => 'label column 3',
+ 'LSformat' => '[LSformat]',
+ 'alternativeLSformats' => array (
+ '[LSformat 1]',
+ '[LSformat 2]'
+ ),
+ 'formaterLSformat' => '[LSformat]',
+ 'formaterFunction' => '[fonction de formatage]',
+ 'cssStyle' => '[CSS style]',
+ 'visibleTo' => array (
+ '[LSprofile 1]',
+ '[LSprofile 2]'
+ )
+ ),
+ ),
+ 'customActions' => array (
+ // Configuration des customActions pour les recherches de ce type d'objet
+ ),
+ 'showSelectionBoxes' => [boolean],
+);
+attrs
Tableau listant les attributs pouvant être utilisés dans les filtres de recherche LDAP employés +par LdapSaisie. Lorsqu'un motif de recherche est passé par l'utilisateur, LdapSaisie composera un +filtre LDAP à partir de cette liste.
+Lors d'une recherche non-approximative, le filtre de recherche sera composé (par défaut) de la +manière suivante :
+ +Lors d'une recherche approximative, le filtre de recherche sera composé (par défaut) de la manière +suivante :
+ +Il est également possible de paramétrer la manière dont sera composé le filtre de recherche
+attribut par attribut à l'aide des paramètres searchLSformat et approxLSformat.
Important
+Ces filtres, une fois composés, sont insérés dans un autre, filtrant en plus sur les +ObjectClass du type d'LSobject de la manière suivante :
+ +searchLSformat
Ce paramètre est un LSformat permettant de définir, +attribut par attribut, comment le filtre de recherche LDAP est composé à partir d'un motif de +recherche et en cas de recherche non-approximative.
+Ce LSformat est composé à l'aide des éléments
+name, le nom de l'attribut et pattern, le motif de recherche.
Important
+Le filtre déduit doit obligatoirement commencer par ( et se terminer par ).
approxLSformat
Ce paramètre est un LSformat permettant de définir, +attribut par attribut, comment le filtre de recherche LDAP est composé à partir d'un motif de +recherche et en cas de recherche approximative.
+Ce LSformat est composé à l'aide des éléments
+name, le nom de l'attribut et pattern, le motif de recherche.
Important
+Le filtre déduit doit obligatoirement commencer par ( et se terminer par ).
params
Tableau des paramètres par défaut d'une recherche. Ce tableau contient les paramètres qui seront +utilisés pour initialisé une recherche. Ces paramètres pourront être redéfini par l'utilisateur +ou par l'application en fonction du contexte dans lequel cette recherche est effectuée.
+pattern
Mot clé de la recherche.
+sizelimit
Entier determinant le nombre maximum d'objet pouvant être retournés dans une recherche.
+recursive
Booléen déterminant si la recherche récursive est activée.
+approx
Booléen déterminant si la recherche approximative est activée.
+withoutCache
Booléen déterminant si le cache de recherche doit être utilisé.
+onlyAccessible
Booléen déterminant si seul les objets accessibles à l'utilisateur connecté doivent être +retournés par la recherche.
+sortBy
Mot clé déterminant sur quel valeur/colonne le résultat de recherche sera trié.
+Valeurs possibles : displayName, subDn ou NULL.
sortDirection
Mot clé déterminant le sens du trie du résultat de la recherche.
+Valeurs possibles : ASC, DESC ou NULL.
sortlimit
Entier determinant le nombre maximum d'objet pouvant être triés dans le résultat d'une +recherche.
+displayFormat
LSformat d'affichage du nom de l'objet dans le +résultat de la recherche.
+nbObjectsByPage
Entier déterminant le nombre d'objet maximum affichés dans une page de résultat de la recherche.
+nbObjectsByPageChoices
Tableau des choix proposés à l'utilisateur pour le nombre d'objets maximum affichés dans une +page de résultat de la recherche.
+validPatternRegex
Expression régulière de validation des mots clés de recherche pour ce type +d'LSobject.
+(Par défaut : /^[\w\-_\\\'\"^[]\(\){}\=\+\£\%\$\€\.\:\;\,\?\/\@]+$/iu)
predefinedFilters
Tableau associatif contenant des filtres prédéfinis pour la recherche. Les clés sont les filtres +au format LDAP et les valeurs sont les labels associés.
+extraDisplayedColumns
Tableau associatif contenant des colonnes supplémentaires à afficher dans les résultats de +recherche. Les clés sont les identifiants des colonnes supplémentaires et les valeurs sont leur +configuration définie à partir des paramètres suivant :
+label
Le label de la colonne.
+LSformat
Le LSformat d'affichage de la colonne. Ce format +est composé à partir des attributs des objets LDAP dans leur format brut.
+alternativeLSformats
Tableau des LSformats alternatifs à utiliser si le +résultat du format principal est vide. Les formats définis dans cette liste sont essayés les uns +après les autres et le premier LSformat retournant +une valeur non-vide est utilisé.
+formaterLSformat
LSformat optionnel permettant de mettre en forme le
+résultat obtenu des LSformats précédents. Ce
+LSformat ne sera utilisé que si le résultat obtenu
+précédement n'est pas vide. Il est ainsi possible d'utiliser les paramètres LSformat et
+alternativeLSformats afin de récupérer la valeur à afficher, puis de la mettre en forme grâce
+à ce LSformat. Ce format est composé à partir des
+attributs des objets LDAP dans leur format brut et de la valeur retournés précedement accessible
+via la variable val.
formaterFunction
Le nom d'une fonction optionnelle à exécuter pour mettre en forme le résultat obtenu des +LSformats précédents. Cette fonction ne sera +appelée que si le résultat obtenu précédement n'est pas vide. La fonction prendra en paramètre +la valeur à mettre en forme et retournera la valeur mise en forme.
+generateFunction
Le nom d'une fonction qui sera utilisée pour générer la valeur d'affichage de cette colonne. La
+fonction prendra en paramètre une référence de l'objet LSsearchEntry et retournera la valeur
+de la colonne.
additionalAttrs
Un tableau de nom d'attributs à inclure dans le resultat de la recherche LDAP. Ce tableau permet
+notamment d'inclure les attributs nécessaires au bon fonctionnement de la fonction
+generateFunction.
escape
Ce paramètre booléen permet de définir si, lors de l'affichage, le contenu de la colonne doit
+être transformé pour protéger les caractères éligibles en entités HTML. Par défaut, ce paramètre
+est True.
Warning
+Cette fonctionnalité existe pour des raisons de sécurité et notamment en protection des
+failles XSS. Si vous désactivez cette fonctionnalité, il est important de gérer la
+problématique de sécurité par ailleurs.
cssStyle
Ce paramètre permet de définir un style CSS personnalisé pour la colonne. S'il est défini, le
+contenu de ce paramètre sera ajouté en tant qu'attribut style des balises th et td de la
+colone.
visibleTo
Ce paramètre permet de restreindre la visibilité de cette colonne aux seuls +LSprofiles spécifiés. S'il est omis, la +colonne sera visible pour tous.
+customActions
Tableau associatif contenant les paramètres de configuration des +customActions. Voir la section concernée.
+showSelectionBoxes
Booléen permettant de définir si les cases à cocher de sélections des objets doivent être
+affichées. Lorsqu'elles sont affichées, l'utilisateur pourra sélectionner un ou plusieurs objets
+dans la liste avant de déclencher une customAction. Dans ce cas, les DNs de ces
+objets seront passés à la page d'exécution de la customAction via le paramètre
+selected.
Cette section décrit la manière de configurer les actions personnalisées exécutables sur les +recherches d'LSobjects appelées customActions.
+$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSsearch']['customActions'] = array (
+ 'action1' => array(
+ 'label' => '[label l'action]',
+ 'hideLabel' => '[booléen]',
+ 'icon' => '[nom de l'icône de l'action]',
+ 'function' => '[fonction à exécuter]',
+ 'question_format' => '[LSformat de la question de confirmation]',
+ 'onSuccessMsgFormat' => '[LSformat du message à afficher en cas de succès de l'action]',
+ 'disableOnSuccessMsg' => '[booléen]',
+ 'noConfirmation' => '[booléen]',
+ 'redirectToObjectList' => '[booléen]',
+ 'rights' => array(
+ 'LSprofile1',
+ 'LSprofile2',
+ ...
+ )
+ )
+);
+label
Le label de l'action.
+hideLabel
Cache le label dans le bouton de l'action.
+icon
Nom de l'îcone à afficher dans le bouton de l'action. Ce nom correspond au nom du fichier de
+l'image (sans l'extention) qui devra se trouver dans le dossier
+/src/images/[nom du theme d'images]/ ou dans le dossier src/local/images.
function
Le nom de la fonction à exécuter qui implémente l'action personnalisée Cette fonction prendra en
+seule paramètre l'objet LSsearch. sur lequel l'action devra être exécutée et
+retournera True en cas de succès ou False en cas d'échec d'exécution de la fonction.
question_format
Le LSformat de la question de confirmation +d'exécution de l'action. Ce LSformat sera composé à +l'aide du label de l'action.
+onSuccessMsgFormat
Le LSformat du message à afficher en cas de succès +d'exécution de l'action. Ce LSformat sera composé à +l'aide du label de l'action.
+disableOnSuccessMsg
Booléen permetant de désactiver le message afficher en cas de succès d'exécution de l'action.
+noConfirmation
Booléen permetant de désactiver la confirmation de l'exécution de l'action.
+redirectToObjectList
Booléen permetant de rediriger ou non l'utilisateur vers la liste des objets (Vrai par défaut). +Si l'utilisateur n'est redirigé, le template par défaut (ou celui défini durant l'éxécution de la +fonction) sera affiché.
+rights
Tableau contenant la liste des noms des LSprofiles +ayant le droit d'exécuter cette action.
+Une fonction implémentant une customAction se déclare de la manière suivante :
+/*
+ * Ma fonction implémentant ma customAction
+ *
+ * Paramètre :
+ * - $search : L'objet LSsearch de la recherche sur lequel mon action doit être exécutée
+ *
+ * Valeurs retournées :
+ * - True : Tout s'est bien passé
+ * - False : Une erreur est survenue
+ */
+function maFonction ($search) {
+
+ // Actions
+
+}
+Cette fonction doit prendre pour seul paramètre, l'objet LSsearch. sur lequel l'action
+personnalisée doit être exécutée et doit retourner soit True si tout s'est bien passé, soit
+False en cas de problème.
Important
+La recherche passée en paramètre n'a pas encore été exécutée. En conséquence, si vous avez
+besoin d'accéder au résultat de la recherche, il est nécessaire d'exécuter au préalable :
+$search -> run();. Cela permet en outre, de modifier les paramètres de la recherche avant de
+l'exécuter. Cela peut par exemple être utile, si vous avez besoin d'accèder aux valeurs
+d'attributs particuliers, d'ajouter des attributs au résultat de la recherche :
Note
+Ces fonctions sont le plus couramment définies au sein +d'LSaddon.
+Cette section décrit la manière de paramétrer les formats d'import/export pour un type d' +LSobject donné.
+La configuration des ioFormats se situe dans la configuration des
+LSobjects, dans la variable ioFormat
+($GLOBALS['LSobjects']['[nom du type d'LSobject]']['ioFormat']). Cette variable est un tableau
+associatif dont la clé est l'identifiant du format et dont la valeur associée est la configuration
+du format.
Important
+Le moteur d'importation simule la validation d'un formulaire de création du type +d'LSobject (ou de modification en cas d'activation du mode +mise à jour uniquement, voir ci-dessous). En conséquence :
+yes ou no.$GLOBALS['LSobjects']['[nom du type d'LSobject]']['ioFormat'] = array (
+ '[ioFormat ID]' => array (
+ 'label' => '[Label du type de fichier]',
+ 'driver' => '[Pilote d'ioFormat utilisé]',
+ 'driver_options' => array([Options du pilote d'ioFormat utilisé]),
+ 'update_only' => '[Booléen]',
+ 'fields => array (
+ '[champ 1]' => '[attribut 1]',
+ '[champ 2]' => '[attribut 2]',
+ [...]
+ ),
+ 'generated_fields' => array (
+ '[attribute 3]' => '[LSformat]',
+ '[attribute 4]' => array('[LSformat1]', '[LSformat2]', ...)
+ '[attribute 5]' => function($attrs, $row) {
+ return array([...]);
+ },
+ [...]
+ ),
+ 'before_import' => array('function1', 'function2'),
+ 'after_import' => 'function3',
+ ),
+ [...]
+);
+label
Le label du format
+driver
Le pilote a utilisé pour ce format. Le pilote permet de gérér la lecture et l'écriture dans un +type de fichier d'import/export. Pour plus d'information sur les pilotes disponibles, +Voir la section concernée.
+driver_options
Tableau associatif des options du pilote utilisé pour ce format. Pour plus d'informations, +consulter la documentation du pilote utilisé.
+update_only
Booléen permettant d'activer le mode mise à jour uniquement pour ce format. Dans ce mode, les
+données de l'objet LDAP correspondant seront chargées depuis l'annuaire avant toutes validations
+des données fournies dans le fichier d'import, et ce, dans un formulaire de modifications et non
+pas un formulaire de création autrement. Pour que cela soit possible, il est indispensable que le
+DN de l'objet puisse être déduit depuis les données fournies dans le fichier d'import. Pour cela,
+vous pouvez le fournir via un champ du fichier d'import associé à la clé dn ou à défaut il sera
+généré à partir du RDN dont la valeur devra être fournie dans le fichier d'import. Vous pouvez
+également le générer via le paramètre generated_fields (voir ci-dessous).
fields
Tableau associatif permettant d'associer un champ du fichier source (la clé) avec attribut de
+l'objet LDAP (la valeur). Il est également possible d'associé un champ avec la valeur dn pour
+fournir le DN de l'objet en mode mise à jour uniquement (voir ci-dessus).
generated_fields
Tableau associatif permettant de définir soit des
+LSformats, soit un callable (au sens PHP) pour
+générer les valeurs d'attributs automatiquement. Ce tableau contient en clé, le nom de l'attribut
+à générer (ou dn pour la génération du DN de l'objet en mode mise à jour uniquement), et en
+valeur associée, un ou plusieurs LSformat ou un
+callable à utiliser pour générer ses valeurs.
+En cas de LSformat, ils seront composés à l'aide des
+valeurs des autres attributs de l'objet. En cas d'un callable, il sera appeler avec en paramètre
+le tableau des valeurs des autres attributs ($attrs), le tableau des données issues du fichier
+source ($row) et devra retourner le tableau des valeurs générées de l'attribut ou false en cas
+d'erreur.
before_import
Chaîne de caractères (ou tableau de chaîne de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées avant chaque import. Voir la section concernée
+after_import
Chaîne de caractères (ou tableau de chaîne de caractères) correspondant au nom d'une ou plusieurs +fonctions qui seront exécutées après chaque import. Voir la section concernée
+Cette section décrit la manière de configurer les pilotes d'ioFormat utilisés lors des +imports/exports d'LSobjects.
+Ce pilote permet de gérer l'import/export de LSobject à partir
+d'un fichier CSV. Depuis la version 4 d'LdapSaisie, ce pilote utilise les fonctions standards
+fgetcsv() et fputcsv fournis par PHP. Avant cela, la classe PEAR
+File_CSV_DataSource était utilisée. Par défaut,
+les paramètres de lecture et d'écriture des fichiers sont : la virgule sert de délimiteur, le
+caractère " peut être utilisé pour encadrer les valeurs des champs et la longueur maximale d'une
+ligne est infini. Ces paramètres peuvent être modifiés en configurant les options du pilote.
$GLOBALS['LSobjects']['[nom du type d'LSobject]']['ioFormat']['[ID ioFormat]']['driver_options'] = array (
+ 'delimiter' => '[délimiteur]',
+ 'enclosure' => '[caractère d'encadrement de texte]',
+ 'length' => [longueur maximale d'une ligne],
+ 'escape' => '[caractère d'échappement]',
+ 'multiple_value_delimiter' => '[délimiteur]',
+);
+delimiter
Le caractère utilisé pour délimiter les champs (Par défaut, une virgule).
+length
La longueur maximale d'une ligne du fichier. Si zéro est spécifié, la longueur d'une ligne ne sera
+pas limité, mais la lecture du fichier sera ralentie. (Par défaut : 0)
enclosure
Le caractère utilisé pour encadrer les valeurs des champs (Par défaut : ").
escape
Le caractère d'échappement utilisé si un des champs d'une ligne de fichier contient le caractère
+utilisé pour encadrer les valeurs. (Par défaut : \).
Note
+Selon la RFC4180, l'echappement du caractère utilisé pour encadrer les valeurs des champs doit +se faire en le doublant. Le caractère défini ici est une alternative à ce comportement par +défaut. Pour désactiver ce caractère d'échappement alternatif, il est possible depuis de la +version 7.4.0 de PHP de mettre ici une chaine vide.
+multiple_value_delimiter
Le caractère utilisé pour délimiter au sein d'un champs, les valeurs valeurs multiples d'un
+attribut (Par défaut : |).
Cette section décrit la manière de paramétrer des déclencheurs afin que LdapSaisie exécute durant +ses processus, et à des moments bien précis des traitements d'un ioFormat, des +fonctions que vous pourrez développer vous même. De plus, le résultat de l'exécution de vos +fonctions pourra influer sur le déroulement des processus.
+Actuellement, les évenements suivant sont gérés :
+| Nom | +Description | +Bloquant | +
|---|---|---|
before_import |
+Avant l'import. | +Oui | +
after_import |
+Après l'import'. | +Non | +
Note
+Si un événement est dit bloquant, lors de l'exécution des actions liées, si une des fonctions
+retourne false, le processus s'arrêtera.
La configuration des déclencheurs se fait dans la définition des types d'ioFormat. Par
+exemple, pour définir les fonctions à exécuter après l'import des LSobjects de type LSpeople avec
+son LSioFormat mycsv, c'est à dire lors de leur évènement after_import, il faut définir la
+variable suivante :
Cette variable peut contenir soit une chaine de caractères correspondant au nom de la fonction à +exécuter, soit un tableau de chaînes de caractères correspondant aux noms des fonctions à exécuter. +Il est également possible de mettre ici directement des +fonctions anonymes.
+Une fonction exécutée par un déclencheur d'un ioFormat se déclare de la manière suivante :
+/*
+ * Ma fonction à exécuter lors de l'evenement [event]
+ *
+ * Paramètres :
+ * - $ioFormat : Le LSioFormat sur lequel l'évènement survient
+ * - $data : Les données de contexte de l'évènement
+ *
+ * Valeurs retournées :
+ * - True : Tout s'est bien passé
+ * - False : Une erreur est survenue ou la fonction souhaite bloquer le
+ * processus lors d'un évènement bloquant.
+ */
+function maFonction (&$ioFormat, &$data) {
+
+ // Actions
+
+}
+Cette fonction doit accepter deux paramètres, le LSioFormat sur lequel l'évènement survient et un
+tableau des données contextuelles de l'évènement. Elle doit par ailleurs retourner True si tout
+s'est bien passé ou False en cas de problème. Dans le cas d'un événement bloquant, si la fonction
+retourne False, le processus est arrêté.
Les données contextuelles de l'évènement, passées en paramètre, pourront dépendre du contexte et de +l'évènement déclencheur, mais pour les moments, il s'agit toujours d'un tableau telque décrit +ci-dessous :
+array(
+ 'input_file' => "[/path/of/import.file]",
+ 'updateIfExists' => [boolean],
+ 'justTry' => [boolean],
+ 'objectsData' => array(
+ [Données des objets chargés depuis le fichier d'import]
+ ),
+ 'return' => array(
+ 'success' => [boolean],
+ 'LSobject' => "[nom du type d'LSobject]",
+ 'ioFormat' => "[nom du type d'ioFormat]",
+ 'updateIfExists' => [boolean],
+ 'justTry' => [boolean],
+ 'imported' => array([objets importés]),
+ 'updated' => array([objets mis à jour]),
+ 'errors' => array(
+ array(
+ 'data' => [données de l'objet importé ayant déclenché l'erreur],
+ 'errors' => array (
+ 'globals' => array("Erreur 1", [...]),
+ 'attrs' => array(
+ 'attr1' => array("Erreur 1", [...]),
+ [...]
+ ),
+ ),
+ ),
+ [...]
+ ),
+ ),
+)
+Note
+Les clés objectsData et return sont des références. En cas de modification, cela influencera
+respectivement sur les données utilisées pour l'import et sur le résultat de l'import tel
+qu'affiché dans l'interface.
Cette partie décrit la manière de configurer les différents LSaddons actuellement supportés par
+LdapSaisie. Ces addons peuvent avoir un fichier de configuration et il sera alors stocké dans le
+dossier conf/LSaddons/ et potera le nom config.LSaddons.[addon name].php.
Cet LSaddon fournit la fonction showObjectAccessLogs()
+pouvant être utilisée comme customActions et
+permettant d'afficher les logs d'accès produits par
+l'overlay OpenLDAP accesslog
+sur un objet de l'annuaire.
La constante LS_ACCESSLOG_BASEDN du fichier de configuration de l'addon
+(conf/LSaddons/config.LSaddons.accesslog.php) permet d'indiquer le base DN de la base stockant les
+logs :
Warning
+LdapSaisie se connectera à la base stockant les logs d'accès de l'annuaire avec les mêmes +paramètres de connexion que pour la base principale (excepté le base DN). Pensez à ajuster les +ACLs de la base stockant les logs d'accès pour autoriser l'utilisateur d'LdapSaisie à se +connecter et lire les informations qu'elle contient.
+Exemple d'ACL à mettre en place : +
+Ci-dessous, vous trouverez un exemple de configuration de la fonction showObjectAccessLogs() comme
+customActions :
Exemple d'utilisation :
+$GLOBALS['LSobjects']['LSpeople'] = array (
+ [...]
+ 'customActions' => array (
+ 'showObjectAccessLogs' => array (
+ 'function' => 'showObjectAccessLogs',
+ 'label' => 'Show access logs',
+ 'hideLabel' => true,
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'icon' => 'clock',
+ 'rights' => array (
+ 'admin'
+ ),
+ ),
+ ),
+ [...]
+);
+Cet LSaddon est utilisé pour gérer les fonctionnalités +spécifiques au serveur de téléphonie Asterisk. Cet LSaddon +donne accès à une fonction permettant l'encodage d'un mot de passe au format spécifique attendu par +Asterisk. Ce format est un hash MD5 d'une chaine de caractère composée du nom d'utilisateur, d'une +chaine fixe spécifiée dans la configuration d'Asterisk et du mot de passe en clair.
Cet LSaddon fournie une fonction du même nom pouvant être +utilisée comme customActions et permettant de télécharger +le résultat d'une recherche au format CSV. L'export généré reprend exactement le contenu des +colonnes du tableau du résultat de la recherche. Le DN de l'objet LDAP correspondant est également +fournis dans une colonne.
+Des paramètres de configuration sont disponibles dans le fichier de configuration
+config.LSaddons.exportSearchResultAsCSV.php. Ils permettent notamment de contrôller le format du
+fichier CSV généré.
// CSV file delimiter
+define('LS_EXPORTSEARCHRESULTASCSV_DELIMITER',',');
+
+// CSV file enclosure
+define('LS_EXPORTSEARCHRESULTASCSV_ENCLOSURE','"');
+
+// CSV file escape character (available since PHP 5.5.4)
+define('LS_EXPORTSEARCHRESULTASCSV_ESCAPE_CHAR','\\');
+Ci-dessous, vous trouverez un exemple de configuration de la fonction exportSearchResultAsCSV()
+comme customActions :
$GLOBALS['LSobjects']['LSpeople']['LSsearch'] = array (
+ [...]
+ 'customActions' => array (
+ 'exportSearchResultAsCSV' => array (
+ 'label' => 'Export result as CSV',
+ 'icon' => 'export_csv',
+ 'function' => 'exportSearchResultAsCSV',
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'rights' => array (
+ 'admin'
+ )
+ ),
+ ),
+ [...]
+);
+Note
+Le label et l'icône fournis dans cet exemple sont traduits et délivrés avec LdapSaisie.
+Cet LSaddon fournie une fonction du même nom pouvant être +utilisée comme customActions et permettant de se +reconnecter en tant qu'un autre utilisateur de l'annuaire.
+Ci-dessous, vous trouverez un exemple de configuration de la fonction impersonate() comme
+customActions :
Exemple d'utilisation :
+$GLOBALS['LSobjects']['LSpeople'] = array (
+ [...]
+ 'customActions' => array (
+ 'impersonate' => array (
+ 'function' => 'impersonate',
+ 'label' => 'Reconnect as this user',
+ 'hideLabel' => True,
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'icon' => 'user_go',
+ 'rights' => array (
+ 'admin'
+ ),
+ ),
+ ),
+ [...]
+);
+Cet LSaddon offre une interface de visualisation des droits +d'accès des différents LSprofiles configurés. +Pour chaque type d'objet, la matrice des droits d'accès par attribut et par profil est affiché sous +la forme d'un tableau.
+Le fichier de configuration permet de définir au travers la variable
+$GLOBALS['LSaccessRightsMatrixView_allowed_LSprofiles'] la liste des
+LSprofiles autorisés à accéder à cette interface.
Cet LSaddon est utilisé pour gérer l'envoi de courriels. Il +utilise pour cela les librairies PEAR Mail et Mail_Mime qui doivent être +installés.
+Cet LSaddon offre aussi la possibilité d'envoyer des
+courriels dont le contenu est construit à partir de modèles. Ces modèles sont enregistrés dans des
+fichiers textes stockés (voir $GLOBALS['MAIL_TEMPLATES_DIRECTORIES']). Pour chaque modèle, vous
+devez fournir trois fichiers portant le même nom mais avec des extensions différentes :
template.subject : le sujet du courriel. Note : seule la première ligne du fichier est utilisé
+ (et passée dans la fonction trim())template.html : le contenu HTML du courrieltemplate.txt: le contenu texte du courrielCes trois fichiers sont utilisés en tant que modèle Smarty et seront +construit en utilisant les variables fournies dans le contexte d'envoi des courriels. À noter que le +moteur Smarty utilisé pour la génération du contenu de ces courriels n'est pas le même que celui +utilisé par LdapSaisie pour l'affichage des pages.
+Par ailleurs, cet LSaddon fourni une vue de gestion des
+modèles de courriels existants (voir $GLOBALS['MAIL_TEMPLATES_EDITOR_VIEW_ACCESS'] pour la
+configuration des accès).
Warning
+Cette vue n'est pas conçues pour être mise entre toutes les mains. La sécurisation de modèles de +courriels étant très complexe, il est fortement recommandé de n'ouvrir l'accès à cette vue +qu'aux utilisateurs avertis et de confiances.
+Cet LSaddon doit être configuré en éditant son
+fichier de configuration config.LSaddons.mail.php.
***********************************************
+ * Configuration du support de l'envoi de mail *
+ ***********************************************
+ */
+
+// Pear :: Mail
+define('PEAR_MAIL','/usr/share/php/Mail.php');
+
+// Pear :: Mail_mime
+define('PEAR_MAIL_MIME','/usr/share/php/Mail/mime.php');
+
+/*
+ * Méthode d'envoie :
+ * - mail : envoie avec la méthode PHP mail()
+ * - sendmail : envoie la commande sendmail du système
+ * - smtp : envoie en utilisant un serveur SMTP
+ */
+define('MAIL_SEND_METHOD','smtp');
+
+/*
+ * Paramètres d'envoie :
+ * Ces paramètres dépende de la méthode utilisé. Repporté vous à la documentation
+ * de PEAR :: Mail pour plus d'information.
+ * Lien : http://pear.php.net/manual/en/package.mail.mail.factory.php
+ * Infos :
+ * List of parameter for the backends
+ * mail
+ * o If safe mode is disabled, $params will be passed as the fifth
+ * argument to the PHP mail() function. If $params is an array,
+ * its elements will be joined as a space-delimited string.
+ * sendmail
+ * o $params["sendmail_path"] - The location of the sendmail program
+ * on the filesystem. Default is /usr/bin/sendmail.
+ * o $params["sendmail_args"] - Additional parameters to pass to the
+ * sendmail. Default is -i.
+ * smtp
+ * o $params["host"] - The server to connect. Default is localhost.
+ * o $params["port"] - The port to connect. Default is 25.
+ * o $params["auth"] - Whether or not to use SMTP authentication.
+ * Default is FALSE.
+ * o $params["username"] - The username to use for SMTP authentication.
+ * o $params["password"] - The password to use for SMTP authentication.
+ * o $params["localhost"] - The value to give when sending EHLO or HELO.
+ * Default is localhost
+ * o $params["timeout"] - The SMTP connection timeout.
+ * Default is NULL (no timeout).
+ * o $params["verp"] - Whether to use VERP or not. Default is FALSE.
+ * o $params["debug"] - Whether to enable SMTP debug mode or not.
+ * Default is FALSE.
+ * o $params["persist"] - Indicates whether or not the SMTP connection
+ * should persist over multiple calls to the send() method.
+ */
+$GLOBALS['MAIL_SEND_PARAMS'] = NULL;
+
+/*
+ * Headers :
+ */
+$GLOBALS['MAIL_HEARDERS = array();
+
+// Catch all sent emails
+$GLOBALS['MAIL_CATCH_ALL'] = array();
+
+/**
+ * Email templates
+ *
+ * This addon offer ability to send email by using templates. Email templates are stored in
+ * full-text files in configured directories (see $GLOBALS['MAIL_TEMPLATES_DIRECTORIES']). For each
+ * template, you have to provide three files with the same name but with different extensions:
+ * - template.subject: the email subject. Note: only the first line is used (and stripped)
+ * - template.html: the HTML content of the email
+ * - template.txt: the text content of the email
+ * All these files will be used as Smarty templates and will be computed using variables provided
+ * in the sending context. Note that the Smarty object used to compute the template is not the same
+ * as the one used by LdapSaisie to display pages.
+ *
+ * Futhermore, this addon offer a view to list and edit existing template (see
+ * $GLOBALS['MAIL_TEMPLATES_EDITOR_VIEW_ACCESS'] to configured access).
+ */
+
+// List of directory paths where as stored mail templates
+// Notes:
+// - provided path could be absolute or relative. Relative path are relative to the root base
+// sources LdapSaisie directory (commonly /usr/share/ldapsaisie or the src directory if you
+// installed it from sources). On Debian installation, you can specify 'local/email_templates' to
+// refer to /etc/ldapsaisie/local/email_templates directory/
+// - Multiple directories could be specified, sorted so that the first ones take priority over
+// the last one.
+// - To allow users to edit them using the editor view, these directories must be
+// writable by PHP process (commonly runed as www-data).
+$GLOBALS['MAIL_TEMPLATES_DIRECTORIES'] = array('local/email_templates');
+
+// List of granted LSprofiles to access mail templates editor view
+// WARNING: Sanitizing mail templates is hell... EXPOSE THIS VIEW ONLY TO TRUSTED USERS!
+$GLOBALS['MAIL_TEMPLATES_EDITOR_VIEW_ACCESS'] = array('admin');
+Cet LSaddon offre avant tout la possibilité d'envoyer des
+courriels en utilisant la fonction PHP sendMail() :
bool sendMail(
+ <string> $to,
+ <string> $subject,
+ <string> $msg,
+ <array(string)> $headers,
+ <array> $attachments,
+ <string> $eol,
+ <string> $encoding,
+ <boolean> $html
+);
+Pour l'envoi de courriels en utilisant un modèle, il faut utiliser la fonction PHP
+sendMailFromTemplate() :
Cet LSaddon est utilisé pour gérer la manipulation distante +de maildir.
+FIXME
Cet LSaddon fournie une fonction mailquota_get_usage
+pouvant être utilisée pour récupérer l'utilisation du quota d'une boîte mail IMAP. Pour cela,
+LdapSaisie se connecte au serveur IMAP en utilisant un compte maître.
Cet LSaddon fournie une également une fonction
+mailquota_show_usage pouvant être utilisée comme
+customActions et permettant d'afficher l'utilisation
+du quota de la boîte mail correspondante via une message dynamique (LSinfo).
Des paramètres de configuration sont disponibles dans le fichier de configuration
+config.LSaddons.mailquota.php.
// IMAP Mailbox connection string LSformat (composed with LSldapObject attributes)
+// See : https://php.net/imap_open (parameter $mailbox)
+define('MAILQUOTA_IMAP_MAILBOX','{localhost}');
+
+// IMAP Master user
+define('MAILQUOTA_IMAP_MASTER_USER', 'ldapsaisie');
+
+// IMAP Master user's password
+define('MAILQUOTA_IMAP_MASTER_USER_PWD', 'secret');
+
+// IMAP Master user LSformat composed with :
+// * masteruser = master username (MAILQUOTA_IMAP_MASTER_USER)
+// * LSldapObject attributes
+define('MAILQUOTA_IMAP_MASTER_USER_FORMAT', '%{mail}*%{masteruser}');
+
+// IMAP quota root mailbox
+define('MAILQUOTA_IMAP_QUOTA_ROOT_MAILBOX', 'INBOX');
+Ci-dessous, vous trouverez un exemple de configuration de la fonction mailquota_show_usage()
+comme customActions :
$GLOBALS['LSobjects']['LSpeople'] = array (
+ [...]
+ 'customActions' => array (
+ 'showmailquotausage' => array (
+ 'function' => 'mailquota_show_usage',
+ 'label' => 'Show mail quota usage',
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'icon' => 'mail',
+ 'rights' => array (
+ 'admin'
+ )
+ ),
+ [...]
+ ),
+ [...]
+);
+Cet LSaddon est utilisé pour permettre un lien facile entre +le logiciel PhpLdapAdmin et LdapSaisie. Il sera possible +ainsi à partir d'un objet dans LdapSaisie de voir ce même objet dans +PhpLdapAdmin.
+Il est necessaire de configurer l'URL de votre installation de
+PhpLdapAdmin dans le fichier de configuration
+config.LSaddons.phpldapadmin.php.
Structure du fichier :
+// PhpLdapAdmin View Object URL format
+define('LS_PHPLDAPADMIN_VIEW_OBJECT_URL_FORMAT','//'.$_SERVER['SERVER_NAME'].'/phpldapadmin/cmd.php?cmd=template_engine&server_id=0&dn=%{dn}');
+Cet LSaddon offre la possibilité d'utilisé la fonction PHP
+redirectToPhpLdapAdmin() comme customActions.
Exemple d'utilisation :
+$GLOBALS['LSobjects']['LSpeople'] = array (
+ [...]
+ 'customActions' => array (
+ 'redirectPhpLdapAdmin' => array (
+ 'function' => 'redirectToPhpLdapAdmin',
+ 'label' => 'See in PhpLdapAdmin',
+ 'hideLabel' => True,
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'icon' => 'phpldapadmin',
+ 'rights' => array (
+ 'admin'
+ )
+ ),
+ ),
+ [...]
+);
+Cet LSaddon fourni :
+une fonction ppolicy_extraDisplayColumn_password_expiration pouvant être utilisée pour la
+ génération d'une extraDisplayedColumn affichant l'état d'expiration du mot de passe des objets
+ d'une recherche.
Exemple d'utilisation :
+$GLOBALS['LSobjects']['LSpeople']['LSsearch'] = array (
+ [...]
+ 'extraDisplayedColumns' => array (
+ [...]
+ 'password_expiration' => array (
+ 'label' => 'Password expiration',
+ 'generateFunction' => 'ppolicy_extraDisplayColumn_password_expiration',
+ 'additionalAttrs' => array('pwdChangedTime', 'pwdPolicySubentry'),
+ 'escape' => false,
+ 'cssStyle' => 'width: 14em; text-align: center;'
+ ),
+ [...]
+ ),
+ [...]
+);
+une fonction ppolicy_export_search_info pouvant être utilisée comme
+ actions personnalisées sur les recherches d'LSobjects
+ pour exporter au format CSV les informations des politiques de mots de passe des objets retournés
+ par la recherche.
Exemple d'utilisation :
+$GLOBALS['LSobjects']['LSpeople']['LSsearch'] = array (
+ [...]
+ 'customActions' => array (
+ 'exportPpolicyInfo' => array (
+ 'label' => 'Export password policy info',
+ 'icon' => 'export_csv',
+ 'function' => 'ppolicy_export_search_info',
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'rights' => array (
+ 'admin',
+ ),
+ ),
+ ),
+ [...]
+);
+exportPpolicyInfo permettant d'exporter les informations des politiques de mots
+ de passe de tous les objets d'un type donné. Cette méthode est accessible via l'URL au format
+ suivant : /api/1.0/exportPpolicyInfo/[object type]la commande CLI export_ppolicy_info permettant d'exporter les informations des politiques de
+ mots de passe de tous les objets d'un type donné.
Utilisation :
+ +Des paramètres de configuration sont disponibles dans le fichier de configuration
+config.LSaddons.ppolicy.php.
// Default password policy object DN (set to null if no default policy is configured)
+define('LS_PPOLICY_DEFAULT_DN', null);
+
+// Ppolicy password warning expiration threshold (in seconds)
+define('LS_PPOLICY_WARNING_EXPIRATION_THRESHOLD', 7 * 86400);
+
+// Ppolicy password critical expiration threshold (in seconds)
+define('LS_PPOLICY_CRITICAL_EXPIRATION_THRESHOLD', 2 * 86400);
+
+// CSV file delimiter
+define('LS_PPOLICY_CSV_DELIMITER',';');
+
+// CSV file enclosure
+define('LS_PPOLICY_CSV_ENCLOSURE','"');
+
+// CSV file escape character (available since PHP 5.5.4)
+define('LS_PPOLICY_CSV_ESCAPE_CHAR','\\');
+
+// List of LSprofiles who are granted to use the exportPpolicyInfo API method
+$GLOBALS['LS_PPOLICY_API_GRANTED_PROFILES'] = array('admin');
+
+// List of extra attributes to include in Ppolicy info export
+$GLOBALS['LS_PPOLICY_INFO_EXPORT_EXTRA_ATTRS'] = array();
+LS_PPOLICY_DEFAULT_DN
Constante définissant le DN de la politique par défaut. Si aucune politique par défaut n'est
+définie, ce paramètre doit valoir null.
LS_PPOLICY_WARNING_EXPIRATION_THRESHOLD
Constante définissant le seuil d'alerte pour l'expiration des mots de passe (en seconde). Par +défaut : 7 jours.
+LS_PPOLICY_CRITICAL_EXPIRATION_THRESHOLD
Constante définissant le seuil critique pour l'expiration des mots de passe (en seconde). Par +défaut : 2 jours.
+LS_PPOLICY_CSV_DELIMITER
Constante définissant le caractère utilisé lors de la génération de l'export CSV comme séparateur +de champ. Par défaut : un point-virgule.
+LS_PPOLICY_CSV_ENCLOSURE
Constante définissant le caractère utilisé lors de la génération de l'export CSV pour +l'encadrement des champs. Par défaut : un guillemet double.
+LS_PPOLICY_CSV_ESCAPE_CHAR
Constante définissant le caractère utilisé lors de la génération de l'export CSV pour +l'échappement des champs. Par défaut : une barre oblique inverse.
+$GLOBALS['LS_PPOLICY_API_GRANTED_PROFILES']
Tableau global listant les LSprofiles
+autorisés à utiliser la méthode d'API exportPpolicyInfo.
$GLOBALS['LS_PPOLICY_INFO_EXPORT_EXTRA_ATTRS']
Tableau global listant les attributs supplémentaires à inclure lors de l'export des informations +de politique de mots de passe.
+Cet LSaddon fourni une page affichant les informations utiles
+pour l'équipe assurant le support de l'application. Cette page est accessible à l'adresse
+addon/showSupportInfo/showMySupportInfo. Elle compile (et permet de télécharger) l'ensemble des
+informations utiles à l'appréciation du contexte d'accès à l'application par l'utilisateur.
Cette page est accessible par tous les utilisateurs connectés à l'application. Cependant, par
+défaut, il n'y a aucun lien d'accès à celle-ci. Il est possible d'ajouter un lien d'accès dans le
+menu et modifiant la valeur de la constante SHOW_SUPPORT_INFO_IN_MENU à True.
Une fonction showMySupportInfo() est également fournie et peut-être utilisée comme
+customActions. Elle redirigera alors l'utilisateur
+vers cette page. Ci-dessous, vous trouverez un exemple de configuration de la fonction
+showMySupportInfo() comme customActions :
$GLOBALS['LSobjects']['LSpeople'] = array (
+ [...]
+ 'customActions' => array (
+ 'showMySupportInfo' => array (
+ 'function' => 'showMySupportInfo',
+ 'label' => 'Show my support information',
+ 'hideLabel' => True,
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'icon' => 'terminal',
+ 'rights' => array (
+ 'self'
+ ),
+ ),
+ ),
+ [...]
+);
+Note
+Le label et l'icône fournis dans cet exemple sont traduits et délivrés avec LdapSaisie.
+Cet LSaddon fournie une fonction du même nom pouvant être +utilisée comme customActions et permettant d'afficher +les informations techniques d'un objet de l'annuaire.
+Ci-dessous, vous trouverez un exemple de configuration de la fonction showTechInfo() comme
+customActions :
$GLOBALS['LSobjects']['LSpeople'] = array (
+ [...]
+ 'customActions' => array (
+ 'showTechInfo' => array (
+ 'function' => 'showTechInfo',
+ 'label' => 'Show technical information',
+ 'hideLabel' => True,
+ 'noConfirmation' => true,
+ 'disableOnSuccessMsg' => true,
+ 'icon' => 'tech_info',
+ 'rights' => array (
+ 'admin'
+ ),
+ ),
+ ),
+ [...]
+);
+Note
+Le label et l'icône fournis dans cet exemple sont traduits et délivrés avec LdapSaisie.
+Cette partie décrit la manière de configurer les méthodes d'authentification d'LdapSaisie appelée
+LSauthMethod). Ces librairies peuvent avoir un fichier de configuration et il sera alors stocké dans
+le dossier conf/LSauth/.
Cette LSauthMethod est utilisée pour gérer
+l'authentification automatique des utilisateurs arrivant (équivalent à un mode anonyme). Cette
+librairie doit être configurée en éditant le fichier de configuration
+conf/LSauth/config.LSauthMethod_anonymous.php et notament en définissant la constante
+LSAUTHMETHOD_ANONYMOUS_USER contenant le login d'un utilisateur dont les droits d'accès seront
+endossés par tout les personnes utilisant LdapSaisie.
Cette LSauthMethod est utilisée pour gérer
+l'authentification via un service SSO CAS. Cette librairie doit être configurée en éditant le
+fichier de configuration conf/LSauth/config.LSauthMethod_CAS.php.
Structure du fichier :
+/*
+ *****************************************************
+ * Configuration of the CAS authentification support *
+ *****************************************************
+ */
+
+// phpCAS Path (http://www.ja-sig.org/wiki/display/CASC/phpCAS)
+define('PHP_CAS_PATH','/usr/share/php/CAS.php');
+
+// phpCAS Debug File
+// define('PHP_CAS_DEBUG_FILE','/tmp/phpCAS.log');
+
+// Disable logout
+define('LSAUTH_CAS_DISABLE_LOGOUT',false);
+
+// CAS Server version (used constant name know by phpCAS : CAS_VERSION_1_0 or CAS_VERSION_2_0)
+define('LSAUTH_CAS_VERSION','CAS_VERSION_2_0');
+
+// CAS Server hostname
+define('LSAUTH_CAS_SERVER_HOSTNAME','cas.univ.fr');
+
+// CAS Server port
+define('LSAUTH_CAS_SERVER_PORT',443);
+
+// CAS Server URI (empty by default)
+// define('LSAUTH_CAS_SERVER_URI','cas/');
+
+// No SSL validation for the CAS server
+define('LSAUTH_CAS_SERVER_NO_SSL_VALIDATION',false);
+
+// CAS server SSL CA Certificate path
+//define('LSAUTH_CAS_SERVER_SSL_CACERT','');
+PHP_CAS_PATH
Le chemin d'accès du fichier CAS.php de la librairie
+phpCAS. Le chemin d'exemple correspond au chemin
+résultant d'une installation via PEAR sur une Debian (Lenny).
PHP_CAS_DEBUG_FILE
Chemin du fichier de log de la librairie phpCAS. +Commenter la ligne pour désactiver les logs.
+LSAUTH_CAS_DISABLE_LOGOUT
Booléen définissant si l'utilisateur peut se déconnecter du serveur CAS depuis l'interface.
+Note
+Remarque : l'appel de l'URL de déconnexion via une requête GET supprimera la session PHP et
+donc la session LdapSaisie sans déconnecter pour autant l'utilisateur au niveau du serveur
+CAS. Cela peut donc permettre de gérer la déconnexion automatique au niveau d'LdapSaisie suite
+à une déconnexion au niveau du CAS à traver le concepte de Global Logout.
LSAUTH_CAS_VERSION
Nom de la constant phpCAS permettant de définir
+la version CAS du serveur. Actuellement, la librairie
+phpCAS ne reconnait que la constante
+CAS_VERSION_1_0 pour la version 1 de CAS ou la constante CAS_VERSION_2_0 pour la version 2 de
+CAS.
Note
+Remarque : Des tests on montrés que l'utilisation d'une compatibilité CAS version 2 peut +également fonctionner sur un version 3 du serveur CAS.
+LSAUTH_CAS_SERVER_HOSTNAME
Le nom d'hôte du serveur CAS.
+LSAUTH_CAS_SERVER_PORT
Le port d'écoute du serveur CAS.
+LSAUTH_CAS_SERVER_URI
Le dossier HTTP dans lequel se trouve le service CAS. Exemple : Pour un service CAS accessible via
+l'URL https://cas.univ.fr/cas/, la constante devra valoir cas/.
LSAUTH_CAS_SERVER_NO_SSL_VALIDATION
Booléen permettant de désactiver la validation du certificat SSL du serveur CAS lors des requêtes +de validation des tickets CAS.
+LSAUTH_CAS_SERVER_SSL_CACERT
Chemin d'accès du fichier contenant le certificat SSL de la CA du serveur CAS au format PEM. +Commenter la ligne pour désactiver ce paramètre.
+Cette LSauthMethod est utilisée pour gérer +l'authentification via les variables d'environnements définies suite à une authentification, +potentiellement déléguée au serveur web.
+Cette méthode récupère dans l'environment d'exécution PHP, le nom d'utilisateur et le mot de passe +de l'utilisateur connecté. À partir du nom d'utilisateur, une recherche dans l'annuaire sera +effectuée pour trouver l'utilisateur correspondant. L'authentification sera réussie uniquement si un +et un seul utilisateur est retourné par la recherche et si une authentification auprès de l'annuaire +LDAP réussie à l'aide du DN de l'objet LDAP trouvé et du mot de passe fourni.
+Note
+En cas d'authentification déléguée au serveur web, il est possible de désactiver la vérification
+du mot de passe via le paramètre LSAUTHMETHOD_HTTP_TRUST_WITHOUT_PASSWORD_CHALLENGE
+(voir ci-dessous).
Les variables d'environnements utilisées pour authentifier l'utilisateur connecté dépendent de la
+méthode configurée via la constante LSAUTHMETHOD_HTTP_METHOD (voir ci-dessous). Si ces variables
+ne sont pas disponibles, une erreur HTTP 403 sera générée pour réclamer une authentification à
+l'utilisateur.
Note
+Cette LSauthMethod supporte le mode API et il s'agit +de la méthode utilisée par défaut dans ce mode.
+Cette librairie peut être configurée en éditant le fichier de configuration
+conf/LSauth/config.LSauthMethod_HTTP.php.
Structure du fichier :
+/*
+ *****************************************************
+ * Configuration of the HTTP authentification support *
+ *****************************************************
+ */
+
+// Don't check HTTP server's login/password by LDAP authentication challenge
+//define('LSAUTHMETHOD_HTTP_TRUST_WITHOUT_PASSWORD_CHALLENGE',true);
+
+// Authentication realm (API mode only)
+//define('LSAUTHMETHOD_HTTP_API_REALM', ___('LdapSaisie API - Authentication required'));
+LSAUTHMETHOD_HTTP_TRUST_WITHOUT_PASSWORD_CHALLENGE
Permet de désactiver le test d'authentification auprès de l'annuaire LDAP. Pour cela, cette
+constante doit être définie et valoir True.
LSAUTHMETHOD_HTTP_METHOD
Permet de définir la méthode utilisée par le serveur web pour passer à PHP +l'identifiant de l'utilisateur connecté et son mot de passe.
+Cette constance peut pendre les valeurs suivantes :
+PHP_PASS
Dans cette méthode, le serveur web défini les variables d'environnement PHP_AUTH_USER et
+PHP_AUTH_PW. Cette méthode est la méthode par défaut et convient en cas d'utilisation de
+mod_php.
REMOTE_USER
Dans cette méthode, le serveur web défini la variable d'environnement REMOTE_USER. Cette
+variable ne contient que l'identifiant de l'utilisateur connecté. Cette méthode ne peut donc
+être utilisée que conjointement avec l'activation du paramètre
+LSAUTHMETHOD_HTTP_TRUST_WITHOUT_PASSWORD_CHALLENGE.
AUTHORIZATION
Dans cette méthode, le serveur web passe le contenu de l'entête HTTP Authorization dans la
+variable d'environnement HTTP_AUTHORIZATION. Cette méthode convient en cas d'utilisation de
+PHP en mode CGI ou encore via PHP-FPM.
Pour utiliser cette méthode, il faudra adapter la configuration du serveur web. Par exemple,
+pour Apache HTTPd, vous pouvez utiliser le module rewrite et la règle de réécriture suivante :
LSAUTHMETHOD_HTTP_LOGOUT_REMOTE_URL
URL de déconnexion externe, utile par exemple dans le contexte d'une connexion via un service SSO. +L'utilisateur sera automatiquement redirigé vers cette URL après sa déconnexion effective au +niveau d'LdapSaisie.
+Note
+Si cette URL de déconnexion n'est pas défini, le bouton de déconnexion sera masqué.
+LSAUTHMETHOD_HTTP_REALM
Domaine d'authentification (reaml) utilisé pour réclamer l'authentification de l'utilisateur
+(facultatif).
Note
+Pour que le message soit traduit, utilisez la fonction ___() (voir exemple).
Depuis la version 4.0, LdapSaisie offre une API visant à permettre de faire les mêmes choses que ce +qu'il est possible d'accomplir via l'interface web. L'idée n'est bien entendue pas de se substituer +systématiquement à la possibilité de se connecter directement à l'annuaire, mais plutôt d'offrir une +API web pour l'intégration d'outil préférant ce mode d'interaction, ou encore, pour exposer des +méthodes accès aux données de l'annuaire tout en profitant des logiques métiers +implémentées/configurées dans LdapSaisie : validation syntaxique et d'unicité, règle de génération +et d'interdépendances des attributs, déclencheurs, ...
+Note
+Cette API est actuellement dans une phase de test et n'offre pas encore toutes les +fonctionnalités proposées dans l'interface web. Elle est vouée à évoluer pour intégrer petit à +petit un maximum de fonctionnalités. Des contributions à ce sujet seront plus qu'appréciée !
+L'authentification à l'API utilise le même composant LSauth que lors d'une authentification à
+l'interface web, cependant, ce composant s'adapte pour prendre en compte de mode de connexion. Par
+défaut, la méthode d'authentification utilisée sera
+LSauthMethod_HTTP et permettra de se
+connecter en spécifiant le nom d'utilisateur et le mot de l'utilisateur cherchant à se connecter via
+une authentification basique HTTP.
Warning
+Il est à noter que tous les types d'utilisateur ne peuvent pas forcément utiliser l'API : le
+paramètre api_access doit être explicitement positionné à True dans
+la configuration du serveur LDAP.
Une fois connecté, l'utilisateur endossera les droits associés à ses +LSprofiles, tout comme un utilisateur +connecté à l'interface web.
+Les URLs des méthodes de l'API ont été construites par mimétisme sur celle de l'interface web et
+sous la racine web api/. Par ailleurs, un numéro de version d'API a été insérée dans chacune
+d'elles afin d'anticiper toutes évolutions futures majeures nécéssitants de conserver une
+rétrocompatibilité avec les anciennes versions de l'API.
Toutes les méthodes retournent des informations au format JSON et accepte le paramètre pretty
+permettant d'obtenir un retour plus facilement lisible. Les chaines de caractères échangées doivent
+par ailleurs être encodées en UTF-8. On trouvera par ailleurs dans le retour JSON :
success
Booléen précisant si l'action demandée a correctement été exécutée.
+messages
Ce tableau pourra être présent et lister les messages d'informations générées par l'action +demandée. Il s'agira des mêmes messages que ceux affichés dans l'interface web lorsque les +actions équivalentes y sont faites.
+errors
+ Ce tableau pourra être présent et lister les messages d'erreurs générées par l'action demandée.Note
+Les messages d'informations et d'erreurs générées par l'application sont traduites dans la
+langue courante qui peut être spécifiée via le paramètre lang accepté par toutes les méthodes
+(exemple : fr_FR ou en_US).
Lorsqu'une méthode cible un type d'objets, voir un objet en particulier, ces informations seront +transmises dans l'URL appelée. Si le type d'objet ou l'objet demandé est introuvable, une erreur +HTTP 404 sera générée.
+Important
+Sauf précision contraire, toutes les méthodes exposées sont accessibles uniquement via les
+méthodes HTTP GET ou POST. L'accès via une autre méthode retournera une erreur 404.
/api/1.0/object/[object type]
Cette méthode permet de rechercher/lister les informations d'un type d'objets de l'annuaire en +particulier. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence. Par +mimétisme du comportement de l'interface web, la recherche est paginée et accepte des paramètres +similaires en plus de paramètre plus appropriés à un fonctionnement programmatique :
+filter
Permet de spécifier un filtre de recherche LDAP personnalisé. Celui-ci sera combiné avec les
+paramètres propres au type d'objets recherchés et aux autres paramètres spécifiés (pattern
+par exemple).
Warning
+Du fait d'une limitation de la classe Net_LDAP2_Filter utilisée pour analyser le
+filtre passé en paramètre, seuls les filtres simples du type (attribut=valeur) sont
+acceptés ici. Pour les mêmes raisons, il est important que le filtre spécifié soit
+toujours entourné de paranthèses.
predefinedFilter
Permet de spécifier un des filtres de recherche LDAP prédéfinis dans la configuration du +type d'objet.
+pattern
Permet de spécifier un mot clé de recherche, comme proposé dans l'interface web.
+approx
Booléen permettant d'activer/désactiver la recherche approximative sur le mot clé. Les
+valeurs acceptées sont 1 ou 0.
basedn
Permet de spécifier une base de recherche personnalisé pour la recherche.
+subDn
Dans le cas d'un serveur LDAP configuré avec des +sous-niveaux de connexion, permet de +spécifier le sous-niveau pour la recherche.
+scope
Permet de spécifier l'étendue de la recherche dans l'annuaire. Valeurs acceptées: sub,
+one et base.
recursive
Booléen permettant d'activer/désactiver la recherche recursive, c'est à dire une recherche à
+la racine de l'annuaire (ou du
+sous-niveau de connexion) avec une
+étendue de recherche maximale. Les valeurs acceptées sont 1 ou 0.
displayFormat
Permet de spécifier un LSformat personnalisé +pour le nom des objets dans le résultat de recherche.
+extraDisplayedColumns
Booléen permettant d'activer le retour des colonnes personnalisées dans le résultat de
+recherche. Les valeurs acceptées sont 1 ou 0.
attributes
Liste des attributs supplémentaires que devra retourner la recherche.
+attributesDetails
Permet d'obtenir les détails sur les valeurs des attributs (au lieu des valeurs au format +attendu en cas de création/modification de l'objet). Seul la présence de ce paramètre suffit +à activer ce comportement, sa valeur n'a pas d'importance.
+sortBy
Permet de préciser sur quelle information le résultat de recherche doit être trié. Valeurs
+acceptées : displayName, subDn ou un des noms des colonnes personnalisées.
sortDirection
Permet de préciser l'ordre de tri du résultat de recherche. Valeurs acceptées : ASC (A-Z)
+ou DESC (Z-A).
page
Permet de préciser la page du résultat de recherche.
+nbObjectsByPage
Permet de préciser le nombre maximum d'objets retournés par page du résultat de recherche.
+all
Permet de réclamer le résultat complet de la recherche (désactivation de la pagination). +Seul la présence de ce paramètre suffit à activer ce comportement, sa valeur n'a pas +d'importance.
+as_list
Permet de réclamer un résultat de recherche dans lequel, la clé objects sera une liste et
+non un dictionnaire. Dans ce cas, le DN de l'objet est fourni dans la clé dn des détails
+des objets. Seul la présence de ce paramètre suffit à activer ce comportement, sa valeur n'a pas
+d'importance.
withoutCache
Booléen permettant de désactiver l'utilisation du cache. Les valeurs acceptées sont 1 ou
+0.
keepParamsBetweenSearches
Booléen permettant d'activer/désactiver le stockage en session des paramètres de recherche
+(optionnel, par défaut : False). Les valeurs acceptées sont 1 ou 0.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople?extraDisplayedColumns=1&pretty'
+{
+ "success": true,
+ "objects": {
+ "uid=hmartin,ou=people,o=ls": {
+ "name": "Henri MARTIN",
+ "Mail": "henri.martin@ls.com"
+ },
+ "uid=s.ldapsaisie,ou=people,o=ls": {
+ "name": "Secretariat LdapSaisie",
+ "Mail": "secretariat@ldapsaisie.biz"
+ },
+ "uid=ls,ou=people,o=ls": {
+ "name": "LdapSaisie",
+ "Mail": "ldap.saisie@ls.com"
+ },
+ "uid=erwpa,ou=people,o=ls": {
+ "name": "Erwan PAGE",
+ "Mail": "erwan.page@ldapsaisie.biz"
+ },
+ "uid=user2,ou=people,ou=company1,ou=companies,o=ls": {
+ "name": "prenom2 nom2",
+ "Mail": "user2@ls.com"
+ }
+ },
+ "total": 14,
+ "params": {
+ "keepParamsBetweenSearches": false,
+ "filter": null,
+ "pattern": null,
+ "predefinedFilter": false,
+ "basedn": null,
+ "scope": null,
+ "sizelimit": 0,
+ "attronly": false,
+ "approx": false,
+ "recursive": true,
+ "attributes": [],
+ "onlyAccessible": true,
+ "sortDirection": null,
+ "sortBy": null,
+ "sortlimit": 0,
+ "displayFormat": "%{cn}",
+ "nbObjectsByPage": 25,
+ "withoutCache": false,
+ "extraDisplayedColumns": true
+ },
+ "page": 1,
+ "nbPages": 3
+}
+/api/1.0/object/[object type]/[dn]
Cette méthode permet de récupérer les informations d'un objet de l'annuaire au format JSON. Le
+type de l'objet et son DN sont précisés dans l'URL et doivent être encodés en conséquence. Par
+défaut, les valeurs des attributs retournées sont au format tel qu'attendu en cas de
+création/modification de l'objet. Il est cependant possible d'ajouter le paramètre details
+afin d'obtenir des informations complémentaires sur les valeurs des attributs.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=hmartin,ou=people,o=ls?pretty'
+{
+ "success": true,
+ "dn": "uid=hmartin,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Henri MARTIN",
+ "details": false,
+ "attributes": {
+ "uid": "hmartin",
+ "givenName": "Henri",
+ "sn": "MARTIN",
+ "cn": "Henri MARTIN",
+ "mail": "henri.martin@ls.com",
+ "personalTitle": "M.",
+ "description": [],
+ "jpegPhoto": null,
+ "lsGodfatherDn": [
+ "uid=eeggs,ou=people,o=ls"
+ ],
+ "uidNumber": "101022",
+ "gidNumber": "102001",
+ "loginShell": "no",
+ "homeDirectory": "\/home\/com",
+ "gecos": null,
+ "shadowExpire": null,
+ "shadowMax": null,
+ "shadowInactive": null,
+ "shadowLastChange": null,
+ "sambaSID": "S-1-5-21-2421470416-3566881284-3047381809-203044",
+ "sambaPrimaryGroupSID": "S-1-5-21-2421470416-3566881284-3047381809-205003",
+ "sambaAcctFlags": [
+ "U"
+ ],
+ "sambaHomeDrive": null,
+ "sambaHomePath": null,
+ "sambaProfilePath": null,
+ "sambaLogonScript": null,
+ "sambaLogonTime": null,
+ "sambaLogoffTime": null,
+ "sambaKickoffTime": null,
+ "sambaPwdLastSet": null,
+ "sambaPwdMustChange": null,
+ "sambaPwdCanChange": null
+ },
+ "relations": {
+ "groups": {
+ "cn=direction,ou=groups,o=ls": "direction",
+ "cn=secretariat,ou=groups,o=ls": "secretariat"
+ },
+ "godfather": []
+ }
+}
+/api/1.0/object/[object type]/create
Cette méthode permet de créer un objet dans l'annuaire. Le type de l'objet qui sera créé est
+précisé dans l'URL et doit être encodé en conséquence. Les informations de l'objet doivent est
+transmises au format x-www-form-urlencoded. Elles peuvent également être au format
+multipart/form-data, en particulier si votre requête contient une image. Par mimétisme avec
+l'interface web, seuls les attributs prévus dans le formulaire de création du type d'objet
+peuvent être passées ici. De la même manière, les attributs non-spécifiés ici, pouront être
+auto-générés en accord avec leur configuration et la requête sera acceptée uniquement si tous
+les attributs obligatoires y sont spécifiés ou s'ils peuvent être auto-générés.
Le format et la syntaxe des valeurs des attributs dépends de leur type HTML. Ainsi, par exemple,
+un attribut de type HTML boolean acceptera comme valeurs possibles yes ou no. Pour plus
+de détails sur le type de valeur acceptée par un type d'attribut HTML en particulier, consultez
+sa documentation. Vous pouvez également analyser le code de la méthode getPostData() de la
+classe PHP correspondante.
Si l'application détecte un souci avec les informations transmises pour les attributs, un
+tableau fields_errors sera présent dans la réponse JSON et contiendra pour chacun des
+attributs problématique, un tableau des messages d'erreurs générées par l'application.
Si le type d'objet en prévoit, vous pouvez également utiliser un
+masque de saisie via le
+paramètre dataEntryForm.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/create?pretty' -d "uid=foo.bar&personalTitle=M.&givenName=foo&sn=bar&cn=Foo Bar&mail=foo.bar@example.com&userPassword=Y0urS3cr3t&lsGodfatherDn[]=uid=admin,ou=people,o=ls&gidNumber=70000"
+{
+ "success": true,
+ "type": "LSpeople",
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "name": "Foo Bar",
+ "messages": [
+ "Le mail de notification a \u00e9t\u00e9 envoy\u00e9.",
+ "L'objet a \u00e9t\u00e9 ajout\u00e9."
+ ]
+}
+/api/1.0/object/[object type]/[dn]/modify
Cette méthode permet de modifier un objet dans l'annuaire. Le type de l'objet et son DN sont
+précisés dans l'URL et doivent être encodés en conséquence. Les informations de l'objet à
+modifier doivent être transmises au même format que pour la méthode create (voir ci-dessus).
+Comme pour cette dernière, seuls les attributs prévus dans le formulaire de modification du type
+d'objet peuvent être passées ici et la réponse JSON pourra contenir un tableau fields_errors
+contenant les erreurs générées par l'application au sujet des valeurs transmises pour les
+attributs.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/modify?pretty' -d "givenName=foo&sn=bar&cn=Foo Bar"
+{
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Foo Bar",
+ "success": true,
+ "messages": [
+ "L'objet a bien \u00e9t\u00e9 modifi\u00e9."
+ ]
+}
+/api/1.0/object/[object type]/[dn]/remove
Cette méthode permet de supprimer un objet dans l'annuaire. Le type de l'objet et son DN sont +précisés dans l'URL et doivent être encodés en conséquence.
+Exemple :
+ +/api/1.0/object/[object type]/[dn]/customAction/[customAction]
Cette méthode permet d'exécuter une action personnalisée sur +un objet dans l'annuaire. Le nom de l'action ainsi que le type de l'objet et son DN sont précisés +dans l'URL et doivent être encodés en conséquence.
+Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/customAction/action?pretty'
+{
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Foo Bar",
+ "success": true,
+ "messages": [
+ "L'action personnalis\u00e9e action a \u00e9t\u00e9 correctement ex\u00e9cut\u00e9e sur Foo Bar.",
+ ]
+}
+Note
+Par défaut, une action personnalisée ne retourne qu'un booléen permettant de savoir si +l'action a correctement été exécutée ou non. En outre, dans un contexte d'appel via l'API, il +est possible de retourner des informations via un tableau associatif dont le contenu sera +fusionné avec les données retournées par la requête. Pour plus d'informations à ce sujet, +consultez la documentation sur l'écriture d'une fonction implémentant une customAction.
+/api/1.0/object/[object type]/import
Cette méthode permet d'importer des objets d'un type en particulier à partir de données d'import +formatées selon un ioFormat configuré pour ce type +d'objets. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence. Par +mimétisme du comportement de l'interface web, cette méthode accepte des paramètres similaires et +s'attend à récupérer les données d'import dans le corps de la requête.
+ioFormat
Le nom de l'ioFormatdes données d'import.
+updateIfExists
Booléen permettant d'activer/désactiver la mise à jour des données des objets s'ils existent
+déjà. Si ce mode est inactif et qu'un objet des données d'import existe déjà, une erreur
+sera remontée. Les valeurs acceptées sont 1 ou 0.
justTry
Booléen permettant d'activer/désactiver le mode de vérification des données d'import
+uniquement. Si ce mode est actif, les données d'import seront analysées pour vérifier
+qu'elles sont correctes, mais l'import en lui-même ne sera pas effectué. Les valeurs
+acceptées sont 1 ou 0.
Note
+Le retour de cette méthode en mode justTry est identique à une exécution en mode
+normal. Ce mode permet donc d'anticiper le résultat d'un import à partir d'un jeu de
+données sources.
Warning
+En mode justTry, seul la vérification syntaxique des données est fiable, car les
+informations doublonnées au sein des données d'import ne pourront être détectées.
En cas d'erreurs détectées dans les informations des objets des données d'import, le tableau
+errors du retour de la méthode contiendra une entrée pour chaque objet en erreur sous le
+format d'un dictionnaire dont la clé data reprendra les informations de l'objet telle que
+chargé (ou générée) depuis les données sources, ainsi qu'un dictionnaire sous la clé errors
+qui contiendra les erreurs globales concernant l'objet sous la clé globals et les erreurs
+propres à ses attributs dans un dictionnaire sous la clé attrs.
Note
+Les erreurs d'importation sur un objet sont non-bloquantes : l'importation des autres objets +ne sera pas interrompue.
+Exemple :
+# curl -u username:secret --data-binary @/path/to/input.file 'https://ldapsaisie/api/1.0/object/LSpeople/import?ioFormat=mycsv&pretty'
+{
+ "success": false,
+ "LSobject": "LSpeople",
+ "ioFormat": "mycsv",
+ "updateIfExists": false,
+ "justTry": false,
+ "imported": {
+ "uid=rturin,ou=people,o=ls": "M. Roger TURIN"
+ },
+ "updated": [],
+ "errors": [
+ {
+ "data": {
+ "uid": [
+ "lmartin"
+ ],
+ "personalTitle": [
+ "Mme"
+ ],
+ "givenName": [
+ "Ludivine"
+ ],
+ "sn": [
+ "MARTIN"
+ ],
+ "mail": [
+ "lmartin@gmail.com"
+ ],
+ "userPassword": [
+ "123Yh%uT"
+ ],
+ "gidNumber": [
+ "102009"
+ ],
+ "loginShell": [
+ "no"
+ ],
+ "cn": [
+ "Mme Ludivine MARTIN"
+ ]
+ },
+ "errors": {
+ "globals": [
+ "Un objet existe d\u00e9j\u00e0 dans l'annuaire LDAP avec le DN uid=lmartin,ou=people,o=ls."
+ ],
+ "attrs": []
+ }
+ }
+ ],
+ "messages": [
+ "Le mail de notification a \u00e9t\u00e9 envoy\u00e9."
+ ]
+}
+/api/1.0/object/[object type]/export
Cette méthode permet d'exporter les objets d'un type en particulier dans un +ioFormat configuré pour ce type d'objets. Le type de +l'objet est précisé dans l'URL et doit être encodé en conséquence.
+ioFormat
Le nom de l'ioFormat .
+En tant normal, le retour de cette méthode sera directement le fichier d'export demandé.
+Cependant, si une erreur survient, les paramètres d'export seront repris dans le retour JSON
+de la méthode qui contiendra également les erreurs survenues.
Exemple :
+# curl -u username:secret --data-binary @/path/to/input.file 'https://ldapsaisie/api/1.0/object/LSpeople/export?ioFormat=mycsv&pretty'
+login;civility;firstname;name;mail;password;gid;shell
+hmartin;M.;Henri;MARTIN;henri.martin@ls.com;********;102001;no
+s.ldapsaisie;M.;Secretariat;LdapSaisie;secretariat@ldapsaisie.biz;********;70000;no
+ls;M.;Ldap;Saisie;ldap.saisie@ls.com;********;102001;no
+erwpa;M.;Erwan;PAGEARD;erwan.page@ldapsaisie.biz;********;102009;no
+[...]
+/api/1.0/object/[object type]/[dn]/relation/[relation]
Cette méthode permet de gérer les objets en relation avec un objet en particulier de l'annuaire.
+Le type de l'objet, son DN et le nom de la relation sont précisés dans l'URL et doivent être
+encodés en conséquence. Cette méthode accepte les paramètres add et remove permettant de
+lister le ou les DN d'objet(s) à respectivement ajouter ou supprimer parmis les objets
+actuellement en relation avec l'objet spécifié. Si aucun DN n'est spécifié comme devant être
+ajouté ou supprimé, la méthode retournera simplement les DN des objets en relation. En cas de
+modification demandée, la méthode retournera la nouvelle liste des DNs des objets en relation,
+quel que soit le résultat de l'opération de mise à jour.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/relation/groups?pretty&add[]=cn=ls,ou=groups,o=ls&add[]=cn=invite,ou=groups,o=ls'
+{
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Foo Bar",
+ "relation": "groups",
+ "success": true,
+ "relatedObjects": [
+ "cn=ls,ou=groups,o=ls",
+ "cn=invite,ou=groups,o=ls"
+ ],
+ "messages": [
+ "Objects in relation updated."
+ ]
+}
+/api/1.0/search
Cette méthode permet d'effectuer une recherche sur plusieurs types d'objets de l'annuaire à la +fois. Par mimétisme du comportement de l'interface web, la recherche est paginée et accepte des +paramètres similaires en plus de paramètre plus appropriés à un fonctionnement programmatique.
+Les paramètres acceptés par cette méthode sont sensiblement les mêmes que ceux acceptés par la +méthode de recherche d'un type d'objet de l'annuaire en particulier et ils ne seront donc pas +tous redocumentés ici :
+filterpredefinedFilterpatternapproxbasednsubDnscoperecursivedisplayFormatextraDisplayedColumnsattributesattributesDetailspageallas_listwithoutCachekeepParamsBetweenSearchesnbObjectsByPage
Permet de préciser le nombre maximum d'objets retournés par type d'objet ET par page du résultat +de recherche.
+types
Permet de limiter les types d'objets à inclure dans le résultat de recherche. Par défaut, tous +les types d'objets auxquels l'utilisateur à accès et dont la recherche globale n'est pas +désactivée seront inclus.
+splited_result
Permet de faire en sorte que les objets inclus dans le résultat de recherche soient séparés par
+type dans des sous-clés de objects. Par défaut, tous les objets sont retournés dans la clé
+objects et une sous-clé type est ajouté à chacun d'eux pour les distinguer. Seul la présence
+de ce paramètre suffit à activer ce comportement, sa valeur n'a pas d'importance.
Important
+Pour chaque type d'objets inclus dans la recherche, un filtre et/ou un mot clé de recherche +doit être spécifié. Cette méthode n'a pas vocation à permettre de lister tous les objets de +l'annuaire.
+Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/search?pattern=LdapSaisie&pretty'
+{
+ "success": true,
+ "objects": {
+ "uid=s.ldapsaisie,ou=people,o=ls": {
+ "name": "Secretariat LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "secretariat@ldapsaisie.biz"
+ },
+ "uid=ls,ou=people,o=ls": {
+ "name": "LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "ldap.saisie@ls.com"
+ },
+ "uid=erwpa,ou=people,o=ls": {
+ "name": "Erwan PAGE",
+ "type": "LSpeople",
+ "Mail": "erwan.page@ldapsaisie.biz"
+ },
+ "uid=invite,ou=people,o=ls": {
+ "name": "Utilisateur de passage",
+ "type": "LSpeople",
+ "Mail": "invite@ldapsaisie.biz"
+ },
+ "uid=demo,ou=people,o=ls": {
+ "name": "Demonstration LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "demo@ls.com"
+ },
+ "uid=admin,ou=people,o=ls": {
+ "name": "Administration LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "admin@ls.com"
+ },
+ "uid=admin3,ou=people,o=ls": {
+ "name": "ZAdministration LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "admin@ls.com"
+ },
+ "uid=ldapsaisie,ou=sysaccounts,o=ls": {
+ "name": "ldapsaisie",
+ "type": "LSsysaccount"
+ }
+ },
+ "total": null,
+ "params": {
+ "keepParamsBetweenSearches": false,
+ "LSpeople": {
+ "filter": null,
+ "pattern": "LdapSaisie",
+ "predefinedFilter": false,
+ "basedn": null,
+ "scope": null,
+ "sizelimit": 0,
+ "attronly": false,
+ "approx": false,
+ "recursive": true,
+ "attributes": [],
+ "onlyAccessible": true,
+ "sortDirection": null,
+ "sortBy": null,
+ "sortlimit": 0,
+ "displayFormat": "%{cn}",
+ "nbObjectsByPage": 25,
+ "withoutCache": false,
+ "extraDisplayedColumns": true
+ },
+ "LSsysaccount": {
+ "filter": null,
+ "pattern": "LdapSaisie",
+ "predefinedFilter": false,
+ "basedn": null,
+ "scope": null,
+ "sizelimit": 0,
+ "attronly": false,
+ "approx": false,
+ "recursive": false,
+ "attributes": [],
+ "onlyAccessible": true,
+ "sortDirection": null,
+ "sortBy": null,
+ "sortlimit": 0,
+ "displayFormat": "%{uid}",
+ "nbObjectsByPage": 30,
+ "withoutCache": false,
+ "extraDisplayedColumns": true
+ }
+ },
+ "page": 1,
+ "nbPages": 1
+}
+Comme tout projet libre qui se respecte, les contributions à LdapSaisie sont les bienvenues. Ce +chapitre explique les possibilités de contribution.
Les LSaddons sont utilisés pour implémenter dans LdapSaisie +des fonctionnalités spécifiques tel que :
+generate_function) ;L'écriture d'un LSaddon doit respecter une structure +suffisamment souple afin de ne pas être un frein à vos contributions, tout en permettant d'assurer +la bonne intégration de votre contribution au projet. Le code que vous écrirez sera réparti dans +deux fichiers :
+conf/LSaddons/config.LSaddons.[addon name].php
Ce fichier contiendra la configuration de votre LSaddon. +On y retrouvera la déclaration de constances et/ou variables de configuration permettant d'adapter +votre LSaddon à une installation et à un environnement.
+includes/addons/LSaddons.[addon name].php
Ce fichier contiendra le code à proprement dit de votre LSaddon.
+Structure du fichier includes/addons/LSaddons.[addon name].php :
+<?php
+
+/*
+ * Error messages
+ */
+
+// Support error messages
+LSerror :: defineError('MYADDON_SUPPORT_01',
+ ___("MYADDON Support : Unable to load %{dep}.")
+);
+
+LSerror :: defineError('MYADDON_SUPPORT_02',
+ ___("MYADDON Support : The constant %{const} is not defined.")
+);
+
+// Other orror messages
+LSerror :: defineError('MYADDON_01',
+ ___("An error : %{msg}.")
+);
+
+LSerror :: defineError('MYADDON_02',
+ ___("An other error about %{about} : %{msg}")
+);
+
+LSerror :: defineError('MYADDON_03',
+ ___("Unknown error.")
+);
+
+/**
+ * Verify support of my addon by LdapSaisie
+ *
+ * @author My Name <my.email@example.com>
+ *
+ * @return boolean true if my addon is totaly supported, false in other cases
+ **/
+function LSaddon_myaddon_support() {
+
+ $retval=true;
+
+ // Check/load dependencies
+ if ( !class_exists('mylib') ) {
+ if ( !LSsession::includeFile(LS_LIB_DIR . 'class.mylib.php') ) {
+ LSerror :: addErrorCode('MYADDON_SUPPORT_01', 'mylib');
+ $retval=false;
+ }
+ }
+
+
+ $MUST_DEFINE_CONST= array(
+ 'LS_MYADDON_CONF_O1',
+ 'LS_MYADDON_CONF_O2',
+ ...
+ );
+
+ foreach($MUST_DEFINE_CONST as $const) {
+ if ( (!defined($const)) || (constant($const) == "")) {
+ LSerror :: addErrorCode('MYADDON_SUPPORT_02',$const);
+ $retval=false;
+ }
+ }
+
+ if ($retval) {
+ // Register LSaddon view using LSsession :: registerLSaddonView()
+
+ if (php_sapi_name() == 'cli') {
+ // Register LSaddon CLI command using LScli :: add_command()
+ }
+ }
+
+ return $retval;
+}
+
+/**
+ * My first function
+ *
+ * Description of this wonderfull function
+ *
+ * @author My Name <my.email@example.com>
+ *
+ * @return [type(s) of returned values (pipe separator)] Description of the return of this function
+ **/
+function myaddon_first_function($arg1, $arg2) {
+ // Do some stuff
+ if (something) {
+ LSerror :: addErrorCode(
+ 'MYADDON_01',
+ 'something went wrong' // Error LSformat unique argument
+ );
+ return false;
+ }
+
+ if (something else) {
+ LSerror :: addErrorCode(
+ 'MYADDON_02',
+ array( // Error LSformat arguments
+ 'about' => 'second step',
+ 'msg' => 'something went wrong'
+ )
+ );
+ return false;
+ }
+
+ if (still something else) {
+ LSerror :: addErrorCode('MYADDON_03'); // Error without argument
+ return false;
+ }
+ return true;
+}
+
+[...]
+
+// Defined custom CLI commands functions only on CLI context
+if (php_sapi_name() != 'cli')
+ return true; // Always return true to avoid some warning in log
+
+// Defined functions handling custom CLI commands and optionnaly
+// their arguments autocompleter functions.
+Par convention, la structure de ce fichier est toujours à peu près la même:
+LSerror :: defineError() qui attends en premier argument, l'identifiant du message
+ d'erreur et en tant que second argument, le
+ LSformat du message d'erreur. Par convention,
+ les identifiants des messages d'erreurs seront en majuscule et préfixés du nom du
+ LSaddon.On déclare ensuite une fonction LSaddon_[myaddon]_support qui sera exécutée lors du chargement
+ de l'addon et qui permettra de s'assurer du support de celui-ci. Cette fonction devra retourner
+ True si c'est le cas ou False dans le cas contraire.
Cette fonction s'assura notamment :
+Si notre addon offre des commandes CLI personnalisées, les
+ fonctions les implémentant ne seront définies, dans un souci de performance, que dans un contexte
+ ou elles seraient potentiellement appelables, c'est à dire dans un contexte d'exécution CLI.
+ Pour cela, nous utilisons communément la fonction php_sapi_name pour déterminer le contexte
+ d'exécution et si celui-ci vaut cli, nous stoppons l'exécution du reste du code du fichier via
+ un return true.
Note
+Il est important dans ce contexte de ne jamais retourner autre chose que True pour éviter
+tout message d'erreur inutile dans les logs.
Les LSaddons peuvent fournir des vues personnalisées qui +seront accessibles à tout ou parties des utilisateurs de l'application. Ce filtrage d'accès sera +fait en utilisant les LSprofiles de +l'utilisateur connecté sur la +racine courante de l'annuaire LDAP.
+Pour mettre en place une telle vue personnalisée, il est nécessaire de :
+LSaddon_[addon]_support de l'addon à l'aide de la méthode
+ LSsession :: registerLSaddonView() ;Pour implémenter une telle vue personnalisée, vous pouvez vous inspirer de l'exemple fourni +ci-dessous ou encore des vues fournies par les autres +LSaddons (par exemple, l'addon +exportSearchResultAsCSV).
+Structure du fichier includes/addons/LSaddons.[addon name].php :
+<?php
+function LSaddon_myaddon_support() {
+
+ $retval=true;
+
+ // Some check
+
+ if ($retval) {
+ $retval = LSsession :: registerLSaddonView(
+ 'myaddon', // addon name
+ 'myaddon_view', // addon view ID
+ __('MyAddon view'), // addon view label
+ 'myaddon_view', // callable (ex: function name) that implement addon view
+ array('user'), // array listing allowed LSprofiles
+ true // Show/hide this addon view in user menu
+ );
+ }
+
+ return $retval;
+}
+
+[...]
+
+/**
+ * My addon view handler function
+ *
+ * Description of this view
+ *
+ * @author My Name <my.email@example.com>
+ *
+ * @return void
+ **/
+function myaddon_view() {
+ // Do some stuff and set some template variables
+ $list = array ([...]);
+ LStemplate :: assign('list', $list);
+
+ // Load some CSS & JS files need on this view
+ LStemplate :: addCssFile('LSaddon_myadon.css');
+ LStemplate :: addJSscript('LSaddon_myadon.js');
+
+ // Set template file of the view
+ LSsession :: setTemplate('LSaddon_myadon_view.tpl');
+}
+Les LSaddons peuvent fournir des commandes CLI
+personnalisées qui seront accessibles via la commande ldapsaisie fournie avec l'application. Cela
+peut, par exemple, vous permettre de rendre accessible en ligne de commandes une procédure
+implémentée dans le code d'LdapSaisie et vous permettre de mettre en place une tâche planifiée
+exécutant cette procédure régulièrement.
Pour mettre en place une telle commande CLI personnalisée, il est nécessaire de :
+LSaddon_[addon]_support de l'addon
+ à l'aide de la méthode LScli::add_command() ;True ou False en cas de succès/d'erreur d'exécution de la commande. Cette valeur
+ de retour influencera le code retourné par la commande : 0 en cas de succès, 1 en cas
+ d'erreur.Pour vous aider dans l'écriture de vos méthodes CLI, la classe LScli offre des méthodes
+pour les tâches les plus courantes :
LScli::usage($error, ...$extra_args)
Affichage du message d'aide de votre commande avant arrêt. Un message d'erreur peut également
+être spécifié avec d'éventuels arguments supplémentaires pour le composer (via sprintf()). Si un
+message d'erreur est fourni, le code de retour de la commande sera 1 et à défaut, 0.
LScli::need_ldap_con()
Permet d'établir la connexion à l'annuaire LDAP (si ce n'est pas déjà fait).
+LScli::run_external_command($command, $data_stdin=null, $escape_command_args=true, $cwd=null) :
Permet d'exécuter une commande externe et de récupérer un tableau contenant le code de +retour de la commande exécutée, le contenu affiché sur la sortie standard et le contenu +affiché sur la sortie d'erreur.
+La commande à exécuter peut être passée sous la forme d'une chaîne de caractères ou d'un
+tableau de chaînes de caractères correspondant à la commande et ses arguments. Par défaut,
+les caractères spéciaux contenus dans les paramètres passés à la commande seront
+"échappés", mais il est possible de désactiver cela via le paramètre $escape_command_args.
Il est possible de fournir des données à passer à la commande via son entrée standard via
+le paramètre $data_stdin.
Enfin, il est possible de spécifier l'emplacement du dossier courant d'exécution de la
+commande via le paramètre $cwd.
LScli::confirm($question=null)
Permet de demander à l'utilisateur de confirmer quelque chose. La question à poser peut être
+passée en paramètre et cette méthode retournera true ou false en fonction du choix de
+l'utilisateur.
LScli::parse_arg_value($value, $custom_values=null)
Permet d'interpréter la valeur d'un argument fourni par l'utilisateur. Celui-ci pourra spécifier
+le type de l'argument en préfixant l'argument de son type entre crochets (exemple : [bool]1,
+types supportés : string, str, bool, boolean, int, integer, float, array) et à
+défaut, la valeur sera analysée comme une valeur JSON permettant de passer des paramètres
+complexes à vos méthodes (un tableau associatif arborescent par exemple).
Des valeurs particulières seront également analysées de manières prédéfinies si elles ne
+sont pas préfixées d'un type particulier. C'est le cas par défaut des chaînes de
+caractères true et false qui seront comprises comme des booléens et null qui sera
+compris comme la valeur NULL au sens PHP.
Vous pouvez également spécifier vos propres valeurs particulières via l'argument
+$custom_values sous la forme d'un tableau associatif dont les clés sont les valeurs
+particulières fournies par l'utilisateur et la valeur correspondante, la valeur au sens
+PHP.
Important : l'analyse des valeurs particulières sera faite en mettant
+en minuscule la valeur fournie par l'utilisateur. Il est donc important que vos
+valeurs particulières spécifiées via l'argument $custom_values soient toutes en
+minuscule.
Lors de la déclaration de votre commande CLI personnalisée à l'aide de la méthode
+LScli::add_command(), vous avez la possibilité de spécifier une fonction permettant
+l'autocomplétion des arguments acceptés par celle-ci.
Cette fonction recevra en paramètre :
+$command_args
Un tableau des arguments déjà reçus par la commande.
+$comp_word_num
Un entier indiquant le rang de l'argument que l'autocomplétion tente de compléter. Il peut
+s'agir du rang d'un paramètre déjà fourni et présent dans le tableau $command_args ou bien
+d'un rang supérieur aux nombres d'arguments déjà fournis à la commande et dans ce cas il s'agira
+d'autocompléter tous potentiels autres arguments que pourrait accepter cette commande.
$comp_word
Une chaîne de caractères correspondant à ce qu'a déjà saisi l'utilisateur de l'argument que l'on +tente d'autocompléter. Cette chaîne de caractères peut être vide ou non, en fonction de s'il +s'agit d'un nouvel argument à autocompléter ou non.
+$opts
Un tableau des potentiels arguments globaux acceptés par LScli dans le contexte actuel (par
+exemple, -d ou --debug pour l'activation du mode debug). La réponse de cette fonction devra
+inclure ces potentiels arguments si le contexte d'autocomplétion s'y prête (nouvel argument par
+exemple).
Pour finir, cette fonction devra retourner un tableau des potentielles valeurs que pourrait +prendre l'argument autocomplété. Si une unique proposition est faite à l'utilisateur, celle-ci +sera automatiquement proposée à l'utilisateur et à défaut, la liste des valeurs possibles lui +seront affichées.
+Note
+Pour vous aider dans l'écriture d'une telle méthode d'autocomplétion, des méthodes statiques
+sont fournies par la classe LScli pour les autocomplétions les plus courantes :
LScli::autocomplete_class_name() : Autocomplétion du nom d'une classe PHP.LScli::autocomplete_addon_name() : Autocomplétion du nom d'un
+ LSaddon.LScli::autocomplete_int() : Autocomplétion d'un nombre entier.LScli::autocomplete_LSobject_types() : Autocomplétion du nom d'un type
+ d'LSobject.LScli::autocomplete_LSobject_dn() : Autocomplétion du DN d'un type précis
+ d'LSobject de l'annuaire.LScli::autocomplete_LSobject_attr_name() : Autocomplétion du nom d'un attribut précis
+ pour un type d'LSobject de l'annuaire.LScli::autocomplete_LSobject_ioFormat() : Autocomplétion du nom d'un
+ ioFormat pour un type
+ d'LSobject de l'annuaire.LScli::autocomplete_LSform_name() : Autocomplétion du nom d'un formulaire de
+ l'application.Par ailleurs, la méthode LScli::autocomplete_opts() vous facilitera la construction de la
+liste des valeurs d'autocomplétion de l'argument courant en fonction de ce qui a déjà été
+saisi par l'utilisateur (paramètre $comp_word). Cette méthode s'occupera en l'occurrence de
+filtrer parmi toutes les valeurs contextuelles possibles, celles qui correspondent au préfixe
+fourni par l'utilisateur.
Pour implémenter une telle commande CLI personnalisée, vous pouvez vous inspirer de l'exemple +fourni ci-dessous ou encore des commandes CLI fournies par les autres +LSaddons ou classes PHP de l'application.
+Structure du fichier includes/addons/LSaddons.[addon name].php :
+<?php
+function LSaddon_myaddon_support() {
+
+ $retval=true;
+
+ # Some other checks need to verify your addon support
+
+ if ($retval) {
+ if (php_sapi_name() == 'cli') {
+ LScli::add_command(
+ # The CLI command name (required)
+ 'my_custom_cli_cmd',
+ # The CLI command handler (must be callable, required)
+ 'cli_my_custom_cli_cmd',
+ # A short description of what this command does (required)
+ 'My custom CLI command',
+ # A short list of commands available arguments show in usage message
+ # (optional, default: false)
+ '[arg1] [arg2] [...]',
+ # A long description of what this command does
+ # (optional, default: false)
+ 'This command permit to ...',
+ # Permit to define if this command need connection to LDAP server
+ # (optional, default: true)
+ true,
+ # Callable of the CLI command arguments autocompleter
+ # (optional, default: null)
+ 'cli_my_custom_cli_cmd_autocompleter',
+ # Allow override if a command already exists with the same name
+ # (optional, default: null)
+ true
+ );
+ }
+ }
+
+ return $retval;
+}
+
+[...]
+
+// Defined CLI commands functions only on CLI context
+if (php_sapi_name() != 'cli')
+ return true; // Always return true to avoid some warning in log
+
+/**
+ * My addon CLI command my_custom_cli_cmd handler function
+ *
+ * Description of this CLI command.
+ *
+ * @param array $command_args Command arguments
+ * - Positional arguments :
+ * - LSobject
+ * - dn
+ * - Optional arguments :
+ * - -f|--force : Force mode
+ *
+ * @author My Name <my.email@example.com>
+ *
+ * @return boolean True on success, false otherwise
+ **/
+function cli_my_custom_cli_cmd($command_args) {
+ $objType = null;
+ $dn = null;
+ $force_mode = false;
+ foreach ($command_args as $arg) {
+ if ($arg == '-f' || $arg == '--force')
+ $force_mode = true;
+ elseif (is_null($objType)) {
+ $objType = $arg;
+ }
+ elseif (is_null($dn)) {
+ $dn = $arg;
+ }
+ else
+ LScli::usage("Invalid $arg parameter.");
+ }
+
+ if (is_null($objType) || is_null($dn))
+ LScli::usage('You must provide LSobject type and DN.');
+
+ if (!LSsession::loadLSobject($objType))
+ return false;
+
+ $obj = new $objType();
+ if (!$obj->loadData($dn)) {
+ self::log_fatal("Fail to load object $dn data from LDAP");
+ return false;
+ }
+
+ // Do some stuff on loaded object
+ [...]
+
+ return true;
+}
+
+/**
+ * Args autocompleter for CLI my_custom_cli_cmd command
+ *
+ * @param array<string> $command_args List of already typed words of the command
+ * @param int $comp_word_num The command word number to autocomplete
+ * @param string $comp_word The command word to autocomplete
+ * @param array<string> $opts List of global available options
+ *
+ * @return array<string> List of available options for the word to autocomplete
+ **/
+public static function cli_my_custom_cli_cmd_autocompleter(
+ $command_args, $comp_word_num, $comp_word, $opts
+) {
+ $opts = array_merge($opts, array ('-f', '--force'));
+
+ // Handle positional args
+ $objType = null;
+ $objType_arg_num = null;
+ $dn = null;
+ $dn_arg_num = null;
+ for ($i=0; $i < count($command_args); $i++) {
+ if (!in_array($command_args[$i], $opts)) {
+ // If object type not defined
+ if (is_null($objType)) {
+ // Defined it
+ $objType = $command_args[$i];
+ LScli::unquote_word($objType);
+ $objType_arg_num = $i;
+
+ // Check object type exists
+ $objTypes = LScli::autocomplete_LSobject_types($objType);
+
+ // Load it if exist and not trying to complete it
+ if (in_array($objType, $objTypes) && $i != $comp_word_num) {
+ LSsession::loadLSobject($objType, false);
+ }
+ }
+ elseif (is_null($dn)) {
+ $dn = $command_args[$i];
+ LScli::unquote_word($dn);
+ $dn_arg_num = $i;
+ }
+ }
+ }
+
+ // If objType not already chosen (or currently autocomplete),
+ // add LSobject types to available options
+ if (!$objType || $objType_arg_num == $comp_word_num)
+ $opts = array_merge(
+ $opts,
+ LScli::autocomplete_LSobject_types($comp_word)
+ );
+
+ // If dn not already chosen (or currently autocomplete), try autocomplete it
+ elseif (!$dn || $dn_arg_num == $comp_word_num)
+ $opts = array_merge(
+ $opts,
+ LScli::autocomplete_LSobject_dn($objType, $comp_word)
+ );
+
+ return LScli::autocomplete_opts($opts, $comp_word);
+}
+Les LSformElements sont les types de champs de formulaire supportés par +l'application.
+Pour chaque type implémenté, on devra trouver :
+LSattr_html et devant s'appeler
+ LSattr_html_[nom du type d'attribut HTML]. Dans celle-ci, il devra être défini à minima la
+ variable de classe LSformElement_type permettant de référencer le type
+ d'LSformElement à utiliser ;Une classe PHP dérivée de la classe LSformElement et devant s'appeler
+ LSformElement_[nom du type d'LSformElement]. Cette classe implémentera tout ce qui concerne
+ l'affichage du champ dans le formulaire et le traitement d'une valeur retournée par ce dernier.
+ Cela concerne notamment les méthodes suivantes :
getDisplay()
Retourne les informations d'affichage du champ dans un formulaire sous la forme d'un tableau
+(implémentation obligatoire, pas de méthode par défaut). Il sera possible de s'appuyer sur la
+méthode getLabelInfos() permettant de générer et récupérer tout ce qui concerne le label du
+champ du formulaire. Il faudra cependant à minima fournir également la clé html dans le
+tableau retourné qui devra contenir le bout de code HTML correspondant au champ du formulaire.
+Communément, ce code HTML est généré en appelant la méthode fetchTemplate().
fetchTemplate()
Retourne le code HTML du champ dans le formulaire. L'implémentation de cette méthode est
+facultative et par défaut, cette méthode utilisera la variable de classe $template pour
+connaître le fichier de template à utiliser. Ce fichier de template permettra la génération de
+la liste de tous les champs associés à chacune des valeurs de l'attribut. Individuellement, le
+champ d'une des valeurs de l'attribut est généré à l'aide du fichier de template référencé dans
+la variable de class $fieldTemplate.
Note
+La variable de classe $fieldTemplate est également utilisée par la méthode
+LSformElement :: getEmptyField() qui sert à générer le code HTML d'un champ du formulaire
+pour une nouvelle valeur de l'attribut. Cette méthode est notamment utilisée lorsque l'on
+clique sur le bouton permettant d'ajouter une valeur à un champ du formulaire.
getPostData()
Récupère dans les données postées par le formulaire, celle concernant ce champ. Cette méthode +devra potentiellement traiter l'ensemble des valeurs de l'attribut envoyées par le formulaire +et les définir dans le tableau passé en référence en tant que premier argument, les valeurs de +l'attribut. L'implémentation de cette méthode est facultative et par défaut, un tableau de +valeurs portant le nom de l'attribut LDAP correspondant sera récupérée comme valeur de +l'attribut.
+Note
+Pour plus d'informations sur le rôle et fonctionnement de cette méthode, référer à la
+méthode par défaut, définie dans la classe PHP parente LSformElement.
setValueFromPostData()
Définit les valeurs de l'attribut à partir des données reçues du formulaire (et récupérées par
+la méthode getPostData). L'implémentation de cette méthode est facultative et par défaut,
+aucune transformation ne sera faites à cette étape sur les données récupérées depuis le
+formulaire. Implémenter cette méthode pourra cependant se révéler utile en cas de champs de
+formulaire complexe (attribut composite par exemple).
autocomplete_attr_values()
Génère de la liste des valeurs possibles de l'attribut dans un contexte CLI.
+Note
+Pour plus d'informations sur le rôle et fonctionnement de cette méthode, référer aux
+commentaires de la méthode par défaut, définie dans la classe PHP parente LSformElement.
+Vous pouvez également vous inspirer des exemples d'implémentations fournies avec les autres
+type d'LSformElement.
LSformElement.tpl est utilisé pour générer la structure de la liste des
+ champs correspondant aux différentes valeurs de l'attribut. Ce template utilise une variable
+ $fieldTemplate pour définir quel fichier template devra être utilisé pour générer le code HTML
+ de chaque champ associés à une valeur. C'est ce second fichier de template qui est en général à
+ fournir à minima avec votre LSformElement.Note
+Il peut être utile d'étendre un type d'LSformElement existant pour faciliter
+l'implémentation d'un nouveau type. Pour cela, vous devez utiliser l'héritage de classe PHP en
+faisant dériver vos nouvelles classes des classes du LSformElement dont vous
+vous inspirer, plutôt que les classes génériques. Vous pouvez prendre exemple sur le type
+d'LSformElement pre qui s'inspire du type textarea, ou encore du type
+url dérivé du type text.
Les LSformRules sont les règles syntaxiques applicables aux champs des formulaires.
+Ces règles serviront à s'assurer que les valeurs des champs récupérées des formulaires sont
+syntaxiquement correctes. Elles seront configurables via le paramètre check_data des attributs des
+LSobjects.
Pour chaque type implémenté, on trouvera une classe PHP dérivée de la classe LSformRule et devant
+s'appeler LSattr_rule_[nom du type]. Dans celle-ci, il devra être défini la méthode statique
+validate() qui implémentera le contrôle syntaxique. Cette méthode prendra en paramètres :
$value
La valeur à tester.
+$options
Un tableau des options définies dans la configuration pour ce contrôle syntaxique.
+$formElement
Une référence au champ du formulaire (objet LSformElement).
+Cette méthode devra retourner True ou False si la valeur testée est respectivement valide ou
+invalide. Elle pourra également déclencher une exception LSformRuleException qui lui permettra de
+donner des messages d'erreurs elle-même sur le(s) problème(s) detecté(s) durant l'analyse de la
+valeur passée. Le constructeur de ce type d'exception prend en tant que premier paramètre un tableau
+de messages d'erreurs (ou un simple message d'erreur) qui seront retournés à l'utilisateur.
Note
+Par défaut, les valeurs de l'attribut sont testées une à une via la méthode validate().
+Cependant, il est possible d'implémenter une méthode de validation pour toutes les valeurs de
+l'attribut en une seule fois en affectant la valeur false à la constante de classe
+validate_one_by_one. Dans ce cas, l'ensemble des valeurs de l'attribut seront passées via le
+paramètre $value à la méthode validate() (sous la forme d'un tableau). Cela pourra par
+exemple être utile pour implémenter une validation de la cohérence des valeurs les unes vis à
+vis des autres (unicité, nombre maximum de valeurs, …).
Depuis la version 4.0, LdapSaisie offre une API visant à permettre de faire les mêmes choses que ce +qu'il est possible d'accomplir via l'interface web. L'idée n'est bien entendue pas de se substituer +systématiquement à la possibilité de se connecter directement à l'annuaire, mais plutôt d'offrir une +API web pour l'intégration d'outil préférant ce mode d'interaction, ou encore, pour exposer des +méthodes accès aux données de l'annuaire tout en profitant des logiques métiers +implémentées/configurées dans LdapSaisie : validation syntaxique et d'unicité, règle de génération +et d'interdépendances des attributs, déclencheurs, ...
+Note
+Cette API est actuellement dans une phase de test et n'offre pas encore toutes les +fonctionnalités proposées dans l'interface web. Elle est vouée à évoluer pour intégrer petit à +petit un maximum de fonctionnalités. Des contributions à ce sujet seront plus qu'appréciée !
+L'authentification à l'API utilise le même composant LSauth que lors d'une authentification à
+l'interface web, cependant, ce composant s'adapte pour prendre en compte de mode de connexion. Par
+défaut, la méthode d'authentification utilisée sera
+LSauthMethod_HTTP et permettra de se
+connecter en spécifiant le nom d'utilisateur et le mot de l'utilisateur cherchant à se connecter via
+une authentification basique HTTP.
Warning
+Il est à noter que tous les types d'utilisateur ne peuvent pas forcément utiliser l'API : le
+paramètre api_access doit être explicitement positionné à True dans
+la configuration du serveur LDAP.
Une fois connecté, l'utilisateur endossera les droits associés à ses +LSprofiles, tout comme un utilisateur +connecté à l'interface web.
+Les URLs des méthodes de l'API ont été construites par mimétisme sur celle de l'interface web et
+sous la racine web api/. Par ailleurs, un numéro de version d'API a été insérée dans chacune
+d'elles afin d'anticiper toutes évolutions futures majeures nécéssitants de conserver une
+rétrocompatibilité avec les anciennes versions de l'API.
Toutes les méthodes retournent des informations au format JSON et accepte le paramètre pretty
+permettant d'obtenir un retour plus facilement lisible. Les chaines de caractères échangées doivent
+par ailleurs être encodées en UTF-8. On trouvera par ailleurs dans le retour JSON :
success
Booléen précisant si l'action demandée a correctement été exécutée.
+messages
Ce tableau pourra être présent et lister les messages d'informations générées par l'action +demandée. Il s'agira des mêmes messages que ceux affichés dans l'interface web lorsque les +actions équivalentes y sont faites.
+errors
+ Ce tableau pourra être présent et lister les messages d'erreurs générées par l'action demandée.Note
+Les messages d'informations et d'erreurs générées par l'application sont traduites dans la
+langue courante qui peut être spécifiée via le paramètre lang accepté par toutes les méthodes
+(exemple : fr_FR ou en_US).
Lorsqu'une méthode cible un type d'objets, voir un objet en particulier, ces informations seront +transmises dans l'URL appelée. Si le type d'objet ou l'objet demandé est introuvable, une erreur +HTTP 404 sera générée.
+Important
+Sauf précision contraire, toutes les méthodes exposées sont accessibles uniquement via les
+méthodes HTTP GET ou POST. L'accès via une autre méthode retournera une erreur 404.
/api/1.0/object/[object type]
Cette méthode permet de rechercher/lister les informations d'un type d'objets de l'annuaire en +particulier. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence. Par +mimétisme du comportement de l'interface web, la recherche est paginée et accepte des paramètres +similaires en plus de paramètre plus appropriés à un fonctionnement programmatique :
+filter
Permet de spécifier un filtre de recherche LDAP personnalisé. Celui-ci sera combiné avec les
+paramètres propres au type d'objets recherchés et aux autres paramètres spécifiés (pattern
+par exemple).
Warning
+Du fait d'une limitation de la classe Net_LDAP2_Filter utilisée pour analyser le
+filtre passé en paramètre, seuls les filtres simples du type (attribut=valeur) sont
+acceptés ici. Pour les mêmes raisons, il est important que le filtre spécifié soit
+toujours entourné de paranthèses.
predefinedFilter
Permet de spécifier un des filtres de recherche LDAP prédéfinis dans la configuration du +type d'objet.
+pattern
Permet de spécifier un mot clé de recherche, comme proposé dans l'interface web.
+approx
Booléen permettant d'activer/désactiver la recherche approximative sur le mot clé. Les
+valeurs acceptées sont 1 ou 0.
basedn
Permet de spécifier une base de recherche personnalisé pour la recherche.
+subDn
Dans le cas d'un serveur LDAP configuré avec des +sous-niveaux de connexion, permet de +spécifier le sous-niveau pour la recherche.
+scope
Permet de spécifier l'étendue de la recherche dans l'annuaire. Valeurs acceptées: sub,
+one et base.
recursive
Booléen permettant d'activer/désactiver la recherche recursive, c'est à dire une recherche à
+la racine de l'annuaire (ou du
+sous-niveau de connexion) avec une
+étendue de recherche maximale. Les valeurs acceptées sont 1 ou 0.
displayFormat
Permet de spécifier un LSformat personnalisé +pour le nom des objets dans le résultat de recherche.
+extraDisplayedColumns
Booléen permettant d'activer le retour des colonnes personnalisées dans le résultat de
+recherche. Les valeurs acceptées sont 1 ou 0.
attributes
Liste des attributs supplémentaires que devra retourner la recherche.
+attributesDetails
Permet d'obtenir les détails sur les valeurs des attributs (au lieu des valeurs au format +attendu en cas de création/modification de l'objet). Seul la présence de ce paramètre suffit +à activer ce comportement, sa valeur n'a pas d'importance.
+sortBy
Permet de préciser sur quelle information le résultat de recherche doit être trié. Valeurs
+acceptées : displayName, subDn ou un des noms des colonnes personnalisées.
sortDirection
Permet de préciser l'ordre de tri du résultat de recherche. Valeurs acceptées : ASC (A-Z)
+ou DESC (Z-A).
page
Permet de préciser la page du résultat de recherche.
+nbObjectsByPage
Permet de préciser le nombre maximum d'objets retournés par page du résultat de recherche.
+all
Permet de réclamer le résultat complet de la recherche (désactivation de la pagination). +Seul la présence de ce paramètre suffit à activer ce comportement, sa valeur n'a pas +d'importance.
+as_list
Permet de réclamer un résultat de recherche dans lequel, la clé objects sera une liste et
+non un dictionnaire. Dans ce cas, le DN de l'objet est fourni dans la clé dn des détails
+des objets. Seul la présence de ce paramètre suffit à activer ce comportement, sa valeur n'a pas
+d'importance.
withoutCache
Booléen permettant de désactiver l'utilisation du cache. Les valeurs acceptées sont 1 ou
+0.
keepParamsBetweenSearches
Booléen permettant d'activer/désactiver le stockage en session des paramètres de recherche
+(optionnel, par défaut : False). Les valeurs acceptées sont 1 ou 0.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople?extraDisplayedColumns=1&pretty'
+{
+ "success": true,
+ "objects": {
+ "uid=hmartin,ou=people,o=ls": {
+ "name": "Henri MARTIN",
+ "Mail": "henri.martin@ls.com"
+ },
+ "uid=s.ldapsaisie,ou=people,o=ls": {
+ "name": "Secretariat LdapSaisie",
+ "Mail": "secretariat@ldapsaisie.biz"
+ },
+ "uid=ls,ou=people,o=ls": {
+ "name": "LdapSaisie",
+ "Mail": "ldap.saisie@ls.com"
+ },
+ "uid=erwpa,ou=people,o=ls": {
+ "name": "Erwan PAGE",
+ "Mail": "erwan.page@ldapsaisie.biz"
+ },
+ "uid=user2,ou=people,ou=company1,ou=companies,o=ls": {
+ "name": "prenom2 nom2",
+ "Mail": "user2@ls.com"
+ }
+ },
+ "total": 14,
+ "params": {
+ "keepParamsBetweenSearches": false,
+ "filter": null,
+ "pattern": null,
+ "predefinedFilter": false,
+ "basedn": null,
+ "scope": null,
+ "sizelimit": 0,
+ "attronly": false,
+ "approx": false,
+ "recursive": true,
+ "attributes": [],
+ "onlyAccessible": true,
+ "sortDirection": null,
+ "sortBy": null,
+ "sortlimit": 0,
+ "displayFormat": "%{cn}",
+ "nbObjectsByPage": 25,
+ "withoutCache": false,
+ "extraDisplayedColumns": true
+ },
+ "page": 1,
+ "nbPages": 3
+}
+/api/1.0/object/[object type]/[dn]
Cette méthode permet de récupérer les informations d'un objet de l'annuaire au format JSON. Le
+type de l'objet et son DN sont précisés dans l'URL et doivent être encodés en conséquence. Par
+défaut, les valeurs des attributs retournées sont au format tel qu'attendu en cas de
+création/modification de l'objet. Il est cependant possible d'ajouter le paramètre details
+afin d'obtenir des informations complémentaires sur les valeurs des attributs.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=hmartin,ou=people,o=ls?pretty'
+{
+ "success": true,
+ "dn": "uid=hmartin,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Henri MARTIN",
+ "details": false,
+ "attributes": {
+ "uid": "hmartin",
+ "givenName": "Henri",
+ "sn": "MARTIN",
+ "cn": "Henri MARTIN",
+ "mail": "henri.martin@ls.com",
+ "personalTitle": "M.",
+ "description": [],
+ "jpegPhoto": null,
+ "lsGodfatherDn": [
+ "uid=eeggs,ou=people,o=ls"
+ ],
+ "uidNumber": "101022",
+ "gidNumber": "102001",
+ "loginShell": "no",
+ "homeDirectory": "\/home\/com",
+ "gecos": null,
+ "shadowExpire": null,
+ "shadowMax": null,
+ "shadowInactive": null,
+ "shadowLastChange": null,
+ "sambaSID": "S-1-5-21-2421470416-3566881284-3047381809-203044",
+ "sambaPrimaryGroupSID": "S-1-5-21-2421470416-3566881284-3047381809-205003",
+ "sambaAcctFlags": [
+ "U"
+ ],
+ "sambaHomeDrive": null,
+ "sambaHomePath": null,
+ "sambaProfilePath": null,
+ "sambaLogonScript": null,
+ "sambaLogonTime": null,
+ "sambaLogoffTime": null,
+ "sambaKickoffTime": null,
+ "sambaPwdLastSet": null,
+ "sambaPwdMustChange": null,
+ "sambaPwdCanChange": null
+ },
+ "relations": {
+ "groups": {
+ "cn=direction,ou=groups,o=ls": "direction",
+ "cn=secretariat,ou=groups,o=ls": "secretariat"
+ },
+ "godfather": []
+ }
+}
+/api/1.0/object/[object type]/create
Cette méthode permet de créer un objet dans l'annuaire. Le type de l'objet qui sera créé est
+précisé dans l'URL et doit être encodé en conséquence. Les informations de l'objet doivent est
+transmises au format x-www-form-urlencoded. Elles peuvent également être au format
+multipart/form-data, en particulier si votre requête contient une image. Par mimétisme avec
+l'interface web, seuls les attributs prévus dans le formulaire de création du type d'objet
+peuvent être passées ici. De la même manière, les attributs non-spécifiés ici, pouront être
+auto-générés en accord avec leur configuration et la requête sera acceptée uniquement si tous
+les attributs obligatoires y sont spécifiés ou s'ils peuvent être auto-générés.
Le format et la syntaxe des valeurs des attributs dépends de leur type HTML. Ainsi, par exemple,
+un attribut de type HTML boolean acceptera comme valeurs possibles yes ou no. Pour plus
+de détails sur le type de valeur acceptée par un type d'attribut HTML en particulier, consultez
+sa documentation. Vous pouvez également analyser le code de la méthode getPostData() de la
+classe PHP correspondante.
Si l'application détecte un souci avec les informations transmises pour les attributs, un
+tableau fields_errors sera présent dans la réponse JSON et contiendra pour chacun des
+attributs problématique, un tableau des messages d'erreurs générées par l'application.
Si le type d'objet en prévoit, vous pouvez également utiliser un
+masque de saisie via le
+paramètre dataEntryForm.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/create?pretty' -d "uid=foo.bar&personalTitle=M.&givenName=foo&sn=bar&cn=Foo Bar&mail=foo.bar@example.com&userPassword=Y0urS3cr3t&lsGodfatherDn[]=uid=admin,ou=people,o=ls&gidNumber=70000"
+{
+ "success": true,
+ "type": "LSpeople",
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "name": "Foo Bar",
+ "messages": [
+ "Le mail de notification a \u00e9t\u00e9 envoy\u00e9.",
+ "L'objet a \u00e9t\u00e9 ajout\u00e9."
+ ]
+}
+/api/1.0/object/[object type]/[dn]/modify
Cette méthode permet de modifier un objet dans l'annuaire. Le type de l'objet et son DN sont
+précisés dans l'URL et doivent être encodés en conséquence. Les informations de l'objet à
+modifier doivent être transmises au même format que pour la méthode create (voir ci-dessus).
+Comme pour cette dernière, seuls les attributs prévus dans le formulaire de modification du type
+d'objet peuvent être passées ici et la réponse JSON pourra contenir un tableau fields_errors
+contenant les erreurs générées par l'application au sujet des valeurs transmises pour les
+attributs.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/modify?pretty' -d "givenName=foo&sn=bar&cn=Foo Bar"
+{
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Foo Bar",
+ "success": true,
+ "messages": [
+ "L'objet a bien \u00e9t\u00e9 modifi\u00e9."
+ ]
+}
+/api/1.0/object/[object type]/[dn]/remove
Cette méthode permet de supprimer un objet dans l'annuaire. Le type de l'objet et son DN sont +précisés dans l'URL et doivent être encodés en conséquence.
+Exemple :
+ +/api/1.0/object/[object type]/[dn]/customAction/[customAction]
Cette méthode permet d'exécuter une action personnalisée sur +un objet dans l'annuaire. Le nom de l'action ainsi que le type de l'objet et son DN sont précisés +dans l'URL et doivent être encodés en conséquence.
+Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/customAction/action?pretty'
+{
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Foo Bar",
+ "success": true,
+ "messages": [
+ "L'action personnalis\u00e9e action a \u00e9t\u00e9 correctement ex\u00e9cut\u00e9e sur Foo Bar.",
+ ]
+}
+Note
+Par défaut, une action personnalisée ne retourne qu'un booléen permettant de savoir si +l'action a correctement été exécutée ou non. En outre, dans un contexte d'appel via l'API, il +est possible de retourner des informations via un tableau associatif dont le contenu sera +fusionné avec les données retournées par la requête. Pour plus d'informations à ce sujet, +consultez la documentation sur l'écriture d'une fonction implémentant une customAction.
+/api/1.0/object/[object type]/import
Cette méthode permet d'importer des objets d'un type en particulier à partir de données d'import +formatées selon un ioFormat configuré pour ce type +d'objets. Le type de l'objet est précisé dans l'URL et doit être encodé en conséquence. Par +mimétisme du comportement de l'interface web, cette méthode accepte des paramètres similaires et +s'attend à récupérer les données d'import dans le corps de la requête.
+ioFormat
Le nom de l'ioFormatdes données d'import.
+updateIfExists
Booléen permettant d'activer/désactiver la mise à jour des données des objets s'ils existent
+déjà. Si ce mode est inactif et qu'un objet des données d'import existe déjà, une erreur
+sera remontée. Les valeurs acceptées sont 1 ou 0.
justTry
Booléen permettant d'activer/désactiver le mode de vérification des données d'import
+uniquement. Si ce mode est actif, les données d'import seront analysées pour vérifier
+qu'elles sont correctes, mais l'import en lui-même ne sera pas effectué. Les valeurs
+acceptées sont 1 ou 0.
Note
+Le retour de cette méthode en mode justTry est identique à une exécution en mode
+normal. Ce mode permet donc d'anticiper le résultat d'un import à partir d'un jeu de
+données sources.
Warning
+En mode justTry, seul la vérification syntaxique des données est fiable, car les
+informations doublonnées au sein des données d'import ne pourront être détectées.
En cas d'erreurs détectées dans les informations des objets des données d'import, le tableau
+errors du retour de la méthode contiendra une entrée pour chaque objet en erreur sous le
+format d'un dictionnaire dont la clé data reprendra les informations de l'objet telle que
+chargé (ou générée) depuis les données sources, ainsi qu'un dictionnaire sous la clé errors
+qui contiendra les erreurs globales concernant l'objet sous la clé globals et les erreurs
+propres à ses attributs dans un dictionnaire sous la clé attrs.
Note
+Les erreurs d'importation sur un objet sont non-bloquantes : l'importation des autres objets +ne sera pas interrompue.
+Exemple :
+# curl -u username:secret --data-binary @/path/to/input.file 'https://ldapsaisie/api/1.0/object/LSpeople/import?ioFormat=mycsv&pretty'
+{
+ "success": false,
+ "LSobject": "LSpeople",
+ "ioFormat": "mycsv",
+ "updateIfExists": false,
+ "justTry": false,
+ "imported": {
+ "uid=rturin,ou=people,o=ls": "M. Roger TURIN"
+ },
+ "updated": [],
+ "errors": [
+ {
+ "data": {
+ "uid": [
+ "lmartin"
+ ],
+ "personalTitle": [
+ "Mme"
+ ],
+ "givenName": [
+ "Ludivine"
+ ],
+ "sn": [
+ "MARTIN"
+ ],
+ "mail": [
+ "lmartin@gmail.com"
+ ],
+ "userPassword": [
+ "123Yh%uT"
+ ],
+ "gidNumber": [
+ "102009"
+ ],
+ "loginShell": [
+ "no"
+ ],
+ "cn": [
+ "Mme Ludivine MARTIN"
+ ]
+ },
+ "errors": {
+ "globals": [
+ "Un objet existe d\u00e9j\u00e0 dans l'annuaire LDAP avec le DN uid=lmartin,ou=people,o=ls."
+ ],
+ "attrs": []
+ }
+ }
+ ],
+ "messages": [
+ "Le mail de notification a \u00e9t\u00e9 envoy\u00e9."
+ ]
+}
+/api/1.0/object/[object type]/export
Cette méthode permet d'exporter les objets d'un type en particulier dans un +ioFormat configuré pour ce type d'objets. Le type de +l'objet est précisé dans l'URL et doit être encodé en conséquence.
+ioFormat
Le nom de l'ioFormat .
+En tant normal, le retour de cette méthode sera directement le fichier d'export demandé.
+Cependant, si une erreur survient, les paramètres d'export seront repris dans le retour JSON
+de la méthode qui contiendra également les erreurs survenues.
Exemple :
+# curl -u username:secret --data-binary @/path/to/input.file 'https://ldapsaisie/api/1.0/object/LSpeople/export?ioFormat=mycsv&pretty'
+login;civility;firstname;name;mail;password;gid;shell
+hmartin;M.;Henri;MARTIN;henri.martin@ls.com;********;102001;no
+s.ldapsaisie;M.;Secretariat;LdapSaisie;secretariat@ldapsaisie.biz;********;70000;no
+ls;M.;Ldap;Saisie;ldap.saisie@ls.com;********;102001;no
+erwpa;M.;Erwan;PAGEARD;erwan.page@ldapsaisie.biz;********;102009;no
+[...]
+/api/1.0/object/[object type]/[dn]/relation/[relation]
Cette méthode permet de gérer les objets en relation avec un objet en particulier de l'annuaire.
+Le type de l'objet, son DN et le nom de la relation sont précisés dans l'URL et doivent être
+encodés en conséquence. Cette méthode accepte les paramètres add et remove permettant de
+lister le ou les DN d'objet(s) à respectivement ajouter ou supprimer parmis les objets
+actuellement en relation avec l'objet spécifié. Si aucun DN n'est spécifié comme devant être
+ajouté ou supprimé, la méthode retournera simplement les DN des objets en relation. En cas de
+modification demandée, la méthode retournera la nouvelle liste des DNs des objets en relation,
+quel que soit le résultat de l'opération de mise à jour.
Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/object/LSpeople/uid=foo.bar,ou=people,o=ls/relation/groups?pretty&add[]=cn=ls,ou=groups,o=ls&add[]=cn=invite,ou=groups,o=ls'
+{
+ "dn": "uid=foo.bar,ou=people,o=ls",
+ "type": "LSpeople",
+ "name": "Foo Bar",
+ "relation": "groups",
+ "success": true,
+ "relatedObjects": [
+ "cn=ls,ou=groups,o=ls",
+ "cn=invite,ou=groups,o=ls"
+ ],
+ "messages": [
+ "Objects in relation updated."
+ ]
+}
+/api/1.0/search
Cette méthode permet d'effectuer une recherche sur plusieurs types d'objets de l'annuaire à la +fois. Par mimétisme du comportement de l'interface web, la recherche est paginée et accepte des +paramètres similaires en plus de paramètre plus appropriés à un fonctionnement programmatique.
+Les paramètres acceptés par cette méthode sont sensiblement les mêmes que ceux acceptés par la +méthode de recherche d'un type d'objet de l'annuaire en particulier et ils ne seront donc pas +tous redocumentés ici :
+filterpredefinedFilterpatternapproxbasednsubDnscoperecursivedisplayFormatextraDisplayedColumnsattributesattributesDetailspageallas_listwithoutCachekeepParamsBetweenSearchesnbObjectsByPage
Permet de préciser le nombre maximum d'objets retournés par type d'objet ET par page du résultat +de recherche.
+types
Permet de limiter les types d'objets à inclure dans le résultat de recherche. Par défaut, tous +les types d'objets auxquels l'utilisateur à accès et dont la recherche globale n'est pas +désactivée seront inclus.
+splited_result
Permet de faire en sorte que les objets inclus dans le résultat de recherche soient séparés par
+type dans des sous-clés de objects. Par défaut, tous les objets sont retournés dans la clé
+objects et une sous-clé type est ajouté à chacun d'eux pour les distinguer. Seul la présence
+de ce paramètre suffit à activer ce comportement, sa valeur n'a pas d'importance.
Important
+Pour chaque type d'objets inclus dans la recherche, un filtre et/ou un mot clé de recherche +doit être spécifié. Cette méthode n'a pas vocation à permettre de lister tous les objets de +l'annuaire.
+Exemple :
+# curl -u username:secret 'https://ldapsaisie/api/1.0/search?pattern=LdapSaisie&pretty'
+{
+ "success": true,
+ "objects": {
+ "uid=s.ldapsaisie,ou=people,o=ls": {
+ "name": "Secretariat LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "secretariat@ldapsaisie.biz"
+ },
+ "uid=ls,ou=people,o=ls": {
+ "name": "LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "ldap.saisie@ls.com"
+ },
+ "uid=erwpa,ou=people,o=ls": {
+ "name": "Erwan PAGE",
+ "type": "LSpeople",
+ "Mail": "erwan.page@ldapsaisie.biz"
+ },
+ "uid=invite,ou=people,o=ls": {
+ "name": "Utilisateur de passage",
+ "type": "LSpeople",
+ "Mail": "invite@ldapsaisie.biz"
+ },
+ "uid=demo,ou=people,o=ls": {
+ "name": "Demonstration LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "demo@ls.com"
+ },
+ "uid=admin,ou=people,o=ls": {
+ "name": "Administration LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "admin@ls.com"
+ },
+ "uid=admin3,ou=people,o=ls": {
+ "name": "ZAdministration LdapSaisie",
+ "type": "LSpeople",
+ "Mail": "admin@ls.com"
+ },
+ "uid=ldapsaisie,ou=sysaccounts,o=ls": {
+ "name": "ldapsaisie",
+ "type": "LSsysaccount"
+ }
+ },
+ "total": null,
+ "params": {
+ "keepParamsBetweenSearches": false,
+ "LSpeople": {
+ "filter": null,
+ "pattern": "LdapSaisie",
+ "predefinedFilter": false,
+ "basedn": null,
+ "scope": null,
+ "sizelimit": 0,
+ "attronly": false,
+ "approx": false,
+ "recursive": true,
+ "attributes": [],
+ "onlyAccessible": true,
+ "sortDirection": null,
+ "sortBy": null,
+ "sortlimit": 0,
+ "displayFormat": "%{cn}",
+ "nbObjectsByPage": 25,
+ "withoutCache": false,
+ "extraDisplayedColumns": true
+ },
+ "LSsysaccount": {
+ "filter": null,
+ "pattern": "LdapSaisie",
+ "predefinedFilter": false,
+ "basedn": null,
+ "scope": null,
+ "sizelimit": 0,
+ "attronly": false,
+ "approx": false,
+ "recursive": false,
+ "attributes": [],
+ "onlyAccessible": true,
+ "sortDirection": null,
+ "sortBy": null,
+ "sortlimit": 0,
+ "displayFormat": "%{uid}",
+ "nbObjectsByPage": 30,
+ "withoutCache": false,
+ "extraDisplayedColumns": true
+ }
+ },
+ "page": 1,
+ "nbPages": 1
+}
+