ldapsaisie/src/includes/addons/LSaddons.supann.php

1265 lines
42 KiB
PHP
Raw Normal View History

<?php
/*******************************************************************************
* Copyright (C) 2007 Easter-eggs
* https://ldapsaisie.org
*
* Author: See AUTHORS file in top-level directory.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
******************************************************************************/
// Messages d'erreur
// Support
LSerror :: defineError('SUPANN_SUPPORT_01',
___("SUPANN Support : The constant %{const} is not defined.")
);
LSerror :: defineError('SUPANN_SUPPORT_02',
___("SUPANN Support : The LSobject type %{type} does not exist. Can't work with entities..")
);
LSerror :: defineError('SUPANN_SUPPORT_03',
___("SUPANN Support : The global array %{array} is not defined.")
);
// Autres erreurs
LSerror :: defineError('SUPANN_01',
___("SUPANN: The attribute %{dependency} is missing. Unable to forge the attribute %{attr}.")
);
LSerror :: defineError('SUPANN_02',
___("SUPANN: Can't get the basedn of entities. Unable to forge the attribute %{attr}.")
);
LSerror :: defineError('SUPANN_03',
___("SUPANN: This entity have children entities and could be deleted.")
);
LSerror :: defineError('SUPANN_04',
___("SUPANN: Fail to load nomenclature %{nomenclature}.")
);
2021-06-10 18:45:00 +02:00
/**
* Verification du support SUPANN par ldapSaisie
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @retval boolean true si SUPANN est pleinement supporté, false sinon
*/
function LSaddon_supann_support() {
$retval = true;
$MUST_DEFINE_STRING = array(
'LS_SUPANN_LASTNAME_ATTR',
'LS_SUPANN_FIRSTNAME_ATTR',
'LS_SUPANN_LSOBJECT_ENTITE_TYPE',
'LS_SUPANN_LSOBJECT_ENTITE_FORMAT_SHORTNAME',
'LS_SUPANN_ETABLISSEMENT_UAI',
'LS_SUPANN_ETABLISSEMENT_DN',
'LS_SUPANN_EPPN_FORMAT',
'LS_SUPANN_EPUI_FORMAT',
);
foreach($MUST_DEFINE_STRING as $string) {
if ( isset($GLOBALS[$string]) && is_string($GLOBALS[$string])) {
continue;
}
2021-06-10 18:45:00 +02:00
foreach(LSconfig :: get('ldap_servers') as $id => $infos) {
if ( !isset($infos['globals'][$string]) || !is_string($infos['globals'][$string])) {
LSerror :: addErrorCode('SUPANN_SUPPORT_01',$string);
$retval = false;
continue 2;
}
}
2021-06-10 18:45:00 +02:00
}
2021-06-10 18:45:00 +02:00
$MUST_DEFINE_ARRAY = array(
'LS_SUPANN_LSOBJECT_PARRAIN_TYPES',
'supannNomenclatures',
);
foreach($MUST_DEFINE_ARRAY as $array) {
if ( !isset($GLOBALS[$array]) || !is_array($GLOBALS[$array])) {
LSerror :: addErrorCode('SUPANN_SUPPORT_03',$array);
$retval=false;
}
}
2021-06-10 18:45:00 +02:00
if (isset($GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'])) {
if ( ! LSsession :: loadLSobject( $GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'] ) ) {
LSerror :: addErrorCode('SUPANN_SUPPORT_02', $GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE']);
}
2021-06-10 18:45:00 +02:00
}
2021-06-10 18:45:00 +02:00
return $retval;
}
2021-06-10 18:45:00 +02:00
/***********************************************************************
* Fonctions de génération de valeurs d'attributs
**********************************************************************/
/**
* Generation du displayName
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval string Le displayName ou false si il y a un problème durant la génération
*/
function generate_displayName($ldapObject) {
if ( get_class($ldapObject -> attrs[ $GLOBALS['LS_SUPANN_LASTNAME_ATTR'] ]) != 'LSattribute' ) {
LSerror :: addErrorCode(
'SUPANN_01',
array('dependency' => $GLOBALS['LS_SUPANN_LASTNAME_ATTR'], 'attr' => 'cn')
);
return;
}
if ( get_class($ldapObject -> attrs[ $GLOBALS['LS_SUPANN_FIRSTNAME_ATTR'] ]) != 'LSattribute' ) {
LSerror :: addErrorCode(
'SUPANN_01',
array('dependency' => $GLOBALS['LS_SUPANN_FIRSTNAME_ATTR'], 'attr' => 'cn')
);
return;
}
2021-06-10 18:45:00 +02:00
$noms = $ldapObject -> attrs[ $GLOBALS['LS_SUPANN_LASTNAME_ATTR'] ] -> getValue();
$prenoms = $ldapObject -> attrs[ $GLOBALS['LS_SUPANN_FIRSTNAME_ATTR'] ] -> getValue();
2021-06-10 18:45:00 +02:00
return ($prenoms[0].' '.$noms[0]);
}
2021-06-10 18:45:00 +02:00
/**
* Generation du CN
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval string Le CN ou false si il y a un problème durant la génération
*/
function generate_cn($ldapObject) {
if ( get_class($ldapObject -> attrs[ $GLOBALS['LS_SUPANN_LASTNAME_ATTR'] ]) != 'LSattribute' ) {
LSerror :: addErrorCode(
'SUPANN_01',
array('dependency' => $GLOBALS['LS_SUPANN_LASTNAME_ATTR'], 'attr' => 'cn')
);
return;
}
if ( get_class($ldapObject -> attrs[ $GLOBALS['LS_SUPANN_FIRSTNAME_ATTR'] ]) != 'LSattribute' ) {
LSerror :: addErrorCode(
'SUPANN_01',
array('dependency' => $GLOBALS['LS_SUPANN_FIRSTNAME_ATTR'], 'attr' => 'cn')
);
return;
}
2021-06-10 18:45:00 +02:00
$noms = $ldapObject -> attrs[ $GLOBALS['LS_SUPANN_LASTNAME_ATTR'] ] -> getValue();
$prenoms = $ldapObject -> attrs[ $GLOBALS['LS_SUPANN_FIRSTNAME_ATTR'] ] -> getValue();
2021-06-10 18:45:00 +02:00
return (withoutAccents($noms[0]).' '.withoutAccents($prenoms[0]));
}
2021-06-10 18:45:00 +02:00
/**
* Generation des valeurs de l'attribut eduPersonOrgUnitDN à partir des
* valeurs de l'attribut supannEntiteAffectation.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut eduPersonOrgUnitDN ou false
* si il y a un problème durant la génération
*/
function generate_eduPersonOrgUnitDN($ldapObject) {
if ( get_class($ldapObject -> attrs[ 'supannEntiteAffectation' ]) != 'LSattribute' ) {
LSerror :: addErrorCode(
'SUPANN_01',
array('dependency' => 'supannEntiteAffectation', 'attr' => 'eduPersonOrgUnitDN')
);
return;
}
2021-06-10 18:45:00 +02:00
$affectations = $ldapObject -> attrs[ 'supannEntiteAffectation' ] -> getUpdateData();
2021-06-10 18:45:00 +02:00
$basedn = LSconfig :: get('LSobjects.'.$GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'].'.container_dn').','.LSsession::getTopDn();
if ($basedn == "") {
LSerror :: addErrorCode('SUPANN_02','eduPersonOrgUnitDN');
return;
}
2021-06-10 18:45:00 +02:00
$retval = array();
foreach ($affectations as $aff) {
$retval[] = "supannCodeEntite=".$aff.",$basedn";
}
return $retval;
}
/**
* Generation de la valeur de l'attribut eduPersonPrimaryOrgUnitDN
* à partir de la valeur de l'attribut supannEntiteAffectationPrincipale.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array La valeur de l'attribut eduPersonPrimaryOrgUnitDN
* ou false si il y a un problème durant la génération
*/
2021-06-10 18:45:00 +02:00
function generate_eduPersonPrimaryOrgUnitDN($ldapObject) {
if ( get_class($ldapObject -> attrs[ 'supannEntiteAffectationPrincipale' ]) != 'LSattribute' ) {
LSerror :: addErrorCode('SUPANN_01',array('dependency' => 'supannEntiteAffectationPrincipale', 'attr' => 'eduPersonPrimaryOrgUnitDN'));
return;
}
2021-06-10 18:45:00 +02:00
$affectations = $ldapObject -> attrs[ 'supannEntiteAffectationPrincipale' ] -> getUpdateData();
2021-06-10 18:45:00 +02:00
$basedn = LSconfig :: get('LSobjects.'.$GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'].'.container_dn').','.LSsession::getTopDn();
if ($basedn == "") {
LSerror :: addErrorCode('SUPANN_02','eduPersonPrimaryOrgUnitDN');
return;
}
2021-06-10 18:45:00 +02:00
$retval = array();
foreach ($affectations as $aff) {
$retval[]="supannCodeEntite=".$aff.",$basedn";
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/**
* Generation de la valeur de l'attribut eduPersonOrgDN
* à partir de la valeur de l'attribut supannEtablissement.
*
* La valeur sera $GLOBALS['LS_SUPANN_ETABLISSEMENT_DN'] si l'attribut supannEtablissement
* vaut {UAI}$GLOBALS['LS_SUPANN_ETABLISSEMENT_UAI'].
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array La valeur de l'attribut eduPersonOrgDN ou false
* si il y a un problème durant la génération
*/
2021-06-10 18:45:00 +02:00
function generate_eduPersonOrgDN($ldapObject) {
if ( get_class($ldapObject -> attrs[ 'supannEtablissement' ]) != 'LSattribute' ) {
LSerror :: addErrorCode('SUPANN_01',array('dependency' => 'supannEtablissement', 'attr' => 'eduPersonOrgDN'));
return;
}
2021-06-10 18:45:00 +02:00
$eta = $ldapObject -> attrs[ 'supannEtablissement' ] -> getUpdateData();
2021-06-10 18:45:00 +02:00
$retval=array();
if ($eta[0] == '{UAI}'.$GLOBALS['LS_SUPANN_ETABLISSEMENT_UAI']) {
$retval[] = $GLOBALS['LS_SUPANN_ETABLISSEMENT_DN'];
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/***********************************************************************
* Fonction de parsing des valeurs spécifiques SUPANN
**********************************************************************/
/**
* Parse une valeur a etiquette SUPANN
*
* Exemple de valeur :
*
* {SUPANN}S410
*
* @param[in] $val La valeur
*
* @retval array Un tableau cle->valeur contenant label et value ou False
**/
2021-06-10 18:45:00 +02:00
function supannParseLabeledValue($value) {
if (preg_match('/^\{([^\}]*)\}(.*)$/', $value, $m)) {
return array(
'label' => $m[1],
'value' => $m[2]
);
}
2021-06-10 18:45:00 +02:00
return;
}
/**
* Parse une valeur composite SUPANN
*
* Exemple de valeur :
*
* [key1=value][key2=value][key3=value]
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $val La valeur composite
*
* @retval array Un tableau contenant key->value ou false en cas d'erreur
**/
2021-06-10 18:45:00 +02:00
function supannParseCompositeValue($val) {
// Check value is valid
if (!preg_match('/^(\[[^=]+=[^\]\]]*\])+$/', $val)) {
LSlog :: get_logger('LSaddon_supann') -> warning("supannParseCompositeValue($val): invalid value");
return;
}
// Search for components value
2021-06-10 18:45:00 +02:00
if (preg_match_all('/\[([^=]*)=([^\]]*)\]/',$val,$matches)) {
$parseValue = array();
for($i=0; $i<count($matches[0]); $i++) {
$parseValue[$matches[1][$i]] = $matches[2][$i];
}
2021-06-10 18:45:00 +02:00
return $parseValue;
}
2021-06-10 18:45:00 +02:00
return;
}
/**
* Format une valeur composite SUPANN
*
* Exemple de valeur en entrée :
*
* array (
* 'key1' => 'value1',
* 'key2' => 'value2',
* 'key3' => 'value3',
* )
*
* Exemple de valeur généré :
*
* [key1=value1][key2=value2][key3=value3]
*
* Les clés sont traitées dans l'ordre d'apparition dans le tableau et
* seul les clés avec une valeur non vide sont présentes dans le résultat.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $val Tableau associatif des valeurs
*
* @retval array Un tableau contenant key->value ou false en cas d'erreur
**/
function supannFormatCompositeValue($val) {
$retval = "";
foreach($val as $k => $v)
if (!is_empty($v))
$retval .= "[".$k."=".$v.']';
return $retval;
}
/***********************************************************************
* Fonctions relatives aux entités
**********************************************************************/
/**
* Retourne le nom court d'une entite en fonction de son identifiant
*
* @param[in] $id L'identifiant de l'entite (supannCodeEntite)
*
* @retval string Le nom de l'entite
**/
2021-06-10 18:45:00 +02:00
function supanGetEntiteNameById($id) {
if (LSsession::loadLSobject($GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'])) {
$e = new $GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE']();
$list=$e -> listObjectsName("(supannCodeEntite=$id)",NULL,array('onlyAccessible' => false),$GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_FORMAT_SHORTNAME']);
if (count($list)==1) {
return array_pop($list);
}
}
2021-06-10 18:45:00 +02:00
return getFData(__("Entity %{id} (unrecognized)"), $id);
}
/**
* Valide l'ID d'une entite
*
* @param[in] $id L'identifiant de l'entite (supannCodeEntite)
*
* @retval boolean True si une entité avec cet ID existe, False sinon
**/
2021-06-10 18:45:00 +02:00
function supannValidateEntityId($id) {
if (LSsession::loadLSobject($GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'])) {
$e = new $GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE']();
$list=$e -> listObjectsName("(supannCodeEntite=$id)",NULL,array('onlyAccessible' => False));
if (count($list)==1) {
return true;
}
}
2021-06-10 18:45:00 +02:00
return false;
}
/**
* Cherche des entités répond au pattern de recherche passé en paramètres
* et retourne un tableau mettant en relation leur identifiant et leur nom
* d'affichage.
*
* @param[in] $pattern string Le pattern de recherche
* @param[in] $max_matches int Nombre maximum de résultat retournés (optionnel, par défaut : 10)
*
* @retval array Tableau du résultat de la recherche mettant en relation
* l'identifiant des entités trouvés avec leur nom d'affichage.
**/
2021-06-10 18:45:00 +02:00
function supannSearchEntityByPattern($pattern, $max_matches=10) {
$retval = array();
if (LSsession::loadLSclass('LSsearch')) {
$search=new LSsearch(
$GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'],
'SUPANN:supannSearchEntityByPattern',
array(
'pattern' => $pattern,
'attributes' => array('supannCodeEntite'),
'sizelimit' => $max_matches,
'onlyAccessible' => false
)
);
$search -> run();
foreach($search -> getSearchEntries() as $e) {
$code = $e->get('supannCodeEntite');
if (is_array($code))
$code = $code[0];
$retval[$code] = $e->displayName;
}
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/***********************************************************************
* Fonctions relatives aux parrains
**********************************************************************/
/**
* Retourne les infos d'un parrain en fonction de son DN
*
* @param[in] $dn Le DN du parrain
*
* @retval array Le nom, le type et le DN du parrain (Format: array('dn' => [DN], 'type' => [type], 'name' => [name]))
**/
2021-06-10 18:45:00 +02:00
function supanGetParrainInfoByDN($dn) {
$matched = array(
'dn' => $dn,
'type' => null,
'name' => getFData(__("Godfather %{dn} (unrecognized)"), $dn),
);
foreach($GLOBALS['LS_SUPANN_LSOBJECT_PARRAIN_TYPES'] as $type) {
if (!LSsession::loadLSobject($type)) continue;
$obj = new $type();
$list = $obj -> listObjectsName(
NULL, $dn,
array('onlyAccessible' => false, 'scope' => 'base'),
);
2021-06-10 18:45:00 +02:00
if (count($list)==1) {
$matched['type'] = $type;
$matched['name'] = array_pop($list);
break;
}
}
2021-06-10 18:45:00 +02:00
return $matched;
}
/**
* Valide le DN d'un parrain
*
* @param[in] $dn Le DN d'un parrain
*
* @retval boolean True si un parrain avec ce DN existe, False sinon
**/
2021-06-10 18:45:00 +02:00
function supannValidateParrainDN($dn) {
$info = supanGetParrainInfoByDN($dn);
return !is_null($info['type']);
}
/**
* Cherche des parrains répondant au pattern de recherche passé en paramètres
* et retourne un tableau mettant en relation leur DN et leur nom d'affichage.
*
* @param[in] $pattern string Le pattern de recherche
* @param[in] $max_matches int Nombre maximum de résultat retournés (optionnel, par défaut : 10)
*
* @retval array Tableau du résultat de la recherche mettant en relation
* le DN des parrains trouvés avec leur nom d'affichage.
**/
2021-06-10 18:45:00 +02:00
function supannSearchParrainByPattern($pattern, $max_matches=10) {
$retval = array();
if (LSsession::loadLSclass('LSsearch')) {
foreach($GLOBALS['LS_SUPANN_LSOBJECT_PARRAIN_TYPES'] as $type) {
if (!LSsession::loadLSobject($type)) continue;
$search=new LSsearch(
$type,
'SUPANN:supannSearchParrainByPattern',
array(
'pattern' => $pattern,
'sizelimit' => $max_matches,
'onlyAccessible' => false
)
);
$search -> run();
foreach($search -> getSearchEntries() as $obj) {
$retval[$obj->dn] = $obj->displayName;
}
2021-06-10 18:45:00 +02:00
}
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/***********************************************************************
* Fonctions relatives aux nomenclatures
**********************************************************************/
/**
* Vérifie si une valeur et son étiquette sont valide pour une table donnée
*
* @param[in] $table La table de nomenclature
* @param[in] $label L'étiquette de la valeur (optionnel)
* @param[in] $value La valeur
*
* @retval booleab True si valide, False sinon
**/
2021-06-10 18:45:00 +02:00
function supannValidateNomenclatureValue($table, $label, $value) {
if (!supannLoadNomenclature($table))
return false;
if ($label) {
$label = strtoupper($label);
if (
isset($GLOBALS['supannNomenclatures'][$label]) &&
isset($GLOBALS['supannNomenclatures'][$label][$table]) &&
isset($GLOBALS['supannNomenclatures'][$label][$table][$value])
) {
return array(
'table' => $table,
'label' => $label,
'value' => $value,
'translated' => $GLOBALS['supannNomenclatures'][$label][$table][$value],
);
}
2021-06-10 18:45:00 +02:00
}
else {
foreach($GLOBALS['supannNomenclatures'] as $label => $tables) {
if (!array_key_exists($table, $tables) || !array_key_exists($value, $tables[$table]))
continue;
return array(
'table' => $table,
'label' => $label,
'value' => $value,
'translated' => $tables[$table][$value],
);
}
}
2021-06-10 18:45:00 +02:00
return false;
}
/**
* Retourne le label d'une valeur en fonction de la table de nomenclature
* et de l'étiquette de la valeur.
*
* @param[in] $table La table de nomenclature
* @param[in] $label L'étiquette de la valeur (optionnel)
* @param[in] $value La valeur
*
* @retval array Le label de la valeur. En cas de valeur nor-reconnue, retourne
* la valeur en spécifiant qu'elle n'est pas reconnue.
**/
2021-06-10 18:45:00 +02:00
function supannGetNomenclatureLabel($table, $label, $value) {
$translated = supannValidateNomenclatureValue($table, $label, $value);
if ($translated)
return $translated['translated'];
return getFData(__("%{value} (unrecognized value)"), $value);
}
/**
* Retourne les valeurs possibles d'une table de nomenclature pour chaque fournisseur
*
* @param[in] $table La table de nomenclature
*
* @retval array Tableau contenant pour chaque fournisseur, les valeurs possibles de
* la table de nomenclature
**/
2021-06-10 18:45:00 +02:00
function supannGetNomenclatureTable($table) {
$retval = array();
if (!supannLoadNomenclature($table))
return $retval;
foreach(array_keys($GLOBALS['supannNomenclatures']) as $provider) {
if (isset($GLOBALS['supannNomenclatures'][$provider][$table])) {
$retval[$provider] = $GLOBALS['supannNomenclatures'][$provider][$table];
}
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/**
* Retourne les valeurs possibles d'une table de nomenclature
*
* @param[in] $table La table de nomenclature
* @param[in] $add_provider_label Booléen définissant si le fournisseur de la valeur
* doit être ajouté en tant qu'étiquette de la valeur
* (optinel, par défaut: vrai)
*
* @retval array Tableau contenant les valeurs possibles de la table
* de nomenclature
**/
2021-06-10 18:45:00 +02:00
function supannGetNomenclaturePossibleValues($table, $add_provider_label=True) {
$retval = array();
if (!supannLoadNomenclature($table))
return $retval;
foreach(array_keys($GLOBALS['supannNomenclatures']) as $provider) {
if (isset($GLOBALS['supannNomenclatures'][$provider][$table])) {
foreach($GLOBALS['supannNomenclatures'][$provider][$table] as $value => $label) {
if ($add_provider_label)
$value = "{$provider}$value";
$retval[$value] = __($label);
}
}
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/**
* Cherche des valeurs d'une nomenclature répondant au pattern de recherche passé en paramètres
* et retourne un tableau de celles-ci.
*
* @param[in] $pattern string Le pattern de recherche
* @param[in] $max_matches int Nombre maximum de résultat retournés (optionnel, par défaut : 10)
*
* @retval array Tableau du résultat de la recherche
**/
2021-06-10 18:45:00 +02:00
function supannSearchNomenclatureValueByPattern($table, $pattern, $max_matches=10) {
$retval = array();
$pattern = withoutAccents(strtolower($pattern));
foreach(supannGetNomenclatureTable($table) as $label => $values) {
foreach($values as $value => $txt) {
if (strpos(withoutAccents(strtolower($txt)), $pattern) === false)
continue;
$retval[] = array(
'label' => $label,
'value' => '{'.$label.'}'.$value,
'translated' => $txt
);
if (count($retval) >= $max_matches)
break;
}
2021-06-10 18:45:00 +02:00
if (count($retval) >= $max_matches)
break;
}
2021-06-10 18:45:00 +02:00
return $retval;
}
/**
* Retourne les valeurs possibles de l'attribut supannCivilite.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* get_possible_values de la configuration HTML de l'attribut
* supannCivilite avec un type d'attribut HTML select_list (ou select_box).
*
* @param[in] $options La configuration HTML de l'attribut
* @param[in] $name Le nom de l'attribut
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval array Tableau contenant les valeurs possibles de l'attribut
* (avec les labels traduits).
**/
function supannGetCivilitePossibleValues($options, $name, $ldapObject) {
return supannGetNomenclaturePossibleValues('civilite', false);
}
/**
* Retourne les valeurs possibles des affiliations.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* get_possible_values de la configuration HTML de l'attribut
* eduPersonAffiliation (par exemple) avec un type d'attribut HTML select_list.
*
* @param[in] $options La configuration HTML de l'attribut
* @param[in] $name Le nom de l'attribut
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval array Tableau contenant les valeurs possibles de l'attribut
* (avec les labels traduits).
**/
function supannGetAffiliationPossibleValues($options=null, $name=null, $ldapObject=null) {
return supannGetNomenclaturePossibleValues('affiliation', false);
}
/**
* Retourne les valeurs possibles des ressources.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* get_possible_values de la configuration du composant ressource de l'attribut
* supannRessourceEtat (entre autre) avec un type de composant select.
*
* @param[in] $options La configuration HTML de l'attribut
* @param[in] $name Le nom de l'attribut
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval array Tableau contenant les valeurs possibles de l'attribut
* (avec les labels traduits).
**/
function supannGetRessourcePossibleValues($options=null, $name=null, $ldapObject=null) {
return supannGetNomenclaturePossibleValues('ressource', false);
}
/**
* Retourne les valeurs possibles des états des ressources.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* get_possible_values de la configuration du composant etat de l'attribut
* supannRessourceEtat (entre autre) avec un type de composant select.
*
* @param[in] $options La configuration HTML de l'attribut
* @param[in] $name Le nom de l'attribut
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval array Tableau contenant les valeurs possibles de l'attribut
* (avec les labels traduits).
**/
function supannGetRessourceEtatPossibleValues($options=null, $name=null, $ldapObject=null) {
return supannGetNomenclaturePossibleValues('ressourceEtat', false);
}
/**
* Retourne les valeurs possibles des sous-états des ressources.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* get_possible_values de la configuration du composant sous_etat de l'attribut
* supannRessourceEtat (entre autre) avec un type de composant select.
*
* @param[in] $options La configuration HTML de l'attribut
* @param[in] $name Le nom de l'attribut
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval array Tableau contenant les valeurs possibles de l'attribut
* (avec les labels traduits).
**/
function supannGetRessourceSousEtatPossibleValues($options=null, $name=null, $ldapObject=null) {
return supannGetNomenclaturePossibleValues('ressourceSousEtat', false);
}
/**
* Vérifie les valeurs de l'attribut eduPersonAffiliation
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* function de la configuration de validation de l'intégrité des valeurs
* de l'attribut eduPersonAffiliation (paramètre validation).
*
* Elle s'assure que des valeurs affiliate et member n'ont pas été toutes
* les deux selectionnées, car elles sont incompatibles.
*
* @author Benjamin Dauvergne <bdauvergne@entrouvert.com>
*
* @param[in] &$ldapObject Une référence à l'object LSldapObject
* @author Benjamin Dauvergne <bdauvergne@entrouvert.com>
*
* @retval boolean True si les valeurs sont valides, False sinon
**/
global $_supannCheckEduPersonAffiliation_checked;
$_supannCheckEduPersonAffiliation_checked = false;
function supannCheckEduPersonAffiliation(&$ldapObject) {
2021-06-10 18:45:00 +02:00
global $_supannCheckEduPersonAffiliation_checked;
$values = $ldapObject->getValue('eduPersonAffiliation');
if (!$_supannCheckEduPersonAffiliation_checked && in_array('affiliate', $values) && in_array('member', $values)) {
$_supannCheckEduPersonAffiliation_checked = true;
return false;
}
return true;
}
/**
* Vérifie la valeur de l'attribut eduPersonPrimaryAffiliation
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* function de la configuration de validation de l'intégrité des valeurs
* de l'attribut eduPersonPrimaryAffiliation (paramètre validation).
*
* Elle s'assure que la valeur de l'attribut eduPersonPrimaryAffiliation
* fait bien partie des valeurs de l'attribut eduPersonAffiliation.
*
* @author Benjamin Dauvergne <bdauvergne@entrouvert.com>
*
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval boolean True si la valeur est valide, False sinon
**/
function supannCheckEduPersonPrimaryAffiliation(&$ldapObject) {
2021-06-10 18:45:00 +02:00
$primary = $ldapObject->getValue('eduPersonPrimaryAffiliation');
$affiliations = $ldapObject->getValue('eduPersonAffiliation');
if (!array_intersect($primary, $affiliations))
return false;
return true;
}
/**
* Retourne les valeurs possibles de l'attribut supannOIDCGenre.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* get_possible_values de la configuration HTML de l'attribut
* supannOIDCGenre avec un type d'attribut HTML select_list ou select_box.
*
* @param[in] $options La configuration HTML de l'attribut
* @param[in] $name Le nom de l'attribut
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval array Tableau contenant les valeurs possibles de l'attribut
* (avec les labels traduits).
**/
function supannGetOIDCGenrePossibleValues($options, $name, $ldapObject) {
return supannGetNomenclaturePossibleValues('oidc_genre', false);
}
/*
* Charge une nomenclature SUPANN
*
* @param[in] $table string La nomenclature à charger
*
* @retval boolean True si la nomenclature est chargée, False en cas de problème
*/
$GLOBALS['_supann_loaded_nomenclatures'] = array();
function supannLoadNomenclature($table) {
if (in_array($table, $GLOBALS['_supann_loaded_nomenclatures']))
return true;
switch($table) {
case 'roleGenerique':
if (
!LSsession :: loadResourceFile('supann/role_generique.php') ||
!isset($GLOBALS['supannRoleGenerique']) ||
!is_array($GLOBALS['supannRoleGenerique'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['SUPANN']))
$GLOBALS['supannNomenclatures']['SUPANN'] = array();
$GLOBALS['supannNomenclatures']['SUPANN'][$table] = &$GLOBALS['supannRoleGenerique'];
break;
case 'typeEntite':
if (
!LSsession :: loadResourceFile('supann/type_entite.php') ||
!isset($GLOBALS['supannTypeEntite']) ||
!is_array($GLOBALS['supannTypeEntite'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['SUPANN']))
$GLOBALS['supannNomenclatures']['SUPANN'] = array();
$GLOBALS['supannNomenclatures']['SUPANN'][$table] = &$GLOBALS['supannTypeEntite'];
break;
case 'codePopulation':
if (
!LSsession :: loadResourceFile('supann/populations.php') ||
!isset($GLOBALS['supannPopulations']) ||
!is_array($GLOBALS['supannPopulations'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
$GLOBALS['supannNomenclatures']['SUPANN']['codePopulation'] = array();
function _detectCodesPopulations($populations, $prefix="") {
if (!$populations) {
return;
}
foreach($populations as $letter => $infos) {
$code = "$prefix$letter";
if (isset($infos['label']))
$GLOBALS['supannNomenclatures']['SUPANN']['codePopulation'][$code] = $infos['label']." ($code)";
_detectCodesPopulations($infos['subpopulations'], $code);
}
}
_detectCodesPopulations($GLOBALS['supannPopulations']);
break;
case 'etuDiplome':
if (
!LSsession :: loadResourceFile('supann/BCN_diplome_sise.php') ||
!isset($GLOBALS['BCN_DIPLOME_SISE']) ||
!is_array($GLOBALS['BCN_DIPLOME_SISE'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['SISE']))
$GLOBALS['supannNomenclatures']['SISE'] = array();
$GLOBALS['supannNomenclatures']['SISE'][$table] = &$GLOBALS['BCN_DIPLOME_SISE'];
break;
case 'etuTypeDiplome':
if (
!LSsession :: loadResourceFile('supann/BCN_type_diplome_sise.php') ||
!isset($GLOBALS['BCN_TYPE_DIPLOME_SISE']) ||
!is_array($GLOBALS['BCN_TYPE_DIPLOME_SISE'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['SISE']))
$GLOBALS['supannNomenclatures']['SISE'] = array();
$GLOBALS['supannNomenclatures']['SISE'][$table] = &$GLOBALS['BCN_TYPE_DIPLOME_SISE'];
break;
case 'etuRegimeInscription':
if (
!LSsession :: loadResourceFile('supann/BCN_regime_inscription.php') ||
!isset($GLOBALS['BCN_REGIME_INSCRIPTION']) ||
!is_array($GLOBALS['BCN_REGIME_INSCRIPTION'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['SISE']))
$GLOBALS['supannNomenclatures']['SISE'] = array();
$GLOBALS['supannNomenclatures']['SISE'][$table] = &$GLOBALS['BCN_REGIME_INSCRIPTION'];
break;
case 'etuSecteurDisciplinaire':
if (
!LSsession :: loadResourceFile('supann/BCN_secteur_disciplinaire.php') ||
!isset($GLOBALS['BCN_SECTEUR_DISCIPLINAIRE']) ||
!is_array($GLOBALS['BCN_SECTEUR_DISCIPLINAIRE'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['SISE']))
$GLOBALS['supannNomenclatures']['SISE'] = array();
$GLOBALS['supannNomenclatures']['SISE'][$table] = &$GLOBALS['BCN_SECTEUR_DISCIPLINAIRE'];
break;
case 'codeEtablissement':
if (
!LSsession :: loadResourceFile('supann/UAI_code_etablissements.php') ||
!isset($GLOBALS['UAI_CODE_ETABLISSEMENTS']) ||
!is_array($GLOBALS['UAI_CODE_ETABLISSEMENTS'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['UAI']))
$GLOBALS['supannNomenclatures']['UAI'] = array();
$GLOBALS['supannNomenclatures']['UAI'][$table] = &$GLOBALS['UAI_CODE_ETABLISSEMENTS'];
break;
case 'supannActivite':
if (
!LSsession :: loadResourceFile('supann/activites.php') ||
!isset($GLOBALS['supannActivitesTables']) ||
!is_array($GLOBALS['supannActivitesTables'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
foreach (array_keys($GLOBALS['supannActivitesTables']) as $provider) {
if (!array_key_exists($provider, $GLOBALS['supannNomenclatures']))
$GLOBALS['supannNomenclatures'][$provider] = array();
$GLOBALS['supannNomenclatures'][$provider][$table] = &$GLOBALS['supannActivitesTables'][$provider];
}
break;
case 'empCorps':
if (
!LSsession :: loadResourceFile('supann/BCN_emp_corps.php') ||
!isset($GLOBALS['BCN_EMP_CORPS']) ||
!is_array($GLOBALS['BCN_EMP_CORPS'])
) {
LSerror :: addErrorCode('SUPANN_04', $table);
return false;
}
if (!isset($GLOBALS['supannNomenclatures']['NCORPS']))
$GLOBALS['supannNomenclatures']['NCORPS'] = array();
$GLOBALS['supannNomenclatures']['NCORPS'][$table] = &$GLOBALS['BCN_EMP_CORPS'];
break;
}
$GLOBALS['_supann_loaded_nomenclatures'][] = $table;
return true;
}
/**
* Géneration de la valeur de l'attribut eduPersonPrincipalName
* à partir du LSformat configuré dans $GLOBALS['LS_SUPANN_EPPN_FORMAT']
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array La valeur de l'attribut eduPersonOrgDN ou false
* si il y a un problème durant la génération
*/
function generate_eduPersonPrincipalName($ldapObject) {
2021-06-10 18:45:00 +02:00
return $ldapObject -> getFData($GLOBALS['LS_SUPANN_EPPN_FORMAT']);
}
/**
* Géneration de la valeur de l'attribut eduPersonUniqueId
* à partir du LSformat configuré dans $GLOBALS['LS_SUPANN_EPUI_FORMAT']
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array La valeur de l'attribut eduPersonOrgDN ou false
* si il y a un problème durant la génération
*/
function generate_eduPersonUniqueId($ldapObject) {
$ldapObject -> registerOtherValue('uniqueId', uniqid());
return $ldapObject -> getFData($GLOBALS['LS_SUPANN_EPUI_FORMAT']);
}
/**
* Vérifie si une entité SUPANN peux être suprimée.
*
* Cette fonction est prévue pour pouvoir être utilisé comme paramètre
* before_delete de la configuration du type d'objet correspondant aux
* entités SUPANN. Elle vérifie que l'entité n'a pas d'entité fille
* avant suppression. Si au moins une entité fille est trouvée, la
* suppression est bloquée et une message d'erreur est affiché.
*
* Note: Cette fonction peut également être utilisé pour le type d'objet
* correspond aux établissements.
*
* @param[in] &$ldapObject Une référence à l'object LSldapObject
*
* @retval boolean True si la valeur est valide, False sinon
**/
function supannCheckEntityCouldBeDeleted($ldapObject) {
$children = $ldapObject -> listObjectsInRelation(
$ldapObject,
'supannCodeEntiteParent',
$GLOBALS['LS_SUPANN_LSOBJECT_ENTITE_TYPE'],
'supannCodeEntite'
);
if ($children) {
LSerror :: addErrorCode('SUPANN_03');
return false;
}
return true;
}
/**
* Géneration de la valeur des attributs associés à l'attribut supannEtuInscription
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
* @param[in] $component Le composant associés à l'attribut à généré
* @param[in] $ignore_value Valeur possible du composant qui doit être ignoré (optionnel)
*
* @retval array Les valeurs (uniques) du composant passé en paramètres trouvées dans les
* valeurs de l'attribut supannEtuInscription
*/
function generate_from_supannEtuInscription($ldapObject, $component, $ignore_value=null) {
$retval = array();
$inscriptions = $ldapObject -> getValue('supannEtuInscription');
LSlog :: get_logger('LSaddon_supann') -> debug(
"generate_from_supannEtuInscription($ldapObject, $component, $ignore_value): inscriptions = ".
varDump($inscriptions)
);
if (is_array($inscriptions)) {
foreach($inscriptions as $value) {
$inscription = supannParseCompositeValue($value);
if (
!$inscription ||
!array_key_exists($component, $inscription) ||
in_array($inscription[$component], $retval) ||
is_empty($inscription[$component]) ||
($ignore_value && $inscription[$component] == $ignore_value)
)
continue;
$retval[] = $inscription[$component];
}
}
LSlog :: get_logger('LSaddon_supann') -> debug(
"generate_from_supannEtuInscription($ldapObject, $component, $ignore_value): result = '".
implode(', ', $retval)."'"
);
return $retval;
}
/**
* Géneration de la valeur de l'attribut supannEtuDiplome à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuDiplome
*/
function generate_supannEtuDiplome($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'diplome');
}
/**
* Géneration de la valeur de l'attribut supannEtuTypeDiplome à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuTypeDiplome
*/
function generate_supannEtuTypeDiplome($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'typedip');
}
/**
* Géneration de la valeur de l'attribut supannEtuRegimeInscription à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuRegimeInscription
*/
function generate_supannEtuRegimeInscription($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'regimeinsc', '$');
}
/**
* Géneration de la valeur de l'attribut supannEtuSecteurDisciplinaire à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuSecteurDisciplinaire
*/
function generate_supannEtuSecteurDisciplinaire($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'sectdisc', '-');
}
/**
* Géneration de la valeur de l'attribut supannEtuAnneeInscription à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuAnneeInscription
*/
function generate_supannEtuAnneeInscription($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'anneeinsc');
}
/**
* Géneration de la valeur de l'attribut supannEtuCursusAnnee à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuCursusAnnee
*/
function generate_supannEtuCursusAnnee($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'cursusann');
}
/**
* Géneration de la valeur de l'attribut supannEtuElementPedagogique à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuElementPedagogique
*/
function generate_supannEtuElementPedagogique($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'eltpedago');
}
/**
* Géneration de la valeur de l'attribut supannEtuEtape à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuEtape
*/
function generate_supannEtuEtape($ldapObject) {
return generate_from_supannEtuInscription($ldapObject, 'etape');
}
/**
* Géneration de la valeur de l'attribut supannEtuDateFin à partir des valeurs
* l'attribut supannEtuInscription.
*
* @author Benjamin Renard <brenard@easter-eggs.com>
*
* @param[in] $ldapObject L'objet ldap
*
* @retval array Les valeurs de l'attribut supannEtuDateFin
*/
function generate_supannEtuDateFin($ldapObject) {
$values = generate_from_supannEtuInscription($ldapObject, 'datefin');
LSlog :: get_logger('LSaddon_supann') -> debug(
"generate_supannEtuDateFin($ldapObject): value retrieved from datefin component = ".varDump($values)
);
$max_time = NULL;
// On garde que la plus lointaine
foreach ($values as $value) {
$time = ldapDate2Timestamp($value);
if (!$time)
continue;
if (!$max_time || $time > $max_time) {
$max_time = $time;
}
}
LSlog :: get_logger('LSaddon_supann') -> debug(
"generate_supannEtuDateFin($ldapObject): result = ".varDump($max_time)
);
return $max_time;
}
if (php_sapi_name() != 'cli')
return true;
function cli_generate_supann_codeEtablissement_uai_nomenclature($command_args) {
$data = file_get_contents('https://data.enseignementsup-recherche.gouv.fr/explore/dataset/fr-esr-principaux-etablissements-enseignement-superieur/download?format=json');
$items = json_decode($data, true);
if (!is_array($items))
LSlog :: get_logger('LSaddon_supann') -> fatal('Fail to retreive UAI dataset from data.enseignementsup-recherche.gouv.fr');
$codes = array();
foreach($items as $item) {
if (!isset($item['fields']) || !isset($item['fields']['uai']) || !$item['fields']['uai'])
continue;
$codes[$item['fields']['uai']] = $item['fields']['uo_lib'];
}
var_export($codes);
}
LScli :: add_command(
'generate_supann_codeEtablissement_uai_nomenclature',
'cli_generate_supann_codeEtablissement_uai_nomenclature',
'Generate Supann codeEtablissement UAI nomenclature',
false, // usage args
false, // long desc
false // need LDAP connection
);