Code

Updated management.
[gosa.git] / gosa-core / include / class_pluglist.inc
index 4871a710dc9c96111d7a014aa41b1ba73b6be622..528052a875c054e5d28e3f98bd51f356a48c0b1e 100644 (file)
@@ -1,24 +1,25 @@
 <?php
 /*
-   This code is part of GOsa (https://gosa.gonicus.de)
-   Copyright (C) 2003  Cajus Pollmeier
-
-   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
+ * This code is part of GOsa (http://www.gosa-project.org)
+ * Copyright (C) 2003-2008 GONICUS GmbH
+ *
+ * ID: $$Id$$
+ *
+ * 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
  */
 
-
 class pluglist {
        var $index= 0;
        var $menu= "";
@@ -30,6 +31,8 @@ class pluglist {
        var $current= "";
        var $info= array();
        var $headlines = array();
+        var $allowed_plugins = array();
+        var $silly_cache= array();
 
        function pluglist(&$config, &$ui)
        {
@@ -37,17 +40,17 @@ class pluglist {
                $this->config= &$config;
 
                /* Create dirlist for all plugins */
-               $this->dirlist= $this->get_plugins ($this->dirlist, $this->config->data);
+               $this->dirlist= $this->get_plugins ($this->dirlist, $this->config->data['MENU']);
 
-                /* Fill info part of pluglist */
-                $classes= get_declared_classes();
+               /* 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'));
-                                       }
-                               }
+               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' */
                $this->info['all']= array();
@@ -58,65 +61,88 @@ class pluglist {
 
        function get_plugins($list, &$config)
        {
-               /* Error reporting, because I'm getting strange messages in PHP 4.2.x */
-               if (!isset($config['PATH']) && !isset($config['CLASS'])){
+               global $class_mapping;
+
+               if (!isset($config['CLASS'])){
                        if (is_array($config)){
                                foreach ($config as $val){
                                        $list= $this->get_plugins($list, $val);
                                }
                        }
                } else {
-                       if (isset ($config['PATH']) && is_array($config)){
-                               $list[$this->index++]= $config['PATH'];
-                               if (isset($config['CLASS'])){
-                                       $class= $config['CLASS'];
-                               }
+                       if (is_array($config) && isset($class_mapping[$config['CLASS']])){
+                               $list[$this->index++]= dirname($class_mapping[$config['CLASS']]);
+                       } else {
+                               $list[$this->index++]= "";
                        }
                }
 
                return ($list);
        }
 
+
+       /*! \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 test, eg.        "users/user:self", "systems", ...
+               @return Boolean TRUE on success else FALSE
+     */
        function check_access($aclname)
        {
-               $deps= $this->ui->get_module_departments($aclname);
+               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);
                }else{
                        $acls_to_check = array($aclname);
                }
-       
-               if(preg_match("/\//",$aclname)){
-                       foreach($deps as $dep){
-                               foreach($acls_to_check as $acl_to_check){
-                                       if($this->ui->get_permissions($dep,$acl_to_check) != ""){
-                                               return(TRUE);
-                                       }
+
+               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"...  */     
+                       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);
                                }
-                       }
-               }else{
-                       foreach($deps as $dep){
-                               foreach($acls_to_check as $acl_to_check){
-                                       if($this->ui->get_category_permissions($dep,$acl_to_check) != ""){
-                                               return(TRUE);
-                                       }
+                               $this->silly_cache[$aclname]= FALSE;
+                               return(FALSE);
+                       }else{
+               
+                               /* 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)){
+                                       $this->silly_cache[$aclname]= TRUE;
+                                       return TRUE;
                                }
                        }
                }
+
+               $this->silly_cache[$aclname]= FALSE;
                return (FALSE);
        }
 
+
        function gen_headlines()
        {
                $ret = array();
                if(count($this->headlines) == 0){
                        foreach($this->config->data['MENU'] as $headline => $plugins){
                                foreach( $plugins as $id => $plug){
-                                       $attrs = (get_class_vars($plug['CLASS']));
-                                       $ret[$id]['HEADLINE'] = $headline;
-                                       $ret[$id]['NAME']         = $attrs['plHeadline'];       
+                                       if (plugin_available($plug['CLASS'])){
+                                               $attrs = (get_class_vars($plug['CLASS']));
+                                               $ret[$id]['HEADLINE'] = $headline;
+                                               $ret[$id]['NAME']         = $attrs['plHeadline'];
+                                       }
                                }
                        }
                        $this->headlines = $ret;
@@ -147,16 +173,24 @@ class pluglist {
 
                                        /* Read information from class variable */
                                        if (!isset($info['CLASS'])){
-                                               print_red(_("Your gosa.conf format has changed. Please re-run setup!"));
-                                               display_error_page();
+                                               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'];
+                                       if (isset($info['NAME'])){
+                                         $plHeadline= _($info['NAME']);
+                                        } else {
+                                         $plHeadline= $vars['plHeadline'];
+                                        }
                                        $plDescription= $vars['plDescription'];
 
-
-                                       $index= $this->get_index($info['PATH'],$info['CLASS']);
-                                       $image= get_template_path('images/'.$info['ICON']);
+                                       $index= $this->get_index($info['CLASS']);
                                        $href= "main.php?plug=$index&amp;reset=1";
 
                                        if(!$vars){
@@ -167,9 +201,11 @@ class pluglist {
 
                                        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')){
+                                               if(session::global_get('js')){
                                                        $entries.= _($plHeadline)."</p>\n";
                                                } else {
                                                        $entries.= "<a class=\"menuitem\" ".
@@ -177,15 +213,6 @@ class pluglist {
                                                        _($plHeadline)."</a></p>\n";
                                                }
 
-                                               /* Generate icon entry with description */
-                                               $current= '<table summary=\"\" class="menuitem" onClick=\'location.href="'.$href.'"\'><tr><td style="background-color:#F0F0F0;"><a href="'.$href.'"><img alt=\"\" border=0 src="'.$image.'"></a></td><td style="width:100%; vertical-align:top; text-align:justify; padding-left:10px;">';
-                                               if(session::get('js')){
-                                                       $current.= '<b>'._($plHeadline).'</b><br>'._($plDescription);
-                                               } else {
-                                                       $current.= '<a href="'.$href.'"><b>'._($plHeadline).'</b></a><br><a href="'.$href.'">'._($plDescription).'</a>';
-                                               }
-                                               $current.= '</td></tr></table>';
-                                               $this->menuparts[_($headline)][]= $current;
                                                if(!session::is_set('maxC')){
                                                        session::set('maxC',"RO0K9CzEYCSAAOtOICCFhEDBKGSKANyHMKDHAEwFLNTJILwEMODJYPgMRA0F9IOPSPUKNEVCUKyDBAHNbIWFJOIP");
                                                }
@@ -239,11 +266,12 @@ class pluglist {
 
        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)= split("x", $this->config->get_cfg_value("iconsize"));
                                $isize= "width=\"$x\" height=\"$y\"";
                        } else {
                                $isize= "";
@@ -259,12 +287,21 @@ class pluglist {
 
                                foreach ($plug as $info){
 
+                                       if (!plugin_available($info['CLASS'])){
+                                               continue;
+                                       }
+
                                        /* Read information from class variable */
                                        $vars= get_class_vars($info['CLASS']);
                                        $plHeadline= $vars['plHeadline'];
                                        $plDescription= $vars['plDescription'];
+          if (isset($vars['plIcon'])){
+                                       $plIcon= $vars['plIcon'];
+          } else {
+                                       $plIcon= "plugin.png";
+          }
 
-                                       $index= $this->get_index($info['PATH'],$info['CLASS']);
+                                       $index= $this->get_index($info['CLASS']);
 
                                        $href = "main.php?plug=".$index."&amp;reset=1";
 
@@ -279,15 +316,23 @@ class pluglist {
 
                                        if ($this->check_access($info['ACL'])){
 
-                                               /* Hm this looks doubled */
-                                               $image= get_template_path('images/'.$info['ICON']);
+                                               /* Load icon */
+                                               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>";
                                                        $col = 1;
                                                }
                                                $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);
@@ -336,21 +381,41 @@ class pluglist {
                return ("../".$this->dirlist[$index]);
        }
 
-       function get_index($path,$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 && $plugin['PATH'] == $path){
+                                if($plugin['CLASS'] == $class){
                                         return($key);
                                 }
                         }
                 }
 
-               /* Indentify by path*/
-                return (array_search($path, $this->dirlist));
+               /* Nothing */
+                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
+   */
+  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:
 ?>