Code

Cleaned up pluglist a bit.
[gosa.git] / gosa-core / include / class_pluglist.inc
index 3d892c8e355d816a37106be2ed143e6c4f815fee..1615fe61967dac5f14462887f106953fa36cab09 100644 (file)
@@ -31,38 +31,40 @@ class pluglist {
        var $current= "";
        var $info= array();
        var $headlines = array();
-  var $allowed_plugins = array();
+        var $allowed_plugins = array();
+        var $silly_cache= array();
 
        function pluglist(&$config, &$ui)
        {
                $this->ui= &$ui;
                $this->config= &$config;
 
-               /* Create dirlist for all plugins */
+               // Get list of plugin paths, this allows us to open the plugins main.inc if available.
                $this->dirlist= $this->get_plugins ($this->dirlist, $this->config->data['MENU']);
 
-                /* Fill info part of pluglist */
-                $classes= get_declared_classes();
-
-                               foreach ($classes as $cname){
-                                       $cmethods = get_class_methods($cname);
-                                       if (in_array_ics('plInfo',$cmethods)){
-                                               $this->info[$cname]= @call_user_func(array($cname, 'plInfo'));
-                                       }
-                               }
+               // Detect installed plugins and their configuration, to be able to restrict access later.
+               $classes= get_declared_classes();
+               foreach ($classes as $cname){
+                       $cmethods = get_class_methods($cname);
+                       if (in_array_ics('plInfo',$cmethods)){
+                               $this->info[$cname]= call_user_func(array($cname, 'plInfo'));
+                       }
+               }
 
-               /* Provide field for 'all' */
+               // Reserve a special ACL will allows us to display plugins/addons whenever a user 
+    //  is able to login into gosa. E.g. some kind of welcome page. 
                $this->info['all']= array();
                $this->info['all']['plProvidedAcls']= array();
                $this->info['all']['plDescription']= _("All objects in this category");
                $this->info['all']['plSelfModify']= FALSE;
        }
 
+
+  /*! \brief    Detect plugin installation paths, by walking through the config. 
+   */
        function get_plugins($list, &$config)
        {
-                global $class_mapping;
-
-               /* Error reporting, because I'm getting strange messages in PHP 4.2.x */
+               global $class_mapping;
                if (!isset($config['CLASS'])){
                        if (is_array($config)){
                                foreach ($config as $val){
@@ -70,7 +72,7 @@ class pluglist {
                                }
                        }
                } else {
-                        if (is_array($config) && isset($class_mapping[$config['CLASS']])){
+                       if (is_array($config) && isset($class_mapping[$config['CLASS']])){
                                $list[$this->index++]= dirname($class_mapping[$config['CLASS']]);
                        } else {
                                $list[$this->index++]= "";
@@ -81,47 +83,59 @@ class pluglist {
        }
 
 
-       /*! \brief  Check whether we are allowed to modify the given acl or nit..
-                               This function is used to check which plugins are visible.
-                               
-               @param  The acl tag to test, eg.        "users/user:self", "systems", ...
-               @return Boolean TRUE on success else FALSE
-     */
+  /*! \brief  Check whether we are allowed to modify the given acl or not..
+   *           This function is used to check which plugins are visible.
+   *           
+   *  @param   The acl tag to check for, eg.   "users/user:self", "systems", ...
+   *  @return  Boolean TRUE on success else FALSE
+   */
        function check_access($aclname)
        {
-               /* Split given acl string into an array. 
-                       e.g. "user,systems" => array("users","systems");
-         */
+               if (isset($this->silly_cache[$aclname])) {
+                       return $this->silly_cache[$aclname];
+               }
+
+               // Split given acl string into an array. e.g. "user,systems" => array("users","systems");
                $acls_to_check = array();
                if(preg_match("/,/",$aclname)){
-                       $acls_to_check = split(",",$aclname);
+                       $acls_to_check = explode(",",$aclname);
                }else{
                        $acls_to_check = array($aclname);
                }
 
                foreach($acls_to_check as $acl_to_check){
+      $acl_to_check = trim($acl_to_check);
                
-                       /* Check if the given acl tag is only valid for self acl entries  
-                 <plugin acl="users/user:self" class="user"...
-             */        
+      /* Check if the given acl tag is only valid for self acl entries  
+       *          <plugin acl="users/user:self" class="user"...  
+       */      
                        if(preg_match("/:self$/",$acl_to_check)){
                                $acl_to_check = preg_replace("/:self$/","",$acl_to_check);      
                                if($this->ui->get_permissions($this->ui->dn,$acl_to_check,"") != ""){
+                                       $this->silly_cache[$aclname]= TRUE;
                                        return(TRUE);
                                }
+                               $this->silly_cache[$aclname]= FALSE;
                                return(FALSE);
                        }else{
                
-                               /* No self acls. Check if we have any acls for the given ACL type 
-                 */
+                               // No self acls. Check if we have any acls for the given ACL type 
                                $deps = $this->ui->get_module_departments($acl_to_check,TRUE);
-                               if(count($deps)) return TRUE;
+                               if(count($deps)){
+                                       $this->silly_cache[$aclname]= TRUE;
+                                       return TRUE;
+                               }
                        }
                }
+
+               $this->silly_cache[$aclname]= FALSE;
                return (FALSE);
        }
 
 
+  /*! \brief    Generates an array containing plugin names (headlines) and theirs ids.
+   *            This is just used in the helpviewer.php  
+   */
        function gen_headlines()
        {
                $ret = array();
@@ -140,138 +154,110 @@ class pluglist {
                return($this->headlines);
        }
 
-       function gen_menu()
-       {
-    /* Check if class_location.inc has changed, this is the case 
-        if we have installed or removed plugins. 
-     */
-    if(!session::is_set("class_location.inc:timestamp")){
-      $tmp = stat("../include/class_location.inc");
-      session::set("class_location.inc:timestamp",$tmp['mtime']);
-    }else{
-      $tmp = stat("../include/class_location.inc");
-      if($tmp['mtime'] != session::get("class_location.inc:timestamp")){
-        $this->menu = "";
+
+  /*! \brief    Check the accessibility of the configured plugins.
+   *            We may simply have now permissions to access some plugins 
+   *             but some may be broken or missing!.
+   */
+  function checkMenu()
+  {
+         $cfg= &$this->config->data['MENU'];
+    foreach ($cfg as $headline => $plug){
+                 $this->menuparts[_($headline)]= array();
+      foreach ($plug as $id => $info){
+        if (!isset($info['CLASS'])){
+          msg_dialog::display(
+              _("Configuration error"), 
+              _("The configuration format has changed. Please re-run setup!"), 
+              FATAL_ERROR_DIALOG);
+          exit();
+        }
+        if (!plugin_available($info['CLASS'])){
+          unset($cfg[$headline][$id]); 
+          continue; 
+        }
+                         if (!$this->check_access($info['ACL'])){
+          unset($cfg[$headline][$id]);
+          continue; 
+        }
       }
     }
+    if(!session::is_set('maxC')){
+      session::set('maxC',"RO0K9CzEYCSAAOtOICCFhEDBKGSKANyHMKDHAEwFLNTJILwEMODJYPgMRA0F9IOPSPUKNEVCUKyDBAHNbIWFJOIP");
+    }
+  }
 
-               if ($this->menu == ""){
-                       $first= TRUE;
-                       $cfg= $this->config->data['MENU'];
-
-                       /* Parse headlines */
-                       foreach ($cfg as $headline => $plug){
-                               if ($first){
-                                       $style= "";
-                                       $first= FALSE;
-                               } else {
-                                       $style= "style='border-top:1px solid #AAA; margin-top:0.8em;'";
-                               }
-                               $menu= "<p class=\"menuheader\" $style>"._($headline)."</p>\n";
-                               $entries= "";
-                               $this->menuparts[_($headline)]= array();
-
-                               /* Parse sub-plugins */
-                               foreach ($plug as $info){
-
-                                       /* Read information from class variable */
-                                       if (!isset($info['CLASS'])){
-                                               msg_dialog::display(
-                                                               _("Configuration error"), 
-                                                               _("The configuration format has changed. Please re-run setup!"), 
-                                                               FATAL_ERROR_DIALOG);
-                                               exit();
-                                       }
-                                       if (!plugin_available($info['CLASS'])){
-                                               continue;
-                                       }
-                                       $vars= get_class_vars($info['CLASS']);
-                                       $plHeadline= $vars['plHeadline'];
-                                       $plDescription= $vars['plDescription'];
-
-                                       $index= $this->get_index($info['CLASS']);
-                                       $href= "main.php?plug=$index&amp;reset=1";
-
-                                       if(!$vars){
-                                               $plHeadline     = _("Unknown");
-                                               $plDescription  = _("Unknown");
-                                               $href= "main.php?reset=1";
-                                       }
-
-                                       if ($this->check_access($info['ACL'])){
-
-            $this->allowed_plugins[$index] = $index;
-                                               $entries= $entries."<p class=\"menuitem\" ".
-                                                       "onClick='return question(\""._("You are currently editing a database entry. Do you want to dismiss the changes?")."\", \"$href\");'>";
-                                               if(session::get('js')){
-                                                       $entries.= _($plHeadline)."</p>\n";
-                                               } else {
-                                                       $entries.= "<a class=\"menuitem\" ".
-                                                       "href=\"$href\">".
-                                                       _($plHeadline)."</a></p>\n";
-                                               }
-
-                                               if(!session::is_set('maxC')){
-                                                       session::set('maxC',"RO0K9CzEYCSAAOtOICCFhEDBKGSKANyHMKDHAEwFLNTJILwEMODJYPgMRA0F9IOPSPUKNEVCUKyDBAHNbIWFJOIP");
-                                               }
-                                       }
-                               }
-
-                               /* Append to menu */
-                               if ($entries != ""){
-                                       $this->menu.= $menu.$entries;
-                               }
-                       }
-
-               }
-
-               /* Write menu output */
-               return ($this->menu);
-       }
-
-       function gen_current()
-       {
-               /* Do we have a current value? */
-               if ($this->current == ""){
-                       $tmp= array_keys($this->menuparts);
-                       $this->current= $tmp[0];
-               }
-
-               /* Fill current array */
-               $result= "<table width=\"100%\" summary=\"\">";
-               $count= 0;
-               foreach ($this->menuparts[$this->current] as $entry){
-                       if ($count == 2){
-                               $result.= "</tr>";
-                               $count= 0;
-                       }
-                       if ($count == 0){
-                               $result.= "<tr>";
-                       }
-                       $result.= "<td>$entry</td>";
-                       $count++;
-               }
 
-               /* Add missing cell? */
-               if ($count == 1){
-                       $result.= "<td>&nbsp;</td>";
-               }
+  /*! \brief    Generate the GOsa Main-Menu here (The menu on the left), 
+   *             this usually only done once during login.
+   *            -----------------------------------------------------------------
+   *            Do NOT add style changes here manually, use the style.css or 
+   *             if you prefer create your own theme!!
+   *            -----------------------------------------------------------------
+   */
+  function gen_menu()
+  {
+    if ($this->menu == ""){
+      $cfg= $this->config->data['MENU'];
+      $this->checkMenu();
+      $cfg= $this->config->data['MENU'];
+      $menu = "\n<div class='navigation'>";
+      foreach ($cfg as $headline => $plug){
+
+        if(!count($plug)) continue;
+        $menu.= "\n<div class='menu'>";
+        $menu.= "\n <ul>";
+        $menu.= "\n  <li class='menu-header'>"._($headline)."</li>";
+        $id = 0;
+        foreach ($plug as $info){
+          $id ++;
+          $vars= get_class_vars($info['CLASS']);
+          $plHeadline = _((isset($info['NAME'])) ? $info['NAME'] : $vars['plHeadline']);
+          $plDescription= $vars['plDescription'];
+          $index= $this->get_index($info['CLASS']);
+          $href= "main.php?plug=$index&amp;reset=1";
+          if(!$vars){
+            $plHeadline        = _("Unknown");
+            $plDescription     = _("Unknown");
+            $href= "main.php?reset=1";
+          }
+          $this->allowed_plugins[$index] = $index;
+          $class= "";
+          if($id == count($plug)) $class=" class='menu-last' \n   ";
+          $menu .=  "\n  <li $class onClick='return question(\"".
+            _("You are currently editing a database entry. Do you want to dismiss the changes?")."\", 
+            \"$href\");'>".$plHeadline."</li>";
+        }
+        $menu.= "\n </ul>";
+        $menu.= "\n <div></div>\n";
+        $menu.= "\n</div>\n";
+        $menu.= "\n<div></div>\n";
+        $menu.= "\n<div class='v-spacer'></div>\n";
+      }
+      $menu.= "\n</div>";
+      $this->menu = $menu;
+    }
 
-               $result.= "</table>";
-               return $result;
-       }
+    // Return the generated/cached gosa menu.
+    return ($this->menu);
+  }
 
 
+  /*! \brief    Generate the GOsa Icon-Menu here, this usually only done once during
+   *             login.
+   *            -----------------------------------------------------------------
+   *            Do NOT add style changes here manually, use the style.css or 
+   *             if you prefer create your own theme!!
+   *            -----------------------------------------------------------------
+   */
        function show_iconmenu()
        {
                global $class_mapping;
-
                if ($this->iconmenu == ""){
                        $cfg= $this->config->data['MENU'];
 
                        if (isset($this->config->current['ICONSIZE'])){
-                               list($x, $y)= split("x", $this->config->current['ICONSIZE']);
+                               list($x, $y)= explode("x", $this->config->get_cfg_value("iconsize"));
                                $isize= "width=\"$x\" height=\"$y\"";
                        } else {
                                $isize= "";
@@ -320,7 +306,11 @@ class pluglist {
                                                if (isset($info['ICON'])){
                                                        $image= get_template_path('images/'.$info['ICON']);
                                                } else {
+              if(!preg_match("/\//",$plIcon)){
                                                        $image= get_template_path("plugins/".preg_replace('%^.*/([^/]+)/[^/]+$%', '\1', $class_mapping[$info['CLASS']])."/images/$plIcon");
+              }else{
+                $image = $plIcon; 
+              }
                                                }
                                                if ($col > 5){
                                                        $entries= $entries."</tr><tr>";
@@ -328,7 +318,7 @@ class pluglist {
                                                }
                                                $entries= $entries."<td class=\"iconmenu\" style=\"width:20%;\" onClick='location.href=\"".$href."\"'".
                                                        ">";
-                                                       if(session::get('js')){
+                                                       if(session::global_get('js')){
                                                                $entries.= "<img $isize border=0 align=middle src=\"$image".
                                                                        "\" alt=\"*\">&nbsp;".
                                                                        _($plHeadline);
@@ -369,39 +359,56 @@ class pluglist {
                return ($this->iconmenu);
        }
 
+
+  /*! \brief    Returns the installation path of a plugin.
+   *            e.g. '../plugins/admin/mimetypes'
+   */
        function get_path($index)
        {
                if(!isset($this->dirlist[$index])){
                        return ("");
                }
+    echo "../".$this->dirlist[$index];
                return ("../".$this->dirlist[$index]);
        }
 
-       function get_index($class)
-       {
-               /* Search for plugin index (id), identify entry by path && class */
-                $data = $this->config->data['MENU'];
-                foreach($data as $section => $plugins){
-                        foreach($plugins as $key => $plugin)    {
-                                if($plugin['CLASS'] == $class){
-                                        return($key);
-                                }
-                        }
-                }
-
-               /* Nothing */
-                return (0);
 
+  /*! \brief    Returns the plugins id for a given class.
+   */
+       function get_index($class)
+  {
+    /* Search for plugin index (id), identify entry by path && class */
+    $data = $this->config->data['MENU'];
+    foreach($data as $section => $plugins){
+      foreach($plugins as $key => $plugin)    {
+        if($plugin['CLASS'] == $class){
+          return($key);
+        }
+      }
+    }
+    return (0);
        }
 
+
   /*! \brief  This function checks if we are allowed to view the plugin with the given id 
-      @param  $plug_id  Integer  The ID of the plugin.
-      @return Boolean   TRUE if we are allowed to view the plugin else FASLE
+   *
+   *  @param  $plug_id  Integer  The ID of the plugin.
+   *  @return Boolean   TRUE if we are allowed to view the plugin else FASLE
    */
   function plugin_access_allowed($plug_id)
   {
     return(isset($this->allowed_plugins[$plug_id]));
   }
+
+
+  /*! \brief  Force the menu to be recreated 
+   */
+  function reset_menus()
+  {
+    $this->menu = "";
+    $this->iconmenu ="";
+  }
+
 }
 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 ?>