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 /*! \brief The plugin base class
24 \author Cajus Pollmeier <pollmeier@gonicus.de>
25 \version 2.00
26 \date 24.07.2003
28 This is the base class for all plugins. It can be used standalone or
29 can be included by the tabs class. All management should be done
30 within this class. Extend your plugins from this class.
31 */
33 class plugin
34 {
35 /*!
36 \brief Reference to parent object
38 This variable is used when the plugin is included in tabs
39 and keeps reference to the tab class. Communication to other
40 tabs is possible by 'name'. So the 'fax' plugin can ask the
41 'userinfo' plugin for the fax number.
43 \sa tab
44 */
45 var $parent= NULL;
47 /*!
48 \brief Configuration container
50 Access to global configuration
51 */
52 var $config= NULL;
54 /*!
55 \brief Mark plugin as account
57 Defines whether this plugin is defined as an account or not.
58 This has consequences for the plugin to be saved from tab
59 mode. If it is set to 'FALSE' the tab will call the delete
60 function, else the save function. Should be set to 'TRUE' if
61 the construtor detects a valid LDAP object.
63 \sa plugin::plugin()
64 */
65 var $is_account= FALSE;
66 var $initially_was_account= FALSE;
68 /*!
69 \brief Mark plugin as template
71 Defines whether we are creating a template or a normal object.
72 Has conseqences on the way execute() shows the formular and how
73 save() puts the data to LDAP.
75 \sa plugin::save() plugin::execute()
76 */
77 var $is_template= FALSE;
78 var $ignore_account= FALSE;
79 var $is_modified= FALSE;
81 /*!
82 \brief Represent temporary LDAP data
84 This is only used internally.
85 */
86 var $attrs= array();
88 /* Keep set of conflicting plugins */
89 var $conflicts= array();
91 /* Save unit tags */
92 var $gosaUnitTag= "";
93 var $skipTagging= FALSE;
95 /*!
96 \brief Used standard values
98 dn
99 */
100 var $dn= "";
101 var $uid= "";
102 var $sn= "";
103 var $givenName= "";
104 var $acl= "*none*";
105 var $dialog= FALSE;
106 var $snapDialog = NULL;
108 /* attribute list for save action */
109 var $attributes= array();
110 var $objectclasses= array();
111 var $is_new= TRUE;
112 var $saved_attributes= array();
114 var $acl_base= "";
115 var $acl_category= "";
116 var $read_only = FALSE; // Used when the entry is opened as "readonly" due to locks.
118 /* This can be set to render the tabulators in another stylesheet */
119 var $pl_notify= FALSE;
121 /* Object entry CSN */
122 var $entryCSN = "";
123 var $CSN_check_active = FALSE;
125 /* This variable indicates that this class can handle multiple dns at once. */
126 var $multiple_support = FALSE;
127 var $multi_attrs = array();
128 var $multi_attrs_all = array();
130 /* This aviable indicates, that we are currently in multiple edit handle */
131 var $multiple_support_active = FALSE;
132 var $selected_edit_values = array();
133 var $multi_boxes = array();
135 /*! \brief plugin constructor
137 If 'dn' is set, the node loads the given 'dn' from LDAP
139 \param dn Distinguished name to initialize plugin from
140 \sa plugin()
141 */
142 function plugin (&$config, $dn= NULL, $parent= NULL)
143 {
144 /* Configuration is fine, allways */
145 $this->config= &$config;
146 $this->dn= $dn;
148 /* Handle new accounts, don't read information from LDAP */
149 if ($dn == "new"){
150 return;
151 }
153 /* Check if this entry was opened in read only mode */
154 if(isset($_POST['open_readonly'])){
155 if(session::global_is_set("LOCK_CACHE")){
156 $cache = &session::get("LOCK_CACHE");
157 if(isset($cache['READ_ONLY'][$this->dn])){
158 $this->read_only = TRUE;
159 }
160 }
161 }
163 /* Save current dn as acl_base */
164 $this->acl_base= $dn;
166 /* Get LDAP descriptor */
167 if ($dn !== NULL){
169 /* Load data to 'attrs' and save 'dn' */
170 if ($parent !== NULL){
171 $this->attrs= $parent->attrs;
172 } else {
173 $ldap= $this->config->get_ldap_link();
174 $ldap->cat ($dn);
175 $this->attrs= $ldap->fetch();
176 }
178 /* Copy needed attributes */
179 foreach ($this->attributes as $val){
180 $found= array_key_ics($val, $this->attrs);
181 if ($found != ""){
182 $this->$val= $found[0];
183 }
184 }
186 /* gosaUnitTag loading... */
187 if (isset($this->attrs['gosaUnitTag'][0])){
188 $this->gosaUnitTag= $this->attrs['gosaUnitTag'][0];
189 }
191 /* Set the template flag according to the existence of objectClass
192 gosaUserTemplate */
193 if (isset($this->attrs['objectClass'])){
194 if (in_array_ics ("gosaUserTemplate", $this->attrs['objectClass'])){
195 $this->is_template= TRUE;
196 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
197 "found", "Template check");
198 }
199 }
201 /* Is Account? */
202 $found= TRUE;
203 foreach ($this->objectclasses as $obj){
204 if (preg_match('/top/i', $obj)){
205 continue;
206 }
207 if (!isset($this->attrs['objectClass']) || !in_array_ics ($obj, $this->attrs['objectClass'])){
208 $found= FALSE;
209 break;
210 }
211 }
212 if ($found){
213 $this->is_account= TRUE;
214 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
215 "found", "Object check");
216 }
218 /* Prepare saved attributes */
219 $this->saved_attributes= $this->attrs;
220 foreach ($this->saved_attributes as $index => $value){
221 if (is_numeric($index)){
222 unset($this->saved_attributes[$index]);
223 continue;
224 }
226 if (!in_array_ics($index, $this->attributes) && strcasecmp('objectClass', $index)){
227 unset($this->saved_attributes[$index]);
228 continue;
229 }
231 if (isset($this->saved_attributes[$index][0])){
232 if(!isset($this->saved_attributes[$index]["count"])){
233 $this->saved_attributes[$index]["count"] = count($this->saved_attributes[$index]);
234 }
235 if($this->saved_attributes[$index]["count"] == 1){
236 $tmp= $this->saved_attributes[$index][0];
237 unset($this->saved_attributes[$index]);
238 $this->saved_attributes[$index]= $tmp;
239 continue;
240 }
241 }
242 unset($this->saved_attributes["$index"]["count"]);
243 }
245 if(isset($this->attrs['gosaUnitTag'])){
246 $this->saved_attributes['gosaUnitTag'] = $this->attrs['gosaUnitTag'][0];
247 }
248 }
250 /* Save initial account state */
251 $this->initially_was_account= $this->is_account;
252 }
255 /*! \brief execute plugin
257 Generates the html output for this node
258 */
259 function execute()
260 {
261 /* This one is empty currently. Fabian - please fill in the docu code */
262 session::global_set('current_class_for_help',get_class($this));
264 /* Reset Lock message POST/GET check array, to prevent perg_match errors*/
265 session::set('LOCK_VARS_TO_USE',array());
266 session::set('LOCK_VARS_USED',array());
267 }
269 /*! \brief execute plugin
270 Removes object from parent
271 */
272 function remove_from_parent()
273 {
274 /* include global link_info */
275 $ldap= $this->config->get_ldap_link();
277 /* Get current objectClasses in order to add the required ones */
278 $ldap->cat($this->dn);
279 $tmp= $ldap->fetch ();
280 $oc= array();
281 if (isset($tmp['objectClass'])){
282 $oc= $tmp['objectClass'];
283 unset($oc['count']);
284 }
286 /* Remove objectClasses from entry */
287 $ldap->cd($this->dn);
288 $this->attrs= array();
289 $this->attrs['objectClass']= array_remove_entries_ics($this->objectclasses,$oc);
291 /* Unset attributes from entry */
292 foreach ($this->attributes as $val){
293 $this->attrs["$val"]= array();
294 }
296 /* Unset account info */
297 $this->is_account= FALSE;
299 /* Do not write in plugin base class, this must be done by
300 children, since there are normally additional attribs,
301 lists, etc. */
302 /*
303 $ldap->modify($this->attrs);
304 */
305 }
308 /*! \brief Save HTML posted data to object
309 */
310 function save_object()
311 {
312 /* Update entry CSN if it is empty. */
313 if(empty($this->entryCSN) && $this->CSN_check_active){
314 $this->entryCSN = getEntryCSN($this->dn);
315 }
317 /* Save values to object */
318 foreach ($this->attributes as $val){
319 if ($this->acl_is_writeable($val) && isset ($_POST["$val"])){
320 /* Check for modifications */
321 if (get_magic_quotes_gpc()) {
322 $data= stripcslashes($_POST["$val"]);
323 } else {
324 $data= $this->$val = $_POST["$val"];
325 }
326 if ($this->$val != $data){
327 $this->is_modified= TRUE;
328 }
330 /* Okay, how can I explain this fix ...
331 * In firefox, disabled option fields aren't selectable ... but in IE you can select these fileds.
332 * So IE posts these 'unselectable' option, with value = chr(194)
333 * chr(194) seems to be the in between the ...option> </option.. because there is no value=".." specified in these option fields
334 * This was added for W3c compliance, but now causes these ... ldap errors ...
335 * So we set these Fields to ""; a normal empty string, and we can check these values in plugin::check() again ...
336 */
337 if(isset($data[0]) && $data[0] == chr(194)) {
338 $data = "";
339 }
340 $this->$val= $data;
341 }
342 }
343 }
346 /* Save data to LDAP, depending on is_account we save or delete */
347 function save()
348 {
349 /* include global link_info */
350 $ldap= $this->config->get_ldap_link();
352 /* Save all plugins */
353 $this->entryCSN = "";
355 /* Start with empty array */
356 $this->attrs= array();
358 /* Get current objectClasses in order to add the required ones */
359 $ldap->cat($this->dn);
361 $tmp= $ldap->fetch ();
363 $oc= array();
364 if (isset($tmp['objectClass'])){
365 $oc= $tmp["objectClass"];
366 $this->is_new= FALSE;
367 unset($oc['count']);
368 } else {
369 $this->is_new= TRUE;
370 }
372 /* Load (minimum) attributes, add missing ones */
373 $this->attrs['objectClass']= gosa_array_merge($oc,$this->objectclasses);
375 /* Copy standard attributes */
376 foreach ($this->attributes as $val){
377 if ($this->$val != ""){
378 $this->attrs["$val"]= $this->$val;
379 } elseif (!$this->is_new) {
380 $this->attrs["$val"]= array();
381 }
382 }
384 /* Handle tagging */
385 $this->tag_attrs($this->attrs);
386 }
389 function cleanup()
390 {
391 foreach ($this->attrs as $index => $value){
393 /* Convert arrays with one element to non arrays, if the saved
394 attributes are no array, too */
395 if (is_array($this->attrs[$index]) &&
396 count ($this->attrs[$index]) == 1 &&
397 isset($this->saved_attributes[$index]) &&
398 !is_array($this->saved_attributes[$index])){
400 $tmp= $this->attrs[$index][0];
401 $this->attrs[$index]= $tmp;
402 }
404 /* Remove emtpy arrays if they do not differ */
405 if (is_array($this->attrs[$index]) &&
406 count($this->attrs[$index]) == 0 &&
407 !isset($this->saved_attributes[$index])){
409 unset ($this->attrs[$index]);
410 continue;
411 }
413 /* Remove single attributes that do not differ */
414 if (!is_array($this->attrs[$index]) &&
415 isset($this->saved_attributes[$index]) &&
416 !is_array($this->saved_attributes[$index]) &&
417 $this->attrs[$index] == $this->saved_attributes[$index]){
419 unset ($this->attrs[$index]);
420 continue;
421 }
423 /* Remove arrays that do not differ */
424 if (is_array($this->attrs[$index]) &&
425 isset($this->saved_attributes[$index]) &&
426 is_array($this->saved_attributes[$index])){
428 if (!array_differs($this->attrs[$index],$this->saved_attributes[$index])){
429 unset ($this->attrs[$index]);
430 continue;
431 }
432 }
433 }
435 /* Update saved attributes and ensure that next cleanups will be successful too */
436 foreach($this->attrs as $name => $value){
437 $this->saved_attributes[$name] = $value;
438 }
439 }
441 /* Check formular input */
442 function check()
443 {
444 $message= array();
446 /* Skip if we've no config object */
447 if (!isset($this->config) || !is_object($this->config)){
448 return $message;
449 }
451 /* Find hooks entries for this class */
452 $command= $this->config->search(get_class($this), "CHECK", array('menu', 'tabs'));
454 if ($command != ""){
456 if (!check_command($command)){
457 $message[]= msgPool::cmdnotfound("CHECK", get_class($this));
458 } else {
460 /* Generate "ldif" for check hook */
461 $ldif= "dn: $this->dn\n";
463 /* ... objectClasses */
464 foreach ($this->objectclasses as $oc){
465 $ldif.= "objectClass: $oc\n";
466 }
468 /* ... attributes */
469 foreach ($this->attributes as $attr){
470 if ($this->$attr == ""){
471 continue;
472 }
473 if (is_array($this->$attr)){
474 foreach ($this->$attr as $val){
475 $ldif.= "$attr: $val\n";
476 }
477 } else {
478 $ldif.= "$attr: ".$this->$attr."\n";
479 }
480 }
482 /* Append empty line */
483 $ldif.= "\n";
485 /* Feed "ldif" into hook and retrieve result*/
486 $descriptorspec = array( 0 => array("pipe", "r"), 1 => array("pipe", "w"), 2 => array("pipe", "w"));
487 $fh= proc_open($command, $descriptorspec, $pipes);
488 if (is_resource($fh)) {
489 fwrite ($pipes[0], $ldif);
490 fclose($pipes[0]);
492 $result= stream_get_contents($pipes[1]);
493 if ($result != ""){
494 $message[]= $result;
495 }
497 fclose($pipes[1]);
498 fclose($pipes[2]);
499 proc_close($fh);
500 }
501 }
503 }
505 /* Check entryCSN */
506 if($this->CSN_check_active){
507 $current_csn = getEntryCSN($this->dn);
508 if($current_csn != $this->entryCSN && !empty($this->entryCSN) && !empty($current_csn)){
509 $this->entryCSN = $current_csn;
510 $message[] = _("The object has changed since opened in GOsa. All changes that may be done by others get lost if you save this entry!");
511 }
512 }
513 return ($message);
514 }
516 /* Adapt from template, using 'dn' */
517 function adapt_from_template($dn, $skip= array())
518 {
519 /* Include global link_info */
520 $ldap= $this->config->get_ldap_link();
522 /* Load requested 'dn' to 'attrs' */
523 $ldap->cat ($dn);
524 $this->attrs= $ldap->fetch();
526 /* Walk through attributes */
527 foreach ($this->attributes as $val){
529 /* Skip the ones in skip list */
530 if (in_array($val, $skip)){
531 continue;
532 }
534 if (isset($this->attrs["$val"][0])){
536 /* If attribute is set, replace dynamic parts:
537 %sn, %givenName and %uid. Fill these in our local variables. */
538 $value= $this->attrs["$val"][0];
540 foreach (array("sn", "givenName", "uid") as $repl){
541 if (preg_match("/%$repl/i", $value)){
542 $value= preg_replace ("/%$repl/i", $this->parent->$repl, $value);
543 }
544 }
545 $this->$val= $value;
546 }
547 }
549 /* Is Account? */
550 $found= TRUE;
551 foreach ($this->objectclasses as $obj){
552 if (preg_match('/top/i', $obj)){
553 continue;
554 }
555 if (!in_array_ics ($obj, $this->attrs['objectClass'])){
556 $found= FALSE;
557 break;
558 }
559 }
560 if ($found){
561 $this->is_account= TRUE;
562 }
563 }
565 /* Indicate whether a password change is needed or not */
566 function password_change_needed()
567 {
568 return FALSE;
569 }
572 /* Show header message for tab dialogs */
573 function show_enable_header($button_text, $text, $disabled= FALSE)
574 {
575 if (($disabled == TRUE) || (!$this->acl_is_createable())){
576 $state= "disabled";
577 } else {
578 $state= "";
579 }
580 $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
581 $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".$state.
582 "><p class=\"seperator\"> </p></td></tr></table>";
584 return($display);
585 }
588 /* Show header message for tab dialogs */
589 function show_disable_header($button_text, $text, $disabled= FALSE)
590 {
591 if (($disabled == TRUE) || !$this->acl_is_removeable()){
592 $state= "disabled";
593 } else {
594 $state= "";
595 }
596 $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
597 $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".$state.
598 "><p class=\"seperator\"> </p></td></tr></table>";
600 return($display);
601 }
604 /* Show header message for tab dialogs */
605 function show_header($button_text, $text, $disabled= FALSE)
606 {
607 echo "FIXME: show_header should be replaced by show_disable_header and show_enable_header<br>";
608 if ($disabled == TRUE){
609 $state= "disabled";
610 } else {
611 $state= "";
612 }
613 $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
614 $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".
615 ($this->acl_is_createable()?'':'disabled')." ".$state.
616 "><p class=\"seperator\"> </p></td></tr></table>";
618 return($display);
619 }
622 function postcreate($add_attrs= array())
623 {
624 /* Find postcreate entries for this class */
625 $command= $this->config->search(get_class($this), "POSTCREATE",array('menu', 'tabs'));
627 if ($command != ""){
629 /* Walk through attribute list */
630 foreach ($this->attributes as $attr){
631 if (!is_array($this->$attr)){
632 $add_attrs[$attr] = $this->$attr;
633 }
634 }
635 $add_attrs['dn']=$this->dn;
637 $tmp = array();
638 foreach($add_attrs as $name => $value){
639 $tmp[$name] = strlen($name);
640 }
641 arsort($tmp);
643 /* Additional attributes */
644 foreach ($tmp as $name => $len){
645 $value = $add_attrs[$name];
646 $command= str_replace("%$name", "$value", $command);
647 }
649 if (check_command($command)){
650 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
651 $command, "Execute");
652 exec($command,$arr);
653 foreach($arr as $str){
654 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
655 $command, "Result: ".$str);
656 }
657 } else {
658 $message= msgPool::cmdnotfound("POSTCREATE", get_class($this));
659 msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
660 }
661 }
662 }
664 function postmodify($add_attrs= array())
665 {
666 /* Find postcreate entries for this class */
667 $command= $this->config->search(get_class($this), "POSTMODIFY",array('menu','tabs'));
669 if ($command != ""){
671 /* Walk through attribute list */
672 foreach ($this->attributes as $attr){
673 if (!is_array($this->$attr)){
674 $add_attrs[$attr] = $this->$attr;
675 }
676 }
677 $add_attrs['dn']=$this->dn;
679 $tmp = array();
680 foreach($add_attrs as $name => $value){
681 $tmp[$name] = strlen($name);
682 }
683 arsort($tmp);
685 /* Additional attributes */
686 foreach ($tmp as $name => $len){
687 $value = $add_attrs[$name];
688 $command= str_replace("%$name", "$value", $command);
689 }
691 if (check_command($command)){
692 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,$command, "Execute");
693 exec($command,$arr);
694 foreach($arr as $str){
695 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
696 $command, "Result: ".$str);
697 }
698 } else {
699 $message= msgPool::cmdnotfound("POSTMODIFY", get_class($this));
700 msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
701 }
702 }
703 }
705 function postremove($add_attrs= array())
706 {
707 /* Find postremove entries for this class */
708 $command= $this->config->search(get_class($this), "POSTREMOVE",array('menu','tabs'));
709 if ($command != ""){
711 /* Walk through attribute list */
712 foreach ($this->attributes as $attr){
713 if (!is_array($this->$attr)){
714 $add_attrs[$attr] = $this->$attr;
715 }
716 }
717 $add_attrs['dn']=$this->dn;
719 $tmp = array();
720 foreach($add_attrs as $name => $value){
721 $tmp[$name] = strlen($name);
722 }
723 arsort($tmp);
725 /* Additional attributes */
726 foreach ($tmp as $name => $len){
727 $value = $add_attrs[$name];
728 $command= str_replace("%$name", "$value", $command);
729 }
731 if (check_command($command)){
732 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
733 $command, "Execute");
735 exec($command,$arr);
736 foreach($arr as $str){
737 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
738 $command, "Result: ".$str);
739 }
740 } else {
741 $message= msgPool::cmdnotfound("POSTREMOVE", get_class($this));
742 msg_dialog::display(_("Error"), $message, ERROR_DIALOG);
743 }
744 }
745 }
747 /* Create unique DN */
748 function create_unique_dn($attribute, $base)
749 {
750 $ldap= $this->config->get_ldap_link();
751 $base= preg_replace("/^,*/", "", $base);
753 /* Try to use plain entry first */
754 $dn= "$attribute=".$this->$attribute.",$base";
755 $ldap->cat ($dn, array('dn'));
756 if (!$ldap->fetch()){
757 return ($dn);
758 }
760 /* Look for additional attributes */
761 foreach ($this->attributes as $attr){
762 if ($attr == $attribute || $this->$attr == ""){
763 continue;
764 }
766 $dn= "$attribute=".$this->$attribute."+$attr=".$this->$attr.",$base";
767 $ldap->cat ($dn, array('dn'));
768 if (!$ldap->fetch()){
769 return ($dn);
770 }
771 }
773 /* None found */
774 return ("none");
775 }
777 function rebind($ldap, $referral)
778 {
779 $credentials= LDAP::get_credentials($referral, $this->config->current['REFERRAL']);
780 if (ldap_bind($ldap, $credentials['ADMIN'], $this->config->get_credentials($credentials['PASSWORD']))) {
781 $this->error = "Success";
782 $this->hascon=true;
783 $this->reconnect= true;
784 return (0);
785 } else {
786 $this->error = "Could not bind to " . $credentials['ADMIN'];
787 return NULL;
788 }
789 }
792 /* Recursively copy ldap object */
793 function _copy($src_dn,$dst_dn)
794 {
795 $ldap=$this->config->get_ldap_link();
796 $ldap->cat($src_dn);
797 $attrs= $ldap->fetch();
799 /* Grummble. This really sucks. PHP ldap doesn't support rdn stuff. */
800 $ds= ldap_connect($this->config->current['SERVER']);
801 ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
802 if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['REFERRAL'])) {
803 ldap_set_rebind_proc($ds, array(&$this, "rebind"));
804 }
806 $r=ldap_bind($ds,$this->config->current['ADMINDN'], $this->config->current['ADMINPASSWORD']);
807 $sr=ldap_read($ds, LDAP::fix($src_dn), "objectClass=*");
809 /* Fill data from LDAP */
810 $new= array();
811 if ($sr) {
812 $ei=ldap_first_entry($ds, $sr);
813 if ($ei) {
814 foreach($attrs as $attr => $val){
815 if ($info = @ldap_get_values_len($ds, $ei, $attr)){
816 for ($i= 0; $i<$info['count']; $i++){
817 if ($info['count'] == 1){
818 $new[$attr]= $info[$i];
819 } else {
820 $new[$attr][]= $info[$i];
821 }
822 }
823 }
824 }
825 }
826 }
828 /* close conncetion */
829 ldap_unbind($ds);
831 /* Adapt naming attribute */
832 $dst_name= preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
833 $dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
834 $new[$dst_name]= LDAP::fix($dst_val);
836 /* Check if this is a department.
837 * If it is a dep. && there is a , override in his ou
838 * change \2C to , again, else this entry can't be saved ...
839 */
840 if((isset($new['ou'])) &&( preg_match("/\\,/",$new['ou']))){
841 $new['ou'] = str_replace("\\\\,",",",$new['ou']);
842 }
844 /* Save copy */
845 $ldap->connect();
846 $ldap->cd($this->config->current['BASE']);
848 $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
850 /* FAIvariable=.../..., cn=..
851 could not be saved, because the attribute FAIvariable was different to
852 the dn FAIvariable=..., cn=... */
853 if(in_array_ics("FAIdebconfInfo",$new['objectClass'])){
854 $new['FAIvariable'] = $ldap->fix($new['FAIvariable']);
855 }
856 $ldap->cd($dst_dn);
857 $ldap->add($new);
859 if (!$ldap->success()){
860 trigger_error("Trying to save $dst_dn failed.",
861 E_USER_WARNING);
862 return(FALSE);
863 }
864 return(TRUE);
865 }
868 /* This is a workaround function. */
869 function copy($src_dn, $dst_dn)
870 {
871 /* Rename dn in possible object groups */
872 $ldap= $this->config->get_ldap_link();
873 $ldap->search('(&(objectClass=gosaGroupOfNames)(member='.@LDAP::prepare4filter($src_dn).'))',
874 array('cn'));
875 while ($attrs= $ldap->fetch()){
876 $og= new ogroup($this->config, $ldap->getDN());
877 unset($og->member[$src_dn]);
878 $og->member[$dst_dn]= $dst_dn;
879 $og->save ();
880 }
882 $ldap->cat($dst_dn);
883 $attrs= $ldap->fetch();
884 if (count($attrs)){
885 trigger_error("Trying to overwrite ".LDAP::fix($dst_dn).", which already exists.",
886 E_USER_WARNING);
887 return (FALSE);
888 }
890 $ldap->cat($src_dn);
891 $attrs= $ldap->fetch();
892 if (!count($attrs)){
893 trigger_error("Trying to move ".LDAP::fix($src_dn).", which does not seem to exist.",
894 E_USER_WARNING);
895 return (FALSE);
896 }
898 $ldap->cd($src_dn);
899 $ldap->search("objectClass=*",array("dn"));
900 while($attrs = $ldap->fetch()){
901 $src = $attrs['dn'];
902 $dst = preg_replace("/".preg_quote($src_dn, '/')."$/",$dst_dn,$attrs['dn']);
903 $this->_copy($src,$dst);
904 }
905 return (TRUE);
906 }
910 /*! \brief Move a given ldap object indentified by $src_dn \
911 to the given destination $dst_dn \
912 * Ensure that all references are updated (ogroups) \
913 * Update ACLs \
914 * Update accessTo \
915 @param String The source dn.
916 @param String The destination dn.
917 @return Boolean TRUE on success else FALSE.
918 */
919 function rename($src_dn, $dst_dn)
920 {
921 $start = microtime(1);
923 /* Try to move the source entry to the destination position */
924 $ldap = $this->config->get_ldap_link();
925 $ldap->cd($this->config->current['BASE']);
926 $ldap->create_missing_trees(preg_replace("/^[^,]+,/","",$dst_dn));
927 if (!$ldap->rename_dn($src_dn,$dst_dn)){
928 # msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $src_dn, "", get_class()));
929 new log("debug","Ldap Protocol v3 implementation error, ldap_rename failed, falling back to manual copy.","FROM: $src_dn -- TO: $dst_dn",array(),$ldap->get_error());
930 @DEBUG(DEBUG_LDAP,__LINE__,__FUNCTION__,__FILE__,"Rename failed FROM: $src_dn -- TO: $dst_dn",
931 "Ldap Protocol v3 implementation error, falling back to maunal method.");
932 return(FALSE);
933 }
935 /* Get list of users,groups and roles within this tree,
936 maybe we have to update ACL references.
937 */
938 $leaf_objs = get_list("(|(objectClass=posixGroup)(objectClass=gosaAccount)(objectClass=gosaRole))",array("all"),$dst_dn,
939 array("dn","objectClass"),GL_SUBSEARCH | GL_NO_ACL_CHECK);
940 foreach($leaf_objs as $obj){
941 $new_dn = $obj['dn'];
942 $old_dn = preg_replace("/".preg_quote($dst_dn, '/')."$/i",$src_dn,$new_dn);
943 $this->update_acls($old_dn,$new_dn);
944 }
946 /* Get all objectGroups defined in this database.
947 and check if there is an entry matching the source dn,
948 if this is the case, then update this objectgroup to use the new dn.
949 */
950 $ogroups = get_sub_list("(&(objectClass=gosaGroupOfNames)(member=*))","ogroups",
951 array(get_ou("ogroupRDN")),$this->config->current['BASE'],array("member"),
952 GL_SUBSEARCH | GL_NO_ACL_CHECK) ;
954 /* Walk through all objectGroups and check if there are
955 members matching the source dn
956 */
957 foreach($ogroups as $ogroup){
958 if(isset($ogroup['member'])){
960 /* Reset class object, this will be initialized with class_ogroup on demand
961 */
962 $o_ogroup = NULL;
963 for($i = 0 ; $i < $ogroup['member']['count'] ; $i ++){
965 $c_mem = $ogroup['member'][$i];
967 if(preg_match("/".preg_quote($src_dn, '/')."$/i",$c_mem)){
969 $d_mem = preg_replace("/".preg_quote($src_dn, '/')."$/i",$dst_dn,$ogroup['member'][$i]);
971 if($o_ogroup == NULL){
972 $o_ogroup = new ogroup($this->config,$ogroup['dn']);
973 }
975 unset($o_ogroup->member[$c_mem]);
976 $o_ogroup->member[$d_mem]= $d_mem;
977 }
978 }
980 /* Save object group if there were changes made on the membership */
981 if($o_ogroup != NULL){
982 $o_ogroup->save();
983 }
984 }
985 }
987 /* Check if there are gosa departments moved.
988 If there were deps moved, the force reload of config->deps.
989 */
990 $leaf_deps= get_list("(objectClass=gosaDepartment)",array("all"),$dst_dn,
991 array("dn","objectClass"),GL_SUBSEARCH | GL_NO_ACL_CHECK);
993 if(count($leaf_deps)){
994 $this->config->get_departments();
995 $this->config->make_idepartments();
996 session::global_set("config",$this->config);
997 $ui =get_userinfo();
998 $ui->reset_acl_cache();
999 }
1001 return(TRUE);
1002 }
1006 function move($src_dn, $dst_dn)
1007 {
1008 /* Do not copy if only upper- lowercase has changed */
1009 if(strtolower($src_dn) == strtolower($dst_dn)){
1010 return(TRUE);
1011 }
1014 /* Try to move the entry instead of copy & delete
1015 */
1016 if(TRUE){
1018 /* Try to move with ldap routines, if this was not successfull
1019 fall back to the old style copy & remove method
1020 */
1021 if($this->rename($src_dn, $dst_dn)){
1022 return(TRUE);
1023 }else{
1024 // See code below.
1025 }
1026 }
1028 /* Copy source to destination */
1029 if (!$this->copy($src_dn, $dst_dn)){
1030 return (FALSE);
1031 }
1033 /* Delete source */
1034 $ldap= $this->config->get_ldap_link();
1035 $ldap->rmdir_recursive($src_dn);
1036 if (!$ldap->success()){
1037 trigger_error("Trying to delete $src_dn failed.",
1038 E_USER_WARNING);
1039 return (FALSE);
1040 }
1042 return (TRUE);
1043 }
1046 /* Move/Rename complete trees */
1047 function recursive_move($src_dn, $dst_dn)
1048 {
1049 /* Check if the destination entry exists */
1050 $ldap= $this->config->get_ldap_link();
1052 /* Check if destination exists - abort */
1053 $ldap->cat($dst_dn, array('dn'));
1054 if ($ldap->fetch()){
1055 trigger_error("recursive_move $dst_dn already exists.",
1056 E_USER_WARNING);
1057 return (FALSE);
1058 }
1060 $this->copy($src_dn, $dst_dn);
1062 /* Remove src_dn */
1063 $ldap->cd($src_dn);
1064 $ldap->recursive_remove($src_dn);
1065 return (TRUE);
1066 }
1069 function handle_post_events($mode, $add_attrs= array())
1070 {
1071 switch ($mode){
1072 case "add":
1073 $this->postcreate($add_attrs);
1074 break;
1076 case "modify":
1077 $this->postmodify($add_attrs);
1078 break;
1080 case "remove":
1081 $this->postremove($add_attrs);
1082 break;
1083 }
1084 }
1087 function saveCopyDialog(){
1088 }
1091 function getCopyDialog(){
1092 return(array("string"=>"","status"=>""));
1093 }
1096 function PrepareForCopyPaste($source)
1097 {
1098 $todo = $this->attributes;
1099 if(isset($this->CopyPasteVars)){
1100 $todo = array_merge($todo,$this->CopyPasteVars);
1101 }
1103 if(count($this->objectclasses)){
1104 $this->is_account = TRUE;
1105 foreach($this->objectclasses as $class){
1106 if(!in_array($class,$source['objectClass'])){
1107 $this->is_account = FALSE;
1108 }
1109 }
1110 }
1112 foreach($todo as $var){
1113 if (isset($source[$var])){
1114 if(isset($source[$var]['count'])){
1115 if($source[$var]['count'] > 1){
1116 $this->$var = array();
1117 $tmp = array();
1118 for($i = 0 ; $i < $source[$var]['count']; $i++){
1119 $tmp = $source[$var][$i];
1120 }
1121 $this->$var = $tmp;
1122 }else{
1123 $this->$var = $source[$var][0];
1124 }
1125 }else{
1126 $this->$var= $source[$var];
1127 }
1128 }
1129 }
1130 }
1132 function tag_attrs(&$at, $dn= "", $tag= "", $show= false)
1133 {
1134 /* Skip tagging?
1135 If this is called from departmentGeneric, we have to skip this
1136 tagging procedure.
1137 */
1138 if($this->skipTagging){
1139 return;
1140 }
1142 /* No dn? Self-operation... */
1143 if ($dn == ""){
1144 $dn= $this->dn;
1146 /* No tag? Find it yourself... */
1147 if ($tag == ""){
1148 $len= strlen($dn);
1150 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "No tag for $dn - looking for one...", "Tagging");
1151 $relevant= array();
1152 foreach ($this->config->adepartments as $key => $ntag){
1154 /* This one is bigger than our dn, its not relevant... */
1155 if ($len < strlen($key)){
1156 continue;
1157 }
1159 /* This one matches with the latter part. Break and don't fix this entry */
1160 if (preg_match('/(^|,)'.preg_quote($key, '/').'$/', $dn)){
1161 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, "DEBUG: Possibly relevant: $key", "Tagging");
1162 $relevant[strlen($key)]= $ntag;
1163 continue;
1164 }
1166 }
1168 /* If we've some relevant tags to set, just get the longest one */
1169 if (count($relevant)){
1170 ksort($relevant);
1171 $tmp= array_keys($relevant);
1172 $idx= end($tmp);
1173 $tag= $relevant[$idx];
1174 $this->gosaUnitTag= $tag;
1175 }
1176 }
1177 }
1179 /* Remove tags that may already be here... */
1180 remove_objectClass("gosaAdministrativeUnitTag", $at);
1181 if (isset($at['gosaUnitTag'])){
1182 unset($at['gosaUnitTag']);
1183 }
1185 /* Set tag? */
1186 if ($tag != ""){
1187 add_objectClass("gosaAdministrativeUnitTag", $at);
1188 $at['gosaUnitTag']= $tag;
1189 }
1191 /* Initially this object was tagged.
1192 - But now, it is no longer inside a tagged department.
1193 So force the remove of the tag.
1194 (objectClass was already removed obove)
1195 */
1196 if($tag == "" && $this->gosaUnitTag){
1197 $at['gosaUnitTag'] = array();
1198 }
1199 }
1202 /* Add possibility to stop remove process */
1203 function allow_remove()
1204 {
1205 $reason= "";
1206 return $reason;
1207 }
1210 /* Create a snapshot of the current object */
1211 function create_snapshot($type= "snapshot", $description= array())
1212 {
1214 /* Check if snapshot functionality is enabled */
1215 if(!$this->snapshotEnabled()){
1216 return;
1217 }
1219 /* Get configuration from gosa.conf */
1220 $config = $this->config;
1222 /* Create lokal ldap connection */
1223 $ldap= $this->config->get_ldap_link();
1224 $ldap->cd($this->config->current['BASE']);
1226 /* check if there are special server configurations for snapshots */
1227 if($config->get_cfg_value("snapshotURI") == ""){
1229 /* Source and destination server are both the same, just copy source to dest obj */
1230 $ldap_to = $ldap;
1231 $snapldapbase = $this->config->current['BASE'];
1233 }else{
1234 $server = $config->get_cfg_value("snapshotURI");
1235 $user = $config->get_cfg_value("snapshotAdminDn");
1236 $password = $config->get_cfg_value("snapshotAdminPassword");
1237 $snapldapbase = $config->get_cfg_value("snapshotBase");
1239 $ldap_to = new ldapMultiplexer(new LDAP($user,$password, $server));
1240 $ldap_to -> cd($snapldapbase);
1242 if (!$ldap_to->success()){
1243 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1244 }
1246 }
1248 /* check if the dn exists */
1249 if ($ldap->dn_exists($this->dn)){
1251 /* Extract seconds & mysecs, they are used as entry index */
1252 list($usec, $sec)= explode(" ", microtime());
1254 /* Collect some infos */
1255 $base = $this->config->current['BASE'];
1256 $snap_base = $config->get_cfg_value("snapshotBase");
1257 $base_of_object = preg_replace ('/^[^,]+,/i', '', $this->dn);
1258 $new_base = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1260 /* Create object */
1261 #$data = preg_replace('/^dn:.*\n/', '', $ldap->gen_ldif($this->dn,"(!(objectClass=gosaDepartment))"));
1262 $data = $ldap->gen_ldif($this->dn,"(&(!(objectClass=gosaDepartment))(!(objectClass=FAIclass)))");
1263 $newName = str_replace(".", "", $sec."-".$usec);
1264 $target= array();
1265 $target['objectClass'] = array("top", "gosaSnapshotObject");
1266 $target['gosaSnapshotData'] = gzcompress($data, 6);
1267 $target['gosaSnapshotType'] = $type;
1268 $target['gosaSnapshotDN'] = $this->dn;
1269 $target['description'] = $description;
1270 $target['gosaSnapshotTimestamp'] = $newName;
1272 /* Insert the new snapshot
1273 But we have to check first, if the given gosaSnapshotTimestamp
1274 is already used, in this case we should increment this value till there is
1275 an unused value. */
1276 $new_dn = "gosaSnapshotTimestamp=".$newName.",".$new_base;
1277 $ldap_to->cat($new_dn);
1278 while($ldap_to->count()){
1279 $ldap_to->cat($new_dn);
1280 $newName = str_replace(".", "", $sec."-".($usec++));
1281 $new_dn = "gosaSnapshotTimestamp=".$newName.",".$new_base;
1282 $target['gosaSnapshotTimestamp'] = $newName;
1283 }
1285 /* Inset this new snapshot */
1286 $ldap_to->cd($snapldapbase);
1287 $ldap_to->create_missing_trees($snapldapbase);
1288 $ldap_to->create_missing_trees($new_base);
1289 $ldap_to->cd($new_dn);
1290 $ldap_to->add($target);
1291 if (!$ldap_to->success()){
1292 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $new_dn, LDAP_ADD, get_class()));
1293 }
1295 if (!$ldap->success()){
1296 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $new_base, "", get_class()));
1297 }
1299 }
1300 }
1302 function remove_snapshot($dn)
1303 {
1304 $ui = get_userinfo();
1305 $old_dn = $this->dn;
1306 $this->dn = $dn;
1307 $ldap = $this->config->get_ldap_link();
1308 $ldap->cd($this->config->current['BASE']);
1309 $ldap->rmdir_recursive($this->dn);
1310 if(!$ldap->success()){
1311 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $this->dn));
1312 }
1313 $this->dn = $old_dn;
1314 }
1317 /* returns true if snapshots are enabled, and false if it is disalbed
1318 There will also be some errors psoted, if the configuration failed */
1319 function snapshotEnabled()
1320 {
1321 $config = $this->config;
1322 if($config->get_cfg_value("enableSnapshots") == "true"){
1324 /* Check if the snapshot_base is defined */
1325 if ($config->get_cfg_value("snapshotBase") == ""){
1327 /* Send message if not done already */
1328 if(!session::is_set("snapshotFailMessageSend")){
1329 session::set("snapshotFailMessageSend",TRUE);
1330 msg_dialog::display(_("Configuration error"),
1331 sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),
1332 "snapshotBase"), ERROR_DIALOG);
1333 }
1334 return(FALSE);
1335 }
1337 /* Check if the snapshot_base is defined */
1338 if (!is_callable("gzcompress")){
1340 /* Send message if not done already */
1341 if(!session::is_set("snapshotFailMessageSend")){
1342 session::set("snapshotFailMessageSend",TRUE);
1343 msg_dialog::display(_("Configuration error"),
1344 sprintf(_("The snapshot functionality is enabled, but the required compression module is missing. Please install '%s'."),"php5-zip / php5-gzip"), ERROR_DIALOG);
1345 }
1346 return(FALSE);
1347 }
1349 /* check if there are special server configurations for snapshots */
1350 if ($config->get_cfg_value("snapshotURI") != ""){
1352 /* check if all required vars are available to create a new ldap connection */
1353 $missing = "";
1354 foreach(array("snapshotURI","snapshotAdminDn","snapshotAdminPassword","snapshotBase") as $var){
1355 if($config->get_cfg_value($var) == ""){
1356 $missing .= $var." ";
1358 /* Send message if not done already */
1359 if(!session::is_set("snapshotFailMessageSend")){
1360 ession::set("snapshotFailMessageSend",TRUE);
1361 msg_dialog::display(_("Configuration error"),
1362 sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),
1363 $missing), ERROR_DIALOG);
1364 }
1365 return(FALSE);
1366 }
1367 }
1368 }
1369 return(TRUE);
1370 }
1371 return(FALSE);
1372 }
1375 /* Return available snapshots for the given base
1376 */
1377 function Available_SnapsShots($dn,$raw = false)
1378 {
1379 if(!$this->snapshotEnabled()) return(array());
1381 /* Create an additional ldap object which
1382 points to our ldap snapshot server */
1383 $ldap= $this->config->get_ldap_link();
1384 $ldap->cd($this->config->current['BASE']);
1385 $cfg= &$this->config->current;
1387 /* check if there are special server configurations for snapshots */
1388 if($this->config->get_cfg_value("snapshotURI") == ""){
1389 $ldap_to = $ldap;
1390 }else{
1391 $server = $this->config->get_cfg_value("snapshotURI");
1392 $user = $this->config->get_cfg_value("snapshotAdminDn");
1393 $password = $this->config->get_cfg_value("snapshotAdminPassword");
1394 $snapldapbase = $this->config->get_cfg_value("snapshotBase");
1395 $ldap_to = new ldapMultiplexer(new LDAP($user,$password, $server));
1396 $ldap_to -> cd($snapldapbase);
1397 if (!$ldap_to->success()){
1398 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1399 }
1400 }
1402 /* Prepare bases and some other infos */
1403 $base = $this->config->current['BASE'];
1404 $snap_base = $this->config->get_cfg_value("snapshotBase");
1405 $base_of_object = preg_replace ('/^[^,]+,/i', '', $dn);
1406 $new_base = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1407 $tmp = array();
1409 /* Fetch all objects with gosaSnapshotDN=$dn */
1410 $ldap_to->cd($new_base);
1411 $ldap_to->ls("(&(objectClass=gosaSnapshotObject)(gosaSnapshotDN=".$dn."))",$new_base,
1412 array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
1414 /* Put results into a list and add description if missing */
1415 while($entry = $ldap_to->fetch()){
1416 if(!isset($entry['description'][0])){
1417 $entry['description'][0] = "";
1418 }
1419 $tmp[] = $entry;
1420 }
1422 /* Return the raw array, or format the result */
1423 if($raw){
1424 return($tmp);
1425 }else{
1426 $tmp2 = array();
1427 foreach($tmp as $entry){
1428 $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
1429 }
1430 }
1431 return($tmp2);
1432 }
1435 function getAllDeletedSnapshots($base_of_object,$raw = false)
1436 {
1437 if(!$this->snapshotEnabled()) return(array());
1439 /* Create an additional ldap object which
1440 points to our ldap snapshot server */
1441 $ldap= $this->config->get_ldap_link();
1442 $ldap->cd($this->config->current['BASE']);
1443 $cfg= &$this->config->current;
1445 /* check if there are special server configurations for snapshots */
1446 if($this->config->get_cfg_value("snapshotURI") == ""){
1447 $ldap_to = $ldap;
1448 }else{
1449 $server = $this->config->get_cfg_value("snapshotURI");
1450 $user = $this->config->get_cfg_value("snapshotAdminDn");
1451 $password = $this->config->get_cfg_value("snapshotAdminPassword");
1452 $snapldapbase = $this->config->get_cfg_value("snapshotBase");
1453 $ldap_to = new ldapMultiplexer(new LDAP($user,$password, $server));
1454 $ldap_to -> cd($snapldapbase);
1455 if (!$ldap_to->success()){
1456 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1457 }
1458 }
1460 /* Prepare bases */
1461 $base = $this->config->current['BASE'];
1462 $snap_base = $this->config->get_cfg_value("snapshotBase");
1463 $new_base = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
1465 /* Fetch all objects and check if they do not exist anymore */
1466 $ui = get_userinfo();
1467 $tmp = array();
1468 $ldap_to->cd($new_base);
1469 $ldap_to->ls("(objectClass=gosaSnapshotObject)",$new_base,array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
1470 while($entry = $ldap_to->fetch()){
1472 $chk = str_replace($new_base,"",$entry['dn']);
1473 if(preg_match("/,ou=/",$chk)) continue;
1475 if(!isset($entry['description'][0])){
1476 $entry['description'][0] = "";
1477 }
1478 $tmp[] = $entry;
1479 }
1481 /* Check if entry still exists */
1482 foreach($tmp as $key => $entry){
1483 $ldap->cat($entry['gosaSnapshotDN'][0]);
1484 if($ldap->count()){
1485 unset($tmp[$key]);
1486 }
1487 }
1489 /* Format result as requested */
1490 if($raw) {
1491 return($tmp);
1492 }else{
1493 $tmp2 = array();
1494 foreach($tmp as $key => $entry){
1495 $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
1496 }
1497 }
1498 return($tmp2);
1499 }
1502 /* Restore selected snapshot */
1503 function restore_snapshot($dn)
1504 {
1505 if(!$this->snapshotEnabled()) return(array());
1507 $ldap= $this->config->get_ldap_link();
1508 $ldap->cd($this->config->current['BASE']);
1509 $cfg= &$this->config->current;
1511 /* check if there are special server configurations for snapshots */
1512 if($this->config->get_cfg_value("snapshotURI") == ""){
1513 $ldap_to = $ldap;
1514 }else{
1515 $server = $this->config->get_cfg_value("snapshotURI");
1516 $user = $this->config->get_cfg_value("snapshotAdminDn");
1517 $password = $this->config->get_cfg_value("snapshotAdminPassword");
1518 $snapldapbase = $this->config->get_cfg_value("snapshotBase");
1519 $ldap_to = new ldapMultiplexer(new LDAP($user,$password, $server));
1520 $ldap_to -> cd($snapldapbase);
1521 if (!$ldap_to->success()){
1522 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
1523 }
1524 }
1526 /* Get the snapshot */
1527 $ldap_to->cat($dn);
1528 $restoreObject = $ldap_to->fetch();
1530 /* Prepare import string */
1531 $data = gzuncompress($ldap_to->get_attribute($dn,'gosaSnapshotData'));
1533 /* Import the given data */
1534 $err = "";
1535 $ldap->import_complete_ldif($data,$err,false,false);
1536 if (!$ldap->success()){
1537 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, "", get_class()));
1538 }
1539 }
1542 function showSnapshotDialog($base,$baseSuffixe,&$parent)
1543 {
1544 $once = true;
1545 $ui = get_userinfo();
1546 $this->parent = $parent;
1548 foreach($_POST as $name => $value){
1550 /* Create a new snapshot, display a dialog */
1551 if(preg_match("/^CreateSnapShotDialog_[^_]*_[xy]$/",$name) && $once){
1553 $entry = base64_decode(preg_replace("/^CreateSnapShotDialog_([^_]*)_[xy]$/","\\1",$name));
1554 $once = false;
1555 $entry = preg_replace("/^CreateSnapShotDialog_/","",$entry);
1557 if(!empty($entry) && $ui->allow_snapshot_create($entry,$this->parent->acl_module)){
1558 $this->snapDialog = new SnapShotDialog($this->config,$entry,$this);
1559 }else{
1560 msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to create a snapshot for %s."),$entry),ERROR_DIALOG);
1561 }
1562 }
1564 /* Restore a snapshot, display a dialog with all snapshots of the current object */
1565 if(preg_match("/^RestoreSnapShotDialog_/",$name) && $once){
1566 $once = false;
1567 $entry = base64_decode(preg_replace("/^RestoreSnapShotDialog_([^_]*)_[xy]$/i","\\1",$name));
1568 if(!empty($entry) && $ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1569 $this->snapDialog = new SnapShotDialog($this->config,$entry,$this);
1570 $this->snapDialog->display_restore_dialog = true;
1571 }else{
1572 msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),ERROR_DIALOG);
1573 }
1574 }
1576 /* Restore one of the already deleted objects */
1577 if(((isset($_POST['menu_action']) && $_POST['menu_action'] == "RestoreDeletedSnapShot")
1578 || preg_match("/^RestoreDeletedSnapShot_/",$name)) && $once){
1579 $once = false;
1581 if($ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1582 $this->snapDialog = new SnapShotDialog($this->config,"",$this);
1583 $this->snapDialog->set_snapshot_bases($baseSuffixe);
1584 $this->snapDialog->display_restore_dialog = true;
1585 $this->snapDialog->display_all_removed_objects = true;
1586 }else{
1587 msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$base),ERROR_DIALOG);
1588 }
1589 }
1591 /* Restore selected snapshot */
1592 if(preg_match("/^RestoreSnapShot_/",$name) && $once){
1593 $once = false;
1594 $entry = base64_decode(preg_replace("/^RestoreSnapShot_([^_]*)_[xy]$/i","\\1",$name));
1596 if(!empty($entry) && $ui->allow_snapshot_restore($this->dn,$this->parent->acl_module)){
1597 $this->restore_snapshot($entry);
1598 $this->snapDialog = NULL;
1599 }else{
1600 msg_dialog::display(_("Permission"),sprintf(_("You are not allowed to restore a snapshot for %s."),$entry),ERROR_DIALOG);
1601 }
1602 }
1603 }
1605 /* Create a new snapshot requested, check
1606 the given attributes and create the snapshot*/
1607 if(isset($_POST['CreateSnapshot']) && is_object($this->snapDialog)){
1608 $this->snapDialog->save_object();
1609 $msgs = $this->snapDialog->check();
1610 if(count($msgs)){
1611 foreach($msgs as $msg){
1612 msg_dialog::display(_("Error"), $msg, ERROR_DIALOG);
1613 }
1614 }else{
1615 $this->dn = $this->snapDialog->dn;
1616 $this->create_snapshot("snapshot",$this->snapDialog->CurrentDescription);
1617 $this->snapDialog = NULL;
1618 }
1619 }
1621 /* Restore is requested, restore the object with the posted dn .*/
1622 if((isset($_POST['RestoreSnapshot'])) && (isset($_POST['SnapShot']))){
1623 }
1625 if(isset($_POST['CancelSnapshot'])){
1626 $this->snapDialog = NULL;
1627 }
1629 if(is_object($this->snapDialog )){
1630 $this->snapDialog->save_object();
1631 return($this->snapDialog->execute());
1632 }
1633 }
1636 static function plInfo()
1637 {
1638 return array();
1639 }
1642 function set_acl_base($base)
1643 {
1644 $this->acl_base= $base;
1645 }
1648 function set_acl_category($category)
1649 {
1650 $this->acl_category= "$category/";
1651 }
1654 function acl_is_writeable($attribute,$skip_write = FALSE)
1655 {
1656 if($this->read_only) return(FALSE);
1657 $ui= get_userinfo();
1658 return preg_match('/w/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute, $skip_write));
1659 }
1662 function acl_is_readable($attribute)
1663 {
1664 $ui= get_userinfo();
1665 return preg_match('/r/', $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute));
1666 }
1669 function acl_is_createable($base ="")
1670 {
1671 if($this->read_only) return(FALSE);
1672 $ui= get_userinfo();
1673 if($base == "") $base = $this->acl_base;
1674 return preg_match('/c/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1675 }
1678 function acl_is_removeable($base ="")
1679 {
1680 if($this->read_only) return(FALSE);
1681 $ui= get_userinfo();
1682 if($base == "") $base = $this->acl_base;
1683 return preg_match('/d/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1684 }
1687 function acl_is_moveable($base = "")
1688 {
1689 if($this->read_only) return(FALSE);
1690 $ui= get_userinfo();
1691 if($base == "") $base = $this->acl_base;
1692 return preg_match('/m/', $ui->get_permissions($base, $this->acl_category.get_class($this), '0'));
1693 }
1696 function acl_have_any_permissions()
1697 {
1698 }
1701 function getacl($attribute,$skip_write= FALSE)
1702 {
1703 $ui= get_userinfo();
1704 $skip_write |= $this->read_only;
1705 return $ui->get_permissions($this->acl_base, $this->acl_category.get_class($this), $attribute,$skip_write);
1706 }
1709 /*! \brief Returns a list of all available departments for this object.
1710 If this object is new, all departments we are allowed to create a new user in are returned.
1711 If this is an existing object, return all deps. we are allowed to move tis object too.
1713 @return Array [dn] => "..name" // All deps. we are allowed to act on.
1714 */
1715 function get_allowed_bases()
1716 {
1717 $ui = get_userinfo();
1718 $deps = array();
1720 /* Is this a new object ? Or just an edited existing object */
1721 if(!$this->initially_was_account && $this->is_account){
1722 $new = true;
1723 }else{
1724 $new = false;
1725 }
1727 foreach($this->config->idepartments as $dn => $name){
1728 if($new && $this->acl_is_createable($dn)){
1729 $deps[$dn] = $name;
1730 }elseif(!$new && $this->acl_is_moveable($dn)){
1731 $deps[$dn] = $name;
1732 }
1733 }
1735 /* Add current base */
1736 if(isset($this->base) && isset($this->config->idepartments[$this->base])){
1737 $deps[$this->base] = $this->config->idepartments[$this->base];
1738 }elseif(strtolower($this->dn) == strtolower($this->config->current['BASE'])){
1740 }else{
1741 trigger_error("Cannot return list of departments, no default base found in class ".get_class($this).". ".$this->base);
1742 }
1743 return($deps);
1744 }
1747 /* This function updates ACL settings if $old_dn was used.
1748 * $old_dn specifies the actually used dn
1749 * $new_dn specifies the destiantion dn
1750 */
1751 function update_acls($old_dn,$new_dn,$output_changes = FALSE)
1752 {
1753 /* Check if old_dn is empty. This should never happen */
1754 if(empty($old_dn) || empty($new_dn)){
1755 trigger_error("Failed to check acl dependencies, wrong dn given.");
1756 return;
1757 }
1759 /* Update userinfo if necessary */
1760 $ui = session::global_get('ui');
1761 if($ui->dn == $old_dn){
1762 $ui->dn = $new_dn;
1763 session::global_set('ui',$ui);
1764 new log("view","acl/".get_class($this),$this->dn,array(),"Updated current object dn from '".$old_dn."' to '".$new_dn."'");
1765 }
1767 /* Object was moved, ensure that all acls will be moved too */
1768 if($new_dn != $old_dn && $old_dn != "new"){
1770 /* get_ldap configuration */
1771 $update = array();
1772 $ldap = $this->config->get_ldap_link();
1773 $ldap->cd ($this->config->current['BASE']);
1774 $ldap->search("(&(objectClass=gosaAcl)(gosaAclEntry=*".base64_encode($old_dn)."*))",array("cn","gosaAclEntry"));
1775 while($attrs = $ldap->fetch()){
1776 $acls = array();
1777 $found = false;
1778 for($i = 0 ; $i < $attrs['gosaAclEntry']['count'] ; $i ++ ){
1779 $acl_parts = split(":",$attrs['gosaAclEntry'][$i]);
1781 /* Roles uses antoher data storage order, members are stored int the third part,
1782 while the members in direct ACL assignments are stored in the second part.
1783 */
1784 $id = ($acl_parts[1] == "role") ? 3 : 2;
1786 /* Update member entries to use $new_dn instead of old_dn
1787 */
1788 $members = explode(",",$acl_parts[$id]);
1789 foreach($members as $key => $member){
1790 $member = base64_decode($member);
1791 if($member == $old_dn){
1792 $members[$key] = base64_encode($new_dn);
1793 $found = TRUE;
1794 }
1795 }
1797 /* Check if the selected role has to updated
1798 */
1799 if($acl_parts[1] == "role" && $acl_parts[2] == base64_encode($old_dn)){
1800 $acl_parts[2] = base64_encode($new_dn);
1801 $found = TRUE;
1802 }
1804 /* Build new acl string */
1805 $acl_parts[$id] = implode($members,",");
1806 $acls[] = implode($acl_parts,":");
1807 }
1809 /* Acls for this object must be adjusted */
1810 if($found){
1812 $debug_info= _("Changing ACL dn")." : <br> -"._("from")." <b> ".
1813 $old_dn."</b><br> -"._("to")." <b>".$new_dn."</b><br>";
1814 @DEBUG (DEBUG_ACL, __LINE__, __FUNCTION__, __FILE__,$debug_info,"ACL");
1816 $update[$attrs['dn']] =array();
1817 foreach($acls as $acl){
1818 $update[$attrs['dn']]['gosaAclEntry'][] = $acl;
1819 }
1820 }
1821 }
1823 /* Write updated acls */
1824 foreach($update as $dn => $attrs){
1825 $ldap->cd($dn);
1826 $ldap->modify($attrs);
1827 }
1828 }
1829 }
1833 /* This function enables the entry Serial ID check.
1834 * If an entry was edited while we have edited the entry too,
1835 * an error message will be shown.
1836 * To configure this check correctly read the FAQ.
1837 */
1838 function enable_CSN_check()
1839 {
1840 $this->CSN_check_active =TRUE;
1841 $this->entryCSN = getEntryCSN($this->dn);
1842 }
1845 /*! \brief Prepares the plugin to be used for multiple edit
1846 * Update plugin attributes with given array of attribtues.
1847 * @param array Array with attributes that must be updated.
1848 */
1849 function init_multiple_support($attrs,$all)
1850 {
1851 $ldap= $this->config->get_ldap_link();
1852 $this->multi_attrs = $attrs;
1853 $this->multi_attrs_all= $all;
1855 /* Copy needed attributes */
1856 foreach ($this->attributes as $val){
1857 $found= array_key_ics($val, $this->multi_attrs);
1858 if ($found != ""){
1859 if(isset($this->multi_attrs["$found"][0])){
1860 $this->$val= $this->multi_attrs["$found"][0];
1861 }
1862 }
1863 }
1864 }
1867 /*! \brief Enables multiple support for this plugin
1868 */
1869 function enable_multiple_support()
1870 {
1871 $this->ignore_account = TRUE;
1872 $this->multiple_support_active = TRUE;
1873 }
1876 /*! \brief Returns all values that have been modfied in multiple edit mode.
1877 @return array Cotaining all mdofied values.
1878 */
1879 function get_multi_edit_values()
1880 {
1881 $ret = array();
1882 foreach($this->attributes as $attr){
1883 if(in_array($attr,$this->multi_boxes)){
1884 $ret[$attr] = $this->$attr;
1885 }
1886 }
1887 return($ret);
1888 }
1891 /*! \brief Update class variables with values collected by multiple edit.
1892 */
1893 function set_multi_edit_values($attrs)
1894 {
1895 foreach($attrs as $name => $value){
1896 $this->$name = $value;
1897 }
1898 }
1901 /*! \brief execute plugin
1903 Generates the html output for this node
1904 */
1905 function multiple_execute()
1906 {
1907 /* This one is empty currently. Fabian - please fill in the docu code */
1908 session::global_set('current_class_for_help',get_class($this));
1910 /* Reset Lock message POST/GET check array, to prevent perg_match errors*/
1911 session::set('LOCK_VARS_TO_USE',array());
1912 session::set('LOCK_VARS_USED',array());
1914 return("Multiple edit is currently not implemented for this plugin.");
1915 }
1918 /*! \brief Save HTML posted data to object for multiple edit
1919 */
1920 function multiple_save_object()
1921 {
1922 if(empty($this->entryCSN) && $this->CSN_check_active){
1923 $this->entryCSN = getEntryCSN($this->dn);
1924 }
1926 /* Save values to object */
1927 $this->multi_boxes = array();
1928 foreach ($this->attributes as $val){
1930 /* Get selected checkboxes from multiple edit */
1931 if(isset($_POST["use_".$val])){
1932 $this->multi_boxes[] = $val;
1933 }
1935 if ($this->acl_is_writeable($val) && isset ($_POST["$val"])){
1937 /* Check for modifications */
1938 if (get_magic_quotes_gpc()) {
1939 $data= stripcslashes($_POST["$val"]);
1940 } else {
1941 $data= $this->$val = $_POST["$val"];
1942 }
1943 if ($this->$val != $data){
1944 $this->is_modified= TRUE;
1945 }
1947 /* IE post fix */
1948 if(isset($data[0]) && $data[0] == chr(194)) {
1949 $data = "";
1950 }
1951 $this->$val= $data;
1952 }
1953 }
1954 }
1957 /*! \brief Returns all attributes of this plugin,
1958 to be able to detect multiple used attributes
1959 in multi_plugg::detect_multiple_used_attributes().
1960 @return array Attributes required for intialization of multi_plug
1961 */
1962 public function get_multi_init_values()
1963 {
1964 $attrs = $this->attrs;
1965 return($attrs);
1966 }
1969 /*! \brief Check given values in multiple edit
1970 @return array Error messages
1971 */
1972 function multiple_check()
1973 {
1974 $message = plugin::check();
1975 return($message);
1976 }
1979 /*! \brief Returns the snapshot header part for "Actions" menu in management dialogs
1980 @param $layer_menu
1981 */
1982 function get_snapshot_header($base,$category)
1983 {
1984 $str = "";
1985 $ui = get_userinfo();
1986 if($this->snapshotEnabled() && $ui->allow_snapshot_restore($base,$category)){
1988 $ok = false;
1989 foreach($this->get_used_snapshot_bases() as $base){
1990 $ok |= count($this->getAllDeletedSnapshots($base)) >= 1 ;
1991 }
1993 if($ok){
1994 $str = "..|<img class='center' src='images/lists/restore.png' ".
1995 "alt='"._("Restore")."'> "._("Restore"). "|RestoreDeletedSnapShot|\n";
1996 }else{
1997 $str = "..|<img class='center' src='images/lists/restore_grey.png' alt=''> "._("Restore")."||\n";
1998 }
1999 }
2000 return($str);
2001 }
2004 function get_snapshot_action($base,$category)
2005 {
2006 $str= "";
2007 $ui = get_userinfo();
2008 if($this->snapshotEnabled()){
2009 if ($ui->allow_snapshot_restore($base,$category)){
2011 if(count($this->Available_SnapsShots($base))){
2012 $str.= "<input class='center' type='image' src='images/lists/restore.png'
2013 alt='"._("Restore snapshot")."' name='RestoreSnapShotDialog_".base64_encode($base)."' title='"._("Restore snapshot")."'> ";
2014 } else {
2015 $str = "<img class='center' src='images/lists/restore_grey.png' alt=''> ";
2016 }
2017 }
2018 if($ui->allow_snapshot_create($base,$category)){
2019 $str.= "<input class='center' type='image' src='images/snapshot.png'
2020 alt='"._("Create snapshot")."' name='CreateSnapShotDialog_".base64_encode($base)."'
2021 title='"._("Create a new snapshot from this object")."'> ";
2022 }else{
2023 $str = "<img class='center' src='images/empty.png' alt=' '> ";
2024 }
2025 }
2027 return($str);
2028 }
2031 function get_copypaste_action($base,$category,$class,$copy = TRUE, $cut = TRUE)
2032 {
2033 $ui = get_userinfo();
2034 $action = "";
2035 if($this->CopyPasteHandler){
2036 if($cut){
2037 if($ui->is_cutable($base,$category,$class)){
2038 $action .= "<input class='center' type='image'
2039 src='images/lists/cut.png' alt='"._("cut")."' name='cut_%KEY%' title='"._("Cut this entry")."'> ";
2040 }else{
2041 $action.="<img src='images/empty.png' alt=' ' class='center'> ";
2042 }
2043 }
2044 if($copy){
2045 if($ui->is_copyable($base,$category,$class)){
2046 $action.= "<input class='center' type='image'
2047 src='images/lists/copy.png' alt='"._("copy")."' name='copy_%KEY%' title='"._("Copy this entry")."'> ";
2048 }else{
2049 $action.="<img src='images/empty.png' alt=' ' class='center'> ";
2050 }
2051 }
2052 }
2054 return($action);
2055 }
2058 function get_copypaste_header($base,$category,$copy = TRUE, $cut = TRUE)
2059 {
2060 $s = "";
2061 $ui =get_userinfo();
2063 if(!is_array($category)){
2064 $category = array($category);
2065 }
2067 /* Check permissions for each category, if there is at least one category which
2068 support read or paste permissions for the given base, then display the specific actions.
2069 */
2070 $readable = $pasteable = TRUE;
2071 foreach($category as $cat){
2072 $readable |= $ui->get_category_permissions($base,$cat);
2073 $pasteable|= $ui->is_pasteable($base,$cat);
2074 }
2076 if(($cut || $copy) && isset($this->CopyPasteHandler) && is_object($this->CopyPasteHandler)){
2077 if($readable){
2078 $s.= "..|---|\n";
2079 if($copy){
2080 $s.= "..|<img src='images/lists/copy.png' alt='' border='0' class='center'>".
2081 " "._("Copy")."|"."multiple_copy_systems|\n";
2082 }
2083 if($cut){
2084 $s.= "..|<img src='images/lists/cut.png' alt='' border='0' class='center'>".
2085 " "._("Cut")."|"."multiple_cut_systems|\n";
2086 }
2087 }
2089 if($pasteable){
2090 if($this->CopyPasteHandler->entries_queued()){
2091 $img = "<img border='0' class='center' src='images/lists/paste.png' alt=''>";
2092 $s.="..|".$img." "._("Paste")."|editPaste|\n";
2093 }else{
2094 $img = "<img border='0' class='center' src='images/lists/paste-grey.png' alt=''>";
2095 $s.="..|".$img." "._("Paste")."\n";
2096 }
2097 }
2098 }
2099 return($s);
2100 }
2103 function get_used_snapshot_bases()
2104 {
2105 return(array());
2106 }
2108 function is_modal_dialog()
2109 {
2110 return(isset($this->dialog) && $this->dialog);
2111 }
2112 }
2114 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2115 ?>