Code

Added dependency field
[gosa.git] / gosa-core / include / class_listing.inc
1 <?php
2 /*
3  * This code is part of GOsa (http://www.gosa-project.org)
4  * Copyright (C) 2003-2008 GONICUS GmbH
5  *
6  * ID: $$Id$$
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
23 class listing {
25   var $xmlData;
26   var $entries;
27   var $departments= array();
28   var $departmentBrowser= false;
29   var $departmentRootVisible= false;
30   var $multiSelect= false;
31   var $template;
32   var $headline;
33   var $module;
34   var $base;
35   var $sortDirection= null;
36   var $sortColumn= null;
37   var $sortAttribute;
38   var $sortType;
39   var $numColumns;
40   var $baseMode= false;
41   var $bases= array();
42   var $header= array();
43   var $colprops= array();
44   var $filters= array();
45   var $pid;
46   var $objectTypes= array();
47   var $objectTypeCount= array();
48   var $copyPasteHandler= null;
49   var $snapshotHandler= null;
50   var $exporter= array();
51   var $exportColumns= array();
52   var $useSpan= false;
53   var $height= 0;
56   function listing($filename)
57   {
58     global $config;
59     global $class_mapping;
61     // Initialize pid
62     $this->pid= preg_replace("/[^0-9]/", "", microtime(TRUE));
64     if (!$this->load($filename)) {
65       die("Cannot parse $filename!");
66     }
68     // Set base for filter
69     if ($this->baseMode) {
70       $this->base= session::global_get("CurrentMainBase");
71       if ($this->base == null) {
72         $this->base= $config->current['BASE'];
73       }
74       $this->refreshBasesList();
75     } else {
76       $this->base= $config->current['BASE'];
77     }
79     // Move footer information
80     $this->showFooter= ($config->get_cfg_value("listSummary") == "true");
82     // Register build in filters
83     $this->registerElementFilter("objectType", "listing::filterObjectType");
84     $this->registerElementFilter("departmentLink", "listing::filterDepartmentLink");
85     $this->registerElementFilter("link", "listing::filterLink");
86     $this->registerElementFilter("actions", "listing::filterActions");
88     // Load exporters
89     foreach($class_mapping as $class => $dummy) {
90       if (preg_match('/Exporter$/', $class)) {
91         $info= call_user_func(array($class, "getInfo"));
92         if ($info != null) {
93           $this->exporter= array_merge($this->exporter, $info);
94         }
95       }
96     }
97   }
100   function setCopyPasteHandler($handler)
101   {
102     $this->copyPasteHandler= &$handler;
103   }
106   function setHeight($height)
107   {
108     $this->height= $height;
109   }
112   function setSnapshotHandler($handler)
113   {
114     $this->snapshotHandler= &$handler;
115   }
118   function setFilter($filter)
119   {
120     $this->filter= &$filter;
121     if ($this->departmentBrowser){
122       $this->departments= $this->getDepartments();
123     }
124     $this->filter->setBase($this->base);
125   }
128   function registerElementFilter($name, $call)
129   {
130     if (!isset($this->filters[$name])) {
131       $this->filters[$name]= $call;
132       return true;
133     }
135     return false;
136   }
139   function load($filename)
140   {
141     $contents = file_get_contents($filename);
142     $this->xmlData= xml::xml2array($contents, 1);
144     if (!isset($this->xmlData['list'])) {
145       return false;
146     }
148     $this->xmlData= $this->xmlData["list"];
150     // Load some definition values
151     foreach (array("departmentBrowser", "departmentRootVisible", "multiSelect", "baseMode") as $token) {
152       if (isset($this->xmlData['definition'][$token]) &&
153           $this->xmlData['definition'][$token] == "true"){
154         $this->$token= true;
155       }
156     }
158     // Fill objectTypes from departments and xml definition
159     $types = departmentManagement::get_support_departments();
160     foreach ($types as $class => $data) {
161       $this->objectTypes[]= array("label" => $data['TITLE'],
162                                   "objectClass" => $data['OC'],
163                                   "image" => $data['IMG']);
164     }
165     $this->categories= array();
166     if (isset($this->xmlData['definition']['objectType'])) {
167       if(isset($this->xmlData['definition']['objectType']['label'])) {
168         $this->xmlData['definition']['objectType']= array($this->xmlData['definition']['objectType']);
169       }
170       foreach ($this->xmlData['definition']['objectType'] as $index => $otype) {
171         $this->objectTypes[]= $this->xmlData['definition']['objectType'][$index];
172         if (isset($this->xmlData['definition']['objectType'][$index]['category'])){
173           $this->categories[]= $this->xmlData['definition']['objectType'][$index]['category'];
174         }
175       }
176     }
178     // Parse layout per column
179     $this->colprops= $this->parseLayout($this->xmlData['table']['layout']);
181     // Prepare table headers
182     $this->renderHeader();
184     // Assign headline/module
185     $this->headline= _($this->xmlData['definition']['label']);
186     $this->module= $this->xmlData['definition']['module'];
187     if (!is_array($this->categories)){
188       $this->categories= array($this->categories);
189     }
191     // Evaluate columns to be exported
192     if (isset($this->xmlData['table']['column'])){
193       foreach ($this->xmlData['table']['column'] as $index => $config) {
194         if (isset($config['export']) && $config['export'] == "true"){
195           $this->exportColumns[]= $index;
196         }
197       }
198     }
200     return true;  
201   }
204   function renderHeader()
205   {
206     $this->header= array();
207     $this->plainHeader= array();
209     // Initialize sort?
210     $sortInit= false;
211     if (!$this->sortDirection) {
212       $this->sortColumn= 0;
213       if (isset($this->xmlData['definition']['defaultSortColumn'])){
214         $this->sortColumn= $this->xmlData['definition']['defaultSortColumn'];
215       } else {
216         $this->sortAttribute= "";
217       }
218       $this->sortDirection= array();
219       $sortInit= true;
220     }
222     if (isset($this->xmlData['table']['column'])){
223       foreach ($this->xmlData['table']['column'] as $index => $config) {
224         // Initialize everything to one direction
225         if ($sortInit) {
226           $this->sortDirection[$index]= false;
227         }
229         $sorter= "";
230         if ($index == $this->sortColumn && isset($config['sortAttribute']) &&
231             isset($config['sortType'])) {
232           $this->sortAttribute= $config['sortAttribute'];
233           $this->sortType= $config['sortType'];
234           $sorter= "&nbsp;<img border='0' title='".($this->sortDirection[$index]?_("Up"):_("Down"))."' src='images/lists/sort-".($this->sortDirection[$index]?"up":"down").".png' align='top'>";
235         }
236         $sortable= (isset($config['sortAttribute']));
238         $link= "href='?plug=".$_GET['plug']."&amp;PID=".$this->pid."&amp;act=SORT_$index'";
239         if (isset($config['label'])) {
240           if ($sortable) {
241             $this->header[$index]= "<td class='listheader' ".$this->colprops[$index]."><a $link>"._($config['label'])."$sorter</a></td>";
242           } else {
243             $this->header[$index]= "<td class='listheader' ".$this->colprops[$index].">"._($config['label'])."</td>";
244           }
245           $this->plainHeader[]= _($config['label']);
246         } else {
247           if ($sortable) {
248             $this->header[$index]= "<td class='listheader' ".$this->colprops[$index]."><a $link>&nbsp;$sorter</a></td>";
249           } else {
250             $this->header[$index]= "<td class='listheader' ".$this->colprops[$index].">&nbsp;</td>";
251           }
252           $this->plainHeader[]= "";
253         }
254       }
255     }
256   }
258   function render()
259   {
260     // Check for exeeded sizelimit
261     if (($message= check_sizelimit()) != ""){
262       return($message);
263     }
265     // Initialize list
266     $result= "<input type='hidden' value='$this->pid' name='PID'>\n";
267     $height= 450;
268     if ($this->height != 0) {
269       $result.= "<input type='hidden' value='$this->height' id='d_height'>\n";
270       $height= $this->height;
271     }
272     
273     $result.= "<div class='contentboxb' id='listing_container' style='border-top:1px solid #B0B0B0;'>\n";
274     $result.= "<table summary='$this->headline' style='width:600px;height:".$height."px;' cellspacing='0' id='t_scrolltable'>
275 <tr><td class='scrollhead'><table summary='' style='width:100%;' cellspacing='0' id='t_scrollhead'>\n";
276     $this->numColumns= count($this->colprops) + ($this->multiSelect?1:0);
278     // Build list header
279     $result.= "<tr>\n";
280     if ($this->multiSelect) {
281       $result.= "<td class='listheader' style='width:20px;'><input type='checkbox' id='select_all' name='select_all' title='"._("Select all")."' onClick='toggle_all_(\"listing_selected_[0-9]*$\",\"select_all\");' ></td>\n";
282     }
283     foreach ($this->header as $header) {
284       $result.= $header;
285     }
287     // Add 13px for scroller
288     $result.= "<td class='listheader' style='width:13px;border-right:0px;'>&nbsp;</td></table></td></tr>\n";
290     // New table for the real list contents
291     $result.= "<tr><td colspan='$this->numColumns' class='scrollbody'><div style='width:600px;height:".($height-20)."px;' id='d_scrollbody' class='scrollbody'><table summary='' style='height:100%;width:581px;' cellspacing='0' id='t_scrollbody'>\n";
293     // No results? Just take an empty colspanned row
294     if (count($this->entries) + count($this->departments) == 0) {
295       $result.= "<tr class='rowxp0'><td class='list1nohighlight' colspan='$this->numColumns' style='height:100%;border-right:0px;width:100%;'>&nbsp;</td></tr>";
296     }
298     // Line color alternation
299     $alt= 0;
300     $deps= 0;
302     // Draw department browser if configured and we're not in sub mode
303     $this->useSpan= false;
304     if ($this->departmentBrowser && $this->filter->scope != "sub") {
305       // Fill with department browser if configured this way
306       $departmentIterator= new departmentSortIterator($this->departments, $this->sortDirection[$this->sortColumn]);
307       foreach ($departmentIterator as $row => $entry){
308         $result.="<tr class='rowxp".($alt&1)."'>";
310         // Render multi select if needed
311         if ($this->multiSelect) {
312           $result.="<td style='text-align:center;width:20px;' class='list1'>&nbsp;</td>";
313         }
315         // Render defined department columns, fill the rest with some stuff
316         $rest= $this->numColumns - 1;
317         foreach ($this->xmlData['table']['department'] as $index => $config) {
318           $colspan= 1;
319           if (isset($config['span'])){
320             $colspan= $config['span'];
321             $this->useSpan= true;
322           }
323           $result.="<td colspan='$colspan' ".$this->colprops[$index]." class='list1'>".$this->renderCell($config['value'], $entry, $row)."</td>";
324           $rest-= $colspan;
325         }
327         // Fill remaining cols with nothing
328         $last= $this->numColumns - $rest;
329         for ($i= 0; $i<$rest; $i++){
330           $result.= "<td ".$this->colprops[$last+$i-1]." class='list1'>&nbsp;</td>";
331         }
332         $result.="</tr>";
334         $alt++;
335       }
336       $deps= $alt;
337     }
339     // Fill with contents, sort as configured
340     foreach ($this->entries as $row => $entry) {
341       $trow= "";
343       // Render multi select if needed
344       if ($this->multiSelect) {
345         $trow.="<td style='text-align:center;width:20px;' class='list0'><input type='checkbox' id='listing_selected_$row' name='listing_selected_$row'></td>\n";
346       }
348       foreach ($this->xmlData['table']['column'] as $index => $config) {
349         $renderedCell= $this->renderCell($config['value'], $entry, $row);
350         $trow.="<td ".$this->colprops[$index]." class='list0'>".$renderedCell."</td>\n";
352         // Save rendered column
353         $sort= preg_replace('/.*>([^<]+)<.*$/', '$1', $renderedCell);
354         $sort= preg_replace('/&nbsp;/', '', $sort);
355         if (preg_match('/</', $sort)){
356           $sort= "";
357         }
358         $this->entries[$row]["_sort$index"]= $sort;
359       }
361       // Save rendered entry
362       $this->entries[$row]['_rendered']= $trow;
363     }
365     // Complete list by sorting entries for _sort$index and appending them to the output
366     $entryIterator= new listingSortIterator($this->entries, $this->sortDirection[$this->sortColumn], "_sort".$this->sortColumn, $this->sortType);
367     foreach ($entryIterator as $row => $entry){
368       $alt++;
369       $result.="<tr class='rowxp".($alt&1)."'>\n";
370       $result.= $entry['_rendered'];
371       $result.="</tr>\n";
372     }
374     // Need to fill the list if it's not full (nobody knows why this is 22 ;-))
375     $emptyListStyle= (count($this->entries) + (($this->useSpan && count($this->entries))?$deps:0) == 0)?"border:0;":"";
376     if ((count($this->entries) + $deps) < 22) {
377       $result.= "<tr>";
378       for ($i= 0; $i<$this->numColumns; $i++) {
379         if ($i == 0) {
380           $result.= "<td class='list1nohighlight' style='$emptyListStyle height:100%;'>&nbsp;</td>";
381           continue;
382         }
383         if ($i != $this->numColumns-1) {
384           $result.= "<td class='list1nohighlight' style='$emptyListStyle'>&nbsp;</td>";
385         } else {
386           $result.= "<td class='list1nohighlight' style='border-right:1px solid #AAA;$emptyListStyle'>&nbsp;</td>";
387         }
388       }
389       $result.= "</tr>";
390     }
392     $result.= "</table></div></td></tr>";
394     // Add the footer if requested
395     if ($this->showFooter) {
396       $result.= "<tr><td class='scrollhead'><table summary='' style='width:100%' cellspacing='0' id='t_scrollfoot'><tr><td class='listfooter' style='border-bottom:0px;'>";
398       foreach ($this->objectTypes as $objectType) {
399         if (isset($this->objectTypeCount[$objectType['label']])) {
400           $label= _($objectType['label']);
401           $result.= "<img class='center' src='".$objectType['image']."' title='$label' alt='$label'>&nbsp;".$this->objectTypeCount[$objectType['label']]."&nbsp;&nbsp;&nbsp;&nbsp;";
402         }
403       }
405       $result.= "<td class='listfooter' style='width:13px;border-right:0px;'>&nbsp;</td></table></td></tr>";
406     }
408     $result.= "</table></div>";
410     $smarty= get_smarty();
411     $smarty->assign("usePrototype", "true");
412     $smarty->assign("FILTER", $this->filter->render());
413     $smarty->assign("SIZELIMIT", print_sizelimit_warning());
414     $smarty->assign("LIST", $result);
416     // Assign navigation elements
417     $nav= $this->renderNavigation();
418     foreach ($nav as $key => $html) {
419       $smarty->assign($key, $html);
420     }
422     // Assign action menu / base
423     $smarty->assign("ACTIONS", $this->renderActionMenu());
424     $smarty->assign("BASE", $this->renderBase());
426     // Assign separator
427     $smarty->assign("SEPARATOR", "<img src='images/lists/seperator.png' alt='-' align='middle' height='16' width='1' class='center'>");
429     // Assign summary
430     $smarty->assign("HEADLINE", $this->headline);
432     return ($smarty->fetch(get_template_path($this->xmlData['definition']['template'], true)));
433   }
436   function update()
437   {
438     global $config;
439     $ui= get_userinfo();
441     // Reset object counter
442     $this->objectTypeCount= array();
444     // Do not do anything if this is not our PID
445     if(isset($_REQUEST['PID']) && $_REQUEST['PID'] != $this->pid) {
446       return;
447     }
449     // Save base
450     if (isset($_POST['BASE']) && $this->baseMode) {
451       $base= validate($_POST['BASE']);
452       if (isset($this->bases[$base])) {
453         $this->base= $base;
454       }
455     }
457     // Override the base if we got a message from the browser navigation
458     if ($this->departmentBrowser && isset($_GET['act'])) {
459       if (preg_match('/^department_([0-9]+)$/', validate($_GET['act']), $match)){
460         if (isset($this->departments[$match[1]])){
461           $this->base= $this->departments[$match[1]]['dn'];
462         }
463       }
464     }
466     // Filter POST with "act" attributes -> posted from action menu
467     if (isset($_POST['exec_act']) && $_POST['act'] != '') {
468       if (preg_match('/^export.*$/', $_POST['act']) && isset($this->exporter[$_POST['act']])) {
469         $exporter= $this->exporter[$_POST['act']];
470         $userinfo= ", "._("created by")." ".$ui->cn." - ".strftime('%A, %d. %B %Y, %H:%M:%S');
471         $entryIterator= new listingSortIterator($this->entries, $this->sortDirection[$this->sortColumn], "_sort".$this->sortColumn, $this->sortType);
472         $sortedEntries= array();
473         foreach ($entryIterator as $entry){
474           $sortedEntries[]= $entry;
475         }
476         $instance= new $exporter['class']($this->headline.$userinfo, $this->plainHeader, $sortedEntries, $this->exportColumns);
477         $type= call_user_func(array($exporter['class'], "getInfo"));
478         $type= $type[$_POST['act']];
479         send_binary_content($instance->query(), $type['filename'], $type= $type['mime']);
480       }
481     }
483     // Filter GET with "act" attributes
484     if (isset($_GET['act'])) {
485       $key= validate($_GET['act']);
486       if (preg_match('/^SORT_([0-9]+)$/', $key, $match)) {
487         // Switch to new column or invert search order?
488         $column= $match[1];
489         if ($this->sortColumn != $column) {
490           $this->sortColumn= $column;
491         } else {
492           $this->sortDirection[$column]= !$this->sortDirection[$column];
493         }
495         // Allow header to update itself according to the new sort settings
496         $this->renderHeader();
497       }
498     }
500     // Override base if we got signals from the navigation elements
501     $action= "";
502     foreach ($_POST as $key => $value) {
503       if (preg_match('/^(ROOT|BACK|HOME)_x$/', $key, $match)) {
504         $action= $match[1];
505         break;
506       }
507     }
509     // Navigation handling
510     if ($action == 'ROOT') {
511       $deps= $ui->get_module_departments($this->module);
512       $this->base= $deps[0];
513     }
514     if ($action == 'BACK') {
515       $deps= $ui->get_module_departments($this->module);
516       $base= preg_replace("/^[^,]+,/", "", $this->base);
517       if(in_array_ics($base, $deps)){
518         $this->base= $base;
519       }
520     }
521     if ($action == 'HOME') {
522       $ui= get_userinfo();
523       $this->base= $this->filter->getObjectBase($ui->dn);
524     }
526     // Reload departments
527     if ($this->departmentBrowser){
528       $this->departments= $this->getDepartments();
529     }
531     // Update filter and refresh entries
532     $this->filter->setBase($this->base);
533     $this->entries= $this->filter->query();
534   }
537   function setBase($base)
538   {
539     $this->base= $base;
540   }
543   function getBase()
544   {
545     return $this->base;
546   }
549   function parseLayout($layout)
550   {
551     $result= array();
552     $layout= preg_replace("/^\|/", "", $layout);
553     $layout= preg_replace("/\|$/", "", $layout);
554     $cols= split("\|", $layout);
555     foreach ($cols as $index => $config) {
556       if ($config != "") {
557         $components= split(';', $config);
558         $config= "";
559         foreach ($components as $part) {
560           if (preg_match("/^r$/", $part)) {
561             $config.= "text-align:right;";
562             continue;
563           }
564           if (preg_match("/^l$/", $part)) {
565             $config.= "text-align:left;";
566             continue;
567           }
568           if (preg_match("/^c$/", $part)) {
569             $config.= "text-align:center;";
570             continue;
571           }
572           if (preg_match("/^[0-9]+(|px|%)$/", $part)) {
573             $config.= "width:$part;";
574             continue;
575           }
576         }
578         $result[$index]= " style='$config' ";
579       } else {
580         $result[$index]= null;
581       }
582     }
584     // Save number of columns for later use
585     $this->numColumns= count($cols);
587     return $result;
588   }
591   function renderCell($data, $config, $row)
592   {
593     // Replace flat attributes in data string
594     for ($i= 0; $i<$config['count']; $i++) {
595       $attr= $config[$i];
596       $value= "";
597       if (is_array($config[$attr])) {
598         $value= $config[$attr][0];
599       } else {
600         $value= $config[$attr];
601       }
602       $data= preg_replace("/%\{$attr\}/", $value, $data);
603     }
605     // Watch out for filters and prepare to execute them
606     $data= $this->processElementFilter($data, $config, $row);
608     // Replace all non replaced %{...} instances because they
609     // are non resolved attributes or filters
610     $data= preg_replace('/%{[^}]+}/', '&nbsp;', $data);
612     return $data;
613   }
616   function renderBase()
617   {
618     if (!$this->baseMode) {
619       return;
620     }
622     $result= "<select name='BASE' onChange='mainform.submit()' size='1'>";
623     $firstDN= null;
624     $found= false;
626     foreach ($this->bases as $key=>$value) {
627       // Keep first entry to fall back eventually
628       if(!$firstDN) {
629         $firstDN= $key;
630       }
632       // Prepare to render entry
633       $selected= "";
634       if ($key == $this->base) {
635         $selected= " selected";
636         $found= true;
637       }
638       $result.= "<option value='".$key."'$selected>".$value."</option>";
639     }
640     $result.= "</select>";
642     // Reset the currently used base to the first DN we found if there
643     // was no match.
644     if(!$found){
645       $this->base = $firstDN;
646     }
648     return $result;
649   }
652   function processElementFilter($data, $config, $row)
653   {
654     preg_match_all("/%\{filter:([^(]+)\((.*)\)\}/", $data, $matches, PREG_SET_ORDER);
656     foreach ($matches as $match) {
657       if (!isset($this->filters[$match[1]])) {
658         continue;
659       }
660       $cl= preg_replace('/::.*$/', '', $this->filters[$match[1]]);
661       $method= preg_replace('/^.*::/', '', $this->filters[$match[1]]);
663       // Prepare params for function call
664       $params= array();
665       preg_match_all('/"[^"]+"|[^,]+/', $match[2], $parts);
666       foreach ($parts[0] as $param) {
668         // Row is replaced by the row number
669         if ($param == "row") {
670           $params[]= $row;
671         }
673         // pid is replaced by the current PID
674         if ($param == "pid") {
675           $params[]= $this->pid;
676         }
678         // Fixie with "" is passed directly
679         if (preg_match('/^".*"$/', $param)){
680           $params[]= preg_replace('/"/', '', $param);
681         }
683         // LDAP variables get replaced by their objects
684         for ($i= 0; $i<$config['count']; $i++) {
685           if ($param == $config[$i]) {
686             $values= $config[$config[$i]];
687             if (is_array($values)){
688               unset($values['count']);
689             }
690             $params[]= $values;
691           }
692         }
694         // Move dn if needed
695         if ($param == "dn") {
696           $params[]= LDAP::fix($config["dn"]);
697         }
698       }
700       // Replace information
701       if ($cl == "listing") {
702         // Non static call - seems to result in errors
703         $data= @preg_replace('/'.preg_quote($match[0]).'/', call_user_func_array(array($this, "$method"), $params), $data);
704       } else {
705         // Static call
706         $data= preg_replace('/'.preg_quote($match[0]).'/', call_user_func_array(array($cl, $method), $params), $data);
707       }
708     }
710     return $data;
711   }
714   function getObjectType($types, $classes)
715   {
716     // Walk thru types and see if there's something matching
717     foreach ($types as $objectType) {
718       $ocs= $objectType['objectClass'];
719       if (!is_array($ocs)){
720         $ocs= array($ocs);
721       }
723       $found= true;
724       foreach ($ocs as $oc){
725         if (preg_match('/^!(.*)$/', $oc, $match)) {
726           $oc= $match[1];
727           if (in_array($oc, $classes)) {
728             $found= false;
729           }
730         } else {
731           if (!in_array($oc, $classes)) {
732             $found= false;
733           }
734         }
735       }
737       if ($found) {
738         return $objectType;
739       }
740     }
742     return null;
743   }
746   function filterObjectType($dn, $classes)
747   {
748     // Walk thru classes and return on first match
749     $result= "&nbsp;";
751     $objectType= $this->getObjectType($this->objectTypes, $classes);
752     if ($objectType) {
753       $result= "<img class='center' title='".LDAP::fix($dn)."' src='".$objectType["image"]."'>";
754       if (!isset($this->objectTypeCount[$objectType['label']])) {
755         $this->objectTypeCount[$objectType['label']]= 0;
756       }
757       $this->objectTypeCount[$objectType['label']]++;
758     }
759     return $result;
760   }
763   function filterActions($dn, $row, $classes)
764   {
765     // Do nothing if there's no menu defined
766     if (!isset($this->xmlData['actiontriggers']['action'])) {
767       return "&nbsp;";
768     }
770     // Go thru all actions
771     $result= "";
772     $actions= $this->xmlData['actiontriggers']['action'];
773     foreach($actions as $action) {
774       // Skip the entry completely if there's no permission to execute it
775       if (!$this->hasActionPermission($action, $dn)) {
776         $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
777         continue;
778       }
780       // Skip entry if the pseudo filter does not fit
781       if (isset($action['filter']) && preg_match('/^[a-z0-9_]+!?=[a-z0-9_]+$/i', $action['filter'])) {
782         list($fa, $fv)= split('=', $action['filter']);
783         if (preg_match('/^(.*)!$/', $fa, $m)){
784           $fa= $m[1];
785           if (isset($this->entries[$row][$fa]) && $this->entries[$row][$fa][0] == $fv) {
786             $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
787             continue;
788           }
789         } else {
790           if (!isset($this->entries[$row][$fa]) && !$this->entries[$row][$fa][0] == $fv) {
791             $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
792             continue;
793           }
794         }
795       }
798       // If there's an objectclass definition and we don't have it
799       // add an empty picture here.
800       if (isset($action['objectclass'])){
801         $objectclass= $action['objectclass'];
802         if (preg_match('/^!(.*)$/', $objectclass, $m)){
803           $objectclass= $m[1];
804           if(in_array($objectclass, $classes)) {
805             $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
806             continue;
807           }
808         } else {
809           if(!in_array($objectclass, $classes)) {
810             $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
811             continue;
812           }
813         }
814       }
816       // Render normal entries as usual
817       if ($action['type'] == "entry") {
818         $label= $this->processElementFilter($action['label'], $this->entries[$row], $row);
819         $image= $this->processElementFilter($action['image'], $this->entries[$row], $row);
820         $result.="<input class='center' type='image' src='$image' title='$label' ".
821                  "name='listing_".$action['name']."_$row' style='padding:1px'>";
822       }
824       // Handle special types
825       if ($action['type'] == "copypaste" || $action['type'] == "snapshot") {
827         $objectType= $this->getObjectType($this->objectTypes, $this->entries[$row]['objectClass']);
828         $category= $class= null;
829         if ($objectType) {
830           $category= $objectType['category'];
831           $class= $objectType['class'];
832         }
834         if ($action['type'] == "copypaste") {
835           $result.= $this->renderCopyPasteActions($row, $this->entries[$row]['dn'], $category, $class);
836         } else {
837           $result.= $this->renderSnapshotActions($row, $this->entries[$row]['dn'], $category, $class);
838         }
839       }
840     }
842     return $result;
843   }
846   function filterDepartmentLink($row, $dn, $description)
847   {
848     $attr= $this->departments[$row]['sort-attribute'];
849     $name= $this->departments[$row][$attr];
850     if (is_array($name)){
851       $name= $name[0];
852     }
853     $result= sprintf("%s [%s]", $name, $description[0]);
854     return("<a href='?plug=".$_GET['plug']."&amp;PID=$this->pid&amp;act=department_$row' title='$dn'>$result</a>");
855   }
858   function filterLink()
859   {
860     $result= "&nbsp;";
862     $row= func_get_arg(0);
863     $pid= $this->pid;
864     $dn= LDAP::fix(func_get_arg(1));
865     $params= array(func_get_arg(2));
867     // Collect sprintf params
868     for ($i = 3;$i < func_num_args();$i++) {
869       $val= func_get_arg($i);
870       if (is_array($val)){
871         $params[]= $val[0];
872         continue;
873       }
874       $params[]= $val;
875     }
877     $result= "&nbsp;";
878     $trans= call_user_func_array("sprintf", $params);
879     if ($trans != "") {
880       return("<a href='?plug=".$_GET['plug']."&amp;PID=$pid&amp;act=listing_edit_$row' title='$dn'>$trans</a>");
881     }
883     return $result;
884   }
887   function renderNavigation()
888   {
889     $result= array();
890     $enableBack = true;
891     $enableRoot = true;
892     $enableHome = true;
894     $ui = get_userinfo();
896     /* Check if base = first available base */
897     $deps = $ui->get_module_departments($this->module);
899     if(!count($deps) || $deps[0] == $this->filter->base){
900       $enableBack = false;
901       $enableRoot = false;
902     }
904     $listhead ="";
906     /* Check if we are in users home  department */
907     if(!count($deps) || $this->filter->base == $this->filter->getObjectBase($ui->dn)){
908       $enableHome = false;
909     }
911     /* Draw root button */
912     if($enableRoot){
913       $result["ROOT"]= "<input class='center' type='image' src='images/lists/root.png' align='middle' ".
914                        "title='"._("Go to root department")."' name='ROOT' alt='"._("Root")."'>";
915     }else{
916       $result["ROOT"]= "<img src='images/lists/root_grey.png' class='center' alt='"._("Root")."'>";
917     }
919     /* Draw back button */
920     if($enableBack){
921       $result["BACK"]= "<input class='center' type='image' align='middle' src='images/lists/back.png' ".
922                        "title='"._("Go up one department")."' alt='"._("Up")."' name='BACK'>";
923     }else{
924       $result["BACK"]= "<img src='images/lists/back_grey.png' class='center' alt='"._("Up")."'>";
925     }
927     /* Draw home button */
928     if($enableHome){
929       $result["HOME"]= "<input class='center' type='image' align='middle' src='images/lists/home.png' ".
930                        "title='"._("Go to users department")."' alt='"._("Home")."' name='HOME'>";
931     }else{
932       $result["HOME"]= "<img src='images/lists/home_grey.png' class='center' alt='"._("Home")."'>";
933     }
935     /* Draw reload button, this button is enabled everytime */
936     $result["RELOAD"]= "<input class='center' type='image' src='images/lists/reload.png' align='middle' ".
937                        "title='"._("Reload list")."' name='REFRESH' alt='"._("Submit")."'>";
939     return ($result);
940   }
943   function getAction()
944   {
945     // Do not do anything if this is not our PID, or there's even no PID available...
946     if(!isset($_REQUEST['PID']) || $_REQUEST['PID'] != $this->pid) {
947       return;
948     }
950     $result= array("targets" => array(), "action" => "");
952     // Filter GET with "act" attributes
953     if (isset($_GET['act'])) {
954       $key= validate($_GET['act']);
955       $target= preg_replace('/^listing_[a-zA-Z_]+_([0-9]+)$/', '$1', $key);
956       if (isset($this->entries[$target]['dn'])) {
957         $result['action']= preg_replace('/^listing_([a-zA-Z_]+)_[0-9]+$/', '$1', $key);
958         $result['targets'][]= $this->entries[$target]['dn'];
959       }
961       // Drop targets if empty
962       if (count($result['targets']) == 0) {
963         unset($result['targets']);
964       }
965       return $result;
966     }
968     // Filter POST with "listing_" attributes
969     foreach ($_POST as $key => $prop) {
971       // Capture selections
972       if (preg_match('/^listing_selected_[0-9]+$/', $key)) {
973         $target= preg_replace('/^listing_selected_([0-9]+)$/', '$1', $key);
974         if (isset($this->entries[$target]['dn'])) {
975           $result['targets'][]= $this->entries[$target]['dn'];
976         }
977         continue;
978       }
980       // Capture action with target - this is a one shot
981       if (preg_match('/^listing_[a-zA-Z_]+_[0-9]+(|_x)$/', $key)) {
982         $target= preg_replace('/^listing_[a-zA-Z_]+_([0-9]+)(|_x)$/', '$1', $key);
983         if (isset($this->entries[$target]['dn'])) {
984           $result['action']= preg_replace('/^listing_([a-zA-Z_]+)_[0-9]+(|_x)$/', '$1', $key);
985           $result['targets']= array($this->entries[$target]['dn']);
986         }
987         break;
988       }
990       // Capture action without target
991       if (preg_match('/^listing_[a-zA-Z_]+(|_x)$/', $key)) {
992         $result['action']= preg_replace('/^listing_([a-zA-Z_]+)(|_x)$/', '$1', $key);
993         continue;
994       }
995     }
997     // Filter POST with "act" attributes -> posted from action menu
998     if (isset($_POST['act']) && $_POST['act'] != '') {
999       if (!preg_match('/^export.*$/', $_POST['act'])){
1000         $result['action']= validate($_POST['act']);
1001       }
1002     }
1004     // Drop targets if empty
1005     if (count($result['targets']) == 0) {
1006       unset($result['targets']);
1007     }
1008     return $result;
1009   }
1012   function renderActionMenu()
1013   {
1014     // Don't send anything if the menu is not defined
1015     if (!isset($this->xmlData['actionmenu']['action'])){
1016       return "";
1017     }
1019     // Array?
1020     if (isset($this->xmlData['actionmenu']['action']['type'])){
1021       $this->xmlData['actionmenu']['action']= array($this->xmlData['actionmenu']['action']);
1022     }
1024     // Load shortcut
1025     $actions= &$this->xmlData['actionmenu']['action'];
1026     $result= "<input type='hidden' name='act' id='actionmenu' value=''><div style='display:none'><input type='submit' name='exec_act' id='exec_act' value=''></div>".
1027              "<ul class='level1' id='root'><li><a href='#'>Aktionen&nbsp;<img ".
1028              "border=0 class='center' src='images/lists/sort-down.png'></a>";
1030     // Build ul/li list
1031     $result.= $this->recurseActions($actions);
1033     return "<div id='pulldown'>".$result."</li></ul><div>";
1034   }
1037   function recurseActions($actions)
1038   {
1039     global $class_mapping;
1040     static $level= 2;
1041     $result= "<ul class='level$level'>";
1042     $separator= "";
1044     foreach ($actions as $action) {
1046       // Skip the entry completely if there's no permission to execute it
1047       if (!$this->hasActionPermission($action, $this->filter->base)) {
1048         continue;
1049       }
1051       // Skip entry if there're missing dependencies
1052       if (isset($action['depends'])) {
1053         $deps= is_array($action['depends'])?$action['depends']:array($action['depends']);
1054         foreach($deps as $clazz) {
1055           if (!isset($class_mapping[$clazz])){
1056             continue 2;
1057           }
1058         }
1059       }
1061       // Fill image if set
1062       $img= "";
1063       if (isset($action['image'])){
1064         $img= "<img border='0' class='center' src='".$action['image']."'>&nbsp;";
1065       }
1067       if ($action['type'] == "separator"){
1068         $separator= " style='border-top:1px solid #AAA' ";
1069         continue;
1070       }
1072       // Dive into subs
1073       if ($action['type'] == "sub" && isset($action['action'])) {
1074         $level++;
1075         if (isset($action['label'])){
1076           $result.= "<li$separator><a href='#'>$img"._($action['label'])."&nbsp;<img border='0' src='images/forward-arrow.png'></a>";
1077         }
1078         $result.= $this->recurseActions($action['action'])."</li>";
1079         $level--;
1080         $separator= "";
1081         continue;
1082       }
1084       // Render entry elseways
1085       if (isset($action['label'])){
1086         $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"".$action['name']."\";mainform.submit();'>$img"._($action['label'])."</a></li>";
1087       }
1089       // Check for special types
1090       switch ($action['type']) {
1091         case 'copypaste':
1092           $result.= $this->renderCopyPasteMenu($separator);
1093           break;
1095         case 'snapshot':
1096           $result.= $this->renderSnapshotMenu($separator);
1097           break;
1099         case 'exporter':
1100           $result.= $this->renderExporterMenu($separator);
1101           break;
1103         case 'daemon':
1104           $result.= $this->renderDaemonMenu($separator);
1105           break;
1106       }
1108       $separator= "";
1109     }
1111     $result.= "</ul>";
1112     return $result;
1113   }
1116   function hasActionPermission($action, $dn)
1117   {
1118     $ui= get_userinfo();
1120     if (isset($action['acl'])) {
1121       $acls= $action['acl'];
1122       if (!is_array($acls)) {
1123         $acls= array($acls);
1124       }
1126       // Every ACL has to pass
1127       foreach ($acls as $acl) {
1128         $module= $this->module;
1129         $aclList= array();
1131         // Split for category and plugins if needed
1132         // match for "[rw]" style entries
1133         if (preg_match('/^\[([rwcdm]+)\]$/', $acl, $match)){
1134           $aclList= array($match[1]);
1135         }
1137         // match for "users[rw]" style entries
1138         if (preg_match('/^([a-zA-Z0-9]+)\[([rwcdm]+)\]$/', $acl, $match)){
1139           $module= $match[1];
1140           $aclList= array($match[2]);
1141         }
1143         // match for "users/user[rw]" style entries
1144         if (preg_match('/^([a-zA-Z0-9]+\/[a-zA-Z0-9]+)\[([rwcdm]+)\]$/', $acl, $match)){
1145           $module= $match[1];
1146           $aclList= array($match[2]);
1147         }
1149         // match "users/user[userPassword:rw(,...)*]" style entries
1150         if (preg_match('/^([a-zA-Z0-9]+\/[a-zA-Z0-9]+)\[([a-zA-Z0-9]+:[rwcdm]+(,[a-zA-Z0-9]+:[rwcdm]+)*)\]$/', $acl, $match)){
1151           $module= $match[1];
1152           $aclList= split(',', $match[2]);
1153         }
1155         // Walk thru prepared ACL by using $module
1156         foreach($aclList as $sAcl) {
1157           $checkAcl= "";
1159           // Category or detailed permission?
1160           if (strpos('/', $module) === false) {
1161             if (preg_match('/([a-zA-Z0-9]+):([rwcdm]+)/', $sAcl, $m) ) {
1162               $checkAcl= $ui->get_permissions($dn, $module, $m[1]);
1163               $sAcl= $m[2];
1164             } else {
1165               $checkAcl= $ui->get_permissions($dn, $module, '0');
1166             }
1167           } else {
1168             $checkAcl= $ui->get_category_permissions($dn, $module);
1169           }
1171           // Split up remaining part of the acl and check if it we're
1172           // allowed to do something...
1173           $parts= str_split($sAcl);
1174           foreach ($parts as $part) {
1175             if (strpos($checkAcl, $part) === false){
1176               return false;
1177             }
1178           }
1180         }
1181       }
1182     }
1184     return true;
1185   }
1188   function refreshBasesList()
1189   {
1190     global $config;
1191     $ui= get_userinfo();
1193     // Do some array munching to get it user friendly
1194     $ids= $config->idepartments;
1195     $d= $ui->get_module_departments($this->module);
1196     $k_ids= array_keys($ids);
1197     $deps= array_intersect($d,$k_ids);
1199     // Fill internal bases list
1200     $this->bases= array();
1201     foreach($k_ids as $department){
1202       $this->bases[$department] = $ids[$department];
1203     }
1204   }
1207   function getDepartments()
1208   {
1209     $departments= array();
1210     $ui= get_userinfo();
1212     // Get list of supported department types
1213     $types = departmentManagement::get_support_departments();
1215     // Load departments allowed by ACL
1216     $validDepartments = $ui->get_module_departments($this->module);
1218     // Build filter and look in the LDAP for possible sub departments
1219     // of current base
1220     $filter= "(&(objectClass=gosaDepartment)(|";
1221     $attrs= array("description", "objectClass");
1222     foreach($types as $name => $data){
1223       $filter.= "(objectClass=".$data['OC'].")";
1224       $attrs[]= $data['ATTR'];
1225     }
1226     $filter.= "))";
1227     $res= get_list($filter, $this->module, $this->base, $attrs, GL_NONE);
1229     // Analyze list of departments
1230     foreach ($res as $department) {
1231       if (!in_array($department['dn'], $validDepartments)) {
1232         continue;
1233       }
1235       // Add the attribute where we use for sorting
1236       $oc= null;
1237       foreach(array_keys($types) as $type) {
1238         if (in_array($type, $department['objectClass'])) {
1239           $oc= $type;
1240           break;
1241         }
1242       }
1243       $department['sort-attribute']= $types[$oc]['ATTR'];
1245       // Move to the result list
1246       $departments[]= $department;
1247     }
1249     return $departments;
1250   }
1253   function renderCopyPasteMenu($separator, $copy= true, $cut= true)
1254   {
1255     // We can only provide information if we've got a copypaste handler
1256     // instance
1257     if(!(isset($this->copyPasteHandler) && is_object($this->copyPasteHandler))){
1258       return "";
1259     }
1261     // Presets
1262     $result= "";
1263     $read= $paste= false;
1264     $ui= get_userinfo();
1266     // Switch flags to on if there's at least one category which allows read/paste
1267     foreach($this->categories as $category){
1268       $read= $read || preg_match('/r/', $ui->get_category_permissions($this->base, $category));
1269       $paste= $paste || $ui->is_pasteable($this->base, $category) == 1;
1270     }
1273     // Draw entries that allow copy and cut
1274     if($read){
1276       // Copy entry
1277       if($copy){
1278         $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"copy\";document.getElementById(\"exec_act\").click();'><img src='images/lists/copy.png' alt='' border='0' class='center'>&nbsp;"._("Copy")."</a></li>";
1279         $separator= "";
1280       }
1282       // Cut entry
1283       if($cut){
1284         $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"cut\";document.getElementById(\"exec_act\").click();'><img src='images/lists/cut.png' alt='' border='0' class='center'>&nbsp;"._("Cut")."</a></li>";
1285         $separator= "";
1286       }
1287     }
1289     // Draw entries that allow pasting entries
1290     if($paste){
1291       if($this->copyPasteHandler->entries_queued()){
1292         $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"paste\";document.getElementById(\"exec_act\").click();'><img src='images/lists/paste.png' alt='' border='0' class='center'>&nbsp;"._("Paste")."</a></li>";
1293       }else{
1294         $result.= "<li$separator><a href='#'><img src='images/lists/paste-grey.png' alt='' border='0' class='center'>&nbsp;"._("Paste")."</a></li>";
1295       }
1296     }
1297     
1298     return($result);
1299   }
1302   function renderCopyPasteActions($row, $dn, $category, $class, $copy= true, $cut= true)
1303   {
1304     // We can only provide information if we've got a copypaste handler
1305     // instance
1306     if(!(isset($this->copyPasteHandler) && is_object($this->copyPasteHandler))){
1307       return "";
1308     }
1310     // Presets
1311     $ui = get_userinfo();
1312     $result = "";
1314     // Render cut entries
1315     if($cut){
1316       if($ui->is_cutable($dn, $category, $class)){
1317         $result .= "<input class='center' type='image'
1318           src='images/lists/cut.png' alt='"._("Cut")."' name='listing_cut_$row' title='"._("Cut this entry")."' style='padding:1px'>";
1319       }else{
1320         $result.="<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
1321       }
1322     }
1324     // Render copy entries
1325     if($copy){
1326       if($ui->is_copyable($dn, $category, $class)){
1327         $result.= "<input class='center' type='image'
1328           src='images/lists/copy.png' alt='"._("Copy")."' name='listing_copy_$row' title='"._("Copy this entry")."' style='padding:1px'>";
1329       }else{
1330         $result.="<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
1331       }
1332     }
1334     return($result);
1335   }
1338   function renderSnapshotMenu($separator)
1339   {
1340     // We can only provide information if we've got a snapshot handler
1341     // instance
1342     if(!(isset($this->snapshotHandler) && is_object($this->snapshotHandler))){
1343       return "";
1344     }
1346     // Presets
1347     $result = "";
1348     $ui = get_userinfo();
1350     if($this->snapshotHandler->enabled() && $ui->allow_snapshot_restore($this->base, $this->module)){
1352       // Check if there is something to restore
1353       $restore= false;
1354       foreach($this->snapshotHandler->getSnapshotBases() as $base){
1355         $restore= $restore || count($this->snapshotHandler->getDeletedSnapshots($base)) > 0;
1356       }
1358       // Draw icons according to the restore flag
1359       if($restore){
1360         $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"restore\";document.getElementById(\"exec_act\").click();'><img src='images/lists/restore.png' alt='' border='0' class='center'>&nbsp;"._("Restore snapshots")."</a></li>";
1361       }else{
1362         $result.= "<li$separator><a href='#'><img src='images/lists/restore_grey.png' alt='' border='0' class='center'>&nbsp;"._("Restore snapshots")."</a></li>";
1363       }
1364     }
1366     return($result);
1367   }
1370   function renderExporterMenu($separator)
1371   {
1372     // Presets
1373     $result = "";
1375     // Draw entries
1376     $result.= "<li$separator><a href='#'><img border='0' class='center' src='images/lists/export.png'>&nbsp;"._("Export list")."&nbsp;<img border='0' src='images/forward-arrow.png'></a><ul class='level3'>";
1378     // Export CVS as build in exporter
1379     foreach ($this->exporter as $action => $exporter) {
1380       $result.= "<li><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"$action\";document.getElementById(\"exec_act\").click();'><img border='0' class='center' src='".$exporter['image']."'>&nbsp;".$exporter['label']."</a></li>";
1381     }
1383     // Finalize list
1384     $result.= "</ul></li>";
1386     return($result);
1387   }
1390   function renderSnapshotActions($row, $dn, $category, $class, $copy= true, $cut= true)
1391   {
1392     // We can only provide information if we've got a snapshot handler
1393     // instance
1394     if(!(isset($this->snapshotHandler) && is_object($this->snapshotHandler))){
1395       return "";
1396     }
1398     // Presets
1399     $result= "";
1400     $ui = get_userinfo();
1402     // Only act if enabled here
1403     if($this->snapshotHandler->enabled()){
1405       // Draw restore button
1406       if ($ui->allow_snapshot_restore($dn, $category)){
1408         // Do we have snapshots for this dn?
1409         if($this->snapshotHandler->hasSnapshots($dn)){
1410           $result.= "<input class='center' type='image' src='images/lists/restore.png' ".
1411                      "alt='"._("Restore snapshot")."' name='listing_restore_$row' title='".
1412                      _("Restore snapshot")."' style='padding:1px'>";
1413         } else {
1414           $result.= "<img src='images/lists/restore_grey.png' alt=' ' class='center' style='padding:1px'>";
1415         }
1416       }
1418       // Draw snapshot button
1419       if($ui->allow_snapshot_create($dn, $category)){
1420           $result.= "<input class='center' type='image' src='images/snapshot.png' ".
1421                      "alt='"._("Create snapshot")."' name='listing_snapshot_$row' title='".
1422                      _("Create a new snapshot from this object")."' style='padding:1px'>";
1423       }else{
1424           $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
1425       }
1426     }
1428     return($result);
1429   }
1432   function renderDaemonMenu($separator)
1433   {
1434     $result= "";
1436     // If there is a daemon registered, draw the menu entries
1437     if(class_available("DaemonEvent")){
1438       $events= DaemonEvent::get_event_types_by_category($this->categories);
1439       if(isset($events['BY_CLASS']) && count($events['BY_CLASS'])){
1440         foreach($events['BY_CLASS'] as $name => $event){
1441           $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value=\"$name\";document.getElementById(\"exec_act\").click();'>".$event['MenuImage']."&nbsp;".$event['s_Menu_Name']."</a></li>";
1442           $separator= "";
1443         }
1444       }
1445     }
1447     return $result;
1448   }
1452 ?>