Plugin is now GOsa conform

git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@18805 594d385d-05f5-0310-b6e9-bd551577e9d8

diff --git a/gosa-plugins/dyngroup/addons/dyngroup/classDynamicLdapGroup.inc b/gosa-plugins/dyngroup/addons/dyngroup/classDynamicLdapGroup.inc
index 730f6f9da93fb374b1ccda03d075ba5ff11674f3..4f9a8990f34ddffbb88364f7762707d3468d9205 100644 (file)
--- a/gosa-plugins/dyngroup/addons/dyngroup/classDynamicLdapGroup.inc
+++ b/gosa-plugins/dyngroup/addons/dyngroup/classDynamicLdapGroup.inc
@@ -25,336 +25,250 @@
  * @author Thomas Chemineau - thomas.chemineau<at>gmail.com
  * @version 0.01
  */
-class DynamicLdapGroup extends group
+class DynamicLdapGroup extends plugin
 {
 
-  /**
-   * The attribute that will use GOsa to store LDAP URI.
-   * @var array
-   */
-  public $attributes = array('labeledURI');
+    /**
+     * The attribute that will use GOsa to store LDAP URI.
+     * @var array
+     */
+    public $attributes = array('labeledURI');
 
-  /**
-   * The objectClass that will use GOsa to identify a group as dynamic.
-   * @var array
-   */
-  public $objectclasses = array('labeledURIObject');
+    /**
+     * The objectClass that will use GOsa to identify a group as dynamic.
+     * @var array
+     */
+    public $objectclasses = array('labeledURIObject');
 
-  /**
-   * Default value for the corresponding attribute found in the $this->attributes
-   * array of this plugin.
-   * @var string
-   */
-  public $labeledURI = 'ldap:///dc=example,dc=com?memberUid?sub?(objectClass=posixGroup)';
+    /**
+     * Default value for the corresponding attribute found in the $this->attributes
+     * array of this plugin.
+     * @var string
+     */
+    public $labeledURI = 'ldap:///dc=example,dc=com?memberUid?sub?(objectClass=posixGroup)';
 
-  /**
-   * Indicates if the feature is enabled or not.
-   * @var boolean
-   */
-  private $_isEnabled = false;
+    /**
+     * Store values of memberUrl.
+     * @var Array
+     */
+    private $_memberUrls = Array();
 
-  /**
-   * Indicates if this plugin is manualy activated.
-   * @var boolean
-   */
-  private $_isManualyActivated = false;
+    public $orig_dn ="";
 
-  /**
-   * Store values of memberUrl.
-   * @var Array
-   */
-  private $_memberUrls = Array();
+    /**
+     * Create this object.
+     * @param Array $config GOsa config.
+     * @param string $dn Current DN.
+     */
+    public function __construct ($config, $dn)
+    {
+        parent::__construct($config, $dn);
 
-  /**
-   * Create this object.
-   * @param Array $config GOsa config.
-   * @param string $dn Current DN.
-   */
-  public function __construct ($config, $dn)
-  {
-    parent::__construct($config, $dn);
-    $attr_label = $this->attributes[0];
-    $this->$attr_label = str_replace('dc=example,dc=com', LDAP::fix($this->dn), $this->$attr_label);
-  }
+        // Preset the labeled URI with a valid value.
+        if(!$this->is_account){
+            $attr_label = $this->attributes[0];
+            $this->$attr_label = str_replace('dc=example,dc=com', LDAP::fix($this->dn), $this->$attr_label);
+        }
 
-  /**
-   * This function is called by GOsa when the current group will be saved into the
-   * LDAP directory. It will check status of this plugin.
-   */
-  public function check ()
-  {
-    if (!$this->_isManualyActivated)
-    {
-      $this->_isEnabled = $this->isDynamicGroup();
+        $this->orig_dn = $this->dn;
     }
-    return Array();
-  }
 
-  /**
-   * Execute this plugin.
-   * @return string HTML to print.
-   */
-  public function execute ()
-  {
-    //
-    // Are we trying to modify state of this group ? If so,
-    // we can edit the current object.
-    //
-    if (isset($_POST['modify_state']))
-    {
-      $this->_isEnabled = !$this->_isEnabled;
-      $this->_isManualyActivated = true;
-    }
-    //
-    // Found if this group is dynamic or not. If it is not dynamic,
-    // we propose to enable this feature on this group. But by default,
-    // we mark this feature disabled.
-    //
-    $this->check();
-    //
-    // Display a message if this feature is disabled.
-    //
-    if (!$this->_isEnabled)
+    public function check ()
     {
-      return $this->show_disable_header(msgPool::addFeaturesButton(_("Dynamic Group")), msgPool::featuresDisabled(_("Dynamic Group")));
+        return Array();
     }
-    $display = $this->show_disable_header(msgPool::removeFeaturesButton(_("Dynamic Group")), msgPool::featuresEnabled(_("Dynamic Group")));
-    //
-    // Now, we search for current attributes, and display them.
-    //
-    $this->save_object();
-    $attr_label = $this->attributes[0];
-    $attr_value = $this->$attr_label;
-    // Display values.
-    //
-    $smarty = get_smarty();
-    $smarty->assign('memberURLAttributeLabel', $attr_label);
-    $smarty->assign('memberURLAttributeValue', $attr_value);
-    $display .= $smarty->fetch(get_template_path('dyngroup.tpl', TRUE, dirname(__FILE__)));
-    return $display;
-  }
 
-  /**
-   * Return attributes values of an LDAP entry.
-   * @param String $dn DN of the LDAP entry.
-   * @param Array $attributes Attributes to look for.
-   * @return Array An associative array of requested values.
-   */
-  public function getAttributesValues ($dn, $attributes = Array('dn'))
-  {
-    $ldap = $this->config->get_ldap_link();
-    $ldap->cat($dn, $attributes);
-    if ($attrs = $ldap->fetch())
+
+    /**
+     * Execute this plugin.
+     * @return string HTML to print.
+     */
+    public function execute ()
     {
-      $data = Array();
-      foreach ($attributes as $attribute)
-      {
-        if (array_key_exists($attribute, $attrs) !== false)
+        //
+        // Are we trying to modify state of this group ? If so,
+        // we can edit the current object.
+        //
+        if (isset($_POST['modify_state']))
         {
-          $data[$attribute] = $attrs[$attribute];
-          unset($data[$attribute]['count']);
+            $this->is_account = !$this->is_account;
         }
-      }
-      if (sizeof($data) > 0)
-      {
-        return $data;
-      }
-    }
-    return false;
-  }
 
-  /**
-   * Test if the current group is dynamic or not.
-   * The more simple way is to test if the objectclass exists into
-   * the entry.
-   * @return boolean True if this entry is considered as dynamic.
-   */
-  public function isDynamicGroup ()
-  {
-    $obj_ocs = $this->getAttributesValues($this->dn, Array('objectClass'));
-    if ($obj_ocs === false)
-    {
-      return false;
-    }
-    $obj_ocs = array_map('strtolower', $obj_ocs['objectClass']);
-    $plu_ocs = $this->objectclasses;
-    $plu_ocs_size = sizeof($this->objectclasses);
-    $found = 0;
-    for ($i=0; $i<$plu_ocs_size && $found<$plu_ocs_size; $i++)
-    {
-      $plu_oc = strtolower($plu_ocs[$i]);
-      if (in_array($plu_oc, $obj_ocs))
-      {
-        $found++;
-      }
-    }
-    if ($found >= $plu_ocs_size)
-    {
-      return true;
+        //
+        // Display a message if this feature is disabled.
+        //
+        if (!$this->is_account)
+        {
+            return $this->show_disable_header(msgPool::addFeaturesButton(_("Dynamic Group")), msgPool::featuresDisabled(_("Dynamic Group")));
+        }
+        $display = $this->show_disable_header(msgPool::removeFeaturesButton(_("Dynamic Group")), msgPool::featuresEnabled(_("Dynamic Group")));
+
+        //
+        // Now, we search for current attributes, and display them.
+        //
+        $attr_label = $this->attributes[0];
+        $attr_value = $this->$attr_label;
+
+        // Display values.
+        //
+        $smarty = get_smarty();
+        $smarty->assign('memberURLAttributeLabel', $attr_label);
+        $smarty->assign('memberURLAttributeValue', $attr_value);
+        $display .= $smarty->fetch(get_template_path('dyngroup.tpl', TRUE, dirname(__FILE__)));
+        return $display;
     }
-    return false;
-  }
 
-  /**
-   * Static method to set ACL for this plugin.
-   */
-  public static function plInfo()
-  {
-    return Array(
-        "plShortName"   => _("dyngroup"),
-        "plDescription" => _("Dynamic group setting"),
-        "plSelfModify"  => TRUE,
-        "plDepends"     => Array(),
-        "plPriority"    => 1,
-        "plSection"     => Array("addon"),
-        "plCategory"    => Array("groups", "department", "ogroups"),
-        "plProvidedAcls" => array(
-            'labeledURI' =>  _('labeledURI'),
-          )
-      );
-  }
 
-  /**
-   * This plugin does nothing when this method is invoked.
-   */
-  public function remove_from_parent ()
-  {
-    return;
-  }
 
-  /**
-   * Modify search base for all URL of all dynamic groups objects into the LDAP
-   * directory.
-   */
-  public function renameDNsInDynGroupsValues ($old_dn, $new_dn)
-  {
-    $ldap = $this->config->get_ldap_link();
-    $ldap->cd($this->config->current['BASE']);
-    //
-    // Build the LDAP search filter. We take only LDAP entries which have all
-    // objectClasses and attributes defined by this plugin.
-    //
-    $filter = '';
-    foreach ($this->objectclasses as $objectclass)
+    /**
+     * This plugin does nothing when this method is invoked.
+     */
+    public function remove_from_parent ()
     {
-      $filter .= '(objectClass=' . $objectclass . ')';
+        parent::remove_from_parent();
+        $ldap = $this->config->get_ldap_link();
+        $ldap->cd($this->dn);
+        $ldap->modify($this->attrs);
+        if(!$ldap->success()){
+            msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $this->dn, LDAP_DEL, get_class()));
+        }
+        return;
     }
-    foreach ($this->attributes as $attribute)
+
+
+    /**
+     * This function is called when tab is undisplayed. For example, the current user
+     * wants to change other settings of this group, but not save it to the LDAP
+     * directory directly.
+     */
+    public function save_object ()
     {
-      $filter .= '(' . $attribute . '=*)';
+        parent::save_object();
     }
-    $filter = '(&' . $filter . ')';
-    //
-    // The search should return some LDAP entries. If so, performed modifications
-    // on values (delete the values, and add it again with correct search DN).
-    //
-    $ldap->search($filter, Array('dn'));
-    if ($attrs = $ldap->fetch())
+
+
+    /**
+     * That will add additionnal information into the current LDAP entry.
+     * If this plugin is disable, then it will remove any data that references
+     * this plugin into the LDAP directory.
+     * @return boolean
+     */
+    public function save ()
     {
-      foreach ($attrs as $dn)
-      {
-        $values = $this->getAttributesValues($dn, $this->attributes);
-        if ($values === false || !is_array($values))
-        {
-          continue;
+        parent::save();
+        $this->cleanup();
+        $ldap = $this->config->get_ldap_link();
+        $ldap->cd($this->dn);
+        $ldap->modify($this->attrs);
+        if(!$ldap->success()){
+            msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $this->dn, LDAP_DEL, get_class()));
         }
-        foreach ($values as $attribute => $value)
+
+        if (strcasecmp($this->orig_dn, $this->dn) != 0)
         {
-          for($i=0; $i<sizeof($value); $i++)
-          {
-            $values[$attribute][$i] = str_replace($old_dn, $new_dn, $values[$attribute][$i]);
-          }
+            $this->renameDNsInDynGroupsValues($this->orig_dn, $this->dn);
         }
-        $ldap->cd($dn);
-        $ldap->modify($values);
-      }
     }
-  }
 
-  /**
-   * This function is called when tab is undisplayed. For example, the current user
-   * wants to change other settings of this group, but not save it to the LDAP
-   * directory directly.
-   */
-  public function save_object ()
-  {
-    $cur_memberURLLabel = $this->attributes[0];
-    $cur_memberURLValue = null;
-    if (isset($_POST[$cur_memberURLLabel]))
-    {
-      $cur_memberURLValue = $_POST[$cur_memberURLLabel];
-      $this->_isManualyActivated = true;
-    }
-    else if (!$this->_isManualyActivated)
-    {
-      $obj_memberURLValue = $this->getAttributesValues($this->dn, $this->attributes);
-      if ($obj_memberURLValue !== false)
-      {
-        $cur_memberURLValue = $obj_memberURLValue[$cur_memberURLLabel];
-      }
-    }
-    if (!is_null($cur_memberURLValue))
-    {
-      $this->$cur_memberURLLabel = $cur_memberURLValue;
-    }
-  }
 
-  /**
-   * That will add additionnal information into the current LDAP entry.
-   * If this plugin is disable, then it will remove any data that references
-   * this plugin into the LDAP directory.
-   * @return boolean
-   */
-  public function save ()
-  {
-    $ldap = $this->config->get_ldap_link();
-    $ldap->cd($this->dn);
-    //
-    // We disable dynamic group feature for this group, when:
-    // - The feature should be disable and this group is not dynamic;
-    // - The attributes exists into the entry.
-    //
-    if (!$this->_isEnabled && $this->isDynamicGroup())
+    /**
+     * Return attributes values of an LDAP entry.
+     * @param String $dn DN of the LDAP entry.
+     * @param Array $attributes Attributes to look for.
+     * @return Array An associative array of requested values.
+     */
+    public function getAttributesValues ($dn, $attributes = Array('dn'))
     {
-      if (array_key_exists($this->attributes[0], $this->attrs) !== false)
-      {
-        $data = Array(
-            $this->attributes[0] => Array()
-          );
-        $ldap->modify($data);
-      }
-      $data = Array(
-          'objectClass' => $this->objectclasses
-        );
-      $ldap->rm($data);
+        $ldap = $this->config->get_ldap_link();
+        $ldap->cat($dn, $attributes);
+        if ($attrs = $ldap->fetch())
+        {
+            $data = Array();
+            foreach ($attributes as $attribute)
+            {
+                if (array_key_exists($attribute, $attrs) !== false)
+                {
+                    $data[$attribute] = $attrs[$attribute];
+                    unset($data[$attribute]['count']);
+                }
+            }
+            if (sizeof($data) > 0)
+            {
+                return $data;
+            }
+        }
+        return false;
     }
-    //
-    // GOsa auto update $this->$attributeLabel with data found into
-    // forms. So, existing data will be saved, without doing anything.
-    // The operation is already done, no checks.
-    //
-    else if ($this->_isEnabled)
+
+
+    /**
+     * Modify search base for all URL of all dynamic groups objects into the LDAP
+     * directory.
+     */
+    public function renameDNsInDynGroupsValues ($old_dn, $new_dn)
     {
-      $data = Array(
-          'objectClass' => $this->objectclasses
-        );
-      $ldap->mod_add($data);
-      $attributeLabel = $this->attributes[0];
-      $data = Array(
-          $this->attributes[0] => Array($this->$attributeLabel)
-        );
-      $ldap->modify($data);
+        $ldap = $this->config->get_ldap_link();
+        $ldap->cd($this->config->current['BASE']);
+        //
+        // Build the LDAP search filter. We take only LDAP entries which have all
+        // objectClasses and attributes defined by this plugin.
+        //
+        $filter = '';
+        foreach ($this->objectclasses as $objectclass)
+        {
+            $filter .= '(objectClass=' . $objectclass . ')';
+                    }
+                    foreach ($this->attributes as $attribute)
+                    {
+                    $filter .= '(' . $attribute . '=*)';
+                    }
+            $filter = '(&' . $filter . ')';
+            //
+            // The search should return some LDAP entries. If so, performed modifications
+            // on values (delete the values, and add it again with correct search DN).
+            //
+            $ldap->search($filter, Array('dn'));
+            if ($attrs = $ldap->fetch())
+            {
+                foreach ($attrs as $dn)
+                {
+                    $values = $this->getAttributesValues($dn, $this->attributes);
+                    if ($values === false || !is_array($values))
+                    {
+                        continue;
+                    }
+                    foreach ($values as $attribute => $value)
+                    {
+                        for($i=0; $i<sizeof($value); $i++)
+                        {
+                            $values[$attribute][$i] = str_replace($old_dn, $new_dn, $values[$attribute][$i]);
+                        }
+                    }
+                    $ldap->cd($dn);
+                    $ldap->modify($values);
+                }
+            }
     }
-    //
-    // Detect if the current entry is renamed. If so, search for all
-    // dynamic groups, and modify search basedn if necessary.
-    //
-    if (strcasecmp($this->orig_dn, $this->dn) != 0)
+
+
+    /**
+     * Static method to set ACL for this plugin.
+     */
+    public static function plInfo()
     {
-      $this->renameDNsInDynGroupsValues($this->orig_dn, $this->dn);
+        return Array(
+                "plShortName"   => _("dyngroup"),
+                "plDescription" => _("Dynamic group setting"),
+                "plSelfModify"  => TRUE,
+                "plDepends"     => Array(),
+                "plPriority"    => 1,
+                "plSection"     => Array("addon"),
+                "plCategory"    => Array("groups", "department", "ogroups"),
+                "plProvidedAcls" => array(
+                    'labeledURI' =>  _('labeledURI'),
+                    )
+                );
     }
-  }
-
 }
 
 ?>