From: cajus Date: Wed, 10 May 2006 14:05:37 +0000 (+0000) Subject: Added contributed DFS plugin (not usable, yet) X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=efc4e81fce01d325e3fb877e23f08fcab9ce05a2;p=gosa.git Added contributed DFS plugin (not usable, yet) git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@3269 594d385d-05f5-0310-b6e9-bd551577e9d8 --- diff --git a/html/TreeMenu.js b/html/TreeMenu.js new file mode 100755 index 000000000..4782b9e2c --- /dev/null +++ b/html/TreeMenu.js @@ -0,0 +1,697 @@ +// +-----------------------------------------------------------------------+ +// | Copyright (c) 2002-2005, Richard Heyes, Harald Radi | +// | All rights reserved. | +// | | +// | Redistribution and use in source and binary forms, with or without | +// | modification, are permitted provided that the following conditions | +// | are met: | +// | | +// | o Redistributions of source code must retain the above copyright | +// | notice, this list of conditions and the following disclaimer. | +// | o Redistributions in binary form must reproduce the above copyright | +// | notice, this list of conditions and the following disclaimer in the | +// | documentation and/or other materials provided with the distribution.| +// | o The names of the authors may not be used to endorse or promote | +// | products derived from this software without specific prior written | +// | permission. | +// | | +// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | +// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | +// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | +// | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | +// | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | +// | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | +// | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | +// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | +// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | +// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | +// | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | +// | | +// +-----------------------------------------------------------------------+ +// | Author: Richard Heyes | +// | Harald Radi | +// +-----------------------------------------------------------------------+ +// +// $Id: TreeMenu.js,v 1.21 2005/03/02 02:39:26 richard Exp $ + +/** +* Function to create copies of objects which are +* normally passed around by references (Arrays for example) +*/ +function arrayCopy(input) +{ + var output = new Array(input.length); + + for (i in input) { + if (typeof(input[i]) == 'array') { + output[i] = arrayCopy(input[i]); + } else { + output[i] = input[i]; + } + } + + return output; +} + +/** +* TreeMenu class +*/ + function TreeMenu(iconpath, myname, linkTarget, defaultClass, usePersistence, noTopLevelImages) + { + // Properties + this.iconpath = iconpath; + this.myname = myname; + this.linkTarget = linkTarget; + this.defaultClass = defaultClass; + this.usePersistence = usePersistence; + this.noTopLevelImages = noTopLevelImages; + this.n = new Array(); + this.output = ''; + + this.nodeRefs = new Array(); + this.branches = new Array(); + this.branchStatus = new Array(); + this.layerRelations = new Array(); + this.childParents = new Array(); + this.cookieStatuses = new Array(); + + this.preloadImages(); + } + +/** +* Adds a node to the tree +*/ + TreeMenu.prototype.addItem = function (newNode) + { + newIndex = this.n.length; + this.n[newIndex] = newNode; + + return this.n[newIndex]; + } + +/** +* Preload images hack for Mozilla +*/ + TreeMenu.prototype.preloadImages = function () + { + var plustop = new Image; plustop.src = this.iconpath + '/plustop.gif'; + var plusbottom = new Image; plusbottom.src = this.iconpath + '/plusbottom.gif'; + var plus = new Image; plus.src = this.iconpath + '/plus.gif'; + + var minustop = new Image; minustop.src = this.iconpath + '/minustop.gif'; + var minusbottom = new Image; minusbottom.src = this.iconpath + '/minusbottom.gif'; + var minus = new Image; minus.src = this.iconpath + '/minus.gif'; + + var branchtop = new Image; branchtop.src = this.iconpath + '/branchtop.gif'; + var branchbottom = new Image; branchbottom.src = this.iconpath + '/branchbottom.gif'; + var branch = new Image; branch.src = this.iconpath + '/branch.gif'; + + var linebottom = new Image; linebottom.src = this.iconpath + '/linebottom.gif'; + var line = new Image; line.src = this.iconpath + '/line.gif'; + } + +/** +* Main function that draws the menu and assigns it +* to the layer (or document.write()s it) +*/ + TreeMenu.prototype.drawMenu = function ()// OPTIONAL ARGS: nodes = [], level = [], prepend = '', expanded = false, visbility = 'inline', parentLayerID = null + { + /** + * Necessary variables + */ + var output = ''; + var modifier = ''; + var layerID = ''; + var parentLayerID = ''; + + /** + * Parse any optional arguments + */ + var nodes = arguments[0] ? arguments[0] : this.n + var level = arguments[1] ? arguments[1] : []; + var prepend = arguments[2] ? arguments[2] : ''; + var expanded = arguments[3] ? arguments[3] : false; + var visibility = arguments[4] ? arguments[4] : 'inline'; + var parentLayerID = arguments[5] ? arguments[5] : null; + + var currentlevel = level.length; + + for (var i=0; i 1 ? "top" : 'single'; + } else if(i == (nodes.length-1)) { + modifier = "bottom"; + } else { + modifier = ""; + } + + /** + * Single root branch is always expanded + */ + if (!this.doesMenu() || (parentLayerID == null && (nodes.length == 1 || this.noTopLevelImages))) { + expanded = true; + + } else if (nodes[i].expanded) { + expanded = true; + + } else { + expanded = false; + } + + /** + * Make sure visibility is correct based on parent status + */ + visibility = this.checkParentVisibility(layerID) ? visibility : 'none'; + + /** + * Setup branch status and build an indexed array + * of branch layer ids + */ + if (nodes[i].n.length > 0) { + this.branchStatus[layerID] = expanded; + this.branches[this.branches.length] = layerID; + } + + /** + * Setup toggle relationship + */ + if (!this.layerRelations[parentLayerID]) { + this.layerRelations[parentLayerID] = new Array(); + } + this.layerRelations[parentLayerID][this.layerRelations[parentLayerID].length] = layerID; + + /** + * Branch images + */ + var gifname = nodes[i].n.length && this.doesMenu() && nodes[i].isDynamic ? (expanded ? 'minus' : 'plus') : 'branch'; + var iconName = expanded && nodes[i].expandedIcon ? nodes[i].expandedIcon : nodes[i].icon; + var iconimg = nodes[i].icon ? this.stringFormat('', this.iconpath, iconName, layerID) : ''; + + /** + * Add event handlers + */ + var eventHandlers = ""; + for (j in nodes[i].events) { + eventHandlers += this.stringFormat('{0}="{1}" ', j, nodes[i].events[j]); + } + + /** + * Build the html to write to the document + * IMPORTANT: + * document.write()ing the string: '
', layerID, visibility, (nodes[i].cssClass ? nodes[i].cssClass : this.defaultClass)) : this.stringFormat('
', nodes[i].cssClass ? nodes[i].cssClass : this.defaultClass); + var onMDown = this.doesMenu() && nodes[i].n.length && nodes[i].isDynamic ? this.stringFormat('onmousedown="{0}.toggleBranch(\'{1}\', true)" style="cursor: pointer; cursor: hand"', this.myname, layerID) : ''; + var imgTag = this.stringFormat('', this.iconpath, gifname, modifier, layerID, onMDown); + var linkTarget= nodes[i].linkTarget ? nodes[i].linkTarget : this.linkTarget; + var linkStart = nodes[i].link ? this.stringFormat('', nodes[i].link, linkTarget) : ''; + + var linkEnd = nodes[i].link ? '' : ''; + + this.output += this.stringFormat('{0}{1}{2}{3}{4}{6}{7}
', + layerTag, + prepend, + parentLayerID == null && (nodes.length == 1 || this.noTopLevelImages) ? '' : imgTag, + iconimg, + linkStart, + eventHandlers, + nodes[i].title, + linkEnd); + + /** + * Traverse sub nodes ? + */ + if (nodes[i].n.length) { + /** + * Determine what to prepend. If there is only one root + * node then the prepend to pass to children is nothing. + * Otherwise it depends on where we are in the tree. + */ + if (parentLayerID == null && (nodes.length == 1 || this.noTopLevelImages)) { + var newPrepend = ''; + + } else if (i < (nodes.length - 1)) { + var newPrepend = prepend + this.stringFormat('', this.iconpath); + + } else { + var newPrepend = prepend + this.stringFormat('', this.iconpath); + } + + this.drawMenu(nodes[i].n, + arrayCopy(level), + newPrepend, + nodes[i].expanded, + expanded ? 'inline' : 'none', + layerID); + } + } + } + +/** +* Writes the output generated by drawMenu() to the page +*/ + TreeMenu.prototype.writeOutput = function () + { + document.write(this.output); + } + +/** +* Toggles a branches visible status. Called from resetBranches() +* and also when a +/- graphic is clicked. +*/ + TreeMenu.prototype.toggleBranch = function (layerID, updateStatus) // OPTIONAL ARGS: fireEvents = true + { + var currentDisplay = this.getLayer(layerID).style.display; + var newDisplay = (this.branchStatus[layerID] && currentDisplay == 'inline') ? 'none' : 'inline'; + var fireEvents = arguments[2] != null ? arguments[2] : true; + + for (var i=0; i= 5)); + var is_gecko = (agt.indexOf('gecko') != -1); + + + var is_ie = ((agt.indexOf("msie") != -1) && (agt.indexOf("opera") == -1)); + var is_ie4 = (is_ie && (is_major == 4) && (agt.indexOf("msie 4")!=-1) ); + var is_ie4up = (is_ie && (is_major >= 4)); + + var is_opera = (agt.indexOf("opera") != -1); + var is_opera7 = (is_opera && is_major >= 7) || agt.indexOf("opera 7") != -1; + + // Patch from Harald Fielker + if (agt.indexOf('konqueror') != -1) { + var is_nav = false; + var is_nav6up = false; + var is_gecko = false; + var is_ie = true; + var is_ie4 = true; + var is_ie4up = true; + } +//--> end hide JavaScript diff --git a/html/TreeMenu.php b/html/TreeMenu.php new file mode 100755 index 000000000..1123a859e --- /dev/null +++ b/html/TreeMenu.php @@ -0,0 +1,822 @@ + | +// | Harald Radi | +// +-----------------------------------------------------------------------+ +// +// $Id: TreeMenu.php,v 1.21 2005/03/02 02:24:26 richard Exp $ + +/** +* HTML_TreeMenu Class +* +* A simple couple of PHP classes and some not so simple +* Jabbascript which produces a tree menu. In IE this menu +* is dynamic, with branches being collapsable. In IE5+ the +* status of the collapsed/open branches persists across page +* refreshes.In any other browser the tree is static. Code is +* based on work of Harald Radi. +* +* Usage. +* +* After installing the package, copy the example php script to +* your servers document root. Also place the TreeMenu.js and the +* images folder in the same place. Running the script should +* then produce the tree. +* +* Thanks go to Chip Chapin (http://www.chipchapin.com) for many +* excellent ideas and improvements. +* +* @author Richard Heyes +* @author Harald Radi +* @access public +* @package HTML_TreeMenu +*/ + +class HTML_TreeMenu +{ + /** + * Indexed array of subnodes + * @var array + */ + var $items; + + /** + * Constructor + * + * @access public + */ + function HTML_TreeMenu() + { + // Not much to do here :( + } + + /** + * This function adds an item to the the tree. + * + * @access public + * @param object $node The node to add. This object should be + * a HTML_TreeNode object. + * @return object Returns a reference to the new node inside + * the tree. + */ + function &addItem(&$node) + { + $this->items[] = &$node; + return $this->items[count($this->items) - 1]; + } + + /** + * Import method for creating HTML_TreeMenu objects/structures + * out of existing tree objects/structures. Currently supported + * are Wolfram Kriesings' PEAR Tree class, and Richard Heyes' (me!) + * Tree class (available here: http://www.phpguru.org/). This + * method is intended to be used statically, eg: + * $treeMenu = &HTML_TreeMenu::createFromStructure($myTreeStructureObj); + * + * @param array $params An array of parameters that determine + * how the import happens. This can consist of: + * structure => The tree structure + * type => The type of the structure, currently + * can be either 'heyes' or 'kriesing' + * nodeOptions => Default options for each node + * + * @return object The resulting HTML_TreeMenu object + */ + function createFromStructure($params) + { + if (!isset($params['nodeOptions'])) { + $params['nodeOptions'] = array(); + } + + switch (@$params['type']) { + + /** + * Wolfram Kriesings' PEAR Tree class + */ + case 'kriesing': + $className = strtolower(get_class($params['structure']->dataSourceClass)); + $isXMLStruct = strpos($className,'_xml') !== false ? true : false; + + // Get the entire tree, the $nodes are sorted like in the tree view + // from top to bottom, so we can easily put them in the nodes + $nodes = $params['structure']->getNode(); + + // Make a new menu and fill it with the values from the tree + $treeMenu = new HTML_TreeMenu(); + $curNode[0] = &$treeMenu; // we need the current node as the reference to the + + foreach ( $nodes as $aNode ) { + $events = array(); + $data = array(); + + // In an XML, all the attributes are saved in an array, but since they might be + // used as the parameters, we simply extract them here if we handle an XML-structure + if ( $isXMLStruct && sizeof($aNode['attributes']) ){ + foreach ( $aNode['attributes'] as $key=>$val ) { + if ( !$aNode[$key] ) { // dont overwrite existing values + $aNode[$key] = $val; + } + } + } + + // Process all the data that are saved in $aNode and put them in the data and/or events array + foreach ( $aNode as $key=>$val ) { + if ( !is_array($val) ) { + // Dont get the recursive data in here! they are always arrays + if ( substr($key,0,2) == 'on' ){ // get the events + $events[$key] = $val; + } + + // I put it in data too, so in case an options starts with 'on' its also passed to the node ... not too cool i know + $data[$key] = $val; + } + } + + // Normally the text is in 'name' in the Tree class, so we check both but 'text' is used if found + $data['text'] = $aNode['text'] ? $aNode['text'] : $aNode['name']; + + // Add the item to the proper node + $thisNode = &$curNode[$aNode['level']]->addItem( new HTML_TreeNode( $data , $events ) ); + $curNode[$aNode['level']+1] = &$thisNode; + } + break; + + /** + * Richard Heyes' (me!) second (array based) Tree class + */ + case 'heyes_array': + // Need to create a HTML_TreeMenu object ? + if (!isset($params['treeMenu'])) { + $treeMenu = &new HTML_TreeMenu(); + $parentID = 0; + } else { + $treeMenu = &$params['treeMenu']; + $parentID = $params['parentID']; + } + + // Loop thru the trees nodes + foreach ($params['structure']->getChildren($parentID) as $nodeID) { + $data = $params['structure']->getData($nodeID); + $parentNode = &$treeMenu->addItem(new HTML_TreeNode(array_merge($params['nodeOptions'], $data))); + + // Recurse ? + if ($params['structure']->hasChildren($nodeID)) { + $recurseParams['type'] = 'heyes_array'; + $recurseParams['parentID'] = $nodeID; + $recurseParams['nodeOptions'] = $params['nodeOptions']; + $recurseParams['structure'] = &$params['structure']; + $recurseParams['treeMenu'] = &$parentNode; + HTML_TreeMenu::createFromStructure($recurseParams); + } + } + + break; + + /** + * Richard Heyes' (me!) original OO based Tree class + */ + case 'heyes': + default: + // Need to create a HTML_TreeMenu object ? + if (!isset($params['treeMenu'])) { + $treeMenu = &new HTML_TreeMenu(); + } else { + $treeMenu = &$params['treeMenu']; + } + + // Loop thru the trees nodes + foreach ($params['structure']->nodes->nodes as $node) { + $tag = $node->getTag(); + $parentNode = &$treeMenu->addItem(new HTML_TreeNode(array_merge($params['nodeOptions'], $tag))); + + // Recurse ? + if (!empty($node->nodes->nodes)) { + $recurseParams['structure'] = $node; + $recurseParams['nodeOptions'] = $params['nodeOptions']; + $recurseParams['treeMenu'] = &$parentNode; + HTML_TreeMenu::createFromStructure($recurseParams); + } + } + break; + + } + + return $treeMenu; + } + + /** + * Creates a treeMenu from XML. The structure of your XML should be + * like so: + * + * + * + * + * + * + * + * + * + * Any of the options you can supply to the HTML_TreeNode constructor can be supplied as + * attributes to the tag. If there are no subnodes for a particular node, you can + * use the XML shortcut instead of . The $xml argument can + * be either the XML as a string, or an pre-created XML_Tree object. Also, this method + * REQUIRES my own Tree class to work (http://phpguru.org/tree.html). If this has not + * been include()ed or require()ed this method will die(). + * + * @param mixed $xml This can be either a string containing the XML, or an XML_Tree object + * (the PEAR::XML_Tree package). + * @return object The HTML_TreeMenu object + */ + function createFromXML($xml) + { + if (!class_exists('Tree')) { + die('Could not find Tree class'); + } + + // Supplied $xml is a string + if (is_string($xml)) { + require_once('XML/Tree.php'); + $xmlTree = &new XML_Tree(); + $xmlTree->getTreeFromString($xml); + + // Supplied $xml is an XML_Tree object + } else { + $xmlTree = $xml; + } + + // Now process the XML_Tree object, setting the XML attributes + // to be the tag data (with out the XML tag name or contents). + $treeStructure = Tree::createFromXMLTree($xmlTree, true); + $treeStructure->nodes->traverse(create_function('&$node', '$tagData = $node->getTag(); $node->setTag($tagData["attributes"]);')); + + + return HTML_TreeMenu::createFromStructure(array('structure' => $treeStructure)); + } +} // HTML_TreeMenu + + +/** +* HTML_TreeNode class +* +* This class is supplementary to the above and provides a way to +* add nodes to the tree. A node can have other nodes added to it. +* +* @author Richard Heyes +* @author Harald Radi +* @access public +* @package HTML_TreeMenu +*/ +class HTML_TreeNode +{ + /** + * The text for this node. + * @var string + */ + var $text; + + /** + * The link for this node. + * @var string + */ + var $link; + + /** + * The icon for this node. + * @var string + */ + var $icon; + + /** + * The icon to show when expanded for this node. + * @var string + */ + var $expandedIcon; + + /** + * The css class for this node + * @var string + */ + var $cssClass; + + /** + * The link target for this node + * @var string + */ + var $linkTarget; + + /** + * Indexed array of subnodes + * @var array + */ + var $items; + + /** + * Whether this node is expanded or not + * @var bool + */ + var $expanded; + + /** + * Whether this node is dynamic or not + * @var bool + */ + var $isDynamic; + + /** + * Should this node be made visible? + * @var bool + */ + var $ensureVisible; + + /** + * The parent node. Null if top level + * @var object + */ + var $parent; + + /** + * Javascript event handlers; + * @var array + */ + var $events; + + /** + * Constructor + * + * @access public + * @param array $options An array of options which you can pass to change + * the way this node looks/acts. This can consist of: + * o text The title of the node, defaults to blank + * o link The link for the node, defaults to blank + * o icon The icon for the node, defaults to blank + * o expandedIcon The icon to show when the node is expanded + * o cssClass The CSS class for this node, defaults to blank + * o expanded The default expanded status of this node, defaults to false + * This doesn't affect non dynamic presentation types + * o linkTarget Target for the links. Defaults to linkTarget of the + * HTML_TreeMenu_Presentation. + * o isDynamic If this node is dynamic or not. Only affects + * certain presentation types. + * o ensureVisible If true this node will be made visible despite the expanded + * settings, and client side persistence. Will not affect + * some presentation styles, such as Listbox. Default is false + * @param array $events An array of javascript events and the corresponding event handlers. + * Additionally to the standard javascript events you can specify handlers + * for the 'onexpand', 'oncollapse' and 'ontoggle' events which will be fired + * whenever a node is collapsed and/or expanded. + */ + function HTML_TreeNode($options = array(), $events = array()) + { + $this->text = ''; + $this->link = ''; + $this->icon = ''; + $this->expandedIcon = ''; + $this->cssClass = ''; + $this->expanded = false; + $this->isDynamic = true; + $this->ensureVisible = false; + $this->linkTarget = null; + + $this->parent = null; + $this->events = $events; + + foreach ($options as $option => $value) { + $this->$option = $value; + } + } + + /** + * Allows setting of various parameters after the initial + * constructor call. Possible options you can set are: + * o text + * o link + * o icon + * o cssClass + * o expanded + * o isDynamic + * o ensureVisible + * ie The same options as in the constructor + * + * @access public + * @param string $option Option to set + * @param string $value Value to set the option to + */ + function setOption($option, $value) + { + $this->$option = $value; + } + + /** + * Adds a new subnode to this node. + * + * @access public + * @param object $node The new node + */ + function &addItem(&$node) + { + $node->parent = &$this; + $this->items[] = &$node; + + /** + * If the subnode has ensureVisible set it needs + * to be handled, and all parents set accordingly. + */ + if ($node->ensureVisible) { + $this->_ensureVisible(); + } + + return $this->items[count($this->items) - 1]; + } + + /** + * Private function to handle ensureVisible stuff + * + * @access private + */ + function _ensureVisible() + { + $this->ensureVisible = true; + $this->expanded = true; + + if (!is_null($this->parent)) { + $this->parent->_ensureVisible(); + } + } +} // HTML_TreeNode + + +/** +* HTML_TreeMenu_Presentation class +* +* Base class for other presentation classes to +* inherit from. +*/ +class HTML_TreeMenu_Presentation +{ + /** + * The TreeMenu structure + * @var object + */ + var $menu; + + /** + * Base constructor simply sets the menu object + * + * @param object $structure The menu structure + */ + function HTML_TreeMenu_Presentation(&$structure) + { + $this->menu = &$structure; + } + + /** + * Prints the HTML generated by the toHTML() method. + * toHTML() must therefore be defined by the derived + * class. + * + * @access public + * @param array Options to set. Any options taken by + * the presentation class can be specified + * here. + */ + function printMenu($options = array()) + { + foreach ($options as $option => $value) { + $this->$option = $value; + } + + echo $this->toHTML(); + } +} + + +/** +* HTML_TreeMenu_DHTML class +* +* This class is a presentation class for the tree structure +* created using the TreeMenu/TreeNode. It presents the +* traditional tree, static for browsers that can't handle +* the DHTML. +*/ +class HTML_TreeMenu_DHTML extends HTML_TreeMenu_Presentation +{ + /** + * Dynamic status of the treemenu. If true (default) this has no effect. If + * false it will override all dynamic status vars and set the menu to be + * fully expanded an non-dynamic. + */ + var $isDynamic; + + /** + * Path to the images + * @var string + */ + var $images; + + /** + * Target for the links generated + * @var string + */ + var $linkTarget; + + /** + * Whether to use clientside persistence or not + * @var bool + */ + var $usePersistence; + + /** + * The default CSS class for the nodes + */ + var $defaultClass; + + /** + * Whether to skip first level branch images + * @var bool + */ + var $noTopLevelImages; + + /** + * Name of Jabbascript object to use + * @var string + */ + var $jsObjectName; + + /** + * Constructor, takes the tree structure as + * an argument and an array of options which + * can consist of: + * o images - The path to the images folder. Defaults to "images" + * o linkTarget - The target for the link. Defaults to "_self" + * o defaultClass - The default CSS class to apply to a node. Default is none. + * o usePersistence - Whether to use clientside persistence. This persistence + * is achieved using cookies. Default is true. + * o noTopLevelImages - Whether to skip displaying the first level of images if + * there is multiple top level branches. + * o maxDepth - The maximum depth of indentation. Useful for ensuring + * deeply nested trees don't go way off to the right of your + * page etc. Defaults to no limit. + * o jsObjectName - Name to use for jabbascript object. Set this if you have + * different menus that should maintain their persistence + * information separately. + * + * And also a boolean for whether the entire tree is dynamic or not. + * This overrides any perNode dynamic settings. + * + * @param object $structure The menu structure + * @param array $options Array of options + * @param bool $isDynamic Whether the tree is dynamic or not + */ + function HTML_TreeMenu_DHTML(&$structure, $options = array(), $isDynamic = true) + { + $this->HTML_TreeMenu_Presentation($structure); + $this->isDynamic = $isDynamic; + + // Defaults + $this->images = 'images'; + $this->maxDepth = 0; // No limit + $this->linkTarget = '_self'; + $this->jsObjectName = 'objTreeMenu'; + $this->defaultClass = ''; + $this->usePersistence = true; + $this->noTopLevelImages = false; + + foreach ($options as $option => $value) { + $this->$option = $value; + } + } + + /** + * Returns the HTML for the menu. This method can be + * used instead of printMenu() to use the menu system + * with a template system. + * + * @access public + * @return string The HTML for the menu + */ + function toHTML() + { + static $count = 0; + $menuObj = $this->jsObjectName . '_' . ++$count; + + $html = "\n"; + $html .= '"; + + return $html; + } + + /** + * Prints a node of the menu + * + * @access private + */ + function _nodeToHTML($nodeObj, $prefix, $return = 'newNode', $currentDepth = 0, $maxDepthPrefix = null) + { + $prefix = empty($maxDepthPrefix) ? $prefix : $maxDepthPrefix; + + $expanded = $this->isDynamic ? ($nodeObj->expanded ? 'true' : 'false') : 'true'; + $isDynamic = $this->isDynamic ? ($nodeObj->isDynamic ? 'true' : 'false') : 'false'; + $html = sprintf("\t %s = %s.addItem(new TreeNode('%s', %s, %s, %s, %s, '%s', '%s', %s));\n", + $return, + $prefix, + str_replace("'", "\\'", $nodeObj->text), + !empty($nodeObj->icon) ? "'" . $nodeObj->icon . "'" : 'null', + !empty($nodeObj->link) ? "'" . $nodeObj->link . "'" : 'null', + $expanded, + $isDynamic, + $nodeObj->cssClass, + $nodeObj->linkTarget, + !empty($nodeObj->expandedIcon) ? "'" . $nodeObj->expandedIcon . "'" : 'null'); + + foreach ($nodeObj->events as $event => $handler) { + $html .= sprintf("\t %s.setEvent('%s', '%s');\n", + $return, + $event, + str_replace(array("\r", "\n", "'"), array('\r', '\n', "\'"), $handler)); + } + + if ($this->maxDepth > 0 AND $currentDepth == $this->maxDepth) { + $maxDepthPrefix = $prefix; + } + + /** + * Loop through subnodes + */ + if (!empty($nodeObj->items)) { + for ($i=0; $iitems); $i++) { + $html .= $this->_nodeToHTML($nodeObj->items[$i], $return, $return . '_' . ($i + 1), $currentDepth + 1, $maxDepthPrefix); + } + } + + return $html; + } +} // End class HTML_TreeMenu_DHTML + + +/** +* HTML_TreeMenu_Listbox class +* +* This class presents the menu as a listbox +*/ +class HTML_TreeMenu_Listbox extends HTML_TreeMenu_Presentation +{ + /** + * The text that is displayed in the first option + * @var string + */ + var $promoText; + + /** + * The character used for indentation + * @var string + */ + var $indentChar; + + /** + * How many of the indent chars to use + * per indentation level + * @var integer + */ + var $indentNum; + + /** + * Target for the links generated + * @var string + */ + var $linkTarget; + + /** + * Constructor + * + * @param object $structure The menu structure + * @param array $options Options whic affect the display of the listbox. + * These can consist of: + * o promoText The text that appears at the the top of the listbox + * Defaults to "Select..." + * o indentChar The character to use for indenting the nodes + * Defaults to " " + * o indentNum How many of the indentChars to use per indentation level + * Defaults to 2 + * o linkTarget Target for the links. Defaults to "_self" + * o submitText Text for the submit button. Defaults to "Go" + */ + function HTML_TreeMenu_Listbox($structure, $options = array()) + { + $this->HTML_TreeMenu_Presentation($structure); + + $this->promoText = 'Select...'; + $this->indentChar = ' '; + $this->indentNum = 2; + $this->linkTarget = '_self'; + $this->submitText = 'Go'; + + foreach ($options as $option => $value) { + $this->$option = $value; + } + } + + /** + * Returns the HTML generated + */ + function toHTML() + { + static $count = 0; + $nodeHTML = ''; + + /** + * Loop through subnodes + */ + if (isset($this->menu->items)) { + for ($i=0; $imenu->items); $i++) { + $nodeHTML .= $this->_nodeToHTML($this->menu->items[$i]); + } + } + + return sprintf('
', + $this->linkTarget, + 'HTML_TreeMenu_Listbox_' . ++$count, + 'HTML_TreeMenu_Listbox_' . $count, + 'HTML_TreeMenu_Listbox_' . $count, + $this->promoText, + $nodeHTML, + $this->submitText); + } + + /** + * Returns HTML for a single node + * + * @access private + */ + function _nodeToHTML($node, $prefix = '') + { + $html = sprintf('', $node->link, $prefix, $node->text); + + /** + * Loop through subnodes + */ + if (isset($node->items)) { + for ($i=0; $iitems); $i++) { + $html .= $this->_nodeToHTML($node->items[$i], $prefix . str_repeat($this->indentChar, $this->indentNum)); + } + } + + return $html; + } +} // End class HTML_TreeMenu_Listbox +?> diff --git a/include/TreeMenu.inc b/include/TreeMenu.inc new file mode 100644 index 000000000..c55e039cf --- /dev/null +++ b/include/TreeMenu.inc @@ -0,0 +1,822 @@ + | +// | Harald Radi | +// +-----------------------------------------------------------------------+ +// +// $Id: TreeMenu.php,v 1.21 2005/03/02 02:24:26 richard Exp $ + +/** +* HTML_TreeMenu Class +* +* A simple couple of PHP classes and some not so simple +* Jabbascript which produces a tree menu. In IE this menu +* is dynamic, with branches being collapsable. In IE5+ the +* status of the collapsed/open branches persists across page +* refreshes.In any other browser the tree is static. Code is +* based on work of Harald Radi. +* +* Usage. +* +* After installing the package, copy the example php script to +* your servers document root. Also place the TreeMenu.js and the +* images folder in the same place. Running the script should +* then produce the tree. +* +* Thanks go to Chip Chapin (http://www.chipchapin.com) for many +* excellent ideas and improvements. +* +* @author Richard Heyes +* @author Harald Radi +* @access public +* @package HTML_TreeMenu +*/ + +class HTML_TreeMenu +{ + /** + * Indexed array of subnodes + * @var array + */ + var $items; + + /** + * Constructor + * + * @access public + */ + function HTML_TreeMenu() + { + // Not much to do here :( + } + + /** + * This function adds an item to the the tree. + * + * @access public + * @param object $node The node to add. This object should be + * a HTML_TreeNode object. + * @return object Returns a reference to the new node inside + * the tree. + */ + function addItem(&$node) + { + $this->items[] = &$node; + return $this->items[count($this->items) - 1]; + } + + /** + * Import method for creating HTML_TreeMenu objects/structures + * out of existing tree objects/structures. Currently supported + * are Wolfram Kriesings' PEAR Tree class, and Richard Heyes' (me!) + * Tree class (available here: http://www.phpguru.org/). This + * method is intended to be used statically, eg: + * $treeMenu = &HTML_TreeMenu::createFromStructure($myTreeStructureObj); + * + * @param array $params An array of parameters that determine + * how the import happens. This can consist of: + * structure => The tree structure + * type => The type of the structure, currently + * can be either 'heyes' or 'kriesing' + * nodeOptions => Default options for each node + * + * @return object The resulting HTML_TreeMenu object + */ + function createFromStructure($params) + { + if (!isset($params['nodeOptions'])) { + $params['nodeOptions'] = array(); + } + + switch (@$params['type']) { + + /** + * Wolfram Kriesings' PEAR Tree class + */ + case 'kriesing': + $className = strtolower(get_class($params['structure']->dataSourceClass)); + $isXMLStruct = strpos($className,'_xml') !== false ? true : false; + + // Get the entire tree, the $nodes are sorted like in the tree view + // from top to bottom, so we can easily put them in the nodes + $nodes = $params['structure']->getNode(); + + // Make a new menu and fill it with the values from the tree + $treeMenu = new HTML_TreeMenu(); + $curNode[0] = &$treeMenu; // we need the current node as the reference to the + + foreach ( $nodes as $aNode ) { + $events = array(); + $data = array(); + + // In an XML, all the attributes are saved in an array, but since they might be + // used as the parameters, we simply extract them here if we handle an XML-structure + if ( $isXMLStruct && sizeof($aNode['attributes']) ){ + foreach ( $aNode['attributes'] as $key=>$val ) { + if ( !$aNode[$key] ) { // dont overwrite existing values + $aNode[$key] = $val; + } + } + } + + // Process all the data that are saved in $aNode and put them in the data and/or events array + foreach ( $aNode as $key=>$val ) { + if ( !is_array($val) ) { + // Dont get the recursive data in here! they are always arrays + if ( substr($key,0,2) == 'on' ){ // get the events + $events[$key] = $val; + } + + // I put it in data too, so in case an options starts with 'on' its also passed to the node ... not too cool i know + $data[$key] = $val; + } + } + + // Normally the text is in 'name' in the Tree class, so we check both but 'text' is used if found + $data['text'] = $aNode['text'] ? $aNode['text'] : $aNode['name']; + + // Add the item to the proper node + $thisNode = &$curNode[$aNode['level']]->addItem( new HTML_TreeNode( $data , $events ) ); + $curNode[$aNode['level']+1] = &$thisNode; + } + break; + + /** + * Richard Heyes' (me!) second (array based) Tree class + */ + case 'heyes_array': + // Need to create a HTML_TreeMenu object ? + if (!isset($params['treeMenu'])) { + $treeMenu = new HTML_TreeMenu(); + $parentID = 0; + } else { + $treeMenu = &$params['treeMenu']; + $parentID = $params['parentID']; + } + + // Loop thru the trees nodes + foreach ($params['structure']->getChildren($parentID) as $nodeID) { + $data = $params['structure']->getData($nodeID); + $parentNode = &$treeMenu->addItem(new HTML_TreeNode(array_merge($params['nodeOptions'], $data))); + + // Recurse ? + if ($params['structure']->hasChildren($nodeID)) { + $recurseParams['type'] = 'heyes_array'; + $recurseParams['parentID'] = $nodeID; + $recurseParams['nodeOptions'] = $params['nodeOptions']; + $recurseParams['structure'] = &$params['structure']; + $recurseParams['treeMenu'] = &$parentNode; + HTML_TreeMenu::createFromStructure($recurseParams); + } + } + + break; + + /** + * Richard Heyes' (me!) original OO based Tree class + */ + case 'heyes': + default: + // Need to create a HTML_TreeMenu object ? + if (!isset($params['treeMenu'])) { + $treeMenu = new HTML_TreeMenu(); + } else { + $treeMenu = &$params['treeMenu']; + } + + // Loop thru the trees nodes + foreach ($params['structure']->nodes->nodes as $node) { + $tag = $node->getTag(); + $parentNode = &$treeMenu->addItem(new HTML_TreeNode(array_merge($params['nodeOptions'], $tag))); + + // Recurse ? + if (!empty($node->nodes->nodes)) { + $recurseParams['structure'] = $node; + $recurseParams['nodeOptions'] = $params['nodeOptions']; + $recurseParams['treeMenu'] = &$parentNode; + HTML_TreeMenu::createFromStructure($recurseParams); + } + } + break; + + } + + return $treeMenu; + } + + /** + * Creates a treeMenu from XML. The structure of your XML should be + * like so: + * + * + * + * + * + * + * + * + * + * Any of the options you can supply to the HTML_TreeNode constructor can be supplied as + * attributes to the tag. If there are no subnodes for a particular node, you can + * use the XML shortcut instead of . The $xml argument can + * be either the XML as a string, or an pre-created XML_Tree object. Also, this method + * REQUIRES my own Tree class to work (http://phpguru.org/tree.html). If this has not + * been include()ed or require()ed this method will die(). + * + * @param mixed $xml This can be either a string containing the XML, or an XML_Tree object + * (the PEAR::XML_Tree package). + * @return object The HTML_TreeMenu object + */ + function createFromXML($xml) + { + if (!class_exists('Tree')) { + die('Could not find Tree class'); + } + + // Supplied $xml is a string + if (is_string($xml)) { + require_once('XML/Tree.php'); + $xmlTree = new XML_Tree(); + $xmlTree->getTreeFromString($xml); + + // Supplied $xml is an XML_Tree object + } else { + $xmlTree = $xml; + } + + // Now process the XML_Tree object, setting the XML attributes + // to be the tag data (with out the XML tag name or contents). + $treeStructure = Tree::createFromXMLTree($xmlTree, true); + $treeStructure->nodes->traverse(create_function('&$node', '$tagData = $node->getTag(); $node->setTag($tagData["attributes"]);')); + + + return HTML_TreeMenu::createFromStructure(array('structure' => $treeStructure)); + } +} // HTML_TreeMenu + + +/** +* HTML_TreeNode class +* +* This class is supplementary to the above and provides a way to +* add nodes to the tree. A node can have other nodes added to it. +* +* @author Richard Heyes +* @author Harald Radi +* @access public +* @package HTML_TreeMenu +*/ +class HTML_TreeNode +{ + /** + * The text for this node. + * @var string + */ + var $text; + + /** + * The link for this node. + * @var string + */ + var $link; + + /** + * The icon for this node. + * @var string + */ + var $icon; + + /** + * The icon to show when expanded for this node. + * @var string + */ + var $expandedIcon; + + /** + * The css class for this node + * @var string + */ + var $cssClass; + + /** + * The link target for this node + * @var string + */ + var $linkTarget; + + /** + * Indexed array of subnodes + * @var array + */ + var $items; + + /** + * Whether this node is expanded or not + * @var bool + */ + var $expanded; + + /** + * Whether this node is dynamic or not + * @var bool + */ + var $isDynamic; + + /** + * Should this node be made visible? + * @var bool + */ + var $ensureVisible; + + /** + * The parent node. Null if top level + * @var object + */ + var $parent; + + /** + * Javascript event handlers; + * @var array + */ + var $events; + + /** + * Constructor + * + * @access public + * @param array $options An array of options which you can pass to change + * the way this node looks/acts. This can consist of: + * o text The title of the node, defaults to blank + * o link The link for the node, defaults to blank + * o icon The icon for the node, defaults to blank + * o expandedIcon The icon to show when the node is expanded + * o cssClass The CSS class for this node, defaults to blank + * o expanded The default expanded status of this node, defaults to false + * This doesn't affect non dynamic presentation types + * o linkTarget Target for the links. Defaults to linkTarget of the + * HTML_TreeMenu_Presentation. + * o isDynamic If this node is dynamic or not. Only affects + * certain presentation types. + * o ensureVisible If true this node will be made visible despite the expanded + * settings, and client side persistence. Will not affect + * some presentation styles, such as Listbox. Default is false + * @param array $events An array of javascript events and the corresponding event handlers. + * Additionally to the standard javascript events you can specify handlers + * for the 'onexpand', 'oncollapse' and 'ontoggle' events which will be fired + * whenever a node is collapsed and/or expanded. + */ + function HTML_TreeNode($options = array(), $events = array()) + { + $this->text = ''; + $this->link = ''; + $this->icon = ''; + $this->expandedIcon = ''; + $this->cssClass = ''; + $this->expanded = false; + $this->isDynamic = true; + $this->ensureVisible = false; + $this->linkTarget = null; + + $this->parent = null; + $this->events = $events; + + foreach ($options as $option => $value) { + $this->$option = $value; + } + } + + /** + * Allows setting of various parameters after the initial + * constructor call. Possible options you can set are: + * o text + * o link + * o icon + * o cssClass + * o expanded + * o isDynamic + * o ensureVisible + * ie The same options as in the constructor + * + * @access public + * @param string $option Option to set + * @param string $value Value to set the option to + */ + function setOption($option, $value) + { + $this->$option = $value; + } + + /** + * Adds a new subnode to this node. + * + * @access public + * @param object $node The new node + */ + function &addItem(&$node) + { + $node->parent = &$this; + $this->items[] = &$node; + + /** + * If the subnode has ensureVisible set it needs + * to be handled, and all parents set accordingly. + */ + if ($node->ensureVisible) { + $this->_ensureVisible(); + } + + return $this->items[count($this->items) - 1]; + } + + /** + * Private function to handle ensureVisible stuff + * + * @access private + */ + function _ensureVisible() + { + $this->ensureVisible = true; + $this->expanded = true; + + if (!is_null($this->parent)) { + $this->parent->_ensureVisible(); + } + } +} // HTML_TreeNode + + +/** +* HTML_TreeMenu_Presentation class +* +* Base class for other presentation classes to +* inherit from. +*/ +class HTML_TreeMenu_Presentation +{ + /** + * The TreeMenu structure + * @var object + */ + var $menu; + + /** + * Base constructor simply sets the menu object + * + * @param object $structure The menu structure + */ + function HTML_TreeMenu_Presentation(&$structure) + { + $this->menu = &$structure; + } + + /** + * Prints the HTML generated by the toHTML() method. + * toHTML() must therefore be defined by the derived + * class. + * + * @access public + * @param array Options to set. Any options taken by + * the presentation class can be specified + * here. + */ + function printMenu($options = array()) + { + foreach ($options as $option => $value) { + $this->$option = $value; + } + + echo $this->toHTML(); + } +} + + +/** +* HTML_TreeMenu_DHTML class +* +* This class is a presentation class for the tree structure +* created using the TreeMenu/TreeNode. It presents the +* traditional tree, static for browsers that can't handle +* the DHTML. +*/ +class HTML_TreeMenu_DHTML extends HTML_TreeMenu_Presentation +{ + /** + * Dynamic status of the treemenu. If true (default) this has no effect. If + * false it will override all dynamic status vars and set the menu to be + * fully expanded an non-dynamic. + */ + var $isDynamic; + + /** + * Path to the images + * @var string + */ + var $images; + + /** + * Target for the links generated + * @var string + */ + var $linkTarget; + + /** + * Whether to use clientside persistence or not + * @var bool + */ + var $usePersistence; + + /** + * The default CSS class for the nodes + */ + var $defaultClass; + + /** + * Whether to skip first level branch images + * @var bool + */ + var $noTopLevelImages; + + /** + * Name of Jabbascript object to use + * @var string + */ + var $jsObjectName; + + /** + * Constructor, takes the tree structure as + * an argument and an array of options which + * can consist of: + * o images - The path to the images folder. Defaults to "images" + * o linkTarget - The target for the link. Defaults to "_self" + * o defaultClass - The default CSS class to apply to a node. Default is none. + * o usePersistence - Whether to use clientside persistence. This persistence + * is achieved using cookies. Default is true. + * o noTopLevelImages - Whether to skip displaying the first level of images if + * there is multiple top level branches. + * o maxDepth - The maximum depth of indentation. Useful for ensuring + * deeply nested trees don't go way off to the right of your + * page etc. Defaults to no limit. + * o jsObjectName - Name to use for jabbascript object. Set this if you have + * different menus that should maintain their persistence + * information separately. + * + * And also a boolean for whether the entire tree is dynamic or not. + * This overrides any perNode dynamic settings. + * + * @param object $structure The menu structure + * @param array $options Array of options + * @param bool $isDynamic Whether the tree is dynamic or not + */ + function HTML_TreeMenu_DHTML(&$structure, $options = array(), $isDynamic = true) + { + $this->HTML_TreeMenu_Presentation($structure); + $this->isDynamic = $isDynamic; + + // Defaults + $this->images = 'images'; + $this->maxDepth = 0; // No limit + $this->linkTarget = '_self'; + $this->jsObjectName = 'objTreeMenu'; + $this->defaultClass = ''; + $this->usePersistence = true; + $this->noTopLevelImages = false; + + foreach ($options as $option => $value) { + $this->$option = $value; + } + } + + /** + * Returns the HTML for the menu. This method can be + * used instead of printMenu() to use the menu system + * with a template system. + * + * @access public + * @return string The HTML for the menu + */ + function toHTML() + { + static $count = 0; + $menuObj = $this->jsObjectName . '_' . ++$count; + + $html = "\n"; + $html .= '"; + + return $html; + } + + /** + * Prints a node of the menu + * + * @access private + */ + function _nodeToHTML($nodeObj, $prefix, $return = 'newNode', $currentDepth = 0, $maxDepthPrefix = null) + { + $prefix = empty($maxDepthPrefix) ? $prefix : $maxDepthPrefix; + + $expanded = $this->isDynamic ? ($nodeObj->expanded ? 'true' : 'false') : 'true'; + $isDynamic = $this->isDynamic ? ($nodeObj->isDynamic ? 'true' : 'false') : 'false'; + $html = sprintf("\t %s = %s.addItem(new TreeNode('%s', %s, %s, %s, %s, '%s', '%s', %s));\n", + $return, + $prefix, + str_replace("'", "\\'", $nodeObj->text), + !empty($nodeObj->icon) ? "'" . $nodeObj->icon . "'" : 'null', + !empty($nodeObj->link) ? "'" . $nodeObj->link . "'" : 'null', + $expanded, + $isDynamic, + $nodeObj->cssClass, + $nodeObj->linkTarget, + !empty($nodeObj->expandedIcon) ? "'" . $nodeObj->expandedIcon . "'" : 'null'); + + foreach ($nodeObj->events as $event => $handler) { + $html .= sprintf("\t %s.setEvent('%s', '%s');\n", + $return, + $event, + str_replace(array("\r", "\n", "'"), array('\r', '\n', "\'"), $handler)); + } + + if ($this->maxDepth > 0 AND $currentDepth == $this->maxDepth) { + $maxDepthPrefix = $prefix; + } + + /** + * Loop through subnodes + */ + if (!empty($nodeObj->items)) { + for ($i=0; $iitems); $i++) { + $html .= $this->_nodeToHTML($nodeObj->items[$i], $return, $return . '_' . ($i + 1), $currentDepth + 1, $maxDepthPrefix); + } + } + + return $html; + } +} // End class HTML_TreeMenu_DHTML + + +/** +* HTML_TreeMenu_Listbox class +* +* This class presents the menu as a listbox +*/ +class HTML_TreeMenu_Listbox extends HTML_TreeMenu_Presentation +{ + /** + * The text that is displayed in the first option + * @var string + */ + var $promoText; + + /** + * The character used for indentation + * @var string + */ + var $indentChar; + + /** + * How many of the indent chars to use + * per indentation level + * @var integer + */ + var $indentNum; + + /** + * Target for the links generated + * @var string + */ + var $linkTarget; + + /** + * Constructor + * + * @param object $structure The menu structure + * @param array $options Options whic affect the display of the listbox. + * These can consist of: + * o promoText The text that appears at the the top of the listbox + * Defaults to "Select..." + * o indentChar The character to use for indenting the nodes + * Defaults to " " + * o indentNum How many of the indentChars to use per indentation level + * Defaults to 2 + * o linkTarget Target for the links. Defaults to "_self" + * o submitText Text for the submit button. Defaults to "Go" + */ + function HTML_TreeMenu_Listbox($structure, $options = array()) + { + $this->HTML_TreeMenu_Presentation($structure); + + $this->promoText = 'Select...'; + $this->indentChar = ' '; + $this->indentNum = 2; + $this->linkTarget = '_self'; + $this->submitText = 'Go'; + + foreach ($options as $option => $value) { + $this->$option = $value; + } + } + + /** + * Returns the HTML generated + */ + function toHTML() + { + static $count = 0; + $nodeHTML = ''; + + /** + * Loop through subnodes + */ + if (isset($this->menu->items)) { + for ($i=0; $imenu->items); $i++) { + $nodeHTML .= $this->_nodeToHTML($this->menu->items[$i]); + } + } + + return sprintf('
', + $this->linkTarget, + 'HTML_TreeMenu_Listbox_' . ++$count, + 'HTML_TreeMenu_Listbox_' . $count, + 'HTML_TreeMenu_Listbox_' . $count, + $this->promoText, + $nodeHTML, + $this->submitText); + } + + /** + * Returns HTML for a single node + * + * @access private + */ + function _nodeToHTML($node, $prefix = '') + { + $html = sprintf('', $node->link, $prefix, $node->text); + + /** + * Loop through subnodes + */ + if (isset($node->items)) { + for ($i=0; $iitems); $i++) { + $html .= $this->_nodeToHTML($node->items[$i], $prefix . str_repeat($this->indentChar, $this->indentNum)); + } + } + + return $html; + } +} // End class HTML_TreeMenu_Listbox +?> diff --git a/include/functions.inc b/include/functions.inc index 0bedbcee8..6d738c32a 100644 --- a/include/functions.inc +++ b/include/functions.inc @@ -770,7 +770,13 @@ function get_ou($name) { global $config; - $ou= $config->current[$name]; + /* Preset ou... */ + if (isset($config->current[$name])){ + $ou= $config->current[$name]; + } else { + return ""; + } + if ($ou != ""){ if (!preg_match('/^[^=]+=[^=]+/', $ou)){ return @LDAP::convert("ou=$ou,"); diff --git a/plugins/addons/godfs/class_dfsManagment.inc b/plugins/addons/godfs/class_dfsManagment.inc new file mode 100644 index 000000000..30bbe647c --- /dev/null +++ b/plugins/addons/godfs/class_dfsManagment.inc @@ -0,0 +1,267 @@ +config = $config; + $this->ui = $ui; + + } + + /* Execute is the function all plugins need. It fills the plugin with life and produces the output. */ + function execute() { + + require_once('TreeMenu.inc'); + /* Normally you would react to user input here. */ + + plugin::execute(); + + $action = ""; + $s_action= ""; + $options = ""; + $regex = ""; + + $icon = 'folder.gif'; + $expandedIcon = 'folder-expanded.gif'; + $base = get_base_from_people($this->ui->dn); + $smarty= get_smarty(); + + foreach ($_POST as $key => $val) { + # delete + if (preg_match("/dfs_del.*/", $key)) { + $s_action = "del"; + $s_entry = preg_replace("/dfs_".$s_action."_/i", "", $key); + $s_entry = preg_replace("/_.*$/", "", $s_entry); + $s_entry = base64_decode($s_entry); + # edit + } elseif (preg_match("/dfs_edit.*/", $key)) { + $s_action = "edit"; + $s_entry = preg_replace("/dfs_".$s_action."_/i", "", $key); + $s_entry = preg_replace("/_.*$/", "", $s_entry); + $s_entry = base64_decode($s_entry); + # new + } elseif (preg_match("/dfs_new.*/", $key)) { + $s_action = "new"; + # back + } elseif (preg_match("/dfs_back.*/", $key)) { + $s_action = "back"; + # home + } elseif (preg_match("/dfs_home.*/", $key)) { + $s_action = "home"; + # root + } elseif (preg_match("/dfs_root.*/", $key)) { + $s_action = "root"; + } + } + + $tree = new HTML_TreeMenu(); + + if ((isset($_GET['act'])) && ($_GET['act'] == "edit_entry")) { + $s_action = "edit"; + $dfs_share = $_GET['id']; + } + + # new + if ($s_action == "new") { + $this->dn = "new"; + $this->dfstab = new dfstabs($this->config, $this->config->data['TABS']['DFSTABS'], $this->dn); + } + + # edit + if (($_SERVER['REQUEST_METHOD'] == "POST") || ($_SERVER['REQUEST_METHOD'] == "GET")) { + if ($s_action == "edit") { + + $this->dn = $dfs_share; + + if (($user = get_lock($this->dn)) != "") { + return (gen_locked_message ($user, $this->dn)); + } else { + add_lock ($this->dn, $this->ui->dn); + } + + $this->acl = get_permissions($this->dn, $this->ui->subtreeACL); + + $this->dfstab = new dfstabs($this->config, $this->config->data['TABS']['DFSTABS'], $this->dn); + $this->dfstab->set_acl($this->acl); + $this->dfstab->save_object(); + $_SESSION['objectinfo']= $this->dn; + } + } + + # save pressed + if (isset($_POST['edit_finish'])) { + $this->dfstab->last = $this->dfstab->current; + $this->dfstab->save_object(); + #$disp = $this->by_object['']; + #var_dump($disp); + + $message = $this->dfstab->check(); + + # any errors? + if (count($message) == 0) { + # write to ldap + $this->dfstab->save(); + } else { + show_errors($message); + } + } + + # cancel pressed + if (isset($_POST['edit_cancel'])) { + del_lock ($_SESSION['objectinfo']); + unset ($this->dfstab); + $this->dfstab = NULL; + $this->dn = ""; + unset($_SESSION['objectinfo']); + } + + # delete pressed + if (isset($_POST['edit_delete'])) { + + # get the current values + $this->sambasharename = $_POST['sambaShareName']; + $this->sharedescription = $_POST['description']; + $this->fileserver = $_POST['fileserver']; + $this->share = $_POST['fileservershare']; + $this->loc = $_POST['location']; + + $base = get_base_from_people($this->ui->dn); + $ou = get_ou("DFS"); + $this->basedn = "sambaShareName=$this->sambasharename,ou=$this->loc,$ou$base"; + + $ldap = $this->config->get_ldap_link(); + $ldap->cd($this->basedn); + $ldap->rmdir($this->basedn); + show_ldap_error($ldap->get_error()); + + del_lock ($_SESSION['objectinfo']); + unset ($this->dfstab); + $this->dfstab = NULL; + $this->dn = ""; + unset($_SESSION['objectinfo']); + } + + # generate main page no tabs + + $ldap = $this->config->get_ldap_link(); + + $ou = get_ou("DFS"); + + $ldap->cd("$ou$base"); + $ldap->search(("ou=*"), array("dn")); + + if ($ldap->count() == 0) { + $message[] = _("No DFS entries found"); + show_errors ($message); + } else { + $have_tree= false; + while ($dfs = $ldap->fetch()) { + if (preg_match("/^ou=DFS.*/", $dfs["dn"])) { + $dfs_root_node = new HTML_TreeNode(array('text' => "DFS", 'icon' => $icon, 'expandedIcon' => $expandedIcon, 'expanded' => false)); + $have_tree= true; + } elseif ($have_tree) { + preg_match("/^ou=(.*),/U", $dfs["dn"], $reg); + $loc = $reg[1]; + $node = $dfs_root_node->addItem(new HTML_TreeNode(array('text' => "$loc", 'icon' => $icon, 'expandedIcon' => $expandedIcon))); + + $sub_node_ldap = $this->config->get_ldap_link(); + $sub_node_ldap->cd("ou=$loc, $ou$base"); + $sub_node_ldap->search("(objectclass=sambaShare)", array("sambaShareName", "description", "documentLocation")); + + while ($dfs_loc = $sub_node_ldap->fetch()) { + $share_name = $dfs_loc["sambaShareName"][0]; + $desc = $dfs_loc["description"][0]; + $srv_loc = preg_replace("/msdfs:/", "", $dfs_loc["documentLocation"][0]); + #$srv_loc = preg_replace("/\\/", "\\\\", $srv_loc); + $link = "main.php\?plug=".$_GET['plug']."\&id=$loc\/$share_name\&act=edit_entry"; + $share_node = &$node->addItem(new HTML_TreeNode(array('text' => "$share_name - $desc", 'link' => "$link", 'icon' => $icon, 'expandedIcon' => $expandedIcon))); + $srv_loc_node = &$share_node->addItem(new HTML_TreeNode(array('text' => "$srv_loc", 'icon' => $icon, 'expandedIcon' => $expandedIcon))); + } + } + } + } + + $tree->addItem($dfs_root_node); + + // Create the presentation class + $treeMenu = new HTML_TreeMenu_DHTML($tree, array('images' => 'images', 'defaultClass' => 'treeMenuDefault')); + $tree_html = $treeMenu->toHTML(); + + if ($this->dfstab == NULL) { + + if (($message = check_sizelimit()) != "") { + return ($message); + } + + $listhead = "
". + "  ". + "  ". + "  ". + "  ". + _("Base")." ". + "  
"; + + + /* Use the smarty templating engine here... */ + + $smarty->assign('tree', $tree_html); + $smarty->assign('search_image', get_template_path('images/search.png')); + $smarty->assign('infoimage', get_template_path('images/info.png')); + $smarty->assign('launchimage', get_template_path('images/launch.png')); + $smarty->assign('alphabet', generate_alphabet()); + $smarty->assign('hint', print_sizelimit_warning()); + $smarty->assign('apply', apply_filter()); + $smarty->assign('dfshead', $listhead); + + /* Let smarty fetch and process the page. Always seperate PHP and HTML as much as + you can. */ + return ($smarty->fetch (get_template_path('contents.tpl', TRUE))); + } + + /* TABS */ + + $display = $this->dfstab->execute(); + + $display .= "

\n"; + $display .= " \n"; + $display .= " \n"; + $display .= " \n"; + $display .= " \n"; + $display .= " \n"; + $display .= " \n"; + $display .= "
\n"; + $display .= " \n"; + $display .= "  \n"; + $display .= " \n"; + $display .= "
\n"; + $display .= "

\n"; + + return ($display); + + } + + function remove_lock() { + if (isset($this->dn)) { + del_lock ($this->dn); + } + } + +} +?> diff --git a/plugins/addons/godfs/class_dfsgeneric.inc b/plugins/addons/godfs/class_dfsgeneric.inc new file mode 100644 index 000000000..bfb00098d --- /dev/null +++ b/plugins/addons/godfs/class_dfsgeneric.inc @@ -0,0 +1,223 @@ + "Eins ist toll", "zwei" => "Zwei ist noch besser"); + + /* Needed values and lists */ + var $base = ""; + var $cn = ""; + + /* attribute list for save action */ + var $attributes = array(); + var $objectclasses = array(); + + function dfsgeneric($config, $dn) { + plugin::plugin($config, $dn); + $this->config = $config; + $this->dn = $dn; + $this->orig_dn = $dn; + } + + function execute() { + /* Call parent execute */ + plugin::execute(); + + $smarty= get_smarty(); + + if (($this->dn == "new") || ($this->dn == "")) { + $smarty->assign("sambasharename", ""); + $smarty->assign("sharedescription", ""); + $smarty->assign("fileserver", ""); + $smarty->assign("fileservershare", ""); + $smarty->assign("location", ""); + $smarty->assign("dfsdescription", ""); + } else { + $ldap = $this->config->get_ldap_link(); + + $base = get_base_from_people($this->dn); + $ou = get_ou("DFS"); + + $tmp = preg_split('/\//', $this->dn, 2); + $this->loc = $tmp[0]; + $this->sambasharename = $tmp[1]; + + $ldap->cd("$ou $base"); + $ldap->search(("ou=$this->loc"), array("description")); + $dfs_desc = $ldap->fetch(); + $this->dfsdescription = $dfs_desc['description'][0]; + + $ldap->cd("ou=$this->loc, $ou $base"); + $ldap->search("(&(sambaShareName=$this->sambasharename)(objectclass=sambaShare))", array("description", "documentLocation")); + + $details = $ldap->fetch(); + $this->sharedescription = $details['description'][0]; + $tmp = preg_split('/\\\\/', $details['documentLocation'][0], 2); + + $this->fileserver = preg_replace("/msdfs:/", "", $tmp[0]); + $this->share = preg_replace("/\\\/", "", $tmp[1]); + + #var_dump($this->dn); + #echo "
\n"; + + /* Fill array */ + #$this->reload(); + $smarty->assign("sambasharename", $this->sambasharename); + $smarty->assign("sharedescription", $this->sharedescription); + $smarty->assign("fileserver", $this->fileserver); + $smarty->assign("fileservershare", $this->share); + $smarty->assign("location", $this->loc); + $smarty->assign("dfsdescription", $this->dfsdescription); + } + + /* Show main page */ + return ($smarty->fetch (get_template_path('generic.tpl', TRUE))); + #, dirname(__FILE__)))); + } + + function check() { + plugin::check(); + $message = array(); + + ## permission + #if (chkacl($this->acl, "create") != "") { + # $message[] = _("You have no premissions to create a dfs share."); + #} + + # existance + + $ldap = $this->config->get_ldap_link(); + $base = get_base_from_people($this->ui->dn); + $ou = get_ou("DFS"); + $dn_explode = explode("/", $this->dn); + $sub_ou = $dn_explode[0]; + $sambaShareName = $dn_explode[1] . "/" . $dn_explode[2] . "/" . $dn_explode[3]; + $dn = "sambaShareName=$sambaShareName,ou=$sub_ou,$ou$base"; + $ldap->cat($dn); + $attrs = $ldap->fetch(); + + if ($this->orig_dn == "new" && !($attrs == FALSE)) { + $message[] = _("Dfs share already exists."); + } elseif ($this->orig_dn != $this->dn && !($attrs == FALSE)) { + $message[] = _("Dfs share already exists."); + } + + if ($this->dn == "new" || $this->dn == "") { + $this->sambasharename = $_POST['sambaShareName']; + $this->sharedescription = $_POST['description']; + $this->fileserver = $_POST['fileserver']; + $this->share = $_POST['fileservershare']; + $this->loc = $_POST['location']; + } + + # required fields set? + if ($this->sambasharename == "") { + $message[] = _("Required Field \"Name of dfs Share\" is not set."); + } + if ($this->sharedescription == "") { + $message[] = _("Required Field \"Description\" is not set."); + } + if ($this->fileserver == "") { + $message[] = _("Required Field \"Fileserver\" is not set."); + } + if ($this->share == "") { + $message[] = _("Required Field \"Share on fileserver\" is not set."); + } + if ($this->loc == "") { + $message[] = _("Required Field \"Location\" is not set."); + } + + return $message; + } + + function save() { + + plugin::save(); + + # get the current values + $this->sambasharename = $_POST['sambaShareName']; + $this->sharedescription = $_POST['description']; + $this->fileserver = $_POST['fileserver']; + $this->share = $_POST['fileservershare']; + $this->loc = $_POST['location']; + + # set the attribs + $this->attrs["sambaShareName"] = "$this->sambasharename,ou=$this->loc,$ou$base"; + $this->attrs["objectClass"][] = "top"; + $this->attrs["objectClass"][] = "SambaShare"; + $this->attrs["objectClass"][] = "extensibleObject"; + $this->attrs["sambaShareName"] = $this->sambasharename; + $this->attrs["description"] = $this->sharedescription; + $this->attrs["documentLocation"] = "msdfs:$this->fileserver\\\\$this->share"; + + $ldap = $this->config->get_ldap_link(); + + if ($this->dn == "new" || $this->dn == "") { + echo "new
\n"; + $base = get_base_from_people($this->ui->dn); + $ou = get_ou("DFS"); + $this->basedn = "sambaShareName=$this->sambasharename,ou=$this->loc,$ou$base"; + $ldap->cd($this->basedn); + $ldap->add($this->attrs); + } else { + # try to find entry + $base = get_base_from_people($this->ui->dn); + $ou = get_ou("DFS"); + #$dn_explode = explode("/", $this->sambasharename); + #$sub_ou = $dn_explode[0]; + #$sambaShareName = $dn_explode[1] . "/" . $dn_explode[2] . "/" . $dn_explode[3]; + $dn = "sambaShareName=$this->sambasharename,ou=$this->loc,$ou$base"; + $ldap->cat($dn); + $attrs = $ldap->fetch(); + + $this->basedn = "sambaShareName=$this->sambasharename,ou=$this->loc,$ou$base"; + $ldap->cd($this->basedn); + $nr = count($attrs); + + if (count($attrs)) { + # modify if found + $ldap->modify($this->attrs); + } else { + # add + $ldap->add($this->attrs); + } + show_ldap_error($ldap->get_error()); + } + } + + function save_object() { + #if (isset($_POST['base'])) { + plugin::save_object(); + #echo "base = ".$_POST['base']."
\n"; + #} + if (chkacl($this->acl, "create") == "") { + $this->base = $_POST['base']; + } + } + + function delete() { + + plugin::delete(); + + # get the current values + $this->sambasharename = $_POST['sambaShareName']; + $this->sharedescription = $_POST['description']; + $this->fileserver = $_POST['fileserver']; + $this->share = $_POST['fileservershare']; + $this->loc = $_POST['location']; + + $base = get_base_from_people($this->ui->dn); + $ou = get_ou("DFS"); + $this->basedn = "sambaShareName=$this->sambasharename,ou=$this->loc,$ou$base"; + echo "BASEDN: $this->basedn
\n"; + + $ldap = $this->config->get_ldap_link(); + $ldap->cd($this->basedn); + $ldap->rmdir($this->basedn); + show_ldap_error($ldap->get_error()); + } + + } + diff --git a/plugins/addons/godfs/contents.tpl b/plugins/addons/godfs/contents.tpl new file mode 100644 index 000000000..e5f2206ab --- /dev/null +++ b/plugins/addons/godfs/contents.tpl @@ -0,0 +1,54 @@ + + + + + + + +
+
+

+ {t}DFS Shares{/t} {$hint} +

+
+
+ {$dfshead} +
+
+
+ {$tree} + +
+
+
+

[i]{t}Information{/t}

+
+
+

+ {t}This menu allows you to create, delete and edit selected dfs shares. Having a large numbers of dfs shares, you might prefer the range selectors on top of the dfs share list.{/t} +

+
+
+
+

[F]{t}Filters{/t}

+
+
+ + {$alphabet} +
+ + + + + +
+ + + +
+ {$apply} +
+
+ + diff --git a/plugins/addons/godfs/generic.tpl b/plugins/addons/godfs/generic.tpl new file mode 100644 index 000000000..c28043464 --- /dev/null +++ b/plugins/addons/godfs/generic.tpl @@ -0,0 +1,52 @@ + + + + + + +
+

{t}DFS Properties{/t}

+ + + + + + + + + + + + + + + + + + +
{$must}
{$must}
{$must}
{$must}
+ +
+   + +

{t}DFS Location{/t}

+ + + + + + + + + + +
{$must}
+ +
+ + + diff --git a/plugins/addons/godfs/main.inc b/plugins/addons/godfs/main.inc new file mode 100644 index 000000000..0d9f69b39 --- /dev/null +++ b/plugins/addons/godfs/main.inc @@ -0,0 +1,43 @@ +remove_lock(); + del_lock($ui->dn); + sess_del('dfsManagment'); + } + } else { + # create dfsManagment object + if (!isset($_SESSION['dfsManagment']) || + (isset($_GET['reset']) && $_GET['reset'] == 1)) { + $_SESSION['dfsManagment'] = new dfsManagment($config, $_SESSION['ui']); + } + $dfsManagment = $_SESSION['dfsManagment']; + $output = $dfsManagment->execute(); + + # create page header + if (isset($_SESSION['objectinfo'])) { + $display = print_header(get_template_path('images/dfs.png'), + _("Distributed File System Administration"), + "\"\" ".$_SESSION['objectinfo']); + } else { + $display = print_header(get_template_path('images/dfs.png'), + _("Distributed File System Administration")); + } + + # create the page + $display .= $output; + + # do we have to reset + if (isset($_GET['reset']) && $_GET['reset'] == 1) { + del_lock ($ui->dn); + sess_del('dfsManagment'); + } + + # show page + $_SESSION['dfsManagment'] = $dfsManagment; + } + +?> diff --git a/plugins/addons/godfs/tabs_dfs.inc b/plugins/addons/godfs/tabs_dfs.inc new file mode 100644 index 000000000..3d2f0f665 --- /dev/null +++ b/plugins/addons/godfs/tabs_dfs.inc @@ -0,0 +1,40 @@ +base = $this->by_object['dfsManagment']->base; + } + + #function save_object() { + # if (isset($_POST['base'])) { + # plugin::save_object(); + # } else { + # $this->base = $_POST['base']; + # } + #} + + + + + function check() { + return (tabs::check(TRUE)); + } + + function save() { + $baseobject = $this->by_object['dfsManagment']; + #$this->dn = $new_dn; + return tabs::save(TRUE); + } + + function del() { + $baseobject = $this->by_object['dfsManagment']; + return tabs::delete(TRUE); + #tabs::del(); + } + +} + +?> diff --git a/plugins/admin/systems/class_servNfs.inc b/plugins/admin/systems/class_servNfs.inc index 6066a4f77..784bf569b 100644 --- a/plugins/admin/systems/class_servNfs.inc +++ b/plugins/admin/systems/class_servNfs.inc @@ -9,7 +9,7 @@ class servnfs extends plugin /* attribute list for save action */ var $ignore_account = TRUE; - var $attributes = array("description","type","charset","path","option"); + var $attributes = array("description","type","charset","path","option", "volume"); var $objectclasses = array("whatever"); var $is_account = true; @@ -21,6 +21,7 @@ class servnfs extends plugin var $types =array(); // Array Types NFS/Samba/NCP/netatalk var $charsets =array(); // Array with charsets var $path =""; // Path + var $volume =""; // Volume var $option =""; // Options var $is_edit =false; var $allow_mounts = false; //do we allow mount entries? @@ -67,13 +68,8 @@ class servnfs extends plugin } if($entry){ - $tmp = split("\|",$entry); - $this->name = $tmp[0]; // Name of NFS - $this->description = $tmp[1]; // description - $this->type = $tmp[2]; // Type NFS/Samba/NCP/netatalk - $this->charset = $tmp[3]; // charset - $this->path = $tmp[4]; // Path - $this->option = $tmp[5]; // Options + list($this->name, $this->description, $this->type, $this->charset, + $this->path, $this->option, $this->volume)= split("\|",$entry); $this->is_edit = true; }else{ @@ -196,6 +192,10 @@ class servnfs extends plugin if(preg_match("/\|/",$this->description)){ $message[]=_("Description contains invalid characters."); } + + if(preg_match("/\|/",$this->volume)){ + $message[]=_("Volume contains invalid characters."); + } if(preg_match("/\|/",$this->path)){ $message[]=_("Path contains invalid characters."); @@ -245,7 +245,8 @@ class servnfs extends plugin $s_return.= $this->type."|"; $s_return.= $this->charset."|"; $s_return.= $this->path."|"; - $s_return.= $this->option; + $s_return.= $this->option."|"; + $s_return.= $this->volume; return(array($this->name=>$s_return)); } diff --git a/plugins/admin/systems/class_servService.inc b/plugins/admin/systems/class_servService.inc index 15432a674..c6d31ed68 100644 --- a/plugins/admin/systems/class_servService.inc +++ b/plugins/admin/systems/class_servService.inc @@ -73,11 +73,10 @@ class servservice extends plugin $tmp =array(); $tmp2=array(); if(isset($this->attrs['goExportEntry'])){ - unset($this->attrs['goExportEntry']['count']); - if((isset($this->attrs['goExportEntry']))&&(isset($this->attrs['goExportEntry']))){ - foreach($this->attrs['goExportEntry'] as $entry){ - $tmp2= split("\|",$entry); - $tmp[$tmp2[0]]= $entry; + if(isset($this->attrs['goExportEntry']['count'])){ + for($i= 0; $i<$this->attrs['goExportEntry']['count']; $i++){ + $entry= $this->attrs['goExportEntry'][$i]; + $tmp[preg_replace('/|.*$/', '', $entry)]= $entry; } } } @@ -122,14 +121,13 @@ class servservice extends plugin function execute() { - /* Call parent execute */ - plugin::execute(); + /* Call parent execute */ + plugin::execute(); /* Fill templating stuff */ $smarty= get_smarty(); - $smarty->assign("staticAddress", ""); - + if((isset($_POST['DelNfsEnt']))&&(isset($_POST['goExportEntry']))){ if($this->allow_mounts){ $this->deleteFromMountList($this->goExportEntry[$_POST['goExportEntry']]); @@ -144,7 +142,7 @@ class servservice extends plugin } if((isset($_POST['NewNfsEdit']))&&(isset($_POST['goExportEntry']))){ - $entry = $this->goExportEntry[$_POST['goExportEntry']]; + $entry = $this->goExportEntry[$_POST['goExportEntry'][0]]; $add_mount=isset($this->mounts_to_add[$entry]); $this->oldone=$entry; $this->o_subWindow = new servnfs($this->config,$this->acl,$this->allow_mounts,$this->dn,$entry,$add_mount); diff --git a/plugins/admin/systems/servnfs.tpl b/plugins/admin/systems/servnfs.tpl index e5a8139b1..dcea65b3f 100644 --- a/plugins/admin/systems/servnfs.tpl +++ b/plugins/admin/systems/servnfs.tpl @@ -28,6 +28,14 @@ + + +
{t}Volume{/t} {$must}
+ + + + + @@ -50,12 +58,21 @@ document.getElementById('sharetype').onchange=function() { var foobar=this[this.selectedIndex].value; var box=document.getElementById('netatalk_mount'); - if(foobar=="NFS"||foobar=="netatalk") + var volume=document.getElementById('volume'); + var vlabel=document.getElementById('vlabel'); + if(foobar=="NFS"||foobar=="netatalk"){ box.disabled=false; - else { + } else { box.disabled=true; box.checked=false; } + if(foobar=="NCP"){ + volume.style.visibility="visible"; + vlabel.style.visibility="visible"; + } else { + volume.style.visibility="hidden"; + vlabel.style.visibility="hidden"; + } }; document.getElementById('sharetype').onchange(); diff --git a/plugins/admin/systems/servservice.tpl b/plugins/admin/systems/servservice.tpl index 76b26f117..46ca099d7 100644 --- a/plugins/admin/systems/servservice.tpl +++ b/plugins/admin/systems/servservice.tpl @@ -12,7 +12,7 @@
- {html_options values=$goExportEntry output=$goExportEntryKeys}