c2c4ca5f8ebf24626f4bf882728ba0a19dd96283
1 <?php
2 /*
3 This code is part of GOsa (https://gosa.gonicus.de)
4 Copyright (C) 2003 Cajus Pollmeier
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
21 /*! \brief The plugin base class
22 \author Cajus Pollmeier <pollmeier@gonicus.de>
23 \version 2.00
24 \date 24.07.2003
26 This is the base class for all plugins. It can be used standalone or
27 can be included by the tabs class. All management should be done
28 within this class. Extend your plugins from this class.
29 */
31 class plugin
32 {
33 /*!
34 \brief Reference to parent object
36 This variable is used when the plugin is included in tabs
37 and keeps reference to the tab class. Communication to other
38 tabs is possible by 'name'. So the 'fax' plugin can ask the
39 'userinfo' plugin for the fax number.
41 \sa tab
42 */
43 var $parent= NULL;
45 /*!
46 \brief Configuration container
48 Access to global configuration
49 */
50 var $config= NULL;
52 /*!
53 \brief Mark plugin as account
55 Defines whether this plugin is defined as an account or not.
56 This has consequences for the plugin to be saved from tab
57 mode. If it is set to 'FALSE' the tab will call the delete
58 function, else the save function. Should be set to 'TRUE' if
59 the construtor detects a valid LDAP object.
61 \sa plugin::plugin()
62 */
63 var $is_account= FALSE;
64 var $initially_was_account= FALSE;
66 /*!
67 \brief Mark plugin as template
69 Defines whether we are creating a template or a normal object.
70 Has conseqences on the way execute() shows the formular and how
71 save() puts the data to LDAP.
73 \sa plugin::save() plugin::execute()
74 */
75 var $is_template= FALSE;
76 var $ignore_account= FALSE;
77 var $is_modified= FALSE;
79 /*!
80 \brief Represent temporary LDAP data
82 This is only used internally.
83 */
84 var $attrs= array();
87 /*!
88 \brief Used standard values
90 dn
91 */
92 var $dn= "";
93 var $uid= "";
94 var $sn= "";
95 var $givenName= "";
96 var $acl= "*none*";
97 var $dialog= FALSE;
99 /* attribute list for save action */
100 var $attributes= array();
101 var $objectclasses= array();
102 var $new= TRUE;
103 var $saved_attributes= array();
105 /*! \brief plugin constructor
107 If 'dn' is set, the node loads the given 'dn' from LDAP
109 \param dn Distinguished name to initialize plugin from
110 \sa plugin()
111 */
112 function plugin ($config, $dn= NULL)
113 {
114 /* Configuration is fine, allways */
115 $this->config= $config;
116 $this->dn= $dn;
118 /* Handle new accounts, don't read information from LDAP */
119 if ($dn == "new"){
120 return;
121 }
123 /* Get LDAP descriptor */
124 $ldap= $this->config->get_ldap_link();
125 if ($dn != NULL){
127 /* Load data to 'attrs' and save 'dn' */
128 $ldap->cat ($dn);
129 $this->attrs= $ldap->fetch();
131 /* Copy needed attributes */
132 foreach ($this->attributes as $val){
133 #if (isset($this->attrs["$val"][0])){
134 $found= array_key_ics($val, $this->attrs);
135 if ($found != ""){
136 $this->$val= $this->attrs["$found"][0];
137 }
138 }
140 /* Set the template flag according to the existence of objectClass
141 gosaUserTemplate */
142 if (isset($this->attrs['objectClass'])){
143 if (in_array ("gosaUserTemplate", $this->attrs['objectClass'])){
144 $this->is_template= TRUE;
145 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
146 "found", "Template check");
147 }
148 }
150 /* Is Account? */
151 error_reporting(0);
152 $found= TRUE;
153 foreach ($this->objectclasses as $obj){
154 if (preg_match('/top/i', $obj)){
155 continue;
156 }
157 if (!isset($this->attrs['objectClass']) || !in_array_ics ($obj, $this->attrs['objectClass'])){
158 $found= FALSE;
159 break;
160 }
161 }
162 error_reporting(E_ALL);
163 if ($found){
164 $this->is_account= TRUE;
165 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
166 "found", "Object check");
167 }
169 /* Prepare saved attributes */
170 $this->saved_attributes= $this->attrs;
171 foreach ($this->saved_attributes as $index => $value){
172 if (preg_match('/^[0-9]+$/', $index)){
173 unset($this->saved_attributes[$index]);
174 continue;
175 }
176 if (!in_array($index, $this->attributes) && $index != "objectClass"){
177 unset($this->saved_attributes[$index]);
178 continue;
179 }
180 if ($this->saved_attributes[$index]["count"] == 1){
181 $tmp= $this->saved_attributes[$index][0];
182 unset($this->saved_attributes[$index]);
183 $this->saved_attributes[$index]= $tmp;
184 continue;
185 }
187 unset($this->saved_attributes["$index"]["count"]);
188 }
189 }
191 /* Save initial account state */
192 $this->initially_was_account= $this->is_account;
193 }
195 /*! \brief execute plugin
197 Generates the html output for this node
198 */
199 function execute()
200 {
201 # This one is empty currently. Fabian - please fill in the docu code
202 $_SESSION['current_class_for_help'] = get_class($this);
203 }
205 /* remove object from parent */
206 function remove_from_parent()
207 {
208 /* include global link_info */
209 $ldap= $this->config->get_ldap_link();
211 /* Get current objectClasses in order to add the required ones */
212 $ldap->cat($this->dn);
213 $tmp= $ldap->fetch ();
214 if (isset($tmp['objectClass'])){
215 $oc= $tmp['objectClass'];
216 } else {
217 $oc= array("count" => 0);
218 }
220 /* Remove objectClasses from entry */
221 $ldap->cd($this->dn);
222 $this->attrs= array();
223 $this->attrs['objectClass']= array();
224 for ($i= 0; $i<$oc["count"]; $i++){
225 if (!in_array_ics($oc[$i], $this->objectclasses)){
226 $this->attrs['objectClass'][]= $oc[$i];
227 }
228 }
230 /* Unset attributes from entry */
231 foreach ($this->attributes as $val){
232 $this->attrs["$val"]= array();
233 }
235 /* Unset account info */
236 $this->is_account= FALSE;
238 /* Do not write in plugin base class, this must be done by
239 children, since there are normally additional attribs,
240 lists, etc. */
241 /*
242 $ldap->modify($this->attrs);
243 */
244 }
247 /* Save data to object */
248 function save_object()
249 {
250 /* Save values to object */
251 foreach ($this->attributes as $val){
252 if (chkacl ($this->acl, "$val") == "" && isset ($_POST["$val"])){
253 /* Check for modifications */
254 if (get_magic_quotes_gpc()) {
255 $data= stripcslashes($_POST["$val"]);
256 } else {
257 $data= $this->$val = $_POST["$val"];
258 }
259 if ($this->$val != $data){
260 $this->is_modified= TRUE;
261 }
263 /* Okay, how can I explain this fix ...
264 * In firefox, disabled option fields aren't selectable ... but in IE you can select these fileds.
265 * So IE posts these 'unselectable' option, with value = chr(194)
266 * chr(194) seems to be the in between the ...option> </option.. because there is no value=".." specified in these option fields
267 * This was added for W3c compliance, but now causes these ... ldap errors ...
268 * So we set these Fields to ""; a normal empty string, and we can check these values in plugin::check() again ...
269 */
270 if(isset($data[0]) && $data[0] == chr(194)) {
271 $data = "";
272 }
273 $this->$val= $data;
274 }
275 }
276 }
279 /* Save data to LDAP, depending on is_account we save or delete */
280 function save()
281 {
282 /* include global link_info */
283 $ldap= $this->config->get_ldap_link();
285 /* Start with empty array */
286 $this->attrs= array();
288 /* Get current objectClasses in order to add the required ones */
289 $ldap->cat($this->dn);
291 $tmp= $ldap->fetch ();
293 if (isset($tmp['objectClass'])){
294 $oc= $tmp["objectClass"];
295 $this->new= FALSE;
296 } else {
297 $oc= array("count" => 0);
298 $this->new= TRUE;
299 }
301 /* Load (minimum) attributes, add missing ones */
302 $this->attrs['objectClass']= $this->objectclasses;
303 for ($i= 0; $i<$oc["count"]; $i++){
304 if (!in_array_ics($oc[$i], $this->objectclasses)){
305 $this->attrs['objectClass'][]= $oc[$i];
306 }
307 }
309 /* Copy standard attributes */
310 foreach ($this->attributes as $val){
311 if ($this->$val != ""){
312 $this->attrs["$val"]= $this->$val;
313 } elseif (!$this->new) {
314 $this->attrs["$val"]= array();
315 }
316 }
318 }
320 function cleanup()
321 {
322 /* Clean up */
323 foreach ($this->attrs as $index => $value){
324 if (is_array($this->attrs[$index]) && count($this->attrs[$index]) == 0 && !isset($this->saved_attributes[$index])){
325 unset ($this->attrs[$index]);
326 continue;
327 }
329 if (!is_array($this->attrs[$index]) && isset($this->saved_attributes[$index])
330 && !is_array($this->saved_attributes[$index]) && $value == $this->saved_attributes[$index]){
331 unset ($this->attrs[$index]);
332 continue;
333 }
335 if (is_array($this->attrs[$index]) && is_array($this->saved_attributes[$index]) &&
336 count(array_diff($this->attrs[$index], $this->saved_attributes[$index]))==0 && $index != "objectClass"){
337 unset ($this->attrs[$index]);
338 continue;
339 }
340 }
342 #################################
343 ; echo "--- DEBUG: changes ---" ;
344 ; print_a ($this->attrs) ;
345 #################################
346 }
348 /* Check formular input */
349 function check()
350 {
351 $message= array();
352 return ($message);
353 }
355 /* Adapt from template, using 'dn' */
356 function adapt_from_template($dn)
357 {
358 /* Include global link_info */
359 $ldap= $this->config->get_ldap_link();
361 /* Load requested 'dn' to 'attrs' */
362 $ldap->cat ($dn);
363 $this->attrs= $ldap->fetch();
365 /* Walk through attributes */
366 foreach ($this->attributes as $val){
368 if (isset($this->attrs["$val"][0])){
370 /* If attribute is set, replace dynamic parts:
371 %sn, %givenName and %uid. Fill these in our local variables. */
372 $value= $this->attrs["$val"][0];
374 foreach (array("sn", "givenName", "uid") as $repl){
375 if (preg_match("/%$repl/i", $value)){
376 $value= preg_replace ("/%$repl/i", $this->parent->$repl, $value);
377 }
378 }
379 $this->$val= $value;
380 }
381 }
383 /* Is Account? */
384 $found= TRUE;
385 foreach ($this->objectclasses as $obj){
386 if (preg_match('/top/i', $obj)){
387 continue;
388 }
389 if (!in_array_ics ($obj, $this->attrs['objectClass'])){
390 $found= FALSE;
391 break;
392 }
393 }
394 if ($found){
395 $this->is_account= TRUE;
396 }
397 }
399 /* Indicate whether a password change is needed or not */
400 function password_change_needed()
401 {
402 return FALSE;
403 }
405 /* Show header message for tab dialogs */
406 function show_header($button_text, $text, $disabled= FALSE)
407 {
408 if ($disabled == TRUE){
409 $state= "disabled";
410 } else {
411 $state= "";
412 }
413 $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
414 $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".
415 chkacl($this->acl, "all")." ".$state.
416 "><p class=\"seperator\"> </p></td></tr></table>";
418 return($display);
419 }
421 function postcreate()
422 {
423 /* Find postcreate entries for this class */
424 $command= search_config($this->config->data['MENU'], get_class($this), "POSTCREATE");
425 if ($command == "" && isset($this->config->data['TABS'])){
426 $command= search_config($this->config->data['TABS'], get_class($this), "POSTCREATE");
427 }
429 if ($command != ""){
430 /* Walk through attribute list */
431 foreach ($this->attributes as $attr){
432 if (!is_array($this->$attr)){
433 $command= preg_replace("/%$attr/", $this->$attr, $command);
434 }
435 }
436 $command= preg_replace("/%dn/", $this->dn, $command);
437 if (check_command($command)){
438 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
439 $command, "Execute");
441 exec($command);
442 } else {
443 $message= sprintf(_("Command '%s', specified as POSTCREATE for plugin '%s' doesn't seem to exist."), $command, get_class($this));
444 print_red ($message);
445 }
446 }
447 }
449 function postmodify()
450 {
451 /* Find postcreate entries for this class */
452 $command= search_config($this->config->data['MENU'], get_class($this), "POSTMODIFY");
453 if ($command == "" && isset($this->config->data['TABS'])){
454 $command= search_config($this->config->data['TABS'], get_class($this), "POSTMODIFY");
455 }
457 if ($command != ""){
458 /* Walk through attribute list */
459 foreach ($this->attributes as $attr){
460 if (!is_array($this->$attr)){
461 $command= preg_replace("/%$attr/", $this->$attr, $command);
462 }
463 }
464 $command= preg_replace("/%dn/", $this->dn, $command);
465 if (check_command($command)){
466 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
467 $command, "Execute");
469 exec($command);
470 } else {
471 $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, get_class($this));
472 print_red ($message);
473 }
474 }
475 }
477 function postremove()
478 {
479 /* Find postremove entries for this class */
480 $command= search_config($this->config->data['MENU'], get_class($this), "POSTREMOVE");
481 if ($command == "" && isset($this->config->data['TABS'])){
482 $command= search_config($this->config->data['TABS'], get_class($this), "POSTREMOVE");
483 }
485 if ($command != ""){
486 /* Walk through attribute list */
487 foreach ($this->attributes as $attr){
488 if (!is_array($this->$attr)){
489 $command= preg_replace("/%$attr/", $this->$attr, $command);
490 }
491 }
492 $command= preg_replace("/%dn/", $this->dn, $command);
493 if (check_command($command)){
494 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
495 $command, "Execute");
497 exec($command);
498 } else {
499 $message= sprintf(_("Command '%s', specified as POSTREMOVE for plugin '%s' doesn't seem to exist."), $command, get_class($this));
500 print_red ($message);
501 }
502 }
503 }
505 /* Create unique DN */
506 function create_unique_dn($attribute, $base)
507 {
508 $ldap= $this->config->get_ldap_link();
509 $base= preg_replace("/^,*/", "", $base);
511 /* Try to use plain entry first */
512 $dn= "$attribute=".$this->$attribute.",$base";
513 $ldap->cat ($dn);
514 if (!$ldap->fetch()){
515 return ($dn);
516 }
518 /* Look for additional attributes */
519 foreach ($this->attributes as $attr){
520 if ($attr == $attribute || $this->$attr == ""){
521 continue;
522 }
524 $dn= "$attribute=".$this->$attribute."+$attr=".$this->$attr.",$base";
525 $ldap->cat ($dn);
526 if (!$ldap->fetch()){
527 return ($dn);
528 }
529 }
531 /* None found */
532 return ("none");
533 }
535 function rebind($ldap, $referral)
536 {
537 $credentials= LDAP::get_credentials($referral, $this->config->current['REFERRAL']);
538 if (ldap_bind($ldap, $credentials['ADMIN'], $credentials['PASSWORD'])) {
539 $this->error = "Success";
540 $this->hascon=true;
541 $this->reconnect= true;
542 return (0);
543 } else {
544 $this->error = "Could not bind to " . $credentials['ADMIN'];
545 return NULL;
546 }
547 }
549 /* This is a workaround function. */
550 function copy($src_dn, $dst_dn)
551 {
552 /* Rename dn in possible object groups */
553 $ldap= $this->config->get_ldap_link();
554 $ldap->search('(&(objectClass=gosaGroupOfNames)(member='.$src_dn.'))',
555 array('cn'));
556 while ($attrs= $ldap->fetch()){
557 $og= new ogroup($this->config, $ldap->getDN());
558 unset($og->member[$src_dn]);
559 $og->member[$dst_dn]= $dst_dn;
560 $og->save ();
561 }
563 $ldap->cat($dst_dn);
564 $attrs= $ldap->fetch();
565 if (count($attrs)){
566 trigger_error("Trying to overwrite $dst_dn, which already exists.",
567 E_USER_WARNING);
568 return (FALSE);
569 }
571 $ldap->cat($src_dn);
572 $attrs= array();
573 $attrs= $ldap->fetch();
574 if (!count($attrs)){
575 trigger_error("Trying to move $src_dn, which does not seem to exist.",
576 E_USER_WARNING);
577 return (FALSE);
578 }
580 /* Grummble. This really sucks. PHP ldap doesn't support rdn stuff. */
581 $ds= ldap_connect($this->config->current['SERVER']);
582 ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
583 if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['REFERRAL'])) {
584 ldap_set_rebind_proc($ds, array(&$this, "rebind"));
585 }
587 $r=ldap_bind($ds,$this->config->current['ADMIN'], $this->config->current['PASSWORD']);
588 error_reporting (0);
589 $sr=ldap_read($ds, $src_dn, "objectClass=*");
591 /* Fill data from LDAP */
592 $new= array();
593 if ($sr) {
594 $ei=ldap_first_entry($ds, $sr);
595 if ($ei) {
596 foreach($attrs as $attr => $val){
597 if ($info = ldap_get_values_len($ds, $ei, $attr)){
598 for ($i= 0; $i<$info['count']; $i++){
599 if ($info['count'] == 1){
600 $new[$attr]= $info[$i];
601 } else {
602 $new[$attr][]= $info[$i];
603 }
604 }
605 }
606 }
607 }
608 }
610 /* close conncetion */
611 error_reporting (E_ALL);
612 ldap_unbind($ds);
614 /* Adapt naming attribute */
615 $dst_name= preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
616 $dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
617 $new[$dst_name]= $dst_val;
619 /* Save copy */
620 $ldap->connect();
621 $ldap->cd($this->config->current['BASE']);
622 $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
623 $ldap->cd($dst_dn);
624 $ldap->add($new);
626 if ($ldap->error != "Success"){
627 trigger_error("Trying to save $dst_dn failed.",
628 E_USER_WARNING);
629 return(FALSE);
630 }
632 return (TRUE);
633 }
636 function move($src_dn, $dst_dn)
637 {
638 /* Copy source to destination */
639 if (!$this->copy($src_dn, $dst_dn)){
640 return (FALSE);
641 }
643 /* Delete source */
644 $ldap= $this->config->get_ldap_link();
645 $ldap->rmdir($src_dn);
646 if ($ldap->error != "Success"){
647 trigger_error("Trying to delete $src_dn failed.",
648 E_USER_WARNING);
649 return (FALSE);
650 }
652 return (TRUE);
653 }
656 /* Move/Rename complete trees */
657 function recursive_move($src_dn, $dst_dn)
658 {
659 /* Check if the destination entry exists */
660 $ldap= $this->config->get_ldap_link();
662 /* Check if destination exists - abort */
663 $ldap->cat($dst_dn);
664 if ($ldap->fetch()){
665 trigger_error("recursive_move $dst_dn already exists.",
666 E_USER_WARNING);
667 return (FALSE);
668 }
670 /* Perform a search for all objects to be moved */
671 $objects= array();
672 $ldap->cd($src_dn);
673 $ldap->search("(objectClass=*)", array("dn"));
674 while($attrs= $ldap->fetch()){
675 $dn= $attrs['dn'];
676 $objects[$dn]= strlen($dn);
677 }
679 /* Sort objects by indent level */
680 asort($objects);
681 reset($objects);
683 /* Copy objects from small to big indent levels by replacing src_dn by dst_dn */
684 foreach ($objects as $object => $len){
685 $src= $object;
686 $dst= preg_replace("/$src_dn$/", "$dst_dn", $object);
687 if (!$this->copy($src, $dst)){
688 return (FALSE);
689 }
690 }
692 /* Remove src_dn */
693 $ldap->cd($src_dn);
694 $ldap->recursive_remove();
695 return (TRUE);
696 }
699 function handle_post_events($mode)
700 {
701 switch ($mode){
702 case "add":
703 $this->postcreate();
704 break;
706 case "modify":
707 $this->postmodify();
708 break;
710 case "remove":
711 $this->postremove();
712 break;
713 }
714 }
716 }
718 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
719 ?>