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 $objectDnMapping= array();
49 var $copyPasteHandler= null;
50 var $snapshotHandler= null;
51 var $exporter= array();
52 var $exportColumns= array();
53 var $useSpan= false;
54 var $height= 0;
57 function listing($filename)
58 {
59 global $config;
60 global $class_mapping;
62 // Initialize pid
63 $this->pid= preg_replace("/[^0-9]/", "", microtime(TRUE));
65 if (!$this->load($filename)) {
66 die("Cannot parse $filename!");
67 }
69 // Set base for filter
70 if ($this->baseMode) {
71 $this->base= session::global_get("CurrentMainBase");
72 if ($this->base == null) {
73 $this->base= $config->current['BASE'];
74 }
75 $this->refreshBasesList();
76 } else {
77 $this->base= $config->current['BASE'];
78 }
80 // Move footer information
81 $this->showFooter= ($config->get_cfg_value("listSummary") == "true");
83 // Register build in filters
84 $this->registerElementFilter("objectType", "listing::filterObjectType");
85 $this->registerElementFilter("departmentLink", "listing::filterDepartmentLink");
86 $this->registerElementFilter("link", "listing::filterLink");
87 $this->registerElementFilter("actions", "listing::filterActions");
89 // Load exporters
90 foreach($class_mapping as $class => $dummy) {
91 if (preg_match('/Exporter$/', $class)) {
92 $info= call_user_func(array($class, "getInfo"));
93 if ($info != null) {
94 $this->exporter= array_merge($this->exporter, $info);
95 }
96 }
97 }
98 }
101 function setCopyPasteHandler($handler)
102 {
103 $this->copyPasteHandler= &$handler;
104 }
107 function setHeight($height)
108 {
109 $this->height= $height;
110 }
113 function setSnapshotHandler($handler)
114 {
115 $this->snapshotHandler= &$handler;
116 }
119 function setFilter($filter)
120 {
121 $this->filter= &$filter;
122 if ($this->departmentBrowser){
123 $this->departments= $this->getDepartments();
124 }
125 $this->filter->setBase($this->base);
126 }
129 function registerElementFilter($name, $call)
130 {
131 if (!isset($this->filters[$name])) {
132 $this->filters[$name]= $call;
133 return true;
134 }
136 return false;
137 }
140 function load($filename)
141 {
142 $contents = file_get_contents($filename);
143 $this->xmlData= xml::xml2array($contents, 1);
145 if (!isset($this->xmlData['list'])) {
146 return false;
147 }
149 $this->xmlData= $this->xmlData["list"];
151 // Load some definition values
152 foreach (array("departmentBrowser", "departmentRootVisible", "multiSelect", "baseMode") as $token) {
153 if (isset($this->xmlData['definition'][$token]) &&
154 $this->xmlData['definition'][$token] == "true"){
155 $this->$token= true;
156 }
157 }
159 // Fill objectTypes from departments and xml definition
160 $types = departmentManagement::get_support_departments();
161 foreach ($types as $class => $data) {
162 $this->objectTypes[]= array("label" => $data['TITLE'],
163 "objectClass" => $data['OC'],
164 "image" => $data['IMG']);
165 }
166 $this->categories= array();
167 if (isset($this->xmlData['definition']['objectType'])) {
168 if(isset($this->xmlData['definition']['objectType']['label'])) {
169 $this->xmlData['definition']['objectType']= array($this->xmlData['definition']['objectType']);
170 }
171 foreach ($this->xmlData['definition']['objectType'] as $index => $otype) {
172 $this->objectTypes[]= $this->xmlData['definition']['objectType'][$index];
173 if (isset($this->xmlData['definition']['objectType'][$index]['category'])){
174 $this->categories[]= $this->xmlData['definition']['objectType'][$index]['category'];
175 }
176 }
177 }
179 // Parse layout per column
180 $this->colprops= $this->parseLayout($this->xmlData['table']['layout']);
182 // Prepare table headers
183 $this->renderHeader();
185 // Assign headline/module
186 $this->headline= _($this->xmlData['definition']['label']);
187 $this->module= $this->xmlData['definition']['module'];
188 if (!is_array($this->categories)){
189 $this->categories= array($this->categories);
190 }
192 // Evaluate columns to be exported
193 if (isset($this->xmlData['table']['column'])){
194 foreach ($this->xmlData['table']['column'] as $index => $config) {
195 if (isset($config['export']) && $config['export'] == "true"){
196 $this->exportColumns[]= $index;
197 }
198 }
199 }
201 return true;
202 }
205 function renderHeader()
206 {
207 $this->header= array();
208 $this->plainHeader= array();
210 // Initialize sort?
211 $sortInit= false;
212 if (!$this->sortDirection) {
213 $this->sortColumn= 0;
214 if (isset($this->xmlData['definition']['defaultSortColumn'])){
215 $this->sortColumn= $this->xmlData['definition']['defaultSortColumn'];
216 } else {
217 $this->sortAttribute= "";
218 }
219 $this->sortDirection= array();
220 $sortInit= true;
221 }
223 if (isset($this->xmlData['table']['column'])){
224 foreach ($this->xmlData['table']['column'] as $index => $config) {
225 // Initialize everything to one direction
226 if ($sortInit) {
227 $this->sortDirection[$index]= false;
228 }
230 $sorter= "";
231 if ($index == $this->sortColumn && isset($config['sortAttribute']) &&
232 isset($config['sortType'])) {
233 $this->sortAttribute= $config['sortAttribute'];
234 $this->sortType= $config['sortType'];
235 $sorter= " <img border='0' title='".($this->sortDirection[$index]?_("Up"):_("Down"))."' src='images/lists/sort-".($this->sortDirection[$index]?"up":"down").".png' align='top'>";
236 }
237 $sortable= (isset($config['sortAttribute']));
239 $link= "href='?plug=".$_GET['plug']."&PID=".$this->pid."&act=SORT_$index'";
240 if (isset($config['label'])) {
241 if ($sortable) {
242 $this->header[$index]= "<td class='listheader' ".$this->colprops[$index]."><a $link>"._($config['label'])."$sorter</a></td>";
243 } else {
244 $this->header[$index]= "<td class='listheader' ".$this->colprops[$index].">"._($config['label'])."</td>";
245 }
246 $this->plainHeader[]= _($config['label']);
247 } else {
248 if ($sortable) {
249 $this->header[$index]= "<td class='listheader' ".$this->colprops[$index]."><a $link> $sorter</a></td>";
250 } else {
251 $this->header[$index]= "<td class='listheader' ".$this->colprops[$index]."> </td>";
252 }
253 $this->plainHeader[]= "";
254 }
255 }
256 }
257 }
259 function render()
260 {
261 // Check for exeeded sizelimit
262 if (($message= check_sizelimit()) != ""){
263 return($message);
264 }
266 // Initialize list
267 $result= "<input type='hidden' value='$this->pid' name='PID'>\n";
268 $height= 450;
269 if ($this->height != 0) {
270 $result.= "<input type='hidden' value='$this->height' id='d_height'>\n";
271 $height= $this->height;
272 }
274 $result.= "<div class='contentboxb' id='listing_container' style='border-top:1px solid #B0B0B0;'>\n";
275 $result.= "<table summary='$this->headline' style='width:600px;height:".$height."px;' cellspacing='0' id='t_scrolltable'>
276 <tr><td class='scrollhead'><table summary='' style='width:100%;' cellspacing='0' id='t_scrollhead'>\n";
277 $this->numColumns= count($this->colprops) + ($this->multiSelect?1:0);
279 // Build list header
280 $result.= "<tr>\n";
281 if ($this->multiSelect) {
282 $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";
283 }
284 foreach ($this->header as $header) {
285 $result.= $header;
286 }
288 // Add 13px for scroller
289 $result.= "<td class='listheader' style='width:13px;border-right:0px;'> </td></table></td></tr>\n";
291 // New table for the real list contents
292 $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";
294 // No results? Just take an empty colspanned row
295 if (count($this->entries) + count($this->departments) == 0) {
296 $result.= "<tr class='rowxp0'><td class='list1nohighlight' colspan='$this->numColumns' style='height:100%;border-right:0px;width:100%;'> </td></tr>";
297 }
299 // Line color alternation
300 $alt= 0;
301 $deps= 0;
303 // Draw department browser if configured and we're not in sub mode
304 $this->useSpan= false;
305 if ($this->departmentBrowser && $this->filter->scope != "sub") {
306 // Fill with department browser if configured this way
307 $departmentIterator= new departmentSortIterator($this->departments, $this->sortDirection[$this->sortColumn]);
308 foreach ($departmentIterator as $row => $entry){
309 $result.="<tr class='rowxp".($alt&1)."'>";
311 // Render multi select if needed
312 if ($this->multiSelect) {
313 $result.="<td style='text-align:center;width:20px;' class='list1'> </td>";
314 }
316 // Render defined department columns, fill the rest with some stuff
317 $rest= $this->numColumns - 1;
318 foreach ($this->xmlData['table']['department'] as $index => $config) {
319 $colspan= 1;
320 if (isset($config['span'])){
321 $colspan= $config['span'];
322 $this->useSpan= true;
323 }
324 $result.="<td colspan='$colspan' ".$this->colprops[$index]." class='list1'>".$this->renderCell($config['value'], $entry, $row)."</td>";
325 $rest-= $colspan;
326 }
328 // Fill remaining cols with nothing
329 $last= $this->numColumns - $rest;
330 for ($i= 0; $i<$rest; $i++){
331 $result.= "<td ".$this->colprops[$last+$i-1]." class='list1'> </td>";
332 }
333 $result.="</tr>";
335 $alt++;
336 }
337 $deps= $alt;
338 }
340 // Fill with contents, sort as configured
341 foreach ($this->entries as $row => $entry) {
342 $trow= "";
344 // Render multi select if needed
345 if ($this->multiSelect) {
346 $trow.="<td style='text-align:center;width:20px;' class='list0'><input type='checkbox' id='listing_selected_$row' name='listing_selected_$row'></td>\n";
347 }
349 foreach ($this->xmlData['table']['column'] as $index => $config) {
350 $renderedCell= $this->renderCell($config['value'], $entry, $row);
351 $trow.="<td ".$this->colprops[$index]." class='list0'>".$renderedCell."</td>\n";
353 // Save rendered column
354 $sort= preg_replace('/.*>([^<]+)<.*$/', '$1', $renderedCell);
355 $sort= preg_replace('/ /', '', $sort);
356 if (preg_match('/</', $sort)){
357 $sort= "";
358 }
359 $this->entries[$row]["_sort$index"]= $sort;
360 }
362 // Save rendered entry
363 $this->entries[$row]['_rendered']= $trow;
364 }
366 // Complete list by sorting entries for _sort$index and appending them to the output
367 $entryIterator= new listingSortIterator($this->entries, $this->sortDirection[$this->sortColumn], "_sort".$this->sortColumn, $this->sortType);
368 foreach ($entryIterator as $row => $entry){
369 $alt++;
370 $result.="<tr class='rowxp".($alt&1)."'>\n";
371 $result.= $entry['_rendered'];
372 $result.="</tr>\n";
373 }
375 // Need to fill the list if it's not full (nobody knows why this is 22 ;-))
376 $emptyListStyle= (count($this->entries) + (($this->useSpan && count($this->entries))?$deps:0) == 0)?"border:0;":"";
377 if ((count($this->entries) + $deps) < 22) {
378 $result.= "<tr>";
379 for ($i= 0; $i<$this->numColumns; $i++) {
380 if ($i == 0) {
381 $result.= "<td class='list1nohighlight' style='$emptyListStyle height:100%;'> </td>";
382 continue;
383 }
384 if ($i != $this->numColumns-1) {
385 $result.= "<td class='list1nohighlight' style='$emptyListStyle'> </td>";
386 } else {
387 $result.= "<td class='list1nohighlight' style='border-right:1px solid #AAA;$emptyListStyle'> </td>";
388 }
389 }
390 $result.= "</tr>";
391 }
393 $result.= "</table></div></td></tr>";
395 // Add the footer if requested
396 if ($this->showFooter) {
397 $result.= "<tr><td class='scrollhead'><table summary='' style='width:100%' cellspacing='0' id='t_scrollfoot'><tr><td class='listfooter' style='border-bottom:0px;'>";
399 foreach ($this->objectTypes as $objectType) {
400 if (isset($this->objectTypeCount[$objectType['label']])) {
401 $label= _($objectType['label']);
402 $result.= "<img class='center' src='".$objectType['image']."' title='$label' alt='$label'> ".$this->objectTypeCount[$objectType['label']]." ";
403 }
404 }
406 $result.= "<td class='listfooter' style='width:13px;border-right:0px;'> </td></table></td></tr>";
407 }
409 $result.= "</table></div>";
411 $smarty= get_smarty();
412 $smarty->assign("usePrototype", "true");
413 $smarty->assign("FILTER", $this->filter->render());
414 $smarty->assign("SIZELIMIT", print_sizelimit_warning());
415 $smarty->assign("LIST", $result);
417 // Assign navigation elements
418 $nav= $this->renderNavigation();
419 foreach ($nav as $key => $html) {
420 $smarty->assign($key, $html);
421 }
423 // Assign action menu / base
424 $smarty->assign("ACTIONS", $this->renderActionMenu());
425 $smarty->assign("BASE", $this->renderBase());
427 // Assign separator
428 $smarty->assign("SEPARATOR", "<img src='images/lists/seperator.png' alt='-' align='middle' height='16' width='1' class='center'>");
430 // Assign summary
431 $smarty->assign("HEADLINE", $this->headline);
433 return ($smarty->fetch(get_template_path($this->xmlData['definition']['template'], true)));
434 }
437 function update()
438 {
439 global $config;
440 $ui= get_userinfo();
442 // Reset object counter / DN mapping
443 $this->objectTypeCount= array();
444 $this->objectDnMapping= array();
446 // Do not do anything if this is not our PID
447 if(isset($_REQUEST['PID']) && $_REQUEST['PID'] != $this->pid) {
448 return;
449 }
451 // Save base
452 if (isset($_POST['BASE']) && $this->baseMode) {
453 $base= validate($_POST['BASE']);
454 if (isset($this->bases[$base])) {
455 $this->base= $base;
456 session::global_set("CurrentMainBase", $this->base);
457 }
458 }
460 // Override the base if we got a message from the browser navigation
461 if ($this->departmentBrowser && isset($_GET['act'])) {
462 if (preg_match('/^department_([0-9]+)$/', validate($_GET['act']), $match)){
463 if (isset($this->departments[$match[1]])){
464 $this->base= $this->departments[$match[1]]['dn'];
465 }
466 }
467 }
469 // Filter POST with "act" attributes -> posted from action menu
470 if (isset($_POST['exec_act']) && $_POST['act'] != '') {
471 if (preg_match('/^export.*$/', $_POST['act']) && isset($this->exporter[$_POST['act']])) {
472 $exporter= $this->exporter[$_POST['act']];
473 $userinfo= ", "._("created by")." ".$ui->cn." - ".strftime('%A, %d. %B %Y, %H:%M:%S');
474 $entryIterator= new listingSortIterator($this->entries, $this->sortDirection[$this->sortColumn], "_sort".$this->sortColumn, $this->sortType);
475 $sortedEntries= array();
476 foreach ($entryIterator as $entry){
477 $sortedEntries[]= $entry;
478 }
479 $instance= new $exporter['class']($this->headline.$userinfo, $this->plainHeader, $sortedEntries, $this->exportColumns);
480 $type= call_user_func(array($exporter['class'], "getInfo"));
481 $type= $type[$_POST['act']];
482 send_binary_content($instance->query(), $type['filename'], $type= $type['mime']);
483 }
484 }
486 // Filter GET with "act" attributes
487 if (isset($_GET['act'])) {
488 $key= validate($_GET['act']);
489 if (preg_match('/^SORT_([0-9]+)$/', $key, $match)) {
490 // Switch to new column or invert search order?
491 $column= $match[1];
492 if ($this->sortColumn != $column) {
493 $this->sortColumn= $column;
494 } else {
495 $this->sortDirection[$column]= !$this->sortDirection[$column];
496 }
498 // Allow header to update itself according to the new sort settings
499 $this->renderHeader();
500 }
501 }
503 // Override base if we got signals from the navigation elements
504 $action= "";
505 foreach ($_POST as $key => $value) {
506 if (preg_match('/^(ROOT|BACK|HOME)_x$/', $key, $match)) {
507 $action= $match[1];
508 break;
509 }
510 }
512 // Navigation handling
513 if ($action == 'ROOT') {
514 $deps= $ui->get_module_departments($this->module);
515 $this->base= $deps[0];
516 }
517 if ($action == 'BACK') {
518 $deps= $ui->get_module_departments($this->module);
519 $base= preg_replace("/^[^,]+,/", "", $this->base);
520 if(in_array_ics($base, $deps)){
521 $this->base= $base;
522 }
523 }
524 if ($action == 'HOME') {
525 $ui= get_userinfo();
526 $this->base= $this->filter->getObjectBase($ui->dn);
527 }
529 // Reload departments
530 if ($this->departmentBrowser){
531 $this->departments= $this->getDepartments();
532 }
534 // Update filter and refresh entries
535 $this->filter->setBase($this->base);
536 $this->entries= $this->filter->query();
537 }
540 function setBase($base)
541 {
542 $this->base= $base;
543 }
546 function getBase()
547 {
548 return $this->base;
549 }
552 function parseLayout($layout)
553 {
554 $result= array();
555 $layout= preg_replace("/^\|/", "", $layout);
556 $layout= preg_replace("/\|$/", "", $layout);
557 $cols= split("\|", $layout);
558 foreach ($cols as $index => $config) {
559 if ($config != "") {
560 $components= split(';', $config);
561 $config= "";
562 foreach ($components as $part) {
563 if (preg_match("/^r$/", $part)) {
564 $config.= "text-align:right;";
565 continue;
566 }
567 if (preg_match("/^l$/", $part)) {
568 $config.= "text-align:left;";
569 continue;
570 }
571 if (preg_match("/^c$/", $part)) {
572 $config.= "text-align:center;";
573 continue;
574 }
575 if (preg_match("/^[0-9]+(|px|%)$/", $part)) {
576 $config.= "width:$part;";
577 continue;
578 }
579 }
581 $result[$index]= " style='$config' ";
582 } else {
583 $result[$index]= null;
584 }
585 }
587 // Save number of columns for later use
588 $this->numColumns= count($cols);
590 return $result;
591 }
594 function renderCell($data, $config, $row)
595 {
596 // Replace flat attributes in data string
597 for ($i= 0; $i<$config['count']; $i++) {
598 $attr= $config[$i];
599 $value= "";
600 if (is_array($config[$attr])) {
601 $value= $config[$attr][0];
602 } else {
603 $value= $config[$attr];
604 }
605 $data= preg_replace("/%\{$attr\}/", $value, $data);
606 }
608 // Watch out for filters and prepare to execute them
609 $data= $this->processElementFilter($data, $config, $row);
611 // Replace all non replaced %{...} instances because they
612 // are non resolved attributes or filters
613 $data= preg_replace('/%{[^}]+}/', ' ', $data);
615 return $data;
616 }
619 function renderBase()
620 {
621 if (!$this->baseMode) {
622 return;
623 }
625 $result= "<select name='BASE' onChange='mainform.submit()' size='1'>";
626 $firstDN= null;
627 $found= false;
629 foreach ($this->bases as $key=>$value) {
630 // Keep first entry to fall back eventually
631 if(!$firstDN) {
632 $firstDN= $key;
633 }
635 // Prepare to render entry
636 $selected= "";
637 if ($key == $this->base) {
638 $selected= " selected";
639 $found= true;
640 }
641 $result.= "<option value='".$key."'$selected>".$value."</option>";
642 }
643 $result.= "</select>";
645 // Reset the currently used base to the first DN we found if there
646 // was no match.
647 if(!$found){
648 $this->base = $firstDN;
649 }
651 return $result;
652 }
655 function processElementFilter($data, $config, $row)
656 {
657 preg_match_all("/%\{filter:([^(]+)\((.*)\)\}/", $data, $matches, PREG_SET_ORDER);
659 foreach ($matches as $match) {
660 if (!isset($this->filters[$match[1]])) {
661 continue;
662 }
663 $cl= preg_replace('/::.*$/', '', $this->filters[$match[1]]);
664 $method= preg_replace('/^.*::/', '', $this->filters[$match[1]]);
666 // Prepare params for function call
667 $params= array();
668 preg_match_all('/"[^"]+"|[^,]+/', $match[2], $parts);
669 foreach ($parts[0] as $param) {
671 // Row is replaced by the row number
672 if ($param == "row") {
673 $params[]= $row;
674 }
676 // pid is replaced by the current PID
677 if ($param == "pid") {
678 $params[]= $this->pid;
679 }
681 // Fixie with "" is passed directly
682 if (preg_match('/^".*"$/', $param)){
683 $params[]= preg_replace('/"/', '', $param);
684 }
686 // LDAP variables get replaced by their objects
687 for ($i= 0; $i<$config['count']; $i++) {
688 if ($param == $config[$i]) {
689 $values= $config[$config[$i]];
690 if (is_array($values)){
691 unset($values['count']);
692 }
693 $params[]= $values;
694 }
695 }
697 // Move dn if needed
698 if ($param == "dn") {
699 $params[]= LDAP::fix($config["dn"]);
700 }
701 }
703 // Replace information
704 if ($cl == "listing") {
705 // Non static call - seems to result in errors
706 $data= @preg_replace('/'.preg_quote($match[0]).'/', call_user_func_array(array($this, "$method"), $params), $data);
707 } else {
708 // Static call
709 $data= preg_replace('/'.preg_quote($match[0]).'/', call_user_func_array(array($cl, $method), $params), $data);
710 }
711 }
713 return $data;
714 }
717 function getObjectType($types, $classes)
718 {
719 // Walk thru types and see if there's something matching
720 foreach ($types as $objectType) {
721 $ocs= $objectType['objectClass'];
722 if (!is_array($ocs)){
723 $ocs= array($ocs);
724 }
726 $found= true;
727 foreach ($ocs as $oc){
728 if (preg_match('/^!(.*)$/', $oc, $match)) {
729 $oc= $match[1];
730 if (in_array($oc, $classes)) {
731 $found= false;
732 }
733 } else {
734 if (!in_array($oc, $classes)) {
735 $found= false;
736 }
737 }
738 }
740 if ($found) {
741 return $objectType;
742 }
743 }
745 return null;
746 }
749 function filterObjectType($dn, $classes)
750 {
751 // Walk thru classes and return on first match
752 $result= " ";
754 $objectType= $this->getObjectType($this->objectTypes, $classes);
755 if ($objectType) {
756 $this->objectDnMapping[$dn]= $objectType["objectClass"];
757 $result= "<img class='center' title='".LDAP::fix($dn)."' src='".$objectType["image"]."'>";
758 if (!isset($this->objectTypeCount[$objectType['label']])) {
759 $this->objectTypeCount[$objectType['label']]= 0;
760 }
761 $this->objectTypeCount[$objectType['label']]++;
762 }
764 return $result;
765 }
768 function filterActions($dn, $row, $classes)
769 {
770 // Do nothing if there's no menu defined
771 if (!isset($this->xmlData['actiontriggers']['action'])) {
772 return " ";
773 }
775 // Go thru all actions
776 $result= "";
777 $actions= $this->xmlData['actiontriggers']['action'];
778 foreach($actions as $action) {
779 // Skip the entry completely if there's no permission to execute it
780 if (!$this->hasActionPermission($action, $dn)) {
781 $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
782 continue;
783 }
785 // Skip entry if the pseudo filter does not fit
786 if (isset($action['filter']) && preg_match('/^[a-z0-9_]+!?=[a-z0-9_]+$/i', $action['filter'])) {
787 list($fa, $fv)= split('=', $action['filter']);
788 if (preg_match('/^(.*)!$/', $fa, $m)){
789 $fa= $m[1];
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 } else {
795 if (!isset($this->entries[$row][$fa]) && !$this->entries[$row][$fa][0] == $fv) {
796 $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
797 continue;
798 }
799 }
800 }
803 // If there's an objectclass definition and we don't have it
804 // add an empty picture here.
805 if (isset($action['objectclass'])){
806 $objectclass= $action['objectclass'];
807 if (preg_match('/^!(.*)$/', $objectclass, $m)){
808 $objectclass= $m[1];
809 if(in_array($objectclass, $classes)) {
810 $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
811 continue;
812 }
813 } else {
814 if(!in_array($objectclass, $classes)) {
815 $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
816 continue;
817 }
818 }
819 }
821 // Render normal entries as usual
822 if ($action['type'] == "entry") {
823 $label= $this->processElementFilter($action['label'], $this->entries[$row], $row);
824 $image= $this->processElementFilter($action['image'], $this->entries[$row], $row);
825 $result.="<input class='center' type='image' src='$image' title='$label' ".
826 "name='listing_".$action['name']."_$row' style='padding:1px'>";
827 }
829 // Handle special types
830 if ($action['type'] == "copypaste" || $action['type'] == "snapshot") {
832 $objectType= $this->getObjectType($this->objectTypes, $this->entries[$row]['objectClass']);
833 $category= $class= null;
834 if ($objectType) {
835 $category= $objectType['category'];
836 $class= $objectType['class'];
837 }
839 if ($action['type'] == "copypaste") {
840 $result.= $this->renderCopyPasteActions($row, $this->entries[$row]['dn'], $category, $class);
841 } else {
842 $result.= $this->renderSnapshotActions($row, $this->entries[$row]['dn'], $category, $class);
843 }
844 }
845 }
847 return $result;
848 }
851 function filterDepartmentLink($row, $dn, $description)
852 {
853 $attr= $this->departments[$row]['sort-attribute'];
854 $name= $this->departments[$row][$attr];
855 if (is_array($name)){
856 $name= $name[0];
857 }
858 $result= sprintf("%s [%s]", $name, $description[0]);
859 return("<a href='?plug=".$_GET['plug']."&PID=$this->pid&act=department_$row' title='$dn'>$result</a>");
860 }
863 function filterLink()
864 {
865 $result= " ";
867 $row= func_get_arg(0);
868 $pid= $this->pid;
869 $dn= LDAP::fix(func_get_arg(1));
870 $params= array(func_get_arg(2));
872 // Collect sprintf params
873 for ($i = 3;$i < func_num_args();$i++) {
874 $val= func_get_arg($i);
875 if (is_array($val)){
876 $params[]= $val[0];
877 continue;
878 }
879 $params[]= $val;
880 }
882 $result= " ";
883 $trans= call_user_func_array("sprintf", $params);
884 if ($trans != "") {
885 return("<a href='?plug=".$_GET['plug']."&PID=$pid&act=listing_edit_$row' title='$dn'>$trans</a>");
886 }
888 return $result;
889 }
892 function renderNavigation()
893 {
894 $result= array();
895 $enableBack = true;
896 $enableRoot = true;
897 $enableHome = true;
899 $ui = get_userinfo();
901 /* Check if base = first available base */
902 $deps = $ui->get_module_departments($this->module);
904 if(!count($deps) || $deps[0] == $this->filter->base){
905 $enableBack = false;
906 $enableRoot = false;
907 }
909 $listhead ="";
911 /* Check if we are in users home department */
912 if(!count($deps) || $this->filter->base == $this->filter->getObjectBase($ui->dn)){
913 $enableHome = false;
914 }
916 /* Draw root button */
917 if($enableRoot){
918 $result["ROOT"]= "<input class='center' type='image' src='images/lists/root.png' align='middle' ".
919 "title='"._("Go to root department")."' name='ROOT' alt='"._("Root")."'>";
920 }else{
921 $result["ROOT"]= "<img src='images/lists/root_grey.png' class='center' alt='"._("Root")."'>";
922 }
924 /* Draw back button */
925 if($enableBack){
926 $result["BACK"]= "<input class='center' type='image' align='middle' src='images/lists/back.png' ".
927 "title='"._("Go up one department")."' alt='"._("Up")."' name='BACK'>";
928 }else{
929 $result["BACK"]= "<img src='images/lists/back_grey.png' class='center' alt='"._("Up")."'>";
930 }
932 /* Draw home button */
933 if($enableHome){
934 $result["HOME"]= "<input class='center' type='image' align='middle' src='images/lists/home.png' ".
935 "title='"._("Go to users department")."' alt='"._("Home")."' name='HOME'>";
936 }else{
937 $result["HOME"]= "<img src='images/lists/home_grey.png' class='center' alt='"._("Home")."'>";
938 }
940 /* Draw reload button, this button is enabled everytime */
941 $result["RELOAD"]= "<input class='center' type='image' src='images/lists/reload.png' align='middle' ".
942 "title='"._("Reload list")."' name='REFRESH' alt='"._("Submit")."'>";
944 return ($result);
945 }
948 function getAction()
949 {
950 // Do not do anything if this is not our PID, or there's even no PID available...
951 if(!isset($_REQUEST['PID']) || $_REQUEST['PID'] != $this->pid) {
952 return;
953 }
955 $result= array("targets" => array(), "action" => "");
957 // Filter GET with "act" attributes
958 if (isset($_GET['act'])) {
959 $key= validate($_GET['act']);
960 $target= preg_replace('/^listing_[a-zA-Z_]+_([0-9]+)$/', '$1', $key);
961 if (isset($this->entries[$target]['dn'])) {
962 $result['action']= preg_replace('/^listing_([a-zA-Z_]+)_[0-9]+$/', '$1', $key);
963 $result['targets'][]= $this->entries[$target]['dn'];
964 }
966 // Drop targets if empty
967 if (count($result['targets']) == 0) {
968 unset($result['targets']);
969 }
970 return $result;
971 }
973 // Filter POST with "listing_" attributes
974 foreach ($_POST as $key => $prop) {
976 // Capture selections
977 if (preg_match('/^listing_selected_[0-9]+$/', $key)) {
978 $target= preg_replace('/^listing_selected_([0-9]+)$/', '$1', $key);
979 if (isset($this->entries[$target]['dn'])) {
980 $result['targets'][]= $this->entries[$target]['dn'];
981 }
982 continue;
983 }
985 // Capture action with target - this is a one shot
986 if (preg_match('/^listing_[a-zA-Z_]+_[0-9]+(|_x)$/', $key)) {
987 $target= preg_replace('/^listing_[a-zA-Z_]+_([0-9]+)(|_x)$/', '$1', $key);
988 if (isset($this->entries[$target]['dn'])) {
989 $result['action']= preg_replace('/^listing_([a-zA-Z_]+)_[0-9]+(|_x)$/', '$1', $key);
990 $result['targets']= array($this->entries[$target]['dn']);
991 }
992 break;
993 }
995 // Capture action without target
996 if (preg_match('/^listing_[a-zA-Z_]+(|_x)$/', $key)) {
997 $result['action']= preg_replace('/^listing_([a-zA-Z_]+)(|_x)$/', '$1', $key);
998 continue;
999 }
1000 }
1002 // Filter POST with "act" attributes -> posted from action menu
1003 if (isset($_POST['act']) && $_POST['act'] != '') {
1004 if (!preg_match('/^export.*$/', $_POST['act'])){
1005 $result['action']= validate($_POST['act']);
1006 }
1007 }
1009 // Drop targets if empty
1010 if (count($result['targets']) == 0) {
1011 unset($result['targets']);
1012 }
1013 return $result;
1014 }
1017 function renderActionMenu()
1018 {
1019 // Don't send anything if the menu is not defined
1020 if (!isset($this->xmlData['actionmenu']['action'])){
1021 return "";
1022 }
1024 // Array?
1025 if (isset($this->xmlData['actionmenu']['action']['type'])){
1026 $this->xmlData['actionmenu']['action']= array($this->xmlData['actionmenu']['action']);
1027 }
1029 // Load shortcut
1030 $actions= &$this->xmlData['actionmenu']['action'];
1031 $result= "<input type='hidden' name='act' id='actionmenu' value=''><div style='display:none'><input type='submit' name='exec_act' id='exec_act' value=''></div>".
1032 "<ul class='level1' id='root'><li><a href='#'>"._("Actions")." <img ".
1033 "border=0 class='center' src='images/lists/sort-down.png'></a>";
1035 // Build ul/li list
1036 $result.= $this->recurseActions($actions);
1038 return "<div id='pulldown'>".$result."</li></ul><div>";
1039 }
1042 function recurseActions($actions)
1043 {
1044 global $class_mapping;
1045 static $level= 2;
1046 $result= "<ul class='level$level'>";
1047 $separator= "";
1049 foreach ($actions as $action) {
1051 // Skip the entry completely if there's no permission to execute it
1052 if (!$this->hasActionPermission($action, $this->filter->base)) {
1053 continue;
1054 }
1056 // Skip entry if there're missing dependencies
1057 if (isset($action['depends'])) {
1058 $deps= is_array($action['depends'])?$action['depends']:array($action['depends']);
1059 foreach($deps as $clazz) {
1060 if (!isset($class_mapping[$clazz])){
1061 continue 2;
1062 }
1063 }
1064 }
1066 // Fill image if set
1067 $img= "";
1068 if (isset($action['image'])){
1069 $img= "<img border='0' class='center' src='".$action['image']."'> ";
1070 }
1072 if ($action['type'] == "separator"){
1073 $separator= " style='border-top:1px solid #AAA' ";
1074 continue;
1075 }
1077 // Dive into subs
1078 if ($action['type'] == "sub" && isset($action['action'])) {
1079 $level++;
1080 if (isset($action['label'])){
1081 $result.= "<li$separator><a href='#'>$img"._($action['label'])." <img border='0' src='images/forward-arrow.png'></a>";
1082 }
1083 $result.= $this->recurseActions($action['action'])."</li>";
1084 $level--;
1085 $separator= "";
1086 continue;
1087 }
1089 // Render entry elseways
1090 if (isset($action['label'])){
1091 $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"".$action['name']."\";mainform.submit();'>$img"._($action['label'])."</a></li>";
1092 }
1094 // Check for special types
1095 switch ($action['type']) {
1096 case 'copypaste':
1097 $result.= $this->renderCopyPasteMenu($separator);
1098 break;
1100 case 'snapshot':
1101 $result.= $this->renderSnapshotMenu($separator);
1102 break;
1104 case 'exporter':
1105 $result.= $this->renderExporterMenu($separator);
1106 break;
1108 case 'daemon':
1109 $result.= $this->renderDaemonMenu($separator);
1110 break;
1111 }
1113 $separator= "";
1114 }
1116 $result.= "</ul>";
1117 return $result;
1118 }
1121 function hasActionPermission($action, $dn)
1122 {
1123 $ui= get_userinfo();
1125 if (isset($action['acl'])) {
1126 $acls= $action['acl'];
1127 if (!is_array($acls)) {
1128 $acls= array($acls);
1129 }
1131 // Every ACL has to pass
1132 foreach ($acls as $acl) {
1133 $module= $this->module;
1134 $aclList= array();
1136 // Split for category and plugins if needed
1137 // match for "[rw]" style entries
1138 if (preg_match('/^\[([rwcdm]+)\]$/', $acl, $match)){
1139 $aclList= array($match[1]);
1140 }
1142 // match for "users[rw]" style entries
1143 if (preg_match('/^([a-zA-Z0-9]+)\[([rwcdm]+)\]$/', $acl, $match)){
1144 $module= $match[1];
1145 $aclList= array($match[2]);
1146 }
1148 // match for "users/user[rw]" style entries
1149 if (preg_match('/^([a-zA-Z0-9]+\/[a-zA-Z0-9]+)\[([rwcdm]+)\]$/', $acl, $match)){
1150 $module= $match[1];
1151 $aclList= array($match[2]);
1152 }
1154 // match "users/user[userPassword:rw(,...)*]" style entries
1155 if (preg_match('/^([a-zA-Z0-9]+\/[a-zA-Z0-9]+)\[([a-zA-Z0-9]+:[rwcdm]+(,[a-zA-Z0-9]+:[rwcdm]+)*)\]$/', $acl, $match)){
1156 $module= $match[1];
1157 $aclList= split(',', $match[2]);
1158 }
1160 // Walk thru prepared ACL by using $module
1161 foreach($aclList as $sAcl) {
1162 $checkAcl= "";
1164 // Category or detailed permission?
1165 if (strpos('/', $module) === false) {
1166 if (preg_match('/([a-zA-Z0-9]+):([rwcdm]+)/', $sAcl, $m) ) {
1167 $checkAcl= $ui->get_permissions($dn, $module, $m[1]);
1168 $sAcl= $m[2];
1169 } else {
1170 $checkAcl= $ui->get_permissions($dn, $module, '0');
1171 }
1172 } else {
1173 $checkAcl= $ui->get_category_permissions($dn, $module);
1174 }
1176 // Split up remaining part of the acl and check if it we're
1177 // allowed to do something...
1178 $parts= str_split($sAcl);
1179 foreach ($parts as $part) {
1180 if (strpos($checkAcl, $part) === false){
1181 return false;
1182 }
1183 }
1185 }
1186 }
1187 }
1189 return true;
1190 }
1193 function refreshBasesList()
1194 {
1195 global $config;
1196 $ui= get_userinfo();
1198 // Do some array munching to get it user friendly
1199 $ids= $config->idepartments;
1200 $d= $ui->get_module_departments($this->module);
1201 $k_ids= array_keys($ids);
1202 $deps= array_intersect($d,$k_ids);
1204 // Fill internal bases list
1205 $this->bases= array();
1206 foreach($k_ids as $department){
1207 $this->bases[$department] = $ids[$department];
1208 }
1209 }
1212 function getDepartments()
1213 {
1214 $departments= array();
1215 $ui= get_userinfo();
1217 // Get list of supported department types
1218 $types = departmentManagement::get_support_departments();
1220 // Load departments allowed by ACL
1221 $validDepartments = $ui->get_module_departments($this->module);
1223 // Build filter and look in the LDAP for possible sub departments
1224 // of current base
1225 $filter= "(&(objectClass=gosaDepartment)(|";
1226 $attrs= array("description", "objectClass");
1227 foreach($types as $name => $data){
1228 $filter.= "(objectClass=".$data['OC'].")";
1229 $attrs[]= $data['ATTR'];
1230 }
1231 $filter.= "))";
1232 $res= get_list($filter, $this->module, $this->base, $attrs, GL_NONE);
1234 // Analyze list of departments
1235 foreach ($res as $department) {
1236 if (!in_array($department['dn'], $validDepartments)) {
1237 continue;
1238 }
1240 // Add the attribute where we use for sorting
1241 $oc= null;
1242 foreach(array_keys($types) as $type) {
1243 if (in_array($type, $department['objectClass'])) {
1244 $oc= $type;
1245 break;
1246 }
1247 }
1248 $department['sort-attribute']= $types[$oc]['ATTR'];
1250 // Move to the result list
1251 $departments[]= $department;
1252 }
1254 return $departments;
1255 }
1258 function renderCopyPasteMenu($separator, $copy= true, $cut= true)
1259 {
1260 // We can only provide information if we've got a copypaste handler
1261 // instance
1262 if(!(isset($this->copyPasteHandler) && is_object($this->copyPasteHandler))){
1263 return "";
1264 }
1266 // Presets
1267 $result= "";
1268 $read= $paste= false;
1269 $ui= get_userinfo();
1271 // Switch flags to on if there's at least one category which allows read/paste
1272 foreach($this->categories as $category){
1273 $read= $read || preg_match('/r/', $ui->get_category_permissions($this->base, $category));
1274 $paste= $paste || $ui->is_pasteable($this->base, $category) == 1;
1275 }
1278 // Draw entries that allow copy and cut
1279 if($read){
1281 // Copy entry
1282 if($copy){
1283 $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'> "._("Copy")."</a></li>";
1284 $separator= "";
1285 }
1287 // Cut entry
1288 if($cut){
1289 $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'> "._("Cut")."</a></li>";
1290 $separator= "";
1291 }
1292 }
1294 // Draw entries that allow pasting entries
1295 if($paste){
1296 if($this->copyPasteHandler->entries_queued()){
1297 $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'> "._("Paste")."</a></li>";
1298 }else{
1299 $result.= "<li$separator><a href='#'><img src='images/lists/paste-grey.png' alt='' border='0' class='center'> "._("Paste")."</a></li>";
1300 }
1301 }
1303 return($result);
1304 }
1307 function renderCopyPasteActions($row, $dn, $category, $class, $copy= true, $cut= true)
1308 {
1309 // We can only provide information if we've got a copypaste handler
1310 // instance
1311 if(!(isset($this->copyPasteHandler) && is_object($this->copyPasteHandler))){
1312 return "";
1313 }
1315 // Presets
1316 $ui = get_userinfo();
1317 $result = "";
1319 // Render cut entries
1320 if($cut){
1321 if($ui->is_cutable($dn, $category, $class)){
1322 $result .= "<input class='center' type='image'
1323 src='images/lists/cut.png' alt='"._("Cut")."' name='listing_cut_$row' title='"._("Cut this entry")."' style='padding:1px'>";
1324 }else{
1325 $result.="<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
1326 }
1327 }
1329 // Render copy entries
1330 if($copy){
1331 if($ui->is_copyable($dn, $category, $class)){
1332 $result.= "<input class='center' type='image'
1333 src='images/lists/copy.png' alt='"._("Copy")."' name='listing_copy_$row' title='"._("Copy this entry")."' style='padding:1px'>";
1334 }else{
1335 $result.="<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
1336 }
1337 }
1339 return($result);
1340 }
1343 function renderSnapshotMenu($separator)
1344 {
1345 // We can only provide information if we've got a snapshot handler
1346 // instance
1347 if(!(isset($this->snapshotHandler) && is_object($this->snapshotHandler))){
1348 return "";
1349 }
1351 // Presets
1352 $result = "";
1353 $ui = get_userinfo();
1355 if($this->snapshotHandler->enabled() && $ui->allow_snapshot_restore($this->base, $this->module)){
1357 // Check if there is something to restore
1358 $restore= false;
1359 foreach($this->snapshotHandler->getSnapshotBases() as $base){
1360 $restore= $restore || count($this->snapshotHandler->getDeletedSnapshots($base)) > 0;
1361 }
1363 // Draw icons according to the restore flag
1364 if($restore){
1365 $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'> "._("Restore snapshots")."</a></li>";
1366 }else{
1367 $result.= "<li$separator><a href='#'><img src='images/lists/restore_grey.png' alt='' border='0' class='center'> "._("Restore snapshots")."</a></li>";
1368 }
1369 }
1371 return($result);
1372 }
1375 function renderExporterMenu($separator)
1376 {
1377 // Presets
1378 $result = "";
1380 // Draw entries
1381 $result.= "<li$separator><a href='#'><img border='0' class='center' src='images/lists/export.png'> "._("Export list")." <img border='0' src='images/forward-arrow.png'></a><ul class='level3'>";
1383 // Export CVS as build in exporter
1384 foreach ($this->exporter as $action => $exporter) {
1385 $result.= "<li><a href='#' onClick='document.getElementById(\"actionmenu\").value= \"$action\";document.getElementById(\"exec_act\").click();'><img border='0' class='center' src='".$exporter['image']."'> ".$exporter['label']."</a></li>";
1386 }
1388 // Finalize list
1389 $result.= "</ul></li>";
1391 return($result);
1392 }
1395 function renderSnapshotActions($row, $dn, $category, $class, $copy= true, $cut= true)
1396 {
1397 // We can only provide information if we've got a snapshot handler
1398 // instance
1399 if(!(isset($this->snapshotHandler) && is_object($this->snapshotHandler))){
1400 return "";
1401 }
1403 // Presets
1404 $result= "";
1405 $ui = get_userinfo();
1407 // Only act if enabled here
1408 if($this->snapshotHandler->enabled()){
1410 // Draw restore button
1411 if ($ui->allow_snapshot_restore($dn, $category)){
1413 // Do we have snapshots for this dn?
1414 if($this->snapshotHandler->hasSnapshots($dn)){
1415 $result.= "<input class='center' type='image' src='images/lists/restore.png' ".
1416 "alt='"._("Restore snapshot")."' name='listing_restore_$row' title='".
1417 _("Restore snapshot")."' style='padding:1px'>";
1418 } else {
1419 $result.= "<img src='images/lists/restore_grey.png' alt=' ' class='center' style='padding:1px'>";
1420 }
1421 }
1423 // Draw snapshot button
1424 if($ui->allow_snapshot_create($dn, $category)){
1425 $result.= "<input class='center' type='image' src='images/snapshot.png' ".
1426 "alt='"._("Create snapshot")."' name='listing_snapshot_$row' title='".
1427 _("Create a new snapshot from this object")."' style='padding:1px'>";
1428 }else{
1429 $result.= "<img src='images/empty.png' alt=' ' class='center' style='padding:1px'>";
1430 }
1431 }
1433 return($result);
1434 }
1437 function renderDaemonMenu($separator)
1438 {
1439 $result= "";
1441 // If there is a daemon registered, draw the menu entries
1442 if(class_available("DaemonEvent")){
1443 $events= DaemonEvent::get_event_types_by_category($this->categories);
1444 if(isset($events['BY_CLASS']) && count($events['BY_CLASS'])){
1445 foreach($events['BY_CLASS'] as $name => $event){
1446 $result.= "<li$separator><a href='#' onClick='document.getElementById(\"actionmenu\").value=\"$name\";document.getElementById(\"exec_act\").click();'>".$event['MenuImage']." ".$event['s_Menu_Name']."</a></li>";
1447 $separator= "";
1448 }
1449 }
1450 }
1452 return $result;
1453 }
1456 function getType($dn)
1457 {
1458 if (isset($this->objectDnMapping[$dn])) {
1459 return $this->objectDnMapping[$dn];
1460 }
1461 return null;
1462 }
1464 }
1466 ?>