X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=gosa-core%2Finclude%2Fclass_pluglist.inc;h=0f89f3b611bb05aeda5ba7c67a386a0236578d9b;hb=e1e757ca6816d818fa1a393b66f165ffefb1afe7;hp=1615fe61967dac5f14462887f106953fa36cab09;hpb=ce8f2f5dab1154ceea31deeffa973c04d2ea042c;p=gosa.git diff --git a/gosa-core/include/class_pluglist.inc b/gosa-core/include/class_pluglist.inc index 1615fe619..0f89f3b61 100644 --- a/gosa-core/include/class_pluglist.inc +++ b/gosa-core/include/class_pluglist.inc @@ -20,29 +20,46 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -class pluglist { - var $index= 0; - var $menu= ""; - var $iconmenu= ""; - var $menuparts= array(); - var $config= NULL; - var $dirlist= array(); - var $ui= NULL; - var $current= ""; - var $info= array(); - var $headlines = array(); - var $allowed_plugins = array(); - var $silly_cache= array(); - - function pluglist(&$config, &$ui) - { - $this->ui= &$ui; - $this->config= &$config; - - // 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']); - - // Detect installed plugins and their configuration, to be able to restrict access later. +class pluglist +{ + // The id of the last registered plugin id + var $index= 0; + + var $config= NULL; + var $ui= NULL; + + // 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; + $this->loadPluginList(); + } + + function loadPluginList() + { + $this->pluginList = array(); + + /* Fill info part of pluglist */ $classes= get_declared_classes(); foreach ($classes as $cname){ $cmethods = get_class_methods($cname); @@ -51,36 +68,43 @@ class pluglist { } } - // 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; - } + if(!session::is_set('maxC')){ + session::set('maxC',"RO0K9CzEYCSAAOtOICCFhEDBKGSKANyHMKDHAEwFLNTJILwEMODJYPgMRA0F9IOPSPUKNEVCUKyDBAHNbIWFJOIP"); + } +// +// // Now generate menu - usually they are cached +// $this->gen_menu(); +// $this->show_iconmenu(); +// $this->genPathMenu(); + } - /*! \brief Detect plugin installation paths, by walking through the config. + /*! \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 get_plugins($list, &$config) - { - global $class_mapping; - if (!isset($config['CLASS'])){ - if (is_array($config)){ - foreach ($config as $val){ - $list= $this->get_plugins($list, $val); - } - } - } else { - if (is_array($config) && isset($class_mapping[$config['CLASS']])){ - $list[$this->index++]= dirname($class_mapping[$config['CLASS']]); - } else { - $list[$this->index++]= ""; - } - } - - return ($list); - } + function registerPlugin($plug) + { + global $class_mapping; + + if (!isset($plug['CLASS'])){ + msg_dialog::display( + _("Configuration error"), + _("The configuration format has changed: please run the setup again!"), + FATAL_ERROR_DIALOG); + exit(); + } + if (!plugin_available($plug['CLASS'])){ + return(FALSE); + } + if (!$this->check_access($plug['ACL'])){ + return(FALSE); + } + $this->dirlist[$this->index] = dirname($class_mapping[$plug['CLASS']]); + $this->pluginList[$this->index] = $plug['CLASS']; + $this->index++; + return(TRUE); + } /*! \brief Check whether we are allowed to modify the given acl or not.. @@ -89,105 +113,56 @@ class pluglist { * @param The acl tag to check for, eg. "users/user:self", "systems", ... * @return Boolean TRUE on success else FALSE */ - function check_access($aclname) - { - if (isset($this->silly_cache[$aclname])) { - return $this->silly_cache[$aclname]; - } + function check_access($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 = explode(",",$aclname); - }else{ - $acls_to_check = array($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 = explode(",",$aclname); + }else{ + $acls_to_check = array($aclname); + } - foreach($acls_to_check as $acl_to_check){ + 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 * 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 - $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); - } - - - /*! \brief Generates an array containing plugin names (headlines) and theirs ids. - * This is just used in the helpviewer.php - */ - function gen_headlines() - { - $ret = array(); - if(count($this->headlines) == 0){ - foreach($this->config->data['MENU'] as $headline => $plugins){ - foreach( $plugins as $id => $plug){ - if (plugin_available($plug['CLASS'])){ - $attrs = (get_class_vars($plug['CLASS'])); - $ret[$id]['HEADLINE'] = $headline; - $ret[$id]['NAME'] = $attrs['plHeadline']; - } - } - } - $this->headlines = $ret; - } - return($this->headlines); - } - - - /*! \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(preg_match("/:self$/",$acl_to_check)){ + $acl_to_check = preg_replace("/:self$/","",$acl_to_check); + 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); + } } - if (!$this->check_access($info['ACL'])){ - unset($cfg[$headline][$id]); - continue; + }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; } } } - if(!session::is_set('maxC')){ - session::set('maxC',"RO0K9CzEYCSAAOtOICCFhEDBKGSKANyHMKDHAEwFLNTJILwEMODJYPgMRA0F9IOPSPUKNEVCUKyDBAHNbIWFJOIP"); - } + + $this->silly_cache[$aclname]= FALSE; + return (FALSE); } + /*! \brief Generate the GOsa Main-Menu here (The menu on the left), * this usually only done once during login. * ----------------------------------------------------------------- @@ -198,48 +173,72 @@ 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']; - $this->checkMenu(); - $cfg= $this->config->data['MENU']; - $menu = "\n
"; + $menu = "\n
"; foreach ($cfg as $headline => $plug){ if(!count($plug)) continue; - $menu.= "\n
"; - $menu.= "\n
    "; - $menu.= "\n
  • "._($headline)."
    • "; + + $menu.= "\n
    "; + $menu.= "\n
      "; + $menu.= "\n
    • "._($headline)."
      • "; $id = 0; foreach ($plug as $info){ + + // Used to detect the last element in the menu $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&reset=1"; - if(!$vars){ - $plHeadline = _("Unknown"); - $plDescription = _("Unknown"); - $href= "main.php?reset=1"; - } - $this->allowed_plugins[$index] = $index; + + list($index, $title, $desc, $icon) = $this->getPlugData($info['CLASS']); $class= ""; - if($id == count($plug)) $class=" class='menu-last' \n "; - $menu .= "\n
    • ".$plHeadline."
      • "; + if($id == count($plug)) $class=" class='menu-last' "; + $menu .= "\n
    • ".$title."
      • "; } - $menu.= "\n
    "; - $menu.= "\n
    \n"; - $menu.= "\n
    \n"; - $menu.= "\n
    \n"; - $menu.= "\n
    \n"; + $menu.= "\n
"; + $menu.= "\n
 
"; + $menu.= "\n
\n"; + $menu.= "\n
 
"; + $menu.= "\n
\n"; } - $menu.= "\n
"; + $menu.= "\n
\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 .= + "\n \n"; + } + + // Use javascript to mark the currently selected plugin. + $menu = $this->menu; + if(isset($_GET['plug'])){ + $menu.= + "\n \n"; } // Return the generated/cached gosa menu. - return ($this->menu); + return ($menu); } @@ -250,144 +249,145 @@ class pluglist { * 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)= explode("x", $this->config->get_cfg_value("iconsize")); - $isize= "width=\"$x\" height=\"$y\""; - } else { - $isize= ""; - } + 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
"; + if($add_hr){ + $add_hr = FALSE; + $this->iconmenu .= "\n
"; + } + $this->iconmenu .= "\n

". _($headline)."

"; - /* Parse headlines */ - foreach ($cfg as $headline => $plug){ - $col= 1; - $menu= "

". - _($headline)."

\n\n\n"; - $entries= ""; - - 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"; + foreach ($plug as $info){ + + // Get Plugin info + list($index, $title, $desc, $icon) = $this->getPlugData($info['CLASS']); + + // Add a seperating row + if (($col % 4) == 0){ + $this->iconmenu .= "\n
"; } - $index= $this->get_index($info['CLASS']); - - $href = "main.php?plug=".$index."&reset=1"; - - /* Check if class is available. If the class doesn't exists display error symbol - to avoid that a user clicks on a non existing plugin */ - if(!$vars){ - $plHeadline = $plDescription = _("Unknown"); - $info['ICON'] = "error.png"; - $href="main.php?reset=1"; - } - - - if ($this->check_access($info['ACL'])){ - - /* 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.""; - $col = 1; - } - $entries= $entries."\n"; - $col++ ; - - } - } - - /* Append to menu */ - if ($entries != ""){ - $this->iconmenu.= $menu.$entries; - - /* Fill up remaining columns */ - if ($col != 1){ - $col--; - while ($col % 5){ - $this->iconmenu= $this->iconmenu. - "\n"; - $col++; - } - } - - /* close table */ - $this->iconmenu= $this->iconmenu."\n
"; - if(session::global_get('js')){ - $entries.= "\"*\" ". - _($plHeadline); - } else { - $entries.= "". - "\"*\" ". - _($plHeadline).""; - } - $entries.= " 
\n"; - } - } + $this->iconmenu.= "\n
"; + $this->iconmenu.= "\n ".image($icon); + $this->iconmenu.= "\n
"; + $this->iconmenu.= "\n

{$title}

"; + $this->iconmenu.= "\n

{$desc}

"; + $this->iconmenu.= "\n
"; + $this->iconmenu.= "\n
"; + $col++ ; + } + $add_hr = TRUE; + } + } + return ($this->iconmenu); + } - } - /* Write menu output */ - return ($this->iconmenu); - } + /*! \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 of your gosa.conf) + */ + function genPathMenu() + { + if(empty($this->pathMenu)){ + + // 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
". + "\n
    ". + "\n
  • ". + "\n ".image(get_template_path("images/home.png")). + "\n
    • ". + "\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
  • {$title}
    • "; + } + } + $this->pathMenu.= "\n
"; + $this->pathMenu.= "\n
"; + } + + $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; + $vars= get_class_vars($class); + $plHeadline= _($vars['plHeadline']); + $plDescription= _($vars['plDescription']); + $plIcon = (isset($vars['plIcon'])) ? $vars['plIcon']: "plugin.png"; + $index= $this->get_index($class); + + /* Check if class is available. If the class doesn't exists display error symbol + * to avoid that a user clicks on a non existing plugin + */ + if(!$vars){ + $plHeadline = $plDescription = _("Unknown"); + $plIcon = "error.png"; + $index = ''; + } + + // Detect the correct position of the plugin icon + if(!preg_match("/\//",$plIcon)){ + $image= get_template_path("plugins/".preg_replace('%^.*/([^/]+)/[^/]+$%', '\1', + $class_mapping[$class])."/images/$plIcon"); + }else{ + $image = $plIcon; + } + return(array($index, $plHeadline, $plDescription, $image)); + } /*! \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_path($index) + { + if(!isset($this->dirlist[$index])){ + return (""); + } + return ("../".$this->dirlist[$index]); + } /*! \brief Returns the plugins id for a given class. */ - function get_index($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); - } + return (array_search($class, $this->pluginList)); + } /*! \brief This function checks if we are allowed to view the plugin with the given id @@ -397,7 +397,7 @@ class pluglist { */ function plugin_access_allowed($plug_id) { - return(isset($this->allowed_plugins[$plug_id])); + return(isset($this->pluginList[$plug_id])); } @@ -409,6 +409,27 @@ class pluglist { $this->iconmenu =""; } + + /*! \brief Generates an array containing plugin names (headlines) and theirs ids. + * This is just used in the helpviewer.php + */ + function gen_headlines() + { + $ret = array(); + if(count($this->headlines) == 0){ + foreach($this->config->data['MENU'] as $headline => $plugins){ + foreach( $plugins as $id => $plug){ + if (plugin_available($plug['CLASS'])){ + $attrs = (get_class_vars($plug['CLASS'])); + $ret[$id]['HEADLINE'] = $headline; + $ret[$id]['NAME'] = $attrs['plHeadline']; + } + } + } + $this->headlines = $ret; + } + return($this->headlines); + } } // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler: ?>