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 foreach ($this->attrs as $index => $value){
324 /* Remove emtpy arrays if they do not differ */
325 if (is_array($this->attrs[$index]) && count($this->attrs[$index]) == 0 && !isset($this->saved_attributes[$index])){
326 unset ($this->attrs[$index]);
327 continue;
328 }
330 /* Remove single attributes that do not differ */
331 if (!is_array($this->attrs[$index]) && isset($this->saved_attributes[$index])
332 && !is_array($this->saved_attributes[$index]) && $value == $this->saved_attributes[$index]){
333 unset ($this->attrs[$index]);
334 continue;
335 }
337 /* Remove arrays that do not differ */
338 if (is_array($this->attrs[$index]) && isset($this->saved_attributes[$index]) && is_array($this->saved_attributes[$index])){
339 $dst= $this->attrs[$index];
340 $src= $this->saved_attributes[$index];
341 sort($dst);
342 sort($src);
343 if (count(array_diff($src, $dst))==0 ){
344 unset ($this->attrs[$index]);
345 continue;
346 }
347 }
348 }
350 #######################################################
351 ; echo "--- DEBUG: changes ---<br>" ;
352 ; print_a ($this->attrs) ;
353 ; if (count($this->attrs)==0)echo "<b>Skipped</b><br>";
354 #######################################################
355 }
357 /* Check formular input */
358 function check()
359 {
360 $message= array();
361 return ($message);
362 }
364 /* Adapt from template, using 'dn' */
365 function adapt_from_template($dn)
366 {
367 /* Include global link_info */
368 $ldap= $this->config->get_ldap_link();
370 /* Load requested 'dn' to 'attrs' */
371 $ldap->cat ($dn);
372 $this->attrs= $ldap->fetch();
374 /* Walk through attributes */
375 foreach ($this->attributes as $val){
377 if (isset($this->attrs["$val"][0])){
379 /* If attribute is set, replace dynamic parts:
380 %sn, %givenName and %uid. Fill these in our local variables. */
381 $value= $this->attrs["$val"][0];
383 foreach (array("sn", "givenName", "uid") as $repl){
384 if (preg_match("/%$repl/i", $value)){
385 $value= preg_replace ("/%$repl/i", $this->parent->$repl, $value);
386 }
387 }
388 $this->$val= $value;
389 }
390 }
392 /* Is Account? */
393 $found= TRUE;
394 foreach ($this->objectclasses as $obj){
395 if (preg_match('/top/i', $obj)){
396 continue;
397 }
398 if (!in_array_ics ($obj, $this->attrs['objectClass'])){
399 $found= FALSE;
400 break;
401 }
402 }
403 if ($found){
404 $this->is_account= TRUE;
405 }
406 }
408 /* Indicate whether a password change is needed or not */
409 function password_change_needed()
410 {
411 return FALSE;
412 }
414 /* Show header message for tab dialogs */
415 function show_header($button_text, $text, $disabled= FALSE)
416 {
417 if ($disabled == TRUE){
418 $state= "disabled";
419 } else {
420 $state= "";
421 }
422 $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
423 $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".
424 chkacl($this->acl, "all")." ".$state.
425 "><p class=\"seperator\"> </p></td></tr></table>";
427 return($display);
428 }
430 function postcreate()
431 {
432 /* Find postcreate entries for this class */
433 $command= search_config($this->config->data['MENU'], get_class($this), "POSTCREATE");
434 if ($command == "" && isset($this->config->data['TABS'])){
435 $command= search_config($this->config->data['TABS'], get_class($this), "POSTCREATE");
436 }
438 if ($command != ""){
439 /* Walk through attribute list */
440 foreach ($this->attributes as $attr){
441 if (!is_array($this->$attr)){
442 $command= preg_replace("/%$attr/", $this->$attr, $command);
443 }
444 }
445 $command= preg_replace("/%dn/", $this->dn, $command);
446 if (check_command($command)){
447 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
448 $command, "Execute");
450 exec($command);
451 } else {
452 $message= sprintf(_("Command '%s', specified as POSTCREATE for plugin '%s' doesn't seem to exist."), $command, get_class($this));
453 print_red ($message);
454 }
455 }
456 }
458 function postmodify()
459 {
460 /* Find postcreate entries for this class */
461 $command= search_config($this->config->data['MENU'], get_class($this), "POSTMODIFY");
462 if ($command == "" && isset($this->config->data['TABS'])){
463 $command= search_config($this->config->data['TABS'], get_class($this), "POSTMODIFY");
464 }
466 if ($command != ""){
467 /* Walk through attribute list */
468 foreach ($this->attributes as $attr){
469 if (!is_array($this->$attr)){
470 $command= preg_replace("/%$attr/", $this->$attr, $command);
471 }
472 }
473 $command= preg_replace("/%dn/", $this->dn, $command);
474 if (check_command($command)){
475 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
476 $command, "Execute");
478 exec($command);
479 } else {
480 $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, get_class($this));
481 print_red ($message);
482 }
483 }
484 }
486 function postremove()
487 {
488 /* Find postremove entries for this class */
489 $command= search_config($this->config->data['MENU'], get_class($this), "POSTREMOVE");
490 if ($command == "" && isset($this->config->data['TABS'])){
491 $command= search_config($this->config->data['TABS'], get_class($this), "POSTREMOVE");
492 }
494 if ($command != ""){
495 /* Walk through attribute list */
496 foreach ($this->attributes as $attr){
497 if (!is_array($this->$attr)){
498 $command= preg_replace("/%$attr/", $this->$attr, $command);
499 }
500 }
501 $command= preg_replace("/%dn/", $this->dn, $command);
502 if (check_command($command)){
503 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
504 $command, "Execute");
506 exec($command);
507 } else {
508 $message= sprintf(_("Command '%s', specified as POSTREMOVE for plugin '%s' doesn't seem to exist."), $command, get_class($this));
509 print_red ($message);
510 }
511 }
512 }
514 /* Create unique DN */
515 function create_unique_dn($attribute, $base)
516 {
517 $ldap= $this->config->get_ldap_link();
518 $base= preg_replace("/^,*/", "", $base);
520 /* Try to use plain entry first */
521 $dn= "$attribute=".$this->$attribute.",$base";
522 $ldap->cat ($dn);
523 if (!$ldap->fetch()){
524 return ($dn);
525 }
527 /* Look for additional attributes */
528 foreach ($this->attributes as $attr){
529 if ($attr == $attribute || $this->$attr == ""){
530 continue;
531 }
533 $dn= "$attribute=".$this->$attribute."+$attr=".$this->$attr.",$base";
534 $ldap->cat ($dn);
535 if (!$ldap->fetch()){
536 return ($dn);
537 }
538 }
540 /* None found */
541 return ("none");
542 }
544 function rebind($ldap, $referral)
545 {
546 $credentials= LDAP::get_credentials($referral, $this->config->current['REFERRAL']);
547 if (ldap_bind($ldap, $credentials['ADMIN'], $credentials['PASSWORD'])) {
548 $this->error = "Success";
549 $this->hascon=true;
550 $this->reconnect= true;
551 return (0);
552 } else {
553 $this->error = "Could not bind to " . $credentials['ADMIN'];
554 return NULL;
555 }
556 }
558 /* This is a workaround function. */
559 function copy($src_dn, $dst_dn)
560 {
561 /* Rename dn in possible object groups */
562 $ldap= $this->config->get_ldap_link();
563 $ldap->search('(&(objectClass=gosaGroupOfNames)(member='.$src_dn.'))',
564 array('cn'));
565 while ($attrs= $ldap->fetch()){
566 $og= new ogroup($this->config, $ldap->getDN());
567 unset($og->member[$src_dn]);
568 $og->member[$dst_dn]= $dst_dn;
569 $og->save ();
570 }
572 $ldap->cat($dst_dn);
573 $attrs= $ldap->fetch();
574 if (count($attrs)){
575 trigger_error("Trying to overwrite $dst_dn, which already exists.",
576 E_USER_WARNING);
577 return (FALSE);
578 }
580 $ldap->cat($src_dn);
581 $attrs= array();
582 $attrs= $ldap->fetch();
583 if (!count($attrs)){
584 trigger_error("Trying to move $src_dn, which does not seem to exist.",
585 E_USER_WARNING);
586 return (FALSE);
587 }
589 /* Grummble. This really sucks. PHP ldap doesn't support rdn stuff. */
590 $ds= ldap_connect($this->config->current['SERVER']);
591 ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
592 if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['REFERRAL'])) {
593 ldap_set_rebind_proc($ds, array(&$this, "rebind"));
594 }
596 $r=ldap_bind($ds,$this->config->current['ADMIN'], $this->config->current['PASSWORD']);
597 error_reporting (0);
598 $sr=ldap_read($ds, $src_dn, "objectClass=*");
600 /* Fill data from LDAP */
601 $new= array();
602 if ($sr) {
603 $ei=ldap_first_entry($ds, $sr);
604 if ($ei) {
605 foreach($attrs as $attr => $val){
606 if ($info = ldap_get_values_len($ds, $ei, $attr)){
607 for ($i= 0; $i<$info['count']; $i++){
608 if ($info['count'] == 1){
609 $new[$attr]= $info[$i];
610 } else {
611 $new[$attr][]= $info[$i];
612 }
613 }
614 }
615 }
616 }
617 }
619 /* close conncetion */
620 error_reporting (E_ALL);
621 ldap_unbind($ds);
623 /* Adapt naming attribute */
624 $dst_name= preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
625 $dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
626 $new[$dst_name]= $dst_val;
628 /* Save copy */
629 $ldap->connect();
630 $ldap->cd($this->config->current['BASE']);
631 $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
632 $ldap->cd($dst_dn);
633 $ldap->add($new);
635 if ($ldap->error != "Success"){
636 trigger_error("Trying to save $dst_dn failed.",
637 E_USER_WARNING);
638 return(FALSE);
639 }
641 return (TRUE);
642 }
645 function move($src_dn, $dst_dn)
646 {
647 /* Copy source to destination */
648 if (!$this->copy($src_dn, $dst_dn)){
649 return (FALSE);
650 }
652 /* Delete source */
653 $ldap= $this->config->get_ldap_link();
654 $ldap->rmdir($src_dn);
655 if ($ldap->error != "Success"){
656 trigger_error("Trying to delete $src_dn failed.",
657 E_USER_WARNING);
658 return (FALSE);
659 }
661 return (TRUE);
662 }
665 /* Move/Rename complete trees */
666 function recursive_move($src_dn, $dst_dn)
667 {
668 /* Check if the destination entry exists */
669 $ldap= $this->config->get_ldap_link();
671 /* Check if destination exists - abort */
672 $ldap->cat($dst_dn);
673 if ($ldap->fetch()){
674 trigger_error("recursive_move $dst_dn already exists.",
675 E_USER_WARNING);
676 return (FALSE);
677 }
679 /* Perform a search for all objects to be moved */
680 $objects= array();
681 $ldap->cd($src_dn);
682 $ldap->search("(objectClass=*)", array("dn"));
683 while($attrs= $ldap->fetch()){
684 $dn= $attrs['dn'];
685 $objects[$dn]= strlen($dn);
686 }
688 /* Sort objects by indent level */
689 asort($objects);
690 reset($objects);
692 /* Copy objects from small to big indent levels by replacing src_dn by dst_dn */
693 foreach ($objects as $object => $len){
694 $src= $object;
695 $dst= preg_replace("/$src_dn$/", "$dst_dn", $object);
696 if (!$this->copy($src, $dst)){
697 return (FALSE);
698 }
699 }
701 /* Remove src_dn */
702 $ldap->cd($src_dn);
703 $ldap->recursive_remove();
704 return (TRUE);
705 }
708 function handle_post_events($mode)
709 {
710 switch ($mode){
711 case "add":
712 $this->postcreate();
713 break;
715 case "modify":
716 $this->postmodify();
717 break;
719 case "remove":
720 $this->postremove();
721 break;
722 }
723 }
725 }
727 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
728 ?>