Code

Added experimental sorting for rendered cells. Preparing for cached entries.
[gosa.git] / gosa-core / include / class_listing.inc
index e9cc5d9ebe1e19c470500bd640f9d22abb3a999b..e2bdb9a44a2d7e608db8d888dbf9cc66f59bea41 100644 (file)
@@ -45,6 +45,8 @@ class listing {
   var $pid;
   var $objectTypes= array();
   var $objectTypeCount= array();
+  var $copyPasteHandler= null;
+  var $snapshotHandler= null;
 
 
   function listing($filename)
@@ -76,6 +78,29 @@ class listing {
   }
 
 
+  function setCopyPasteHandler($handler)
+  {
+    $this->copyPasteHandler= &$handler;
+  }
+
+
+  function setSnapshotHandler($handler)
+  {
+    $this->snapshotHandler= &$handler;
+  }
+
+
+  function setFilter($filter)
+  {
+    $this->filter= &$filter;
+    if ($this->departmentBrowser){
+      $this->departments= $this->getDepartments();
+    }
+    $this->filter->setBase($this->base);
+    $this->entries= $this->filter->query();
+  }
+
+
   function registerElementFilter($name, $call)
   {
     if (!isset($this->filters[$name])) {
@@ -113,9 +138,16 @@ class listing {
                                   "objectClass" => $data['OC'],
                                   "image" => $data['IMG']);
     }
+    $this->categories= array();
     if (isset($this->xmlData['definition']['objectType'])) {
+      if(isset($this->xmlData['definition']['objectType']['label'])) {
+        $this->xmlData['definition']['objectType']= array($this->xmlData['definition']['objectType']);
+      }
       foreach ($this->xmlData['definition']['objectType'] as $index => $otype) {
         $this->objectTypes[]= $this->xmlData['definition']['objectType'][$index];
+        if (isset($this->xmlData['definition']['objectType'][$index]['category'])){
+          $this->categories[]= $this->xmlData['definition']['objectType'][$index]['category'];
+        }
       }
     }
 
@@ -128,6 +160,9 @@ class listing {
     // Assign headline/module
     $this->headline= _($this->xmlData['definition']['label']);
     $this->module= $this->xmlData['definition']['module'];
+    if (!is_array($this->categories)){
+      $this->categories= array($this->categories);
+    }
 
     return true;  
   }
@@ -186,7 +221,10 @@ class listing {
 
   function render()
   {
-echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
+    // Check for exeeded sizelimit
+    if (($message= check_sizelimit()) != ""){
+      return($message);
+    }
 
     // Initialize list
     $result= "<input type='hidden' value='$this->pid' name='PID'>";
@@ -232,11 +270,18 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
         }
 
         // Render defined department columns, fill the rest with some stuff
+        $rest= $this->numColumns - 1;
         foreach ($this->xmlData['table']['department'] as $index => $config) {
-          $result.="<td ".$this->colprops[$index]." class='list1'>".$this->renderCell($config['value'], $entry, $row)."</td>";
+          $colspan= 1;
+          if (isset($config['span'])){
+            $colspan= $config['span'];
+          }
+          $result.="<td colspan='$colspan' ".$this->colprops[$index]." class='list1'>".$this->renderCell($config['value'], $entry, $row)."</td>";
+          $rest-= $colspan;
         }
-        $last= count($this->xmlData['table']['department']) + 1;
-        $rest= $this->numColumns - $last;
+
+        // Fill remaining cols with nothing
+        $last= $this->numColumns - $rest;
         for ($i= 0; $i<$rest; $i++){
           $result.= "<td ".$this->colprops[$last+$i-1]." class='list1'>&nbsp;</td>";
         }
@@ -248,26 +293,38 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
     }
 
     // Fill with contents, sort as configured
-    $entryIterator= new listingSortIterator($this->entries, $this->sortDirection[$this->sortColumn], $this->sortAttribute, $this->sortType);
-    foreach ($entryIterator as $row => $entry){
-      $result.="<tr class='rowxp".($alt&1)."'>";
+    foreach ($this->entry as $row => $entry) {
+      $trow ="<tr class='rowxp".($alt&1)."'>";
 
       // Render multi select if needed
       if ($this->multiSelect) {
-        $result.="<td style='text-align:center;width:20px;' class='list0'><input type='checkbox' id='listing_selected_$row' name='listing_selected_$row'></td>";
+        $trow.="<td style='text-align:center;width:20px;' class='list0'><input type='checkbox' id='listing_selected_$row' name='listing_selected_$row'></td>";
       }
 
       foreach ($this->xmlData['table']['column'] as $index => $config) {
-        $result.="<td ".$this->colprops[$index]." class='list0'>".$this->renderCell($config['value'], $entry, $row)."</td>";
+        $renderedCell= $this->renderCell($config['value'], $entry, $row);
+        $trow.="<td ".$this->colprops[$index]." class='list0'>".$renderedCell."</td>";
+
+        // Save rendered column
+        $this->entry[$row]["_sort$index"]= $renderedCell;
       }
-      $result.="</tr>";
+      $trow.="</tr>";
+
+      // Save rendered entry
+      $this->entry[$row]['_rendered']= $trow;
 
       $alt++;
     }
 
+    // Complete list by sorting entries for _sort$index and appending them to the output
+    $entryIterator= new listingSortIterator($this->entries, $this->sortDirection[$this->sortColumn], "_sort".$this->sortColumn, $this->sortType);
+    foreach ($entryIterator as $row => $entry){
+      $result.= $entry['_rendered'];
+    }
+
     // Need to fill the list if it's not full (nobody knows why this is 22 ;-))
-    $emptyListStyle= (count($this->entries) + count($deps) == 0)?"border:0;":"";
-    if (count($this->entries) + count($deps) < 22) {
+    $emptyListStyle= (count($this->entries) + $deps == 0)?"border:0;":"";
+    if ((count($this->entries) + $deps) < 22) {
       $result.= "<tr>";
       for ($i= 0; $i<$this->numColumns; $i++) {
         if ($i == 0) {
@@ -303,6 +360,7 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
 
     $smarty= get_smarty();
     $smarty->assign("FILTER", $this->filter->render());
+    $smarty->assign("SIZELIMIT", print_sizelimit_warning());
     $smarty->assign("LIST", $result);
 
     // Assign navigation elements
@@ -325,22 +383,14 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
   }
 
 
-  function setFilter($filter)
-  {
-    $this->filter= &$filter;
-    if ($this->departmentBrowser){
-      $this->departments= $this->getDepartments();
-    }
-    $this->filter->setBase($this->base);
-    $this->entries= $this->filter->query();
-  }
-
-
   function update()
   {
     global $config;
     $ui= get_userinfo();
 
+    // Reset object counter
+    $this->objectTypeCount= array();
+
     // Do not do anything if this is not our PID
     if(isset($_REQUEST['PID']) && $_REQUEST['PID'] != $this->pid) {
       return;
@@ -476,6 +526,10 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
     // Watch out for filters and prepare to execute them
     $data= $this->processElementFilter($data, $config, $row);
 
+    // Replace all non replaced %{...} instances because they
+    // are non resolved attributes or filters
+    $data= preg_replace('/%{[^}]+}/', '&nbsp;', $data);
+
     return $data;
   }
 
@@ -666,19 +720,21 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
       }
 
       // Handle special types
-      if ($action['type'] == "snapshot") {
-        #TODO
-        #echo "actiontriggers: snapshot missing<br>";
-      }
-      if ($action['type'] == "copypaste") {
-        #TODO
-        #echo "actiontriggers: copypaste missing<br>";
-      }
-      if ($action['type'] == "daemon") {
-        #TODO
-        #echo "actiontriggers: daemon missing<br>";
-      }
+      if ($action['type'] == "copypaste" || $action['type'] == "snapshot") {
 
+        $objectType= $this->getObjectType($this->objectTypes, $this->entries[$row]['objectClass']);
+        $category= $class= null;
+        if ($objectType) {
+          $category= $objectType['category'];
+          $class= $objectType['class'];
+        }
+
+        if ($action['type'] == "copypaste") {
+          $result.= $this->renderCopyPasteActions($row, $this->entries[$row]['dn'], $category, $class);
+        } else {
+          $result.= $this->renderSnapshotActions($row, $this->entries[$row]['dn'], $category, $class);
+        }
+      }
     }
 
     return $result;
@@ -860,7 +916,7 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
     $actions= &$this->xmlData['actionmenu']['action'];
     $result= "<input type='hidden' name='act' id='actionmenu' value=''>".
              "<ul class='level1' id='root'><li><a href='#'>Aktionen&nbsp;<img ".
-             "border=0 src='images/lists/sort-down.png'></a>";
+             "border=0 class='center' src='images/lists/sort-down.png'></a>";
 
     // Build ul/li list
     $result.= $this->recurseActions($actions);
@@ -885,7 +941,7 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
       // Fill image if set
       $img= "";
       if (isset($action['image'])){
-        $img= "<img border=0 src='".$action['image']."'>&nbsp;";
+        $img= "<img border='0' class='center' src='".$action['image']."'>&nbsp;";
       }
 
       if ($action['type'] == "separator"){
@@ -913,18 +969,15 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
       // Check for special types
       switch ($action['type']) {
         case 'copypaste':
-          #TODO
-          #echo "actionmenu: copypaste missing<br>";
+          $result.= $this->renderCopyPasteMenu($separator);
           break;
 
         case 'snapshot':
-          #TODO
-          #echo "actionmenu: snapshot missing<br>";
+          $result.= $this->renderSnapshotMenu($separator);
           break;
 
         case 'daemon':
-          #TODO
-          #echo "actionmenu: daemon missing<br>";
+          $result.= $this->renderDaemonMenu($separator);
           break;
       }
 
@@ -949,7 +1002,7 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
       // Every ACL has to pass
       foreach ($acls as $acl) {
         $module= $this->module;
-        $acllist= array();
+        $aclList= array();
 
         // Split for category and plugins if needed
         // match for "[rw]" style entries
@@ -1072,6 +1125,184 @@ echo "sizelimit, copypaste handler, snapshot handler, daemon handler<br>";
     return $departments;
   }
 
+
+  function renderCopyPasteMenu($separator, $copy= true, $cut= true)
+  {
+    // We can only provide information if we've got a copypaste handler
+    // instance
+    if(!(isset($this->copyPasteHandler) && is_object($this->copyPasteHandler))){
+      return "";
+    }
+
+    // Presets
+    $result= "";
+    $read= $paste= false;
+    $ui= get_userinfo();
+
+    // Switch flags to on if there's at least one category which allows read/paste
+    foreach($this->categories as $category){
+      $read= $read || preg_match('/r/', $ui->get_category_permissions($this->base, $category));
+      $paste= $paste || $ui->is_pasteable($this->base, $category) == 1;
+    }
+
+
+    // Draw entries that allow copy and cut
+    if($read){
+
+      // Copy entry
+      if($copy){
+        $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"copy\";mainform.submit();'><img src='images/lists/copy.png' alt='' border='0' class='center'>&nbsp;"._("Copy")."</a></li>";
+        $separator= "";
+      }
+
+      // Cut entry
+      if($cut){
+        $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"cut\";mainform.submit();'><img src='images/lists/cut.png' alt='' border='0' class='center'>&nbsp;"._("Cut")."</a></li>";
+        $separator= "";
+      }
+    }
+
+    // Draw entries that allow pasting entries
+    if($paste){
+      if($this->copyPasteHandler->entries_queued()){
+        $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"paste\";mainform.submit();'><img src='images/lists/paste.png' alt='' border='0' class='center'>&nbsp;"._("Paste")."</a></li>";
+      }else{
+        $result.= "<li$separator><a href='#'><img src='images/lists/paste-grey.png' alt='' border='0' class='center'>&nbsp;"._("Paste")."</a></li>";
+      }
+    }
+    
+    return($result);
+  }
+
+
+  function renderCopyPasteActions($row, $dn, $category, $class, $copy= true, $cut= true)
+  {
+    // We can only provide information if we've got a copypaste handler
+    // instance
+    if(!(isset($this->copyPasteHandler) && is_object($this->copyPasteHandler))){
+      return "";
+    }
+
+    // Presets
+    $ui = get_userinfo();
+    $result = "";
+
+    // Render cut entries
+    if($cut){
+      if($ui->is_cutable($dn, $category, $class)){
+        $result .= "<input class='center' type='image'
+          src='images/lists/cut.png' alt='"._("Cut")."' name='listing_cut_$row' title='"._("Cut this entry")."' style='padding:1px'>";
+      }else{
+        $result.="<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
+      }
+    }
+
+    // Render copy entries
+    if($copy){
+      if($ui->is_copyable($dn, $category, $class)){
+        $result.= "<input class='center' type='image'
+          src='images/lists/copy.png' alt='"._("Copy")."' name='listing_copy_$row' title='"._("Copy this entry")."' style='padding:1px'>";
+      }else{
+        $result.="<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
+      }
+    }
+
+    return($result);
+  }
+
+
+  function renderSnapshotMenu($separator)
+  {
+    // We can only provide information if we've got a snapshot handler
+    // instance
+    if(!(isset($this->snapshotHandler) && is_object($this->snapshotHandler))){
+      return "";
+    }
+
+    // Presets
+    $result = "";
+    $ui = get_userinfo();
+
+    if($this->snapshotHandler->enabled() && $ui->allow_snapshot_restore($this->base, $this->module)){
+
+      // Check if there is something to restore
+      $restore= false;
+      foreach($this->snapshotHandler->getSnapshotBases() as $base){
+        $restore= $restore || count($this->snapshotHandler->getDeletedSnapshots($base)) > 0;
+      }
+
+      // Draw icons according to the restore flag
+      if($restore){
+        $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"restore\";mainform.submit();'><img src='images/lists/restore.png' alt='' border='0' class='center'>&nbsp;"._("Restore snapshots")."</a></li>";
+      }else{
+        $result.= "<li$separator><a href='#'><img src='images/lists/restore_grey.png' alt='' border='0' class='center'>&nbsp;"._("Restore snapshots")."</a></li>";
+      }
+    }
+
+    return($result);
+  }
+
+
+  function renderSnapshotActions($row, $dn, $category, $class, $copy= true, $cut= true)
+  {
+    // We can only provide information if we've got a snapshot handler
+    // instance
+    if(!(isset($this->snapshotHandler) && is_object($this->snapshotHandler))){
+      return "";
+    }
+
+    // Presets
+    $result= "";
+    $ui = get_userinfo();
+
+    // Only act if enabled here
+    if($this->snapshotHandler->enabled()){
+
+      // Draw restore button
+      if ($ui->allow_snapshot_restore($dn, $category)){
+
+        // Do we have snapshots for this dn?
+        if($this->snapshotHandler->hasSnapshots($dn)){
+          $result.= "<input class='center' type='image' src='images/lists/restore.png' ".
+                     "alt='"._("Restore snapshot")."' name='listing_restore_$row' title='".
+                     _("Restore snapshot")."' style='padding:1px'>";
+        } else {
+          $result.= "<img src='images/lists/restore_grey.png' alt=' ' class='center' style='padding:1px'>";
+        }
+      }
+
+      // Draw snapshot button
+      if($ui->allow_snapshot_create($dn, $category)){
+          $result.= "<input class='center' type='image' src='images/snapshot.png' ".
+                     "alt='"._("Create snapshot")."' name='listing_snapshot_$row' title='".
+                     _("Create a new snapshot from this object")."' style='padding:1px'>";
+      }else{
+          $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
+      }
+    }
+
+    return($result);
+  }
+
+
+  function renderDaemonMenu($separator)
+  {
+    $result= "";
+
+    // If there is a daemon registered, draw the menu entries
+    if(class_available("DaemonEvent")){
+      $events= DaemonEvent::get_event_types_by_category($this->categories);
+      if(isset($events['BY_CLASS']) && count($events['BY_CLASS'])){
+        foreach($events['BY_CLASS'] as $name => $event){
+          $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value=\"$name\";mainform.submit();'>".$event['MenuImage']."&nbsp;".$event['s_Menu_Name']."</a></li>";
+          $separator= "";
+        }
+      }
+    }
+
+    return $result;
+  }
+
 }
 
 ?>