index cb70fb4ab98fdbe9bd961f6f31a05da3bddb7efc..469f309b1bf295fb07aa9bb5de24d6b8a0a90ac9 100644 (file)
class filter {
- var $xmlData;
- var $searches= array();
- var $search;
-
- #FIXME - Seems to be obsolete. Categories are defined in the listing.xml <objectType>
- # and not in the filter.xml anymore.
- var $category= "";
- var $objectStorage= array();
- var $base= "";
- var $scope= "";
- var $query;
- var $value= "";
- var $initial= false;
- var $scopeMode= "auto";
- var $converter= null;
- var $pid;
-
- /* An editor which allows to create user defined ldap-filter.
- * Due to the fact that it requires additional ldap schemata
- * (objectClasses=gosaProperties) this is currently optional.
- */
- var $filterEditor = NULL;
-
- /* The categories this filter is made for (e.g. ['users'] or. ['server','workstation']).
- * Since this is set we are able to create user defined filters.
- */
- var $categories = array();
-
- function filter($filename)
- {
- global $config;
-
- // Load eventually passed filename
- if (!$this->load($filename)) {
- die("Cannot parse $filename!");
+ var $searches= array();
+ var $xmlSearches= array();
+ var $attributes= array();
+ var $search;
+ var $defaultSearch;
+ var $category= "";
+ var $objectStorage= array();
+ var $base= "";
+ var $scope= "";
+ var $query;
+ var $value= "";
+ var $initial= false;
+ var $scopeMode= "auto";
+ var $converter= null;
+ var $pid;
+
+
+ function filter($filename)
+ {
+ global $config;
+
+ // Load eventually passed filename
+ if (!$this->load($filename)) {
+ die("Cannot parse $filename!");
+ }
+
+ $this->pid= preg_replace("/[^0-9]/", "", microtime(TRUE));
}
- $this->pid= preg_replace("/[^0-9]/", "", microtime(TRUE));
- // Instantiate the filter editor.
- if(class_available("filterEditor")){
- $this->filterEditor = new filterEditor($config, $this);
- }
- }
+ function load($filename)
+ {
+ $contents = file_get_contents($filename);
+ $xmlData= xml::xml2array($contents, 1);
+ if (!isset($xmlData['filterdef'])) {
+ return false;
+ }
- function load($filename)
- {
- $contents = file_get_contents($filename);
- $this->xmlData= xml::xml2array($contents, 1);
+ $xmlData= $xmlData["filterdef"];
- if (!isset($this->xmlData['filterdef'])) {
- return false;
- }
+ // Load filter
+ if (isset($xmlData['search'])) {
- $this->xmlData= $this->xmlData["filterdef"];
+ // Array conversion
+ if (!isset($xmlData['search'][0])) {
+ $searches= array($xmlData['search']);
+ } else {
+ $searches= $xmlData['search'];
+ }
- // Load filter
- if (isset($this->xmlData['search'])) {
+ /* Store available searches */
+ foreach ($searches as $search) {
- // Array conversion
- if (!is_array($this->xmlData['search'])) {
- $searches= array($this->xmlData['search']);
- } else {
- $searches= $this->xmlData['search'];
- }
+ /* Do multi conversation */
+ if (!isset($search['query'][0])){
+ $search['query']= array($search['query']);
+ }
- /* Store available searches */
- foreach ($this->xmlData['search'] as $search) {
+ /* Store search */
+ $this->xmlSearches[$search['tag']]= $search;
- /* Do multi conversation */
- if (!is_array($search['query'])){
- $search['query']= array($search['query']);
+ }
+ } else {
+ return false;
}
- /* Store search */
- $this->searches[$search['label']]= $search;
+ // Transfer scope
+ $this->scopeMode= $xmlData['definition']['scope'];
+ if ($this->scopeMode == "auto") {
+ $this->scope= "one";
+ } else {
+ $this->scope= $this->scopeMode;
+ }
- }
- } else {
- return false;
- }
+ // Transfer attributes
+ $this->attributes= $xmlData['definition']['attribute'];
+ if (!is_array($this->attributes)) {
+ $this->attributes= array($this->attributes);
+ }
- // Transfer scope
- $this->scopeMode= $this->xmlData['definition']['scope'];
- if ($this->scopeMode == "auto") {
- $this->scope= "one";
- } else {
- $this->scope= $this->scopeMode;
- }
+ // Transfer initial value
+ if (isset($xmlData['definition']['initial']) && $xmlData['definition']['initial'] == "true"){
+ $this->initial= true;
+ }
- // Transfer initial value
- if (isset($this->xmlData['definition']['initial']) && $this->xmlData['definition']['initial'] == "true"){
- $this->initial= true;
+ // Transfer category
+ if (isset($xmlData['definition']['category'])){
+ $this->category= $xmlData['definition']['category'];
+ }
+ if (!is_array($this->category)) {
+ $this->category= array($this->category);
+ }
+
+ // Initialize searches and default search mode
+ $this->defaultSearch= $xmlData['definition']['default'];
+ $this->reloadFilters();
+ $this->setSearch($this->defaultSearch);
+
+ return true;
}
- // Transfer category
- if (isset($this->xmlData['definition']['category'])){
- $this->category= $this->xmlData['definition']['category'];
+
+ function reloadFilters()
+ {
+ $this->searches= array_merge($this->xmlSearches, userFilter::getFilter($this->category));
+ $this->setSearch($this->search);
}
- // Set default search mode
- $this->setSearch($this->xmlData['definition']['default']);
- return true;
- }
+ function setSearch($method= null)
+ {
+ $patch= null;
+ // Maybe our search method has gone?
+ if (!isset($this->searches[$method])) {
+ $method= $this->defaultSearch;
+ }
- function setSearch($method)
- {
- // Move information
- if (isset($this->searches[$method])) {
- $this->query= $this->searches[$method]['query'];
- if (!isset($this->query[0])) {
- $this->query= array($this->query);
- }
- $this->search= $method;
- } else {
- die ("Invalid search module!");
+ // Try to use it, but bail out if there's no help...
+ if (isset($this->searches[$method])) {
+ $this->query= $this->searches[$method]['query'];
+ $this->search= $method;
+ } else {
+ die ("Invalid search module!");
+ }
}
- }
- function getTextfield($element)
- {
- $tag= $element['tag'];
- $size= 30;
- if (isset($element['size'])){
- $size= $element['size'];
- }
- $maxlength= 30;
- if (isset($element['maxlength'])){
- $maxlength= $element['maxlength'];
- }
- $result= "<input class='filter_textfield' id='$tag' name='$tag' type='text' size='$size' maxlength='{$maxlength}' value='".$this->elementValues[$tag]."'>";
- if (isset($element['autocomplete'])) {
- $frequency= "0.5";
- $characters= "1";
- if (isset($element['autocomplete']['frequency'])) {
- $frequency= $element['autocomplete']['frequency'];
- }
- if (isset($element['autocomplete']['characters'])) {
- $characters= $element['autocomplete']['characters'];
- }
- $result.= "<div id='autocomplete$tag' class='autocomplete'></div>".
- "<script type='text/javascript'>".
- "new Ajax.Autocompleter('$tag', 'autocomplete$tag', 'autocomplete.php', { minChars: $characters, frequency: $frequency });".
- "</script>";
-
- $this->autocompleters[$tag]= $element['autocomplete'];
+ function getTextfield($tag, $value= "", $element= null)
+ {
+ $size= 30;
+ $maxlength= 30;
+ $result= "<input class='filter_textfield' placeholder='"._("Search")."...' id='$tag' name='$tag' type='text' size='$size' maxlength='{$maxlength}' value='".$value."'>";
+ if ($element && isset($element['autocomplete'])) {
+ $frequency= "0.5";
+ $characters= "1";
+ if (isset($element['autocomplete']['frequency'])) {
+ $frequency= $element['autocomplete']['frequency'];
+ }
+ if (isset($element['autocomplete']['characters'])) {
+ $characters= $element['autocomplete']['characters'];
+ }
+ $result.= "<div id='autocomplete$tag' class='autocomplete'></div>".
+ "<script type='text/javascript'>".
+ "new Ajax.Autocompleter('$tag', 'autocomplete$tag', 'autocomplete.php', { minChars: $characters, frequency: $frequency });".
+ "</script>";
+
+ $this->autocompleters[$tag]= $element;
+ }
+ return $result;
}
- return $result;
- }
- function getCurrentBase()
- {
- if (isset($this->search->base) && (string)$this->search->scope != "auto") {
- return false;
+ function getCurrentBase()
+ {
+ if (isset($this->search->base) && (string)$this->search->scope != "auto") {
+ return false;
+ }
+
+ return $this->base;
}
- return $this->base;
- }
+ function getCurrentScope()
+ {
+ if (isset($this->search->scope) && (string)$this->search->scope != "auto") {
+ return (string)$this->search->scope;
+ }
- function getCurrentScope()
- {
- if (isset($this->search->scope) && (string)$this->search->scope != "auto") {
- return (string)$this->search->scope;
+ return $this->scope;
}
- return $this->scope;
- }
+ function setConverter($hook)
+ {
+ $this->converter= $hook;
+ }
- function setConverter($hook)
- {
- $this->converter= $hook;
- }
+ function setObjectStorage($storage)
+ {
+ $this->objectStorage= $storage;
+ }
- function setObjectStorage($storage)
- {
- $this->objectStorage= $storage;
- }
+ function setBase($base)
+ {
+ $this->base= $base;
+ }
- function setBase($base)
- {
- $this->base= $base;
- }
+ function setCurrentScope($scope)
+ {
+ $this->scope= $scope;
+ }
- function setCurrentScope($scope)
- {
- $this->scope= $scope;
- }
- function renderApply()
- {
- return ("<input type='submit' name='apply' value='"._("Apply filter")."'>");
- }
+ function render()
+ {
+ $content= "<table class='filter-wrapper' summary='"._("Search filter")."'><tr><td>".$this->renderFilterMenu()."</td><td>";
+ $content.= "<div class='search-filter'>".$this->getTextfield('search_filter', set_post($this->value), $this->searches[$this->search])."</div>".
+ " <button class='search-filter' type='submit' title='"._("Search")."'>".image("images/find.png")."</button></td></tr></table>";
+ // Return meta data
+ return ("<input type='hidden' name='FILTER_PID' value='".$this->pid."'>".$content);
+ }
- function renderScope()
- {
- $checked= $this->scope == "sub"?" checked":"";
- return "<input type='checkbox' id='SCOPE' name='SCOPE' value='1' onClick='document.mainform.submit();'$checked> <LABEL for='SCOPE'>"._("Search in subtrees")."</LABEL>";
- }
+ function query()
+ {
+ global $class_mapping;
+ $result= array();
- function render()
- {
- $content= "<table class='filter-wrapper'><tr><td>".$this->renderFilterMenu()."</td><td>";
- $content.= "<div class='search-filter'><input type='text' name='search_filter' value='".$this->value."'></div>".
- " <button class='search-filter' type='submit' title='"._("Search")."'>".image("images/find.png")."</button></td></tr></table>";
+ // Return empty list if initial is not set
+ if (!$this->initial) {
+ $this->initial= true;
+ return $result;
+ }
+ // Go thru all queries and merge results
+ foreach ($this->query as $query) {
+ if (!isset($query['backend']) || !isset($query['filter'])) {
+ die("No backend specified in search config.");
+ }
- // Return meta data
- return ("<input type='hidden' name='FILTER_PID' value='".$this->pid."'>".$content);
- }
+ // Is backend available?
+ $backend= "filter".$query['backend'];
+ if (!isset($class_mapping["$backend"])) {
+ die("Invalid backend specified in search config.");
+ }
+ // Load filter and attributes
+ $filter= $query['filter'];
+
+ // Handle converters if present
+ if ($this->converter) {
+ preg_match('/([^:]+)::(.*)$/', $this->converter, $m);
+ if ($this->value == "") {
+ $filter= call_user_func(array($m[1], $m[2]), preg_replace('/\$/', "*", $filter));
+ } else {
+ $filter= call_user_func(array($m[1], $m[2]), preg_replace('/\$/', $this->value, $filter));
+ }
+ }
- function query()
- {
- global $class_mapping;
- $result= array();
+ // Do not replace escaped \$ - This is required to be able to search for e.g. windows machines.
+ if ($this->value == "") {
+ $filter= preg_replace("/\\$/", '*', $filter);
+ } else {
+ $filter= preg_replace("/\\$/", "*".normalizeLdap($this->value)."*", $filter);
+ }
- // Return empty list if initial is not set
- if (!$this->initial) {
- $this->initial= true;
- return $result;
- }
+ $result= array_merge($result, call_user_func(array($backend, 'query'), $this->base, $this->scope, $filter, $this->attributes, $this->category, $this->objectStorage));
+ }
- // Go thru all queries and merge results
- foreach ($this->query as $query) {
- if (!isset($query['backend']) || !isset($query['filter']) || !isset($query['attribute'])) {
- die("No backend specified in search config.");
- }
-
- // Is backend available?
- $backend= "filter".$query['backend'];
- if (!isset($class_mapping["$backend"])) {
- die("Invalid backend specified in search config.");
- }
-
- // Load filter and attributes
- $filter= $query['filter'];
- $attributes= $query['attribute'];
-
- // Handle converters if present
- if ($this->converter) {
- preg_match('/([^:]+)::(.*)$/', $this->converter, $m);
- $filter= call_user_func(array($m[1], $m[2]), preg_replace('/\$/', $this->value, $filter));
- }
-
- // Do not replace escaped \$ - This is required to be able to search for e.g. windows machines.
- if ($this->value == "") {
- $filter= preg_replace("/\\$/", '*', $filter);
- } else {
- $filter= preg_replace("/\\$/", "*".normalizeLdap($this->value)."*", $filter);
- }
-
- $result= array_merge($result, call_user_func(array($backend, 'query'), $this->base, $this->scope, $filter, $attributes, $this->categories, $this->objectStorage));
+ return ($result);
}
- return ($result);
- }
+ function update()
+ {
+ if (isset($_POST['FILTER_PID']) && $_POST['FILTER_PID'] == $this->pid) {
+ // Save input field
+ if (isset($_POST['search_filter'])) {
+ $this->value= get_post('search_filter');
+ }
- function update()
- {
- if (isset($_POST['FILTER_PID']) && $_POST['FILTER_PID'] == $this->pid) {
+ // Save scope if needed
+ if ($this->scopeMode == "auto" && isset($_POST['act']) && $_POST['act'] == "toggle-subtree") {
+ $this->scope= ($this->scope == "one")?"sub":"one";
+ }
- // Save input field
- if (isset($_POST['search_filter'])) {
- $this->value= validate($_POST['search_filter']);
- }
+ // Switch filter?
+ if (isset($_POST['act'])) {
+ foreach ($this->searches as $tag => $cfg) {
+ if ($_POST['act'] == "filter-$tag") {
+ $this->setSearch($tag);
+ break;
+ }
+ }
+ }
+ }
- // Save scope if needed
- if ($this->scopeMode == "auto") {
- $this->scope= isset($_POST['SCOPE'])?"sub":"one";
- }
}
- }
+ function getCompletitionList($config, $value="*")
+ {
+ global $class_mapping;
+ $res= array();
- function getCompletitionList($config, $value="*")
- {
- global $class_mapping;
- $res= array();
+ // Load result attributes
+ $attributes= $config['autocomplete']['attribute'];
+ if (!is_array($attributes)) {
+ $attributes= array($attributes);
+ }
- // Is backend available?
- $backend= "filter".$config['backend'];
- if (!isset($class_mapping["$backend"])) {
- die("Invalid backend specified in search config.");
- }
+ // Do the query
+ $result= array();
- // Load filter and attributes
- $filter= $config['filter'];
- $attributes= $config['attribute'];
- if (!is_array($attributes)) {
- $attributes= array($attributes);
- }
+ // Is backend available?
+# FIXME
+ $queries= $config['query'];
+ if (!isset($queries[0])){
+ $queries= array($queries);
+ }
+ foreach ($queries as $query) {
+ $backend= "filter".$query['backend'];
+ if (!isset($class_mapping["$backend"])) {
+ die("Invalid backend specified in search config.");
+ }
+ $filter= preg_replace("/\\$/", "*".normalizeLdap($value)."*", $query['filter']);
- // Make filter
- $filter= preg_replace("/\\$/", normalizeLdap($value), $filter);
- if (isset($config['base']) && isset($config['scope']) && isset($config['category'])) {
- $result= call_user_func(array($backend, 'query'), $config['base'], $config['scope'], $filter, $attributes,
- $config["category"], $config["objectStorage"]);
- } else {
- $result= call_user_func(array($backend, 'query'), $this->base, $this->scope, $filter, $attributes,
- $this->categories, $this->objectStorage);
- }
+ $result= array_merge($result, call_user_func(array($backend, 'query'), $this->base, $this->scope, $filter, $attributes,
+ $this->category, $this->objectStorage));
+ }
- foreach ($result as $entry) {
- foreach ($attributes as $attribute) {
- if (is_array($entry[$attribute])) {
- for ($i= 0; $i<$entry[$attribute]['count']; $i++) {
- if (mb_stristr($entry[$attribute][$i], $value)) {
- $res[]= $entry[$attribute][$i];
+ foreach ($result as $entry) {
+ foreach ($attributes as $attribute) {
+ if (is_array($entry[$attribute])) {
+ for ($i= 0; $i<$entry[$attribute]['count']; $i++) {
+ if (mb_stristr($entry[$attribute][$i], $value)) {
+ $res[]= $entry[$attribute][$i];
+ }
+ }
+ } else {
+ $res[]= $entry[$attribute];
+ }
}
- }
- } else {
- $res[]= $entry[$attribute];
}
- }
+
+ return $res;
}
- return $res;
- }
+ function processAutocomplete()
+ {
+ global $class_mapping;
+ $result= array();
- function processAutocomplete()
- {
- global $class_mapping;
- $result= array();
+ // Introduce maximum number of entries
+ $max= 25;
- // Introduce maximum number of entries
- $max= 25;
+ if(isset($this->searches[$this->search]['autocomplete'])){
+ $result= $this->getCompletitionList($this->searches[$this->search], get_post('search_filter'));
+ $result= array_unique($result);
+ asort($result);
- if(isset($this->searches[$this->search]['autocomplete'])){
- $result= $this->getCompletitionList($this->searches[$this->search]['autocomplete'], $_POST['search_filter']);
- $result= array_unique($result);
- asort($result);
+ echo '<ul>';
+ foreach ($result as $entry) {
+ echo '<li>'.mark(get_post('search_filter'), $entry).'</li>';
+ if ($max-- == 0) {
+ break;
+ }
+ }
- echo '<ul>';
- foreach ($result as $entry) {
- echo '<li>'.mark($_POST['search_filter'], $entry).'</li>';
- if ($max-- == 0) {
- break;
+ echo '</ul>';
}
- }
-
- echo '</ul>';
}
- }
- function getObjectBase($dn)
- {
- global $config;
- $base= "";
+ function getObjectBase($dn)
+ {
+ global $config;
+ $base= "";
- // Try every object storage
- $storage= $this->objectStorage;
- if (!is_array($storage)){
- $storage= array($storage);
- }
- foreach ($storage as $location) {
- $pattern= "/^[^,]+,".preg_quote($location, '/')."/i";
- $base= preg_replace($pattern, '', $dn);
- }
+ // Try every object storage
+ $storage= $this->objectStorage;
+ if (!is_array($storage)){
+ $storage= array($storage);
+ }
+ foreach ($storage as $location) {
+ $pattern= "/^[^,]+,".preg_quote($location, '/')."/i";
+ $base= preg_replace($pattern, '', $dn);
+ }
- /* Set to base, if we're not on a correct subtree */
- if (!isset($config->idepartments[$base])){
- $base= $config->current['BASE'];
+ /* Set to base, if we're not on a correct subtree */
+ if (!isset($config->idepartments[$base])){
+ $base= $config->current['BASE'];
+ }
+
+ return $base;
}
- return $base;
- }
+ function renderFilterMenu()
+ {
+ // Load shortcut
+ $result= "<ul class='level1' id='filter-root'><li><a href='#'>".image("images/filter.png").image("images/lists/sort-down.png")."</a>";
+
+ // Build ul/li list
+ $separator= " style='border-top:1px solid #AAA' ";
+ $result.= "<ul class='level2'>";
+
+ // Build in filters
+ foreach ($this->xmlSearches as $tag => $config) {
+ $label = htmlentities(_($config['label']),ENT_COMPAT,'UTF-8');
+ if ($tag == $this->search) {
+ $result.= "<li><a href='#'>".image("images/checked.png")." ".$label."</a></li>";
+ } else {
+ $result.= "<li><a href='#' onClick='\$(\"act\").value= \"filter-$tag\";\$(\"exec_act\").click();'>".image("images/empty.png")." ".$label."</a></li>";
+ }
+ }
- function renderFilterMenu()
- {
- // Load shortcut
- $result= "<input type='hidden' name='act' id='filter' value=''><div style='display:none'><input type='submit' name='exec_filter' id='exec_filter' value=''></div>".
- "<ul class='level1' id='filter-root'><li><a href='#'>".image("images/filter.png")._("...")." ".image("images/lists/sort-down.png")."</a>";
+ // User defined filters
+ $first= true;
+ foreach (userFilter::getFilter($this->category) as $tag => $config) {
+ if ($tag == $this->search) {
+ $result.= "<li".($first?$separator:"")."><a href='#'>".image("images/checked.png")." "._($config['description'])."</a></li>";
+ } else {
+ $result.= "<li".($first?$separator:"")."><a href='#' onClick='\$(\"act\").value= \"filter-$tag\";\$(\"exec_act\").click();'>".image("images/empty.png")." "._($config['description'])."</a></li>";
+ }
- // Build ul/li list
- $result.= "<ul class='level2'>";
- $result.= "<li><a href='#'>Dummy placeholder</a></li>";
- $result.= "<li><a href='#'>Dummy placeholder</a></li>";
-#$result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"".$action['name']."\";mainform.submit();'>$img"._($action['label'])."</a></li>";
+ $first= false;
+ }
-# AUTOCOMPLETER and getTextbox
+ // Render scope if set to auto
+ if ($this->scopeMode == "auto") {
+ $result.= "<li$separator><a href='#' onClick='\$(\"act\").value= \"toggle-subtree\";\$(\"exec_act\").click();'>".($this->scope=="one"?image("images/empty.png"):image("images/checked.png"))." "._("Search in subtrees")."</a></li>";
+ }
- $result.= "</ul>";
- $script= '<script type="text/javascript" language="JavaScript">var menu2; menu2= new Menu("filter-root", "menu2", configMenu)</script>';
+ // Edit filter menu
+ $result.= "<li$separator><a href='#' onClick='\$(\"act\").value= \"config-filter\";\$(\"exec_act\").click();'>".image("images/configure.png")." "._("Edit filters")."...</a></li>";
- return "<div id='filtermenu'>".$result."</li></ul><div>$script";
- }
+ $result.= "</ul>";
+ $script= '<script type="text/javascript" language="JavaScript">var menu2; menu2= new Menu("filter-root", "menu2", configMenu)</script>';
-
- function setCategories($categories)
- {
- if(!is_array($categories) && !empty($categories)){
- $categories = array($categories) ;
+ return "<div id='filtermenu'>".$result."</li></ul></div>$script";
}
- $this->categories = $categories;
- }
+
+
+ function getFixedFilters()
+ {
+ return array_keys($this->searches);
+ }
+
}