2009-02-10 19:41:20 +00:00
< ? php
/*
$Id $
2009-10-27 18:47:12 +00:00
This code is part of LDAP Account Manager ( http :// www . ldap - account - manager . org / )
2012-02-04 15:56:31 +00:00
Copyright ( C ) 2009 - 2012 Roland Gruber
2009-02-10 19:41:20 +00:00
This program is free software ; you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation ; either version 2 of the License , or
( at your option ) any later version .
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
*/
/**
* Manages the eduPerson extension for user accounts .
*
* @ package modules
* @ author Roland Gruber
*/
/**
* Manages the eduPerson extension for user accounts .
*
* @ package modules
*/
class eduPerson extends baseModule {
private $affiliationTypes = array ( 'faculty' , 'student' , 'staff' , 'alum' ,
'member' , 'affiliate' , 'employee' , 'library-walk-in' );
/**
* Creates a new eduPerson object .
*
* @ param string $scope account type ( user , group , host )
*/
function __construct ( $scope ) {
parent :: __construct ( $scope );
$this -> autoAddObjectClasses = false ;
}
/**
* Returns meta data that is interpreted by parent class
*
* @ return array array with meta data
*
* @ see baseModule :: get_metaData ()
*/
function get_metaData () {
$return = array ();
// icon
2009-02-22 19:25:58 +00:00
$return [ 'icon' ] = 'eduPerson.png' ;
2009-02-10 19:41:20 +00:00
// manages host accounts
$return [ " account_types " ] = array ( " user " );
// alias name
$return [ " alias " ] = _ ( " EDU person " );
// module dependencies
$return [ 'dependencies' ] = array ( 'depends' => array (), 'conflicts' => array ());
// managed object classes
$return [ 'objectClasses' ] = array ( 'eduPerson' );
// managed attributes
$return [ 'attributes' ] = array ( 'eduPersonAffiliation' , 'eduPersonNickname' ,
'eduPersonOrgDN' , 'eduPersonOrgUnitDN' ,
'eduPersonPrimaryAffiliation' , 'eduPersonPrincipalName' ,
'eduPersonEntitlement' , 'eduPersonPrimaryOrgUnitDN' ,
'eduPersonScopedAffiliation' );
2011-03-24 18:58:33 +00:00
// RDN attribute
$return [ " RDN " ] = array ( 'eduPersonPrincipalName' => 'low' );
2009-02-10 19:41:20 +00:00
// help Entries
$return [ 'help' ] = array (
'primaryAffiliation' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Primary affiliation " ), 'attr' => 'eduPersonPrimaryAffiliation' ,
2009-02-10 19:41:20 +00:00
" Text " => _ ( " Specifies the person's primary relationship to the institution in broad categories such as student, faculty, staff, alum, etc. " )
),
2009-02-22 19:25:58 +00:00
'scopedAffiliation' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Scoped affiliation " ), 'attr' => 'eduPersonScopedAffiliation' ,
2009-02-22 19:25:58 +00:00
" Text " => _ ( " Specifies the person's affiliation within a particular security domain in broad categories such as student, faculty, staff, alum, etc. " )
),
2009-02-10 19:41:20 +00:00
'nickName' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Nick names " ), 'attr' => 'eduPersonNickname' ,
2009-02-10 19:41:20 +00:00
" Text " => _ ( " This is a list of nick names for this user. " )
),
'affiliation' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Affiliations " ), 'attr' => 'eduPersonAffiliation' ,
2012-02-05 19:17:58 +00:00
" Text " => _ ( " Specifies the person's relationships to the institution in broad categories such as student, faculty, staff, alum, etc. " )
2009-02-10 19:41:20 +00:00
),
2009-03-06 19:17:22 +00:00
'affiliationUpload' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Affiliations " ), 'attr' => 'eduPersonAffiliation' ,
2012-02-05 19:17:58 +00:00
" Text " => _ ( " Specifies the person's relationships to the institution in broad categories such as student, faculty, staff, alum, etc. " ) . " " .
2009-03-28 18:26:41 +00:00
_ ( 'Multiple values are separated by comma.' )
2009-03-06 19:17:22 +00:00
),
2009-02-10 19:41:20 +00:00
'principalName' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Principal name " ), 'attr' => 'eduPersonPrincipalName' ,
2009-02-13 19:27:48 +00:00
" Text " => _ ( " The \" NetID \" of the person for the purposes of inter-institutional authentication. It should be represented in the form \" user@scope \" where scope defines a local security domain. " )
2009-02-22 19:25:58 +00:00
),
'entitlement' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Entitlements " ), 'attr' => 'eduPersonEntitlement' ,
2009-02-22 19:25:58 +00:00
" Text " => _ ( " URI (either URN or URL) that indicates a set of rights to specific resources. " )
2009-03-03 19:37:17 +00:00
),
2009-03-06 19:17:22 +00:00
'entitlementUpload' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Entitlements " ), 'attr' => 'eduPersonEntitlement' ,
2009-03-28 18:26:41 +00:00
" Text " => _ ( " URI (either URN or URL) that indicates a set of rights to specific resources. " ) . " " . _ ( 'Multiple values are separated by comma.' )
2009-03-06 19:17:22 +00:00
),
2009-03-03 19:37:17 +00:00
'orgDN' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Organisation " ), 'attr' => 'eduPersonOrgDN' ,
2009-03-03 19:37:17 +00:00
" Text " => _ ( " The DN of the directory entry representing the institution with which the person is associated. " )
),
'primaryOrgUnitDN' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Primary organisational unit " ), 'attr' => 'eduPersonPrimaryOrgUnitDN' ,
2011-06-06 18:05:17 +00:00
" Text " => _ ( " The DN of the directory entry representing the person's primary organisational unit. " )
2009-03-03 19:37:17 +00:00
),
'orgUnitDN' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Organisational units " ), 'attr' => 'eduPersonOrgUnitDN' ,
2011-06-06 18:05:17 +00:00
" Text " => _ ( " The DNs of the directory entries representing the person's organisational units. " )
2009-03-06 19:17:22 +00:00
),
'orgUnitDNUpload' => array (
2012-02-04 15:56:31 +00:00
" Headline " => _ ( " Organisational units " ), 'attr' => 'eduPersonOrgUnitDN' ,
2011-06-06 18:05:17 +00:00
" Text " => _ ( " The DNs of the directory entries representing the person's organisational units. " ) . ' ' . _ ( 'Multiple values are separated by comma.' )
2009-12-20 14:35:42 +00:00
),
'autoAdd' => array (
" Headline " => _ ( " Automatically add this extension " ),
" Text " => _ ( " This will enable the extension automatically if this profile is loaded. " )
2009-03-03 19:37:17 +00:00
));
2009-12-20 14:35:42 +00:00
// profile options
2010-09-17 18:27:20 +00:00
$profileContainer = new htmlTable ();
$profileContainer -> addElement ( new htmlTableExtendedInputCheckbox ( 'eduPerson_addExt' , false , _ ( 'Automatically add this extension' ), 'autoAdd' ));
$return [ 'profile_options' ] = $profileContainer ;
2009-02-10 19:41:20 +00:00
// upload fields
$return [ 'upload_columns' ] = array (
array (
2009-03-06 19:17:22 +00:00
'name' => 'eduPerson_principalName' ,
'description' => _ ( 'Principal name' ),
'help' => 'principalName' ,
'example' => _ ( 'user@company.com' ),
'unique' => 'true'
),
array (
'name' => 'eduPerson_primaryAffiliation' ,
'description' => _ ( 'Primary affiliation' ),
'help' => 'primaryAffiliation' ,
'example' => 'student' ,
'values' => implode ( " , " , $this -> affiliationTypes )
),
array (
'name' => 'eduPerson_scopedAffiliation' ,
'description' => _ ( 'Scoped affiliation' ),
'help' => 'scopedAffiliation' ,
'example' => 'student@domain'
),
array (
'name' => 'eduPerson_affiliation' ,
'description' => _ ( 'Affiliations' ),
'help' => 'affiliationUpload' ,
'example' => 'student, employee' ,
'values' => implode ( " , " , $this -> affiliationTypes )
),
array (
'name' => 'eduPerson_nickname' ,
'description' => _ ( 'Nick names' ),
'help' => 'nickName' ,
'example' => _ ( 'Steve, Stevo' )
),
array (
'name' => 'eduPerson_entitlement' ,
'description' => _ ( 'Entitlements' ),
'help' => 'entitlementUpload' ,
'example' => 'http://xstor.com/contracts/HEd123'
),
array (
'name' => 'eduPerson_orgDN' ,
2011-06-06 18:05:17 +00:00
'description' => _ ( 'Organisation' ),
2009-03-06 19:17:22 +00:00
'help' => 'orgDN' ,
'example' => _ ( 'ou=accounts,dc=yourdomain,dc=org' )
),
array (
'name' => 'eduPerson_primaryOrgUnitDN' ,
2011-06-06 18:05:17 +00:00
'description' => _ ( 'Primary organisational unit' ),
2009-03-06 19:17:22 +00:00
'help' => 'primaryOrgUnitDN' ,
'example' => _ ( 'ou=accounts,dc=yourdomain,dc=org' )
),
array (
'name' => 'eduPerson_orgUnitDN' ,
2011-06-06 18:05:17 +00:00
'description' => _ ( 'Organisational units' ),
2009-03-06 19:17:22 +00:00
'help' => 'orgUnitDNUpload' ,
'example' => _ ( 'ou=accounts,dc=yourdomain,dc=org' )
2009-02-10 19:41:20 +00:00
)
);
// available PDF fields
$return [ 'PDF_fields' ] = array (
2010-04-05 12:38:23 +00:00
'affiliation' => _ ( 'Affiliations' ),
'nickname' => _ ( 'Nick names' ),
2011-06-06 18:05:17 +00:00
'orgDN' => _ ( 'Organisation' ),
'orgUnitDN' => _ ( 'Organisational units' ),
2010-04-05 12:38:23 +00:00
'primaryAffiliation' => _ ( 'Primary affiliation' ),
'principalName' => _ ( 'Principal name' ),
'entitlement' => _ ( 'Entitlements' ),
2011-06-06 18:05:17 +00:00
'primaryOrgUnitDN' => _ ( 'Primary organisational unit' ),
2010-04-05 12:38:23 +00:00
'scopedAffiliation' => _ ( 'Scoped affiliation' )
2009-02-10 19:41:20 +00:00
);
return $return ;
}
/**
* This function fills the error message array with messages
*/
function load_Messages () {
2009-03-03 19:37:17 +00:00
$this -> messages [ 'principalName' ][ 0 ] = array ( 'ERROR' , _ ( 'Principal name is invalid!' ));
$this -> messages [ 'principalName' ][ 1 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_principalName' , _ ( 'Principal name is invalid!' ));
2011-06-06 18:05:17 +00:00
$this -> messages [ 'orgDN' ][ 0 ] = array ( 'ERROR' , _ ( 'Please enter a valid DN in the field:' ) . ' ' . _ ( " Organisation " ));
2009-03-06 19:17:22 +00:00
$this -> messages [ 'orgDN' ][ 1 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_orgDN' , _ ( 'This is not a valid DN!' ));
2011-06-06 18:05:17 +00:00
$this -> messages [ 'primaryOrgUnitDN' ][ 0 ] = array ( 'ERROR' , _ ( 'Please enter a valid DN in the field:' ) . ' ' . _ ( " Primary organisational unit " ));
2009-03-06 19:17:22 +00:00
$this -> messages [ 'primaryOrgUnitDN' ][ 1 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_primaryOrgUnitDN' , _ ( 'This is not a valid DN!' ));
2011-06-06 18:05:17 +00:00
$this -> messages [ 'orgUnitDN' ][ 0 ] = array ( 'ERROR' , _ ( 'Organisational units contains an invalid entry.' ));
2009-03-06 19:17:22 +00:00
$this -> messages [ 'orgUnitDN' ][ 1 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_orgUnitDN' , _ ( 'This is not a valid list of DNs!' ));
$this -> messages [ 'primaryAffiliation' ][ 0 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_primaryAffiliation' , _ ( 'Please enter a valid primary affiliation.' ));
$this -> messages [ 'scopedAffiliation' ][ 0 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_scopedAffiliation' , _ ( 'Please enter a valid scoped affiliation.' ));
$this -> messages [ 'affiliation' ][ 0 ] = array ( 'ERROR' , _ ( 'Account %s:' ) . ' eduPerson_affiliation' , _ ( 'Please enter a valid list of affiliations.' ));
2009-02-10 19:41:20 +00:00
}
2011-03-26 12:47:30 +00:00
/**
* This functions return true if all needed settings are done .
*
* @ return boolean true , if all is ok
*/
function module_complete () {
if (( $this -> getAccountContainer () -> rdn == 'eduPersonPrincipalName' ) && ! isset ( $this -> attributes [ 'eduPersonPrincipalName' ][ 0 ])) {
return false ;
}
return true ;
}
2009-02-10 19:41:20 +00:00
/**
* Returns the HTML meta data for the main account page .
*
2010-09-18 11:37:22 +00:00
* @ return htmlElement HTML meta data
2009-02-10 19:41:20 +00:00
*/
function display_html_attributes () {
2010-09-17 18:27:20 +00:00
$return = new htmlTable ();
2009-02-10 19:41:20 +00:00
if ( in_array ( 'eduPerson' , $this -> attributes [ 'objectClass' ])) {
// principal name
$principal = '' ;
if ( isset ( $this -> attributes [ 'eduPersonPrincipalName' ][ 0 ])) {
$principal = $this -> attributes [ 'eduPersonPrincipalName' ][ 0 ];
}
2010-09-17 18:27:20 +00:00
$return -> addElement ( new htmlTableExtendedInputField ( _ ( 'Principal name' ), 'principalName' , $principal , 'principalName' ), true );
2009-02-10 19:41:20 +00:00
// primary affiliation
$primaryAffiliation = array ();
if ( isset ( $this -> attributes [ 'eduPersonPrimaryAffiliation' ][ 0 ])) {
$primaryAffiliation = array ( $this -> attributes [ 'eduPersonPrimaryAffiliation' ][ 0 ]);
}
2010-09-17 18:27:20 +00:00
$return -> addElement ( new htmlTableExtendedSelect ( 'primaryAffiliation' , $this -> affiliationTypes , $primaryAffiliation , _ ( 'Primary affiliation' ), 'primaryAffiliation' ), true );
2009-02-22 19:25:58 +00:00
// scoped affiliation
$scopedAffiliation = '' ;
$scopedAffiliationPrefix = array ();
if ( isset ( $this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ])) {
$parts = explode ( '@' , $this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ]);
$scopedAffiliationPrefix = array ( $parts [ 0 ]);
$scopedAffiliation = substr ( $this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ], strlen ( $parts [ 0 ]) + 1 );
}
2010-09-17 18:27:20 +00:00
$return -> addElement ( new htmlOutputText ( _ ( 'Scoped affiliation' )));
$scopedAffiliationContainer = new htmlTable ();
$scopedAffiliationContainer -> addElement ( new htmlSelect ( 'scopedAffiliationPrefix' , $this -> affiliationTypes , $scopedAffiliationPrefix ));
$scopedAffiliationContainer -> addElement ( new htmlOutputText ( '@' ));
$scopedAffiliationContainer -> addElement ( new htmlInputField ( 'scopedAffiliation' , $scopedAffiliation ));
$return -> addElement ( $scopedAffiliationContainer );
$return -> addElement ( new htmlHelpLink ( 'scopedAffiliation' ), true );
2009-02-10 19:41:20 +00:00
// affiliations
2010-09-17 18:27:20 +00:00
$affiliations = new htmlTable ();
2009-02-10 19:41:20 +00:00
if ( isset ( $this -> attributes [ 'eduPersonAffiliation' ][ 0 ])) {
for ( $i = 0 ; $i < sizeof ( $this -> attributes [ 'eduPersonAffiliation' ]); $i ++ ) {
2010-09-17 18:27:20 +00:00
$affiliations -> addElement ( new htmlSelect ( 'affiliation' . $i , $this -> affiliationTypes , array ( $this -> attributes [ 'eduPersonAffiliation' ][ $i ])));
$affiliationButton = new htmlButton ( 'delAffiliation' . $i , 'del.png' , true );
$affiliations -> addElement ( $affiliationButton , true );
2009-02-10 19:41:20 +00:00
}
}
else {
2010-09-17 18:27:20 +00:00
$affiliations -> addElement ( new htmlOutputText ( '-' ), true );
2009-02-10 19:41:20 +00:00
}
2010-09-17 18:27:20 +00:00
$affiliationLabel = new htmlOutputText ( _ ( 'Affiliations' ));
$affiliationLabel -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $affiliationLabel );
$return -> addElement ( $affiliations );
$affiliationHelp = new htmlHelpLink ( 'affiliation' );
$affiliationHelp -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $affiliationHelp , true );
$return -> addElement ( new htmlOutputText ( '' ));
$newAffiliationContainer = new htmlTable ();
$newAffiliationContainer -> addElement ( new htmlSelect ( 'affiliation' , $this -> affiliationTypes ));
$newAffiliationContainer -> addElement ( new htmlButton ( 'newAffiliation' , 'add.png' , true ));
$return -> addElement ( $newAffiliationContainer );
$return -> addElement ( new htmlOutputText ( '' ), true );
2009-02-10 19:41:20 +00:00
// nick names
2010-09-17 18:27:20 +00:00
$nicks = new htmlTable ();
2009-02-10 19:41:20 +00:00
if ( isset ( $this -> attributes [ 'eduPersonNickname' ][ 0 ])) {
for ( $i = 0 ; $i < sizeof ( $this -> attributes [ 'eduPersonNickname' ]); $i ++ ) {
2010-09-17 18:27:20 +00:00
$nicks -> addElement ( new htmlInputField ( 'nickName' . $i , $this -> attributes [ 'eduPersonNickname' ][ $i ]));
$nicks -> addElement ( new htmlButton ( 'delNickName' . $i , 'del.png' , true ), true );
2009-02-10 19:41:20 +00:00
}
}
else {
2010-09-17 18:27:20 +00:00
$nicks -> addElement ( new htmlOutputText ( '-' ), true );
2009-02-10 19:41:20 +00:00
}
2010-09-17 18:27:20 +00:00
$nickLabel = new htmlOutputText ( _ ( 'Nick names' ));
$nickLabel -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $nickLabel );
$return -> addElement ( $nicks );
$nickHelp = new htmlHelpLink ( 'nickName' );
$nickHelp -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $nickHelp , true );
$return -> addElement ( new htmlOutputText ( '' ));
$newNickContainer = new htmlTable ();
$newNickContainer -> addElement ( new htmlInputField ( 'nickName' , '' ));
$newNickContainer -> addElement ( new htmlButton ( 'newNickName' , 'add.png' , true ));
$return -> addElement ( $newNickContainer );
$return -> addElement ( new htmlOutputText ( '' ), true );
2009-02-22 19:25:58 +00:00
// entitlements
2010-09-17 18:27:20 +00:00
$entitlements = new htmlTable ();
2009-02-22 19:25:58 +00:00
if ( isset ( $this -> attributes [ 'eduPersonEntitlement' ][ 0 ])) {
for ( $i = 0 ; $i < sizeof ( $this -> attributes [ 'eduPersonEntitlement' ]); $i ++ ) {
2010-09-17 18:27:20 +00:00
$entitlements -> addElement ( new htmlInputField ( 'entitlement' . $i , $this -> attributes [ 'eduPersonEntitlement' ][ $i ]));
$entitlements -> addElement ( new htmlButton ( 'delEntitlement' . $i , 'del.png' , true ), true );
2009-02-22 19:25:58 +00:00
}
2009-02-10 19:41:20 +00:00
}
2009-02-22 19:25:58 +00:00
else {
2010-09-17 18:27:20 +00:00
$entitlements -> addElement ( new htmlOutputText ( '-' ));
2009-02-22 19:25:58 +00:00
}
2010-09-17 18:27:20 +00:00
$entitlementLabel = new htmlOutputText ( _ ( 'Entitlements' ));
$entitlementLabel -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $entitlementLabel );
$return -> addElement ( $entitlements );
$entitlementHelp = new htmlHelpLink ( 'entitlement' );
$entitlementHelp -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $entitlementHelp , true );
$return -> addElement ( new htmlOutputText ( '' ));
$newEntitlementContainer = new htmlTable ();
$newEntitlementContainer -> addElement ( new htmlInputField ( 'entitlement' , '' ));
$newEntitlementContainer -> addElement ( new htmlButton ( 'newEntitlement' , 'add.png' , true ));
$return -> addElement ( $newEntitlementContainer );
$return -> addElement ( new htmlOutputText ( '' ), true );
2009-03-03 19:37:17 +00:00
// org DN
$orgDN = '' ;
if ( isset ( $this -> attributes [ 'eduPersonOrgDN' ][ 0 ])) {
$orgDN = $this -> attributes [ 'eduPersonOrgDN' ][ 0 ];
}
2011-06-06 18:05:17 +00:00
$orgDNInput = new htmlTableExtendedInputField ( _ ( 'Organisation' ), 'orgDN' , $orgDN , 'orgDN' );
2010-09-17 18:27:20 +00:00
$orgDNInput -> setFieldSize ( 40 );
$return -> addElement ( $orgDNInput , true );
2009-03-03 19:37:17 +00:00
// primare OU DN
$primaryOrgUnitDN = '' ;
if ( isset ( $this -> attributes [ 'eduPersonPrimaryOrgUnitDN' ][ 0 ])) {
$primaryOrgUnitDN = $this -> attributes [ 'eduPersonPrimaryOrgUnitDN' ][ 0 ];
}
2011-06-06 18:05:17 +00:00
$primaryOUInput = new htmlTableExtendedInputField ( _ ( 'Primary organisational unit' ), 'primaryOrgUnitDN' , $primaryOrgUnitDN , 'primaryOrgUnitDN' );
2010-09-17 18:27:20 +00:00
$primaryOUInput -> setFieldSize ( 40 );
$return -> addElement ( $primaryOUInput , true );
2009-03-03 19:37:17 +00:00
// OUs
2010-09-17 18:27:20 +00:00
$orgUnitDN = new htmlTable ();
2009-03-03 19:37:17 +00:00
if ( isset ( $this -> attributes [ 'eduPersonOrgUnitDN' ][ 0 ])) {
for ( $i = 0 ; $i < sizeof ( $this -> attributes [ 'eduPersonOrgUnitDN' ]); $i ++ ) {
2010-09-17 18:27:20 +00:00
$orgUnitDNInput = new htmlInputField ( 'orgUnitDN' . $i , $this -> attributes [ 'eduPersonOrgUnitDN' ][ $i ]);
$orgUnitDNInput -> setFieldSize ( 40 );
$orgUnitDN -> addElement ( $orgUnitDNInput );
$orgUnitDN -> addElement ( new htmlButton ( 'delOrgUnitDN' . $i , 'del.png' , true ), true );
2009-03-03 19:37:17 +00:00
}
}
else {
2010-09-17 18:27:20 +00:00
$orgUnitDN -> addElement ( new htmlOutputText ( '-' ));
2009-03-03 19:37:17 +00:00
}
2011-06-06 18:05:17 +00:00
$orgUnitDNLabel = new htmlOutputText ( _ ( 'Organisational units' ));
2010-09-17 18:27:20 +00:00
$orgUnitDNLabel -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $orgUnitDNLabel );
$return -> addElement ( $orgUnitDN );
$orgUnitDNHelp = new htmlHelpLink ( 'orgUnitDN' );
$orgUnitDNHelp -> alignment = htmlElement :: ALIGN_TOP ;
$return -> addElement ( $orgUnitDNHelp , true );
$return -> addElement ( new htmlOutputText ( '' ));
$newOrgUnitDN = new htmlTable ();
$newOrgUnitDNInput = new htmlInputField ( 'orgUnitDN' , '' );
$newOrgUnitDNInput -> setFieldSize ( 40 );
$newOrgUnitDN -> addElement ( $newOrgUnitDNInput );
$newOrgUnitDN -> addElement ( new htmlButton ( 'newOrgUnitDN' , 'add.png' , true ));
$return -> addElement ( $newOrgUnitDN );
$return -> addElement ( new htmlOutputText ( '' ), true );
$return -> addElement ( new htmlSpacer ( null , '10px' ), true );
$addButton = new htmlButton ( 'remObjectClass' , _ ( 'Remove EDU person extension' ));
$addButton -> colspan = 3 ;
$return -> addElement ( $addButton );
2009-02-22 19:25:58 +00:00
}
2009-02-10 19:41:20 +00:00
else {
2010-09-17 18:27:20 +00:00
$return -> addElement ( new htmlButton ( 'addObjectClass' , _ ( 'Add EDU person extension' )));
2009-02-10 19:41:20 +00:00
}
return $return ;
}
/**
* Processes user input of the primary module page .
* It checks if all input values are correct and updates the associated LDAP attributes .
*
* @ return array list of info / error messages
*/
function process_attributes () {
2010-09-17 18:27:20 +00:00
if ( isset ( $_POST [ 'addObjectClass' ])) {
2009-12-20 14:35:42 +00:00
$this -> attributes [ 'objectClass' ][] = 'eduPerson' ;
return array ();
}
2010-09-17 18:27:20 +00:00
elseif ( isset ( $_POST [ 'remObjectClass' ])) {
2009-12-20 14:35:42 +00:00
$this -> attributes [ 'objectClass' ] = array_delete ( array ( 'eduPerson' ), $this -> attributes [ 'objectClass' ]);
for ( $i = 0 ; $i < sizeof ( $this -> meta [ 'attributes' ]); $i ++ ) {
if ( isset ( $this -> attributes [ $this -> meta [ 'attributes' ][ $i ]])) {
unset ( $this -> attributes [ $this -> meta [ 'attributes' ][ $i ]]);
}
}
return array ();
}
2010-05-19 19:22:29 +00:00
if ( ! in_array ( 'eduPerson' , $this -> attributes [ 'objectClass' ])) {
return array ();
}
2009-02-10 19:41:20 +00:00
$errors = array ();
// primary affiliation
$this -> attributes [ 'eduPersonPrimaryAffiliation' ][ 0 ] = $_POST [ 'primaryAffiliation' ];
2009-02-22 19:25:58 +00:00
// scoped affiliation
if ( isset ( $_POST [ 'scopedAffiliation' ]) && ( $_POST [ 'scopedAffiliation' ] != '' )) {
$this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ] = $_POST [ 'scopedAffiliationPrefix' ] . '@' . $_POST [ 'scopedAffiliation' ];
}
elseif ( isset ( $this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ])) {
unset ( $this -> attributes [ 'eduPersonScopedAffiliation' ]);
}
2009-02-10 19:41:20 +00:00
// principal name
$this -> attributes [ 'eduPersonPrincipalName' ][ 0 ] = $_POST [ 'principalName' ];
if ( $_POST [ 'principalName' ] != '' ) {
2009-08-13 18:57:26 +00:00
if ( ! preg_match ( '/^[0-9a-z_\\.@-]+$/i' , $_POST [ 'principalName' ])) {
2009-02-10 19:41:20 +00:00
$errors [] = $this -> messages [ 'principalName' ][ 0 ];
}
}
// affiliations
$this -> attributes [ 'eduPersonAffiliation' ] = array ();
$i = 0 ;
while ( isset ( $_POST [ 'affiliation' . $i ])) {
if ( ! isset ( $_POST [ 'delAffiliation' . $i ]) && ( $_POST [ 'affiliation' . $i ] != '' )) {
$this -> attributes [ 'eduPersonAffiliation' ][] = $_POST [ 'affiliation' . $i ];
}
$i ++ ;
}
if ( isset ( $_POST [ 'newAffiliation' ]) && ( $_POST [ 'affiliation' ] != '' )) {
$this -> attributes [ 'eduPersonAffiliation' ][] = $_POST [ 'affiliation' ];
}
$this -> attributes [ 'eduPersonAffiliation' ] = array_unique ( $this -> attributes [ 'eduPersonAffiliation' ]);
// nick names
$this -> attributes [ 'eduPersonNickname' ] = array ();
$i = 0 ;
while ( isset ( $_POST [ 'nickName' . $i ])) {
if ( ! isset ( $_POST [ 'delNickName' . $i ]) && ( $_POST [ 'nickName' . $i ] != '' )) {
$this -> attributes [ 'eduPersonNickname' ][] = $_POST [ 'nickName' . $i ];
}
$i ++ ;
}
if ( isset ( $_POST [ 'newNickName' ]) && ( $_POST [ 'nickName' ] != '' )) {
$this -> attributes [ 'eduPersonNickname' ][] = $_POST [ 'nickName' ];
}
$this -> attributes [ 'eduPersonNickname' ] = array_unique ( $this -> attributes [ 'eduPersonNickname' ]);
2009-02-22 19:25:58 +00:00
// entitlements
$this -> attributes [ 'eduPersonEntitlement' ] = array ();
$i = 0 ;
while ( isset ( $_POST [ 'entitlement' . $i ])) {
if ( ! isset ( $_POST [ 'delEntitlement' . $i ]) && ( $_POST [ 'entitlement' . $i ] != '' )) {
$this -> attributes [ 'eduPersonEntitlement' ][] = $_POST [ 'entitlement' . $i ];
}
$i ++ ;
}
if ( isset ( $_POST [ 'newEntitlement' ]) && ( $_POST [ 'entitlement' ] != '' )) {
$this -> attributes [ 'eduPersonEntitlement' ][] = $_POST [ 'entitlement' ];
}
$this -> attributes [ 'eduPersonEntitlement' ] = array_unique ( $this -> attributes [ 'eduPersonEntitlement' ]);
2009-03-03 19:37:17 +00:00
// org DN
$this -> attributes [ 'eduPersonOrgDN' ][ 0 ] = $_POST [ 'orgDN' ];
if ( $_POST [ 'orgDN' ] != '' ) {
if ( ! get_preg ( $_POST [ 'orgDN' ], 'dn' )) {
$errors [] = $this -> messages [ 'orgDN' ][ 0 ];
}
}
// primary OU
$this -> attributes [ 'eduPersonPrimaryOrgUnitDN' ][ 0 ] = $_POST [ 'primaryOrgUnitDN' ];
if ( $_POST [ 'primaryOrgUnitDN' ] != '' ) {
if ( ! get_preg ( $_POST [ 'primaryOrgUnitDN' ], 'dn' )) {
$errors [] = $this -> messages [ 'primaryOrgUnitDN' ][ 0 ];
}
}
// OUs
$this -> attributes [ 'eduPersonOrgUnitDN' ] = array ();
$i = 0 ;
while ( isset ( $_POST [ 'orgUnitDN' . $i ])) {
if ( ! isset ( $_POST [ 'delOrgUnitDN' . $i ]) && ( $_POST [ 'orgUnitDN' . $i ] != '' )) {
$this -> attributes [ 'eduPersonOrgUnitDN' ][] = $_POST [ 'orgUnitDN' . $i ];
if ( ! get_preg ( $_POST [ 'orgUnitDN' . $i ], 'dn' )) {
$error = $this -> messages [ 'orgUnitDN' ][ 0 ];
array_push ( $error , $_POST [ 'orgUnitDN' . $i ]);
$errors [] = $error ;
}
}
$i ++ ;
}
if ( isset ( $_POST [ 'newOrgUnitDN' ]) && ( $_POST [ 'orgUnitDN' ] != '' )) {
$this -> attributes [ 'eduPersonOrgUnitDN' ][] = $_POST [ 'orgUnitDN' ];
if ( ! get_preg ( $_POST [ 'orgUnitDN' ], 'dn' )) {
$error = $this -> messages [ 'orgUnitDN' ][ 0 ];
array_push ( $error , $_POST [ 'orgUnitDN' ]);
$errors [] = $error ;
}
}
$this -> attributes [ 'eduPersonOrgUnitDN' ] = array_unique ( $this -> attributes [ 'eduPersonOrgUnitDN' ]);
2009-02-10 19:41:20 +00:00
return $errors ;
}
2009-12-20 14:35:42 +00:00
/**
* Loads the values of an account profile into internal variables .
*
* @ param array $profile hash array with profile values ( identifier => value )
*/
function load_profile ( $profile ) {
parent :: load_profile ( $profile );
// add extension
2011-01-09 14:38:00 +00:00
if ( isset ( $profile [ 'eduPerson_addExt' ][ 0 ]) && ( $profile [ 'eduPerson_addExt' ][ 0 ] == " true " )) {
2009-12-20 14:35:42 +00:00
if ( ! in_array ( 'eduPerson' , $this -> attributes [ 'objectClass' ])) {
$this -> attributes [ 'objectClass' ][] = 'eduPerson' ;
}
}
}
2009-02-10 19:41:20 +00:00
/**
* In this function the LDAP account is built up .
*
* @ param array $rawAccounts list of hash arrays ( name => value ) from user input
* @ param array $partialAccounts list of hash arrays ( name => value ) which are later added to LDAP
* @ param array $ids list of IDs for column position ( e . g . " posixAccount_uid " => 5 )
2010-02-15 20:21:44 +00:00
* @ param array $selectedModules list of selected account modules
2009-02-10 19:41:20 +00:00
* @ return array list of error messages if any
*/
2010-02-15 20:21:44 +00:00
function build_uploadAccounts ( $rawAccounts , $ids , & $partialAccounts , $selectedModules ) {
2009-02-10 19:41:20 +00:00
$messages = array ();
for ( $i = 0 ; $i < sizeof ( $rawAccounts ); $i ++ ) {
// add object class
if ( ! in_array ( " eduPerson " , $partialAccounts [ $i ][ 'objectClass' ])) $partialAccounts [ $i ][ 'objectClass' ][] = " eduPerson " ;
2009-03-06 19:17:22 +00:00
// principal name
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_principalName' ]] != " " ) {
2009-08-13 18:57:26 +00:00
if ( ! preg_match ( '/^[0-9a-z_\\.@-]+$/i' , $rawAccounts [ $i ][ $ids [ 'eduPerson_principalName' ]])) {
2009-03-06 19:17:22 +00:00
$error = $this -> messages [ 'principalName' ][ 1 ];
array_push ( $error , $i );
$messages [] = $error ;
}
else {
$partialAccounts [ $i ][ 'eduPersonPrincipalName' ] = $rawAccounts [ $i ][ $ids [ 'eduPerson_principalName' ]];
}
}
2009-02-10 19:41:20 +00:00
// primary affiliation
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_primaryAffiliation' ]] != " " ) {
2009-03-06 19:17:22 +00:00
if ( ! in_array ( $rawAccounts [ $i ][ $ids [ 'eduPerson_primaryAffiliation' ]], $this -> affiliationTypes )) {
$error = $this -> messages [ 'primaryAffiliation' ][ 0 ];
array_push ( $error , $i );
$messages [] = $error ;
}
else {
$partialAccounts [ $i ][ 'eduPersonPrimaryAffiliation' ] = $rawAccounts [ $i ][ $ids [ 'eduPerson_primaryAffiliation' ]];
}
}
// scoped affiliation
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_scopedAffiliation' ]] != " " ) {
$parts = explode ( '@' , $rawAccounts [ $i ][ $ids [ 'eduPerson_scopedAffiliation' ]]);
if ( ! in_array ( $parts [ 0 ], $this -> affiliationTypes )) {
$error = $this -> messages [ 'scopedAffiliation' ][ 0 ];
array_push ( $error , $i );
$messages [] = $error ;
}
else {
$partialAccounts [ $i ][ 'eduPersonScopedAffiliation' ] = $rawAccounts [ $i ][ $ids [ 'eduPerson_scopedAffiliation' ]];
}
}
// affiliations
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_affiliation' ]] != " " ) {
$parts = explode ( ', ' , $rawAccounts [ $i ][ $ids [ 'eduPerson_affiliation' ]]);
$valid = true ;
for ( $a = 0 ; $a < sizeof ( $parts ); $a ++ ) {
if ( ! in_array ( $parts [ $a ], $this -> affiliationTypes )) {
$valid = false ;
$error = $this -> messages [ 'affiliation' ][ 0 ];
array_push ( $error , $i );
$messages [] = $error ;
break ;
}
}
if ( $valid ) {
$partialAccounts [ $i ][ 'eduPersonAffiliation' ] = $parts ;
}
}
// nick names
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_nickname' ]] != " " ) {
$parts = explode ( ', ' , $rawAccounts [ $i ][ $ids [ 'eduPerson_nickname' ]]);
$partialAccounts [ $i ][ 'eduPersonNickname' ] = $parts ;
}
// entitlements
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_entitlement' ]] != " " ) {
$parts = explode ( ', ' , $rawAccounts [ $i ][ $ids [ 'eduPerson_entitlement' ]]);
$partialAccounts [ $i ][ 'eduPersonEntitlement' ] = $parts ;
}
2011-06-06 18:05:17 +00:00
// organisation
2009-03-06 19:17:22 +00:00
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_orgDN' ]] != " " ) {
if ( ! get_preg ( $rawAccounts [ $i ][ $ids [ 'eduPerson_orgDN' ]], 'dn' )) {
$error = $this -> messages [ 'orgDN' ][ 1 ];
array_push ( $error , $i );
$messages [] = $error ;
}
else {
$partialAccounts [ $i ][ 'eduPersonOrgDN' ] = $rawAccounts [ $i ][ $ids [ 'eduPerson_orgDN' ]];
}
}
// primary OU
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_primaryOrgUnitDN' ]] != " " ) {
if ( ! get_preg ( $rawAccounts [ $i ][ $ids [ 'eduPerson_primaryOrgUnitDN' ]], 'dn' )) {
$error = $this -> messages [ 'primaryOrgUnitDN' ][ 1 ];
array_push ( $error , $i );
$messages [] = $error ;
}
else {
$partialAccounts [ $i ][ 'eduPersonPrimaryOrgUnitDN' ] = $rawAccounts [ $i ][ $ids [ 'eduPerson_primaryOrgUnitDN' ]];
}
}
// OUs
if ( $rawAccounts [ $i ][ $ids [ 'eduPerson_orgUnitDN' ]] != " " ) {
$parts = explode ( ', ' , $rawAccounts [ $i ][ $ids [ 'eduPerson_orgUnitDN' ]]);
$valid = true ;
for ( $a = 0 ; $a < sizeof ( $parts ); $a ++ ) {
if ( ! get_preg ( $parts [ $a ], 'dn' )) {
$valid = false ;
$error = $this -> messages [ 'orgUnitDN' ][ 1 ];
array_push ( $error , $i );
$messages [] = $error ;
break ;
}
}
if ( $valid ) {
$partialAccounts [ $i ][ 'eduPersonOrgUnitDN' ] = $parts ;
}
2009-02-10 19:41:20 +00:00
}
}
return $messages ;
}
/**
* Returns the PDF entries for this module .
*
* @ return array list of possible PDF entries
*/
function get_pdfEntries () {
$return = array ();
if ( isset ( $this -> attributes [ 'eduPersonPrimaryAffiliation' ][ 0 ])) {
$return [ 'eduPerson_primaryAffiliation' ][ 0 ] = '<block><key>' . _ ( 'Primary affiliation' ) . '</key><value>' . $this -> attributes [ 'eduPersonPrimaryAffiliation' ][ 0 ] . '</value></block>' ;
}
2009-02-22 19:25:58 +00:00
if ( isset ( $this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ])) {
$return [ 'eduPerson_scopedAffiliation' ][ 0 ] = '<block><key>' . _ ( 'Scoped affiliation' ) . '</key><value>' . $this -> attributes [ 'eduPersonScopedAffiliation' ][ 0 ] . '</value></block>' ;
}
2009-02-10 19:41:20 +00:00
if ( isset ( $this -> attributes [ 'eduPersonPrincipalName' ][ 0 ])) {
$return [ 'eduPerson_principalName' ][ 0 ] = '<block><key>' . _ ( 'Principal name' ) . '</key><value>' . $this -> attributes [ 'eduPersonPrincipalName' ][ 0 ] . '</value></block>' ;
}
if ( isset ( $this -> attributes [ 'eduPersonNickname' ][ 0 ])) {
sort ( $this -> attributes [ 'eduPersonNickname' ]);
$return [ 'eduPerson_nickname' ][ 0 ] = '<block><key>' . _ ( 'Nick names' ) . '</key><value>' . implode ( ', ' , $this -> attributes [ 'eduPersonNickname' ]) . '</value></block>' ;
}
if ( isset ( $this -> attributes [ 'eduPersonAffiliation' ][ 0 ])) {
sort ( $this -> attributes [ 'eduPersonAffiliation' ]);
$return [ 'eduPerson_affiliation' ][ 0 ] = '<block><key>' . _ ( 'Affiliations' ) . '</key><value>' . implode ( ', ' , $this -> attributes [ 'eduPersonAffiliation' ]) . '</value></block>' ;
}
2009-02-22 19:25:58 +00:00
if ( isset ( $this -> attributes [ 'eduPersonEntitlement' ][ 0 ])) {
sort ( $this -> attributes [ 'eduPersonEntitlement' ]);
$return [ 'eduPerson_entitlement' ][ 0 ] = '<block><key>' . _ ( 'Entitlements' ) . '</key><value>' . implode ( ', ' , $this -> attributes [ 'eduPersonEntitlement' ]) . '</value></block>' ;
}
2009-03-03 19:37:17 +00:00
if ( isset ( $this -> attributes [ 'eduPersonOrgDN' ][ 0 ])) {
2011-06-06 18:05:17 +00:00
$return [ 'eduPerson_orgDN' ][ 0 ] = '<block><key>' . _ ( 'Organisation' ) . '</key><value>' . $this -> attributes [ 'eduPersonOrgDN' ][ 0 ] . '</value></block>' ;
2009-03-03 19:37:17 +00:00
}
if ( isset ( $this -> attributes [ 'eduPersonPrimaryOrgUnitDN' ][ 0 ])) {
2011-06-06 18:05:17 +00:00
$return [ 'eduPerson_primaryOrgUnitDN' ][ 0 ] = '<block><key>' . _ ( 'Primary organisational unit' ) . '</key><value>' . $this -> attributes [ 'eduPersonPrimaryOrgUnitDN' ][ 0 ] . '</value></block>' ;
2009-03-03 19:37:17 +00:00
}
if ( isset ( $this -> attributes [ 'eduPersonOrgUnitDN' ][ 0 ])) {
2011-06-06 18:05:17 +00:00
$return [ 'eduPerson_orgUnitDN' ][ 0 ] = '<block><key>' . _ ( 'Organisational units' ) . '</key><value>' . implode ( ', ' , $this -> attributes [ 'eduPersonOrgUnitDN' ]) . '</value></block>' ;
2009-03-03 19:37:17 +00:00
}
2009-02-10 19:41:20 +00:00
return $return ;
}
}
?>