Code

fixed property
[gosa.git] / gosa-core / include / class_pluglist.inc
index 6e1c059a76836d7cd55364a359649213835cc8b2..0f89f3b611bb05aeda5ba7c67a386a0236578d9b 100644 (file)
 
 class pluglist 
 {
+  // The id of the last registered plugin id 
   var $index= 0;
+
   var $config= NULL;
-  var $dirlist= array();
   var $ui= NULL;
-  var $info= array();
+
+  // Contains a list of the paths for all registered plugins.
+  var $dirlist= array();
+
+  // Seems to be used in the help menu to generate an overview.
   var $headlines = array();
+  // Remember stuff in here.
   var $silly_cache= array();
 
+  // The pluglist keeps track of all registered plugins.
+  // (Registered plugins are those we are able to access)
   var $pluginList = array();
 
+  // Some cache vars to avoid regenration of the menus.   
   var $pathMenu = "";
   var $menu= "";
   var $iconmenu= "";
 
+  // Classes plInfo list
+  var $info = array();
+
   function pluglist(&$config, &$ui)
   {
     $this->ui= &$ui;
     $this->config= &$config;
-
-    // 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;
-    
     $this->loadPluginList();
   }
 
@@ -55,44 +59,30 @@ class pluglist
   {
     $this->pluginList = array();
 
-    // 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'));
-      }
-    }
-    
-    // First load Menu Plugins 
-    if(isset($this->config->data['MENU'])){
-      foreach($this->config->data['MENU'] as $section => $plugins){
-        foreach($plugins as $id => $plug){
-          if(!$this->registerPlugin($plug)){ 
-            unset($this->config->data['MENU'][$section][$id]); 
-          }
-        }
-      }
-    }
-    
-    // Now register pathMenu plugins
-    if(isset($this->config->data['PATHMENU'])){
-      foreach($this->config->data['PATHMENU'] as $id => $plugin){
-        if(!$this->registerPlugin($plugin)){
-          unset($this->config->data['PATHMENU'][$id]); 
-        } 
-      }
-    }
+               /* 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'));
+                       }
+               }
 
     if(!session::is_set('maxC')){
       session::set('maxC',"RO0K9CzEYCSAAOtOICCFhEDBKGSKANyHMKDHAEwFLNTJILwEMODJYPgMRA0F9IOPSPUKNEVCUKyDBAHNbIWFJOIP");
     }
-    $this->gen_menu();
-    $this->show_iconmenu();
-    $this->genPathMenu();
+//
+//   // Now generate menu - usually they are cached
+//   $this->gen_menu();
+//   $this->show_iconmenu();
+//   $this->genPathMenu();
   }
 
 
+  /*! \brief    Tries to register a plugin in the pluglist
+   *            Checks existence and ACL for the given plugin.
+   *            Returns true in case of success else false. 
+   */
   function registerPlugin($plug)
   {
     global $class_mapping;
@@ -100,7 +90,7 @@ class pluglist
     if (!isset($plug['CLASS'])){
       msg_dialog::display(
           _("Configuration error"),
-          _("The configuration format has changed. Please re-run setup!"),
+          _("The configuration format has changed: please run the setup again!"),
           FATAL_ERROR_DIALOG);
       exit();
     }
@@ -145,12 +135,17 @@ class pluglist
        */      
       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);
+        if(strpos($acl_to_check,"/")){
+          if($this->ui->get_permissions($this->ui->dn,$acl_to_check,"") != ""){
+            $this->silly_cache[$aclname]= TRUE;
+            return(TRUE);
+          }
+        }else{
+          if($this->ui->get_category_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 
@@ -178,15 +173,28 @@ class pluglist
   function gen_menu()
   {
     if ($this->menu == ""){
+
+      // First load the menu plugins and try to register them in the pluglist
+      //  if this fails for some reason, then remove the plugin from the menu.
+      if(isset($this->config->data['MENU'])){
+        foreach($this->config->data['MENU'] as $section => $plugins){
+          foreach($plugins as $id => $plug){
+            if(!$this->registerPlugin($plug)){ 
+              unset($this->config->data['MENU'][$section][$id]); 
+            }
+          }
+        }
+      }
+
       $cfg= $this->config->data['MENU'];
-      $menu = "\n<div class='navigation'>";
+      $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>";
+        $menu.= "\n        <div class='menu'>";
+        $menu.= "\n          <ul>";
+        $menu.= "\n            <li class='menu-header'>"._($headline)."</li>";
         $id = 0;
         foreach ($plug as $info){
 
@@ -195,40 +203,38 @@ class pluglist
 
           list($index, $title, $desc, $icon) = $this->getPlugData($info['CLASS']);
           $class= "";
-          if($id == count($plug)) $class=" class='menu-last' \n   ";
-          $menu .=  "\n  <li id='plugMenuId_{$index}' $class onClick='return openPlugin({$index});'>".$title."</li>";
+          if($id == count($plug)) $class=" class='menu-last' ";
+          $menu .=  "\n            <li id='plugMenuId_{$index}' $class onClick='return openPlugin({$index});'>".$title."</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          </ul>";
+        $menu.= "\n          <div style='font-size:0'>&nbsp;</div>";
+        $menu.= "\n        </div>\n";
+        $menu.= "\n        <div style='font-size:0'>&nbsp;</div>";
+        $menu.= "\n        <div class='v-spacer'></div>\n";
       }
-      $menu.= "\n</div>";
+      $menu.= "\n      </div>\n";
       $this->menu = $menu;
 
       // Add javascript method to print out warning messages while leaving an unsaved form.
       // We do it in here to get the string translated.
-      $this->menu .= "
-        <script language='javascript' type='text/javascript'>
-        function openPlugin(id){
-          return question(\""._("You are currently editing a database entry. Do you want to dismiss the changes?")."\",
-              \"main.php?plug=\" + id + \"&amp;reset=1\");
-        }
-      </script>
-        "; 
+      $this->menu .=  
+        "\n      <script language='javascript' type='text/javascript'>".
+        "\n        function openPlugin(id){".
+        "\n          return question(\""._("You are currently editing a database entry. Do you want to discard the changes?")."\",".
+        "\n            \"main.php?plug=\" + id + \"&amp;reset=1\");".
+        "\n        }".
+        "\n      </script>\n"; 
     }
   
     // Use javascript to mark the currently selected plugin.
     $menu = $this->menu;
     if(isset($_GET['plug'])){
-      $menu.= "
-        <script language='javascript' type='text/javascript'>
-          if($('plugMenuId_".$_GET['plug']."')){
-            $('plugMenuId_".$_GET['plug']."').className= 'current'
-          }
-        </script>
-        "; 
+      $menu.= 
+     "\n      <script language='javascript' type='text/javascript'>".
+     "\n        if($('plugMenuId_".$_GET['plug']."')){".
+     "\n          $('plugMenuId_".$_GET['plug']."').className= 'current'".
+     "\n        }".
+     "\n      </script>\n";
     }
 
     // Return the generated/cached gosa menu.
@@ -246,17 +252,19 @@ class pluglist
   function show_iconmenu()
   {
     $add_hr =FALSE;
+    $this->iconmenu = "";
     if ($this->iconmenu == ""){
+
       $cfg= $this->config->data['MENU'];
       foreach ($cfg as $headline => $plug){
         $col= 0;
 
-        $this->iconmenu .= "\n  <div class='clear'></div>\n";
+        $this->iconmenu .= "\n        <div class='clear'></div>";
         if($add_hr){
           $add_hr = FALSE;
-          $this->iconmenu .= "\n  <hr>\n";
+          $this->iconmenu .= "\n        <hr>";
         }
-        $this->iconmenu .= "\n  <h3 class='icon-menu-title'>". _($headline)."</h3>\n";
+        $this->iconmenu .= "\n        <h3 class='icon-menu-title'>". _($headline)."</h3>";
 
         foreach ($plug as $info){
 
@@ -265,19 +273,16 @@ class pluglist
 
           // Add a seperating row
           if (($col % 4) == 0){ 
-            $this->iconmenu .= "\n  <div class='clear'></div>\n";
+            $this->iconmenu .= "\n        <div class='clear'></div>";
           }
 
-
-          $this->iconmenu.= "\n  <div class='icon-menu-item' style='width: 25%;' onclick='openPlugin({$index})'>";
-          /* $this->iconmenu.= "\n   ".image($icon); */
-          $this->iconmenu.= "\n   <div class='img' style='width:48px;height:48px;background-image: url({$icon});'></div>";
-          $this->iconmenu.= "\n   <div class='dsc'>";
-          $this->iconmenu.= "\n    <h1>{$title}</h1>";
-          $this->iconmenu.= "\n    <p>{$desc}</p>";
-          $this->iconmenu.= "\n   </div>";
-          $this->iconmenu.= "\n  </div>";
-
+          $this->iconmenu.= "\n        <div class='icon-menu-item' style='width: 25%;' onclick='openPlugin({$index})'>";
+          $this->iconmenu.= "\n          ".image($icon);
+          $this->iconmenu.= "\n          <div class='dsc'>";
+          $this->iconmenu.= "\n            <h1>{$title}</h1>";
+          $this->iconmenu.= "\n            <p>{$desc}</p>";
+          $this->iconmenu.= "\n          </div>";
+          $this->iconmenu.= "\n        </div>";
           $col++ ;
         }
         $add_hr = TRUE;
@@ -287,32 +292,55 @@ class pluglist
   }
 
 
+  /*! \brieg    Generates and the path menu (the one on the upper right) and keeps
+   *             the generated HTML content, so we are not forced to generate it on every 
+   *             page request.
+   *            (See <pathMenu> of your gosa.conf)
+   */
   function genPathMenu()
   {
     if(empty($this->pathMenu)){
-      $this->pathMenu = 
-        "\n    <div class='plugin-path'>".
-        "\n     <ul class='path-navigation'>".
-        "\n      <li class='left right-border' onClick=\"openPlugin('');\">".
-        "\n       <div class='nav-home'></div>".
-        "\n      </li>".
-        "\n      <li class='left'>Welcome to GOsa</li>";
 
+      // Now load the path menu and try to register the plugins in the pluglist
+      //  if this fails for some reason, then remove the plugin from the menu.
+      if(isset($this->config->data['PATHMENU'])){
+        foreach($this->config->data['PATHMENU'] as $id => $plugin){
+          if(!$this->registerPlugin($plugin)){
+            unset($this->config->data['PATHMENU'][$id]); 
+          } 
+        }
+      }
+
+      $this->pathMenu = 
+        "\n        <div class='plugin-path'>".
+        "\n          <ul class='path-navigation'>".
+        "\n            <li class='left' onClick=\"openPlugin('');\" title='"._("Back to main menu")."'>".
+        "\n              ".image(get_template_path("images/home.png")).
+        "\n            </li>".
+        "\n            %navigator%";
+
+      // Check if we've at least one entry defined ih the pathmenu
       if(isset($this->config->data['PATHMENU'])){
         $cfg= &$this->config->data['PATHMENU'];
         $rcfg = array_reverse($cfg);
         foreach($rcfg as $id => $plug){
           list($index, $title, $desc, $icon) = $this->getPlugData($plug['CLASS']);
-          $this->pathMenu.= "\n     <li class='right left-border' onClick='openPlugin({$index})'>{$title}</li>";
+          $this->pathMenu.= "\n            <li class='right left-border' onClick='openPlugin({$index})'>{$title}</li>";
         }
       }
-      $this->pathMenu.= "\n    </ul>";
-      $this->pathMenu.= "\n    </div>";
-    } 
-    return($this->pathMenu); 
+      $this->pathMenu.= "\n          </ul>";
+      $this->pathMenu.= "\n        </div>";
+    }
+
+    $menu = pathNavigator::getCurrentPath();
+    return(preg_replace("/%navigator%/", $menu, $this->pathMenu)); 
   }
   
 
+  /*! \brief    Returns additional info for a given class name, like 
+   *             plugin-icon, title, description and the index of the element 
+                 in the pluglist which uses this class.
+   */
   function getPlugData($class)
   {
     global $class_mapping;