Code

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