![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/gosa-core/include/class_userFilterEditor.inc b/gosa-core/include/class_userFilterEditor.inc
index afa1b83bfb1f90555a44fba777cb08c9b4b9d747..cdf62871bb984d04d778597e26a15adffced2a6f 100644 (file)
class userFilterEditor extends plugin
{
- // The original entry else array(), allows us to perform existence checks.
- public $entry = array();
-
- // The values
- public $name = "";
- public $description = "";
- public $parent = "";
- public $selectedCategories = array();
- public $share = FALSE;
- public $enabled = TRUE;
- public $filter = "(objectClass=*)";
-
- // The list of all categories mangaged by the current filter object.
- // Used in the grop-down box.
- public $availableCategories = array();
- public $fixedFilters = array();
- public $orig_name = "";
-
-
- /*! \brief Instantiate the filter editing dialog.
- * Parses the filter info into editable data.
- */
- function __construct($entry, $categories, $fixedFilters)
- {
- $this->availableCategories = $categories;
- $this->fixedFilters = $fixedFilters;
- if($entry){
- $this->entry = $entry;
- $this->parent = $entry['parent'];
- $this->name = $entry['name'];
- $this->description = $entry['description'];
- $this->filter = $entry['filter'];
- $this->selectedCategories = $entry['categories'];
- $this->share = in_array("share",$entry['flags']);
- $this->enable = in_array("enable",$entry['flags']);
- }
- $this->orig_name = $this->name;
- }
-
-
- /*! \brief Retunrs the filters original name
- * @param The original name of the filter (if none was given
- * an empty string is returned)
- */
- function getOriginalName()
- {
- return($this->orig_name);
- }
-
-
- /*! \brief Retunrs the filters name.
- * @param The name of the filter
- */
- function getCurrentName()
- {
- return($this->name);
- }
-
-
- /*! \brief Generates the <HTML> content, to edit the filter settings.
- * @return String HTML form.
- */
- function execute()
- {
- plugin::execute();
- $smarty = get_smarty();
- $smarty->assign('parent', $this->parent);
- $smarty->assign('name', htmlentities($this->name,ENT_COMPAT,'UTF-8'));
- $smarty->assign('filter', htmlentities($this->filter,ENT_COMPAT,'UTF-8'));
- $smarty->assign('share', $this->share);
- $smarty->assign('enable', $this->enabled);
- $smarty->assign('description', htmlentities($this->description,ENT_COMPAT,'UTF-8'));
- $smarty->assign('selectedCategories', $this->selectedCategories);
- $smarty->assign('availableCategories', $this->availableCategories);
- $smarty->assign('fixedFilters', $this->fixedFilters);
- return($smarty->fetch(get_template_path('userFilterEditor.tpl', FALSE)));
- }
-
-
- /*! \brief Keep values entered in the input form of the dialog. (POST/GET)
- */
- function save_object()
- {
- if(isset($_POST['userFilterEditor'])){
-
- // Get posted strings
- foreach(array('name','description', 'parent') as $attr){
- if(isset($_POST[$attr])){
- $this->$attr = get_post($attr);
- }
- }
-
- // Filter needs special handling, it may contain charactes like < and >
- // wich are stipped out by get_post() && validate()
- if(isset($_POST['filter'])){
- $f = $_POST['filter'];
- if(get_magic_quotes_gpc()){
- $f = stripcslashes($f);
- }
- $f = mb_convert_encoding($_POST['filter'], 'UTF-8');
- $this->filter = $f;
- }
-
- // Get posted flags
- $this->share = isset($_POST['shareFilter']);
- $this->enable = isset($_POST['enableFilter']);
-
- // Get additional category
- if(isset($_POST['addCategory'])){
- if(isset($_POST['manualCategory']) && !empty($_POST['manualCategory'])){
- $this->selectedCategories[] = get_post('manualCategory');
- }elseif(isset($_POST['availableCategory']) && !empty($_POST['availableCategory'])){
- $this->selectedCategories[] = get_post('availableCategory');
- }
- }
+ public $pathTitle= "Edit";
+
+ // The original entry else array(), allows us to perform existence checks.
+ public $entry = array();
+
+ // The values
+ public $name = "";
+ public $description = "";
+ public $parent = "";
+ public $selectedCategories = array();
+ public $share = FALSE;
+ public $enabled = TRUE;
+ public $queries = array();
+
+ public $listing = NULL;
- // Remove categories
- if(isset($_POST['delCategory']) && isset($_POST['usedCategory'])){
- foreach($_POST['usedCategory'] as $cat){
- if(isset($this->selectedCategories[$cat])) unset($this->selectedCategories[$cat]);
+ // The list of all categories mangaged by the current filter object.
+ // Used in the grop-down box.
+ public $orig_name = "";
+ public $backends = array('LDAP','LDAPBlacklist', 'SYSTEMS', 'FAI', 'GroupLDAP','ACL', 'OPSIPackages','APPLICATIONS','MIMETYPES','CONFIGPROPERTIES');
+
+
+ /*! \brief Instantiate the filter editing dialog.
+ * Parses the filter info into editable data.
+ */
+ function __construct($entry, $listing)
+ {
+
+ $this->listing = &$listing;
+ if($entry){
+ $this->entry = $entry;
+ $this->parent = $entry['parent'];
+ $this->name = $entry['tag'];
+ $this->description = $entry['description'];
+
+ foreach($entry['query'] as $query){
+ $query['filter'] = userFilterEditor::_autoIndentFilter($query['filter'], " ");
+ $this->queries[] = $query;
+ }
+ $this->selectedCategories = $entry['categories'];
+ $this->share = in_array_strict("share",$entry['flags']);
+ $this->enable = in_array_strict("enable",$entry['flags']);
}
- }
- }
- }
-
-
- /*! \brief Validate user input
- * @return Array An Array containing potential error messages
- */
- function check()
- {
- $msgs = plugin::check();
-
- // Check if the name is given
- if(empty($this->name)){
- $msgs[] = msgPool::required(_("Name"));
- }elseif(preg_match("/[^a-z0-9\-_ ]/i", $this->name)){
-
- // Check for a valid name, no special chars here - in particular no ;
- $msgs[] = msgPool::invalid(_("Name"), $this->name,"/[a-z0-9\-_ ]/i");
- }
-
- // Description is a must value.
- if(empty($this->description)){
- $msgs[] = msgPool::required(_("Description"));
- }
+ $this->orig_name = $this->name;
- // Count the number of opening and closing brackets - exclude escaped ones.
- $f = preg_replace('/\\\\[\(\)]/',"",$this->filter);
- $o = substr_count($f, '(');
- $c = substr_count($f, ')');
- if($o != $c){
- $msgs[] = sprintf(_("Please check your filter. You have '%s' opening and '%s' closing brackets!"), $o, $c);
+ // Create statistic table entry
+ $this->initTime = microtime(TRUE);
+ stats::log('plugin', $class = get_class($this), $category = array($this->acl_category), $action = 'open',
+ $amount = 1, $duration = (microtime(TRUE) - $this->initTime));
}
- return($msgs);
- }
-
-
- /*! \brief Transforms the entered values into a filter object (array) which is useable
- * for the userFilter overview dialog.
- * @return Returns transformed filter data.
- */
- function save()
- {
- $ret= array();
- $ret['parent'] = $this->parent;
- $ret['name'] = $this->name;
- $ret['description'] = $this->description;
- $ret['categories'] = $this->selectedCategories;
- $ret['filter'] = $this->filter;
- $ret['flags'] = array();
- if($this->share){
- $ret['flags'][] = "share";
- }
- if($this->enable){
- $ret['flags'][] = "enable";
- }
- return($ret);
- }
+
+ /*! \brief Automatic indent indentation for filters.
+ */
+ static function _autoIndentFilter($str, $indent = " ")
+ {
+ // Remove line breaks and escaped brackets
+ $str = preg_replace('/[\t ]*\n[\t ]*/', "", $str);
+ $str = preg_replace('/\\\\\\(/', "::OPEN::", $str);
+ $str = preg_replace('/\\\\\\)/', "::CLOSE::", $str);
+
+ // Add a line break infront of every bracket
+ $str = preg_replace('/\\(/', "\n(", $str);
+ $str = preg_replace('/\\)/', ")\n", $str);
+
+ // Split by linebreaks
+ $lines = preg_split("/\n/", $str);
+ $str = "";
+ $i = 0;
+
+ // Walk trough search blocks
+ foreach($lines as $line){
+ $line = trim($line);
+ if(empty($line)) continue;
+
+ // Go back one level in indentation
+ if(!preg_match("/\\(.*\\)/", $line) && preg_match('/\\)$/', $line)){
+ $i --;
+ }
+
+ $str.= "\n";
+ $str = str_pad($str,strlen($str)+$i, $indent);
+ $str.= $line;
+
+ // Go one level deeper in indentation
+ if(!preg_match("/\\(.*\\)/", $line) && preg_match('/^\\(/', $line)){
+ $i ++;
+ }
+ }
+ $str = preg_replace('/::OPEN::/', '\(', $str);
+ $str = preg_replace('/::CLOSE::/', '\)', $str);
+ return($str);
+ }
+
+
+ /*! \brief Retunrs the filters original name
+ * @param The original name of the filter (if none was given
+ * an empty string is returned)
+ */
+ function getOriginalName()
+ {
+ return($this->orig_name);
+ }
+
+
+ /*! \brief Retunrs the filters name.
+ * @param The name of the filter
+ */
+ function getCurrentName()
+ {
+ return($this->name);
+ }
+
+
+ /*! \brief Generates the <HTML> content, to edit the filter settings.
+ * @return String HTML form.
+ */
+ function execute()
+ {
+ plugin::execute();
+
+ $smarty = get_smarty();
+
+ // Build up HTML compliant html output
+ $queries = array();
+ foreach($this->queries as $key => $query){
+ $query['filter'] = htmlentities($query['filter'],ENT_COMPAT,'UTF-8');
+ $queries[$key] = $query;
+ }
+
+ // Build up list of hard coded filters
+ $filter= $this->listing->getFilter();
+
+ $smarty->assign("fixedFilters", array_keys($filter->searches));
+ $smarty->assign('parent', $this->parent);
+ $smarty->assign('backends', $this->backends);
+ $smarty->assign('name', htmlentities($this->name,ENT_COMPAT,'UTF-8'));
+ $smarty->assign('queries', $queries);
+ $smarty->assign('share', $this->share);
+ $smarty->assign('enable', $this->enabled);
+ $smarty->assign('description', htmlentities($this->description,ENT_COMPAT,'UTF-8'));
+ $smarty->assign('selectedCategories', $this->selectedCategories);
+ $smarty->assign('availableCategories', array_unique($this->listing->categories));
+ return($smarty->fetch(get_template_path('userFilterEditor.tpl', FALSE)));
+ }
+
+
+ /*! \brief Keep values entered in the input form of the dialog. (POST/GET)
+ */
+ function save_object()
+ {
+ if(isset($_POST['userFilterEditor'])){
+
+ // Get posted strings
+ foreach(array('name','description', 'parent') as $attr){
+ if(isset($_POST[$attr])){
+ $this->$attr = get_post($attr);
+ }
+ }
+
+ // Filter needs special handling, it may contain charactes like < and >
+ // wich are stipped out by get_post() && validate()
+ foreach($this->queries as $key => $query){
+ if(isset($_POST['filter_'.$key])){
+ $f = get_post('filter_'.$key);
+ $this->queries[$key]['filter'] = $f;
+ $this->queries[$key]['backend'] = get_post('backend_'.$key);
+ }
+ }
+
+ foreach($this->queries as $key => $query){
+ if(isset($_POST['removeQuery_'.$key])){
+ unset($this->queries[$key]);
+ $this->queries = array_values($this->queries);
+ }
+ }
+
+ // Get posted flags
+ $this->share = isset($_POST['shareFilter']);
+ $this->enable = isset($_POST['enableFilter']);
+
+ // Get additional category
+ if(isset($_POST['addCategory'])){
+ if(isset($_POST['manualCategory']) && !empty($_POST['manualCategory'])){
+ $this->selectedCategories[] = get_post('manualCategory');
+ }elseif(isset($_POST['availableCategory']) && !empty($_POST['availableCategory'])){
+ $this->selectedCategories[] = get_post('availableCategory');
+ }
+ $this->selectedCategories = array_unique($this->selectedCategories);
+ }
+
+ // Remove categories
+ if(isset($_POST['delCategory']) && isset($_POST['usedCategory'])){
+ foreach($_POST['usedCategory'] as $cat){
+ if(isset($this->selectedCategories[$cat])) unset($this->selectedCategories[$cat]);
+ }
+ }
+
+ // Add new query
+ if(isset($_POST['addQuery'])){
+
+ $filter= $this->listing->getFilter();
+ $backend = 'LDAP';
+ $query = "(objectClass=*)";
+ if(isset($filter->searches[$this->parent])){
+
+ $tmp = $filter->searches[$this->parent];
+ if(isset($tmp['query'][count($this->queries)])){
+ $query = $tmp['query'][count($this->queries)]['filter'];
+ $backend = $tmp['query'][count($this->queries)]['backend'];
+ }elseif(isset($tmp['query']['filter'])){
+ $query = $tmp['query']['filter'];
+ $backend = $tmp['query']['backend'];
+ }
+ }
+
+ $this->queries[] = array('backend'=> $backend, 'filter' => userFilterEditor::_autoIndentFilter($query," "));
+ }
+ }
+ }
+
+
+ /*! \brief Validate user input
+ * @return Array An Array containing potential error messages
+ */
+ function check()
+ {
+ $msgs = plugin::check();
+
+ // Check if the name is given
+ if(empty($this->name)){
+ $msgs[] = msgPool::required(_("Name"));
+ }elseif(preg_match("/[^a-z0-9]/i", $this->name)){
+
+ // Check for a valid name, no special chars here - in particular no ;
+ $msgs[] = msgPool::invalid(_("Name"), $this->name,"/[a-z0-9]/i");
+ }
+
+ // Description is a must value.
+ if(empty($this->description)){
+ $msgs[] = msgPool::required(_("Description"));
+ }
+
+ // Count the number of opening and closing brackets - exclude escaped ones.
+ foreach($this->queries as $key => $query){
+ $f = preg_replace('/\\\\[\(\)]/',"",$query['filter']);
+ $o = substr_count($f, '(');
+ $c = substr_count($f, ')');
+ if($o != $c){
+ $msgs[] = sprintf(_("Error in filter #%s: %s opening and %s closing brackets detected!"), bold($key+1), bold($o), bold($c));
+ }
+ }
+
+ return($msgs);
+ }
+
+
+ /*! \brief Transforms the entered values into a filter object (array) which is useable
+ * for the userFilter overview dialog.
+ * @return Returns transformed filter data.
+ */
+ function save()
+ {
+ $ret= array();
+ $ret['parent'] = $this->parent;
+ $ret['tag'] = $this->name;
+ $ret['description'] = $this->description;
+ $ret['categories'] = $this->selectedCategories;
+ $ret['query'] = $this->queries;
+ $ret['flags'] = array();
+ if($this->share){
+ $ret['flags'][] = "share";
+ }
+ if($this->enable){
+ $ret['flags'][] = "enable";
+ }
+ return($ret);
+ }
}
// vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler: