\version 2.00
\date 24.07.2003
This is the base class for all plugins. It can be used standalone or
can be included by the tabs class. All management should be done
within this class. Extend your plugins from this class.
*/
class plugin
{
/*!
\brief Reference to parent object
This variable is used when the plugin is included in tabs
and keeps reference to the tab class. Communication to other
tabs is possible by 'name'. So the 'fax' plugin can ask the
'userinfo' plugin for the fax number.
\sa tab
*/
var $parent= NULL;
/*!
\brief Configuration container
Access to global configuration
*/
var $config= NULL;
/*!
\brief Mark plugin as account
Defines whether this plugin is defined as an account or not.
This has consequences for the plugin to be saved from tab
mode. If it is set to 'FALSE' the tab will call the delete
function, else the save function. Should be set to 'TRUE' if
the construtor detects a valid LDAP object.
\sa plugin::plugin()
*/
var $is_account= FALSE;
var $initially_was_account= FALSE;
/*!
\brief Mark plugin as template
Defines whether we are creating a template or a normal object.
Has conseqences on the way execute() shows the formular and how
save() puts the data to LDAP.
\sa plugin::save() plugin::execute()
*/
var $is_template= FALSE;
var $ignore_account= FALSE;
var $is_modified= FALSE;
/*!
\brief Represent temporary LDAP data
This is only used internally.
*/
var $attrs= array();
/*!
\brief Used standard values
dn
*/
var $dn= "";
var $uid= "";
var $sn= "";
var $givenName= "";
var $acl= "*none*";
var $dialog= FALSE;
/* attribute list for save action */
var $attributes= array();
var $objectclasses= array();
var $new= TRUE;
var $saved_attributes= array();
/*! \brief plugin constructor
If 'dn' is set, the node loads the given 'dn' from LDAP
\param dn Distinguished name to initialize plugin from
\sa plugin()
*/
function plugin ($config, $dn= NULL)
{
/* Configuration is fine, allways */
$this->config= $config;
$this->dn= $dn;
/* Handle new accounts, don't read information from LDAP */
if ($dn == "new"){
return;
}
/* Get LDAP descriptor */
$ldap= $this->config->get_ldap_link();
if ($dn != NULL){
/* Load data to 'attrs' and save 'dn' */
$ldap->cat ($dn);
$this->attrs= $ldap->fetch();
/* Copy needed attributes */
foreach ($this->attributes as $val){
#if (isset($this->attrs["$val"][0])){
$found= array_key_ics($val, $this->attrs);
if ($found != ""){
$this->$val= $this->attrs["$found"][0];
}
}
/* Set the template flag according to the existence of objectClass
gosaUserTemplate */
if (isset($this->attrs['objectClass'])){
if (in_array ("gosaUserTemplate", $this->attrs['objectClass'])){
$this->is_template= TRUE;
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
"found", "Template check");
}
}
/* Is Account? */
error_reporting(0);
$found= TRUE;
foreach ($this->objectclasses as $obj){
if (preg_match('/top/i', $obj)){
continue;
}
if (!isset($this->attrs['objectClass']) || !in_array_ics ($obj, $this->attrs['objectClass'])){
$found= FALSE;
break;
}
}
error_reporting(E_ALL);
if ($found){
$this->is_account= TRUE;
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
"found", "Object check");
}
/* Prepare saved attributes */
$this->saved_attributes= $this->attrs;
foreach ($this->saved_attributes as $index => $value){
if (preg_match('/^[0-9]+$/', $index)){
unset($this->saved_attributes[$index]);
continue;
}
if (!in_array($index, $this->attributes) && $index != "objectClass"){
unset($this->saved_attributes[$index]);
continue;
}
if ($this->saved_attributes[$index]["count"] == 1){
$tmp= $this->saved_attributes[$index][0];
unset($this->saved_attributes[$index]);
$this->saved_attributes[$index]= $tmp;
continue;
}
unset($this->saved_attributes["$index"]["count"]);
}
}
/* Save initial account state */
$this->initially_was_account= $this->is_account;
}
/*! \brief execute plugin
Generates the html output for this node
*/
function execute()
{
# This one is empty currently. Fabian - please fill in the docu code
$_SESSION['current_class_for_help'] = get_class($this);
}
/* remove object from parent */
function remove_from_parent()
{
/* include global link_info */
$ldap= $this->config->get_ldap_link();
/* Get current objectClasses in order to add the required ones */
$ldap->cat($this->dn);
$tmp= $ldap->fetch ();
if (isset($tmp['objectClass'])){
$oc= $tmp['objectClass'];
} else {
$oc= array("count" => 0);
}
/* Remove objectClasses from entry */
$ldap->cd($this->dn);
$this->attrs= array();
$this->attrs['objectClass']= array();
for ($i= 0; $i<$oc["count"]; $i++){
if (!in_array_ics($oc[$i], $this->objectclasses)){
$this->attrs['objectClass'][]= $oc[$i];
}
}
/* Unset attributes from entry */
foreach ($this->attributes as $val){
$this->attrs["$val"]= array();
}
/* Unset account info */
$this->is_account= FALSE;
/* Do not write in plugin base class, this must be done by
children, since there are normally additional attribs,
lists, etc. */
/*
$ldap->modify($this->attrs);
*/
}
/* Save data to object */
function save_object()
{
/* Save values to object */
foreach ($this->attributes as $val){
if (chkacl ($this->acl, "$val") == "" && isset ($_POST["$val"])){
/* Check for modifications */
if (get_magic_quotes_gpc()) {
$data= stripcslashes($_POST["$val"]);
} else {
$data= $this->$val = $_POST["$val"];
}
if ($this->$val != $data){
$this->is_modified= TRUE;
}
/* Okay, how can I explain this fix ...
* In firefox, disabled option fields aren't selectable ... but in IE you can select these fileds.
* So IE posts these 'unselectable' option, with value = chr(194)
* chr(194) seems to be the in between the ...option> $val= $data;
}
}
}
/* Save data to LDAP, depending on is_account we save or delete */
function save()
{
/* include global link_info */
$ldap= $this->config->get_ldap_link();
/* Start with empty array */
$this->attrs= array();
/* Get current objectClasses in order to add the required ones */
$ldap->cat($this->dn);
$tmp= $ldap->fetch ();
if (isset($tmp['objectClass'])){
$oc= $tmp["objectClass"];
$this->new= FALSE;
} else {
$oc= array("count" => 0);
$this->new= TRUE;
}
/* Load (minimum) attributes, add missing ones */
$this->attrs['objectClass']= $this->objectclasses;
for ($i= 0; $i<$oc["count"]; $i++){
if (!in_array_ics($oc[$i], $this->objectclasses)){
$this->attrs['objectClass'][]= $oc[$i];
}
}
/* Copy standard attributes */
foreach ($this->attributes as $val){
if ($this->$val != ""){
$this->attrs["$val"]= $this->$val;
} elseif (!$this->new) {
$this->attrs["$val"]= array();
}
}
}
function cleanup()
{
foreach ($this->attrs as $index => $value){
/* Remove emtpy arrays if they do not differ */
if (is_array($this->attrs[$index]) && count($this->attrs[$index]) == 0 && !isset($this->saved_attributes[$index])){
unset ($this->attrs[$index]);
continue;
}
/* Remove single attributes that do not differ */
if (!is_array($this->attrs[$index]) && isset($this->saved_attributes[$index])
&& !is_array($this->saved_attributes[$index]) && $value == $this->saved_attributes[$index]){
unset ($this->attrs[$index]);
continue;
}
/* Remove arrays that do not differ */
if (is_array($this->attrs[$index]) && isset($this->saved_attributes[$index]) && is_array($this->saved_attributes[$index])){
if (count(array_diff($this->attrs[$index],$this->saved_attributes[$index]))==0 ){
unset ($this->attrs[$index]);
continue;
}
}
}
#######################################
; if (count($this->attrs)!=0){ ;
; echo "--- DEBUG: changes ---
" ;
; print_a ($this->attrs) ;
; } ;
#######################################
}
/* Check formular input */
function check()
{
$message= array();
return ($message);
}
/* Adapt from template, using 'dn' */
function adapt_from_template($dn)
{
/* Include global link_info */
$ldap= $this->config->get_ldap_link();
/* Load requested 'dn' to 'attrs' */
$ldap->cat ($dn);
$this->attrs= $ldap->fetch();
/* Walk through attributes */
foreach ($this->attributes as $val){
if (isset($this->attrs["$val"][0])){
/* If attribute is set, replace dynamic parts:
%sn, %givenName and %uid. Fill these in our local variables. */
$value= $this->attrs["$val"][0];
foreach (array("sn", "givenName", "uid") as $repl){
if (preg_match("/%$repl/i", $value)){
$value= preg_replace ("/%$repl/i", $this->parent->$repl, $value);
}
}
$this->$val= $value;
}
}
/* Is Account? */
$found= TRUE;
foreach ($this->objectclasses as $obj){
if (preg_match('/top/i', $obj)){
continue;
}
if (!in_array_ics ($obj, $this->attrs['objectClass'])){
$found= FALSE;
break;
}
}
if ($found){
$this->is_account= TRUE;
}
}
/* Indicate whether a password change is needed or not */
function password_change_needed()
{
return FALSE;
}
/* Show header message for tab dialogs */
function show_header($button_text, $text, $disabled= FALSE)
{
if ($disabled == TRUE){
$state= "disabled";
} else {
$state= "";
}
$display= "
$text \n"; $display.= "acl, "all")." ".$state. ">
|