Code

Prevent multiple categories of the same type in userFilterEditor
[gosa.git] / gosa-core / include / class_sortableListing.inc
index b87136c612f27a00d41ea01159de3103bd41fe90..55c3bbfe9bc5617b76eabbc41a0c9de330ad8334 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  * This code is part of GOsa (http://www.gosa-project.org)
- * Copyright (C) 2003-2008 GONICUS GmbH
+ * Copyright (C) 2003-2010 GONICUS GmbH
  *
- * ID: $$Id: class_listing.inc 15087 2010-01-06 13:45:49Z hickert $$
+ * ID: $$Id$$
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+define ('LIST_NORMAL', 0);
+define ('LIST_MARKED', 1);
+define ('LIST_DISABLED', 2);
+
 class sortableListing {
   private $header= null;
   private $colspecs= null;
@@ -30,119 +34,186 @@ class sortableListing {
   private $id;
 
   private $data= array();
+  private $keys= array();
+  private $modes= array();
+  private $displayData= array();
   private $columns= 0;
   private $deleteable= false;
   private $editable= false;
+  private $colorAlternate= false;
   private $instantDelete= true;
   private $action;
-  private $targets;
   private $mapping;
   private $current_mapping;
   private $active_index;
+  private $scrollPosition= 0;
+  private $sortColumn= 0;
+  private $sortDirection= array();
+
+  private $acl= "";
+  private $modified= false;
 
-  function sortableListing($data= array())
+  public function sortableListing($data= array(), $displayData= null, $reorderable= false)
   {
     global $config;
 
     // Save data to display
-    $this->setData($data);
+    $this->setListData($data, $displayData);
 
     // Generate instance wide unique ID
     $tmp= gettimeofday();
     $this->id= 'l'.md5($tmp['sec']);
+
+    // Set reorderable flag
+    $this->reorderable= $reorderable;
+    if (!$reorderable) {
+      $this->sortData();
+    }
+  }
+
+
+  public function setListData($data, $displayData= null)
+  {
+    // Save data to display
+    $this->setData($data);
+    if (!$displayData) {
+      $displayData= array();
+      foreach ($data as $key => $value) {
+        $displayData[$key]= array("data" => array($value));
+      }
+    }
+    $this->setDisplayData($displayData);
+  }
+
+
+  private function setData($data)
+  {
+    $this->data= $data;
   }
 
 
-  function setData($data)
+  private function setDisplayData($data)
   {
     if (!is_array($data)) {
       die ("sortableList needs an array as data!");
     }
 
     // Transfer information
-    $this->data= $data;
+    $this->displayData= array();
+    $this->modes= array();
+    foreach ($data as $key => $value) {
+      $this->displayData[]= $value['data'];
+      if (isset($value['mode'])) {
+        $this->modes[]= $value['mode'];
+      }
+    }
+    $this->keys= array_keys($data);
 
     // Create initial mapping
-    $this->mapping= array_keys($data);
+    $this->mapping= range(0, abs(count($this->keys)-1));
+    $this->current_mapping= $this->mapping;
 
     // Find the number of coluns
-    reset($this->data);
-    $first= current($this->data);
+    reset($this->displayData);
+    $first= current($this->displayData);
     if (is_array($first)) {
       $this->columns= count($first);
     } else {
       $this->columns= 1;
     }
+
+    // Preset sort orders to 'down'
+    for ($column= 0; $column<$this->columns; $column++) {
+      $this->sortDirection[]= true;
+    }
   }
 
 
-  function setWidth($width)
+  public function setWidth($width)
   {
     $this->width= $width;
   }
 
 
-  function setInstantDelete($flag)
+  public function setInstantDelete($flag)
   {
     $this->instantDelete= $flag;
   }
 
 
-  function setEditable($flag)
+  public function setColorAlternate($flag)
+  {
+    $this->colorAlternate= $flag;
+  }
+
+
+  public function setEditable($flag)
   {
     $this->editable= $flag;
   }
 
 
-  function setDeleteable($flag)
+  public function setDeleteable($flag)
   {
     $this->deleteable= $flag;
   }
 
 
-  function setHeight($height)
+  public function setHeight($height)
   {
     $this->height= $height;
   }
 
 
-  function setCssClass($css)
+  public function setCssClass($css)
   {
     $this->cssclass= $css;
   }
 
 
-  function setHeader($header)
+  public function setHeader($header)
   {
     $this->header= $header;
   }
 
 
-  function setColspecs($specs)
+  public function setColspecs($specs)
   {
     $this->colspecs= $specs;
   }
 
 
-  function render()
+  public function render()
   {
-    $result= "<div class='sortableListContainer' id='scroll_".$this->id."' style='width: ".$this->width."; height: ".$this->height."'>\n";
-    $result.= "<table border='0' cellpadding='0' cellspacing='0' width='100%' height='100%' style='position: relative;'".(!empty($this->cssclass)?" class='".$this->cssclass."'":"").">\n";
+    $result= "<div class='sortableListContainer' id='scroll_".$this->id."' style='min-width:".$this->width.";height: ".$this->height."'>\n";
+    $result.= "<table summary='"._("Sortable list")."' border='0' cellpadding='0' cellspacing='0' width='100%' style='width:100%' ".(!empty($this->cssclass)?" class='".$this->cssclass."'":"").">\n";
     $action_width= 0;
-    $edit_image= $this->editable?"<input class='center' type='image' src='images/lists/edit.png' alt='"._("Edit")."' name='%ID' title='"._("Edit this entry")."'>":"";
-    $delete_image= $this->deleteable?"<input class='center' type='image' src='images/lists/trash.png' alt='"._("Delete")."' name='%ID' title='"._("Delete this entry")."'>":"";
+    if (strpos($this->acl, 'w') === false) {
+      $edit_image= $this->editable?image("images/lists/edit-grey.png"):"";
+    } else {
+      $edit_image= $this->editable?image('images/lists/edit.png', "%ID", _("Edit this entry")):"";
+    }
+    if (strpos($this->acl, 'd') === false) {
+      $delete_image= $this->deleteable?image('images/lists/trash-grey.png'):"";
+    } else {
+      $delete_image= $this->deleteable?image('images/lists/trash.png', "%ID", _("Delete this entry")):"";
+    }
 
     // Do we need colspecs?
     $action_width= ($this->editable?20:0) + ($this->deleteable?20:0);
     if ($this->colspecs) {
       $result.= " <colgroup>\n";
       for ($i= 0; $i<$this->columns; $i++) {
-        $result.= "  <col width='".(isset($this->colspecs[$i])?$this->colspecs[$i]:"*")."'/>\n";
+        if(isset($this->colspecs[$i]) && $this->colspecs[$i] != '*'){
+          $result.= "  <col style='width:".($this->colspecs[$i])."'>\n";
+        }else{
+          $result.= "  <col>\n";
+        }
       }
 
       // Extend by another column if we've actions specified
       if ($action_width) {
-        $result.= "  <col width='$action_width'/>\n";
+        $result.= "  <col style='width:".$action_width."px' >\n";
       }
       $result.= " </colgroup>\n";
     }
@@ -150,8 +221,20 @@ class sortableListing {
     // Do we need a header?
     if ($this->header) {
       $result.= " <thead>\n  <tr>\n";
+      $first= " style='border-left:0'";
       for ($i= 0; $i<$this->columns; $i++) {
-        $result.= "   <th>".(isset($this->header[$i])?$this->header[$i]:"")."</th>";
+        $link= "href='?plug=".$_GET['plug']."&amp;PID=".$this->id."&amp;act=SORT_$i'";
+        $sorter= "";
+        if ($i == $this->sortColumn){
+          $sorter= "&nbsp;".image("images/lists/sort-".($this->sortDirection[$i]?"up":"down").".png", null, $this->sortDirection[$i]?_("Up"):_("Down"));
+        }
+
+        if ($this->reorderable) {
+          $result.= "   <th$first>".(isset($this->header[$i])?$this->header[$i]:"")."</th>";
+        } else {
+          $result.= "   <th$first><a $link>".(isset($this->header[$i])?$this->header[$i]:"")."$sorter</a></th>";
+        }
+        $first= "";
       }
       if ($action_width) {
         $result.= "<th>&nbsp;</th>";
@@ -159,43 +242,115 @@ class sortableListing {
       $result.= "\n  </tr>\n </thead>\n";
     }
 
-    // Render table body
+    // Render table body if we've read permission
     $result.= " <tbody id='".$this->id."'>\n";
-    foreach ($this->mapping as $nr => $row) {
-      $result.= "  <tr class='sortableListItem".($nr&1?'Odd':'')."' id='item_".$this->id."_$nr'>\n";
-      foreach ($this->data[$row] as $column) {
-        $result.= "   <td>".htmlentities($column)."</td>\n";
-      }
-      if ($action_width) {
-        $result.= "<td>".str_replace('%ID', "edit_".$this->id."_$nr", $edit_image).
-                         str_replace('%ID', "del_".$this->id."_$nr", $delete_image)."</td>";
+    $reorderable= $this->reorderable?"":" style='cursor:default'";
+    if (strpos($this->acl, 'r') !== false) {
+      foreach ($this->mapping as $nr => $row) {
+        $editable= $this->editable?" onclick='$(\"edit_".$this->id."_$nr\").click()'":"";
+
+        $id= "";
+        if (isset($this->modes[$row])) {
+          switch ($this->modes[$row]) {
+            case LIST_DISABLED:
+              $id= " sortableListItemDisabled";
+              $editable= "";
+              break;
+            case LIST_MARKED:
+              $id= " sortableListItemMarked";
+              break;
+          }
+        }
+
+        $result.= "  <tr class='sortableListItem".((($nr&1)||!$this->colorAlternate)?'':'Odd')."$id' id='item_".$this->id."_$nr'$reorderable>\n";
+        $first= " style='border:0'";
+
+        foreach ($this->displayData[$row] as $column) {
+          $result.= "   <td$editable$first>".$column."</td>\n";
+          $first= "";
+        }
+
+        if ($action_width) {
+          $result.= "<td>".str_replace('%ID', "edit_".$this->id."_$nr", $edit_image).
+                           str_replace('%ID', "del_".$this->id."_$nr", $delete_image)."</td>";
+        }
+
+        $result.= "  </tr>\n";
       }
-      $result.= "  </tr>\n";
     }
 
+    // Add spacer
+    $result.= "  <tr class='sortableListItemFill' style='height:100%'><td style='border:0'></td>";
+    $num= $action_width?$this->columns:$this->columns-1;
+    for ($i= 0; $i<$num; $i++) {
+      $result.= "<td class='sortableListItemFill'></td>";
+    }
+    $result.= "</tr>\n";
+
     $result.= " </tbody>\n</table>\n</div>\n";
+    $result.= " <input type='hidden' name='PID' value='".$this->id."' id='PID'>\n";
+    $result.= " <input type='hidden' name='position_".$this->id."' id='position_".$this->id."'>\n";
     $result.= " <input type='hidden' name='reorder_".$this->id."' id='reorder_".$this->id."'>\n";
 
     // Append script stuff if needed
     $result.= '<script type="text/javascript" language="javascript">';
-    $result.= ' function updateOrder(){';
-    $result.= '    var ampcharcode= \'%26\';';
-    $result.= '    var serializeOpts = Sortable.serialize(\''.$this->id.'\')+"='.$this->id.'";';
-    $result.= '    $("reorder_'.$this->id.'").value= serializeOpts;';
-    $result.= '    document.mainform.submit();';
-    $result.= ' }';
-    $result.= 'Position.includeScrollOffsets = true;';
-    $result.= ' Sortable.create(\''.$this->id.'\',{tag:\'tr\', ghosting:false,constraint:\'vertical\', scroll:\'scroll_'.$this->id.'\',onUpdate : updateOrder})';
+    if ($this->reorderable) {
+      $result.= ' function updateOrder(){';
+      $result.= '    var ampcharcode= \'%26\';';
+      $result.= '    var serializeOpts = Sortable.serialize(\''.$this->id.'\')+"='.$this->id.'";';
+      $result.= '    $("reorder_'.$this->id.'").value= serializeOpts;';
+      $result.= '    document.mainform.submit();';
+      $result.= ' }';
+      $result.= 'Position.includeScrollOffsets = true;';
+      $result.= ' Sortable.create(\''.$this->id.'\',{tag:\'tr\', ghosting:false, constraint:\'vertical\', scroll:\'scroll_'.$this->id.'\',onUpdate : updateOrder});';
+    }
+    $result.= '$("scroll_'.$this->id.'").scrollTop= '.$this->scrollPosition.';';
+    $result.= 'var box = $("scroll_'.$this->id.'").onscroll= function() {$("position_'.$this->id.'").value= this.scrollTop;}';
     $result.= '</script>';
 
     return $result;
   }
 
 
-  function update()
+  public function update()
   {
-    // Do not do anything if we're not posted
-    if (isset($_POST['reorder_'.$this->id])){
+    // Do not do anything if this is not our PID, or there's even no PID available...
+    if(!isset($_REQUEST['PID']) || $_REQUEST['PID'] != $this->id) {
+      return;
+    }
+
+    // Filter GET with "act" attributes
+    if (!$this->reorderable && isset($_GET['act'])) {
+      $key= validate($_GET['act']);
+      if (preg_match('/^SORT_([0-9]+)$/', $key, $match)) {
+        // Switch to new column or invert search order?
+        $column= $match[1];
+        if ($this->sortColumn != $column) {
+          $this->sortColumn= $column;
+        } else {
+          $this->sortDirection[$column]= !$this->sortDirection[$column];
+        }
+
+        // Update mapping according to sort parameters
+        $this->sortData();
+      }
+    }
+  }
+
+
+  public function save_object()
+  {
+    // Do not do anything if this is not our PID, or there's even no PID available...
+    if(!isset($_REQUEST['PID']) || $_REQUEST['PID'] != $this->id) {
+      return;
+    }
+
+    // Do not do anything if we're not posted - or have no permission
+    if (strpos($this->acl, 'w') !== false && isset($_POST['reorder_'.$this->id])){
+
+      if (isset($_POST['position_'.$this->id]) && is_numeric($_POST['position_'.$this->id])) {
+        $this->scrollPosition= $_POST['position_'.$this->id];
+      }
 
       // Move requested?
       $move= $_POST['reorder_'.$this->id];
@@ -208,33 +363,55 @@ class sortableListing {
         }
         $this->mapping= $tmp;
         $this->current_mapping= $matches[1];
+        $this->modified= true;
         return;
       }
+    }
 
-      // Delete requested?
+    // Delete requested?
+    $this->action = "";
+    if (strpos($this->acl, 'd') !== false){
       foreach ($_POST as $key => $value) {
-        if (preg_match('/^del_'.$this->id.'_([0-9]+)_x.*$/', $key, $matches)) {
+        if (preg_match('/^del_'.$this->id.'_([0-9]+)$/', $key, $matches)) {
           $this->active_index= $this->mapping[$matches[1]];
+
+          // Ignore request if mode requests it
+          if (isset($this->modes[$this->active_index]) && $this->modes[$this->active_index] == LIST_DISABLED) {
+            $this->active_index= null;
+            continue;
+          }
+
+          // Set action
           $this->action= "delete";
+
+          // Remove value if requested
           if ($this->instantDelete) {
             $this->deleteEntry($this->active_index);
           }
         }
       }
+    }
 
-      // Edit requested?
+    // Edit requested?
+    if (strpos($this->acl, 'w') !== false){
       foreach ($_POST as $key => $value) {
-        if (preg_match('/^edit_'.$this->id.'_([0-9]+)_x.*$/', $key, $matches)) {
+        if (preg_match('/^edit_'.$this->id.'_([0-9]+)$/', $key, $matches)) {
           $this->active_index= $this->mapping[$matches[1]];
+
+          // Ignore request if mode requests it
+          if (isset($this->modes[$this->active_index]) && $this->modes[$this->active_index] == LIST_DISABLED) {
+            $this->active_index= null;
+            continue;
+          }
+
           $this->action= "edit";
         }
       }
-
     }
   }
 
 
-  function getAction()
+  public function getAction()
   {
     // Do not do anything if we're not posted
     if(!isset($_POST['reorder_'.$this->id])) {
@@ -253,14 +430,106 @@ class sortableListing {
   }
 
 
-  function deleteEntry($id)
+  private function deleteEntry($id)
   {
+    // Remove mapping
     $index= array_search($id, $this->mapping);
     if ($index !== false) {
       unset($this->mapping[$index]);
-      $this->mappings= array_values($this->mappings);
+      $this->mapping= array_values($this->mapping);
+      $this->modified= true;
     }
   }
 
 
+  public function getMaintainedData()
+  {
+    $tmp= array();
+
+    foreach ($this->mapping as $src => $dst) {
+      $tmp[$this->keys[$dst]]= $this->data[$dst];
+    }
+
+    return $tmp;
+  }
+
+
+  public function isModified()
+  {
+    return $this->modified;
+  }
+
+
+  public function setAcl($acl)
+  {
+    $this->acl= $acl;
+  }
+
+
+  public function sortData()
+  {
+    // Extract data
+    $tmp= array();
+    foreach($this->displayData as $item) {
+      if (isset($item[$this->sortColumn])){
+        $tmp[]= $item[$this->sortColumn];
+      } else {
+        $tmp[]= "";
+      }
+    }
+
+    // Sort entries
+    if ($this->sortDirection[$this->sortColumn]) {
+      asort($tmp);
+    } else {
+      arsort($tmp);
+    }
+
+    // Adapt mapping accordingly
+    $this->mapping= array();
+    foreach ($tmp as $key => $value) {
+      $this->mapping[]= $key;
+    }
+  }
+
+
+  public function addEntry($entry, $displayEntry= null, $key= null)
+  {
+    // Only add if not already there
+    if (!$key) {
+      if (in_array($entry, $this->data)) {
+        return;
+      }
+    } else {
+      if (isset($this->data[$key])) {
+        return;
+      }
+    }
+
+    // Prefill with default value if not specified
+    if (!$displayEntry) {
+      $displayEntry= array('data' => array($entry));
+    }
+
+    // Append to data and mapping
+    if ($key) {
+      $this->data[$key]= $entry;
+      $this->keys[]= $key;
+    } else {
+      $this->data[]= $entry;
+      $this->keys[]= count($this->mapping);
+    }
+    $this->displayData[]= $displayEntry['data'];
+    $this->mapping[]= count($this->mapping);
+    $this->modified= true;
+
+    // Sort data after we've added stuff
+    $this->sortData();
+  }
+
+
+  public function getKey($index) {
+    return isset($this->keys[$index])?$this->keys[$index]:null;
+  }
+
 }