include/class_plugin.inc

   1 <?php
   2 /*
   3    This code is part of GOsa (https://gosa.gonicus.de)
   4    Copyright (C) 2003  Cajus Pollmeier
   5
   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.
  10
  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.
  15
  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  */
  20
  21 /*! \brief   The plugin base class
  22   \author  Cajus Pollmeier <pollmeier@gonicus.de>
  23   \version 2.00
  24   \date    24.07.2003
  25
  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  */
  30
  31 class plugin
  32 {
  33   /*!
  34     \brief Reference to parent object
  35
  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.
  40
  41     \sa tab
  42    */
  43   var $parent= NULL;
  44
  45   /*!
  46     \brief Configuration container
  47
  48     Access to global configuration
  49    */
  50   var $config= NULL;
  51
  52   /*!
  53     \brief Mark plugin as account
  54
  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.
  60
  61     \sa plugin::plugin()
  62    */
  63   var $is_account= FALSE;
  64   var $initially_was_account= FALSE;
  65
  66   /*!
  67     \brief Mark plugin as template
  68
  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.
  72
  73     \sa plugin::save() plugin::execute()
  74    */
  75   var $is_template= FALSE;
  76   var $ignore_account= FALSE;
  77   var $is_modified= FALSE;
  78
  79   /*!
  80     \brief Represent temporary LDAP data
  81
  82     This is only used internally.
  83    */
  84   var $attrs= array();
  85
  86
  87   /*!
  88     \brief Used standard values
  89
  90     dn
  91    */
  92   var $dn= "";
  93   var $uid= "";
  94   var $sn= "";
  95   var $givenName= "";
  96   var $acl= "*none*";
  97   var $dialog= FALSE;
  98
  99   /* attribute list for save action */
 100   var $attributes= array();
 101   var $objectclasses= array();
 102   var $new= TRUE;
 103   var $saved_attributes= array();
 104
 105   /*! \brief plugin constructor
 106
 107     If 'dn' is set, the node loads the given 'dn' from LDAP
 108
 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;
 117
 118     /* Handle new accounts, don't read information from LDAP */
 119     if ($dn == "new"){
 120       return;
 121     }
 122
 123     /* Get LDAP descriptor */
 124     $ldap= $this->config->get_ldap_link();
 125     if ($dn != NULL){
 126
 127       /* Load data to 'attrs' and save 'dn' */
 128       $ldap->cat ($dn);
 129       $this->attrs= $ldap->fetch();
 130
 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       }
 139
 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       }
 149
 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       }
 168
 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         }
 186
 187         unset($this->saved_attributes["$index"]["count"]);
 188       }
 189     }
 190
 191     /* Save initial account state */
 192     $this->initially_was_account= $this->is_account;
 193   }
 194
 195   /*! \brief execute plugin
 196
 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   }
 204
 205   /* remove object from parent */
 206   function remove_from_parent()
 207   {
 208     /* include global link_info */
 209     $ldap= $this->config->get_ldap_link();
 210
 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     }
 219
 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     }
 229
 230     /* Unset attributes from entry */
 231     foreach ($this->attributes as $val){
 232       $this->attrs["$val"]= array();
 233     }
 234
 235     /* Unset account info */
 236     $this->is_account= FALSE;
 237
 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   }
 245
 246
 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   }
 277
 278
 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();
 284
 285     /* Start with empty array */
 286     $this->attrs= array();
 287
 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     }
 300
 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     }
 308
 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     }
 317
 318     /* Clean up */
 319     foreach ($this->attrs as $index => $value){
 320       if (is_array($this->attrs[$index]) && count($this->attrs[$index]) == 0 && !isset($this->saved_attributes[$index])){
 321         unset ($this->attrs[$index]);
 322         continue;
 323       }
 324
 325       if (!is_array($this->attrs[$index]) && isset($this->saved_attributes[$index])
 326           && !is_array($this->saved_attributes[$index]) && $value == $this->saved_attributes[$index]){
 327         unset ($this->attrs[$index]);
 328         continue;
 329       }
 330
 331       if (is_array($this->attrs[$index]) && is_array($this->saved_attributes[$index]) &&
 332           count(array_diff($this->attrs[$index], $this->saved_attributes[$index]))==0 && $index != "objectClass"){
 333         unset ($this->attrs[$index]);
 334         continue;
 335       }
 336     }
 337 #################################
 338 ; echo "--- DEBUG: changes ---" ;
 339 ; print_a ($this->attrs)        ;
 340 #################################
 341   }
 342
 343   /* Check formular input */
 344   function check()
 345   {
 346     $message= array();
 347     return ($message);
 348   }
 349
 350   /* Adapt from template, using 'dn' */
 351   function adapt_from_template($dn)
 352   {
 353     /* Include global link_info */
 354     $ldap= $this->config->get_ldap_link();
 355
 356     /* Load requested 'dn' to 'attrs' */
 357     $ldap->cat ($dn);
 358     $this->attrs= $ldap->fetch();
 359
 360     /* Walk through attributes */
 361     foreach ($this->attributes as $val){
 362
 363       if (isset($this->attrs["$val"][0])){
 364
 365         /* If attribute is set, replace dynamic parts:
 366            %sn, %givenName and %uid. Fill these in our local variables. */
 367         $value= $this->attrs["$val"][0];
 368
 369         foreach (array("sn", "givenName", "uid") as $repl){
 370           if (preg_match("/%$repl/i", $value)){
 371             $value= preg_replace ("/%$repl/i", $this->parent->$repl, $value);
 372           }
 373         }
 374         $this->$val= $value;
 375       }
 376     }
 377
 378     /* Is Account? */
 379     $found= TRUE;
 380     foreach ($this->objectclasses as $obj){
 381       if (preg_match('/top/i', $obj)){
 382         continue;
 383       }
 384       if (!in_array_ics ($obj, $this->attrs['objectClass'])){
 385         $found= FALSE;
 386         break;
 387       }
 388     }
 389     if ($found){
 390       $this->is_account= TRUE;
 391     }
 392   }
 393
 394   /* Indicate whether a password change is needed or not */
 395   function password_change_needed()
 396   {
 397     return FALSE;
 398   }
 399
 400   /* Show header message for tab dialogs */
 401   function show_header($button_text, $text, $disabled= FALSE)
 402   {
 403     if ($disabled == TRUE){
 404       $state= "disabled";
 405     } else {
 406       $state= "";
 407     }
 408     $display= "<table summary=\"\" width=\"100%\"><tr>\n<td colspan=2><p><b>$text</b></p>\n";
 409     $display.= "<input type=submit value=\"$button_text\" name=\"modify_state\" ".
 410       chkacl($this->acl, "all")." ".$state.
 411       "><p class=\"seperator\">&nbsp;</p></td></tr></table>";
 412
 413     return($display);
 414   }
 415
 416   function postcreate()
 417   {
 418     /* Find postcreate entries for this class */
 419     $command= search_config($this->config->data['MENU'], get_class($this), "POSTCREATE");
 420     if ($command == "" && isset($this->config->data['TABS'])){
 421       $command= search_config($this->config->data['TABS'], get_class($this), "POSTCREATE");
 422     }
 423
 424     if ($command != ""){
 425       /* Walk through attribute list */
 426       foreach ($this->attributes as $attr){
 427         if (!is_array($this->$attr)){
 428           $command= preg_replace("/%$attr/", $this->$attr, $command);
 429         }
 430       }
 431       $command= preg_replace("/%dn/", $this->dn, $command);
 432       if (check_command($command)){
 433         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 434             $command, "Execute");
 435
 436         exec($command);
 437       } else {
 438         $message= sprintf(_("Command '%s', specified as POSTCREATE for plugin '%s' doesn't seem to exist."), $command, get_class($this));
 439         print_red ($message);
 440       }
 441     }
 442   }
 443
 444   function postmodify()
 445   {
 446     /* Find postcreate entries for this class */
 447     $command= search_config($this->config->data['MENU'], get_class($this), "POSTMODIFY");
 448     if ($command == "" && isset($this->config->data['TABS'])){
 449       $command= search_config($this->config->data['TABS'], get_class($this), "POSTMODIFY");
 450     }
 451
 452     if ($command != ""){
 453       /* Walk through attribute list */
 454       foreach ($this->attributes as $attr){
 455         if (!is_array($this->$attr)){
 456           $command= preg_replace("/%$attr/", $this->$attr, $command);
 457         }
 458       }
 459       $command= preg_replace("/%dn/", $this->dn, $command);
 460       if (check_command($command)){
 461         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 462             $command, "Execute");
 463
 464         exec($command);
 465       } else {
 466         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, get_class($this));
 467         print_red ($message);
 468       }
 469     }
 470   }
 471
 472   function postremove()
 473   {
 474     /* Find postremove entries for this class */
 475     $command= search_config($this->config->data['MENU'], get_class($this), "POSTREMOVE");
 476     if ($command == "" && isset($this->config->data['TABS'])){
 477       $command= search_config($this->config->data['TABS'], get_class($this), "POSTREMOVE");
 478     }
 479
 480     if ($command != ""){
 481       /* Walk through attribute list */
 482       foreach ($this->attributes as $attr){
 483         if (!is_array($this->$attr)){
 484           $command= preg_replace("/%$attr/", $this->$attr, $command);
 485         }
 486       }
 487       $command= preg_replace("/%dn/", $this->dn, $command);
 488       if (check_command($command)){
 489         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__,
 490             $command, "Execute");
 491
 492         exec($command);
 493       } else {
 494         $message= sprintf(_("Command '%s', specified as POSTREMOVE for plugin '%s' doesn't seem to exist."), $command, get_class($this));
 495         print_red ($message);
 496       }
 497     }
 498   }
 499
 500   /* Create unique DN */
 501   function create_unique_dn($attribute, $base)
 502   {
 503     $ldap= $this->config->get_ldap_link();
 504     $base= preg_replace("/^,*/", "", $base);
 505
 506     /* Try to use plain entry first */
 507     $dn= "$attribute=".$this->$attribute.",$base";
 508     $ldap->cat ($dn);
 509     if (!$ldap->fetch()){
 510       return ($dn);
 511     }
 512
 513     /* Look for additional attributes */
 514     foreach ($this->attributes as $attr){
 515       if ($attr == $attribute || $this->$attr == ""){
 516         continue;
 517       }
 518
 519       $dn= "$attribute=".$this->$attribute."+$attr=".$this->$attr.",$base";
 520       $ldap->cat ($dn);
 521       if (!$ldap->fetch()){
 522         return ($dn);
 523       }
 524     }
 525
 526     /* None found */
 527     return ("none");
 528   }
 529
 530   function rebind($ldap, $referral)
 531   {
 532     $credentials= LDAP::get_credentials($referral, $this->config->current['REFERRAL']);
 533     if (ldap_bind($ldap, $credentials['ADMIN'], $credentials['PASSWORD'])) {
 534       $this->error = "Success";
 535       $this->hascon=true;
 536       $this->reconnect= true;
 537       return (0);
 538     } else {
 539       $this->error = "Could not bind to " . $credentials['ADMIN'];
 540       return NULL;
 541     }
 542   }
 543
 544   /* This is a workaround function. */
 545   function copy($src_dn, $dst_dn)
 546   {
 547     /* Rename dn in possible object groups */
 548     $ldap= $this->config->get_ldap_link();
 549     $ldap->search('(&(objectClass=gosaGroupOfNames)(member='.$src_dn.'))',
 550         array('cn'));
 551     while ($attrs= $ldap->fetch()){
 552       $og= new ogroup($this->config, $ldap->getDN());
 553       unset($og->member[$src_dn]);
 554       $og->member[$dst_dn]= $dst_dn;
 555       $og->save ();
 556     }
 557
 558     $ldap->cat($dst_dn);
 559     $attrs= $ldap->fetch();
 560     if (count($attrs)){
 561       trigger_error("Trying to overwrite $dst_dn, which already exists.",
 562           E_USER_WARNING);
 563       return (FALSE);
 564     }
 565
 566     $ldap->cat($src_dn);
 567     $attrs= array();
 568     $attrs= $ldap->fetch();
 569     if (!count($attrs)){
 570       trigger_error("Trying to move $src_dn, which does not seem to exist.",
 571           E_USER_WARNING);
 572       return (FALSE);
 573     }
 574
 575     /* Grummble. This really sucks. PHP ldap doesn't support rdn stuff. */
 576     $ds= ldap_connect($this->config->current['SERVER']);
 577     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
 578     if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['REFERRAL'])) {
 579       ldap_set_rebind_proc($ds, array(&$this, "rebind"));
 580     }
 581
 582     $r=ldap_bind($ds,$this->config->current['ADMIN'], $this->config->current['PASSWORD']);
 583     error_reporting (0);
 584     $sr=ldap_read($ds, $src_dn, "objectClass=*");
 585
 586     /* Fill data from LDAP */
 587     $new= array();
 588     if ($sr) {
 589       $ei=ldap_first_entry($ds, $sr);
 590       if ($ei) {
 591         foreach($attrs as $attr => $val){
 592           if ($info = ldap_get_values_len($ds, $ei, $attr)){
 593             for ($i= 0; $i<$info['count']; $i++){
 594               if ($info['count'] == 1){
 595                 $new[$attr]= $info[$i];
 596               } else {
 597                 $new[$attr][]= $info[$i];
 598               }
 599             }
 600           }
 601         }
 602       }
 603     }
 604
 605     /* close conncetion */
 606     error_reporting (E_ALL);
 607     ldap_unbind($ds);
 608
 609     /* Adapt naming attribute */
 610     $dst_name= preg_replace("/^([^=]+)=.*$/", "\\1", $dst_dn);
 611     $dst_val = preg_replace("/^[^=]+=([^,+]+).*,.*$/", "\\1", $dst_dn);
 612     $new[$dst_name]= $dst_val;
 613
 614     /* Save copy */
 615     $ldap->connect();
 616     $ldap->cd($this->config->current['BASE']);
 617     $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $dst_dn));
 618     $ldap->cd($dst_dn);
 619     $ldap->add($new);
 620
 621     if ($ldap->error != "Success"){
 622       trigger_error("Trying to save $dst_dn failed.",
 623           E_USER_WARNING);
 624       return(FALSE);
 625     }
 626
 627     return (TRUE);
 628   }
 629
 630
 631   function move($src_dn, $dst_dn)
 632   {
 633     /* Copy source to destination */
 634     if (!$this->copy($src_dn, $dst_dn)){
 635       return (FALSE);
 636     }
 637
 638     /* Delete source */
 639     $ldap= $this->config->get_ldap_link();
 640     $ldap->rmdir($src_dn);
 641     if ($ldap->error != "Success"){
 642       trigger_error("Trying to delete $src_dn failed.",
 643           E_USER_WARNING);
 644       return (FALSE);
 645     }
 646
 647     return (TRUE);
 648   }
 649
 650
 651   /* Move/Rename complete trees */
 652   function recursive_move($src_dn, $dst_dn)
 653   {
 654     /* Check if the destination entry exists */
 655     $ldap= $this->config->get_ldap_link();
 656
 657     /* Check if destination exists - abort */
 658     $ldap->cat($dst_dn);
 659     if ($ldap->fetch()){
 660       trigger_error("recursive_move $dst_dn already exists.",
 661           E_USER_WARNING);
 662       return (FALSE);
 663     }
 664
 665     /* Perform a search for all objects to be moved */
 666     $objects= array();
 667     $ldap->cd($src_dn);
 668     $ldap->search("(objectClass=*)", array("dn"));
 669     while($attrs= $ldap->fetch()){
 670       $dn= $attrs['dn'];
 671       $objects[$dn]= strlen($dn);
 672     }
 673
 674     /* Sort objects by indent level */
 675     asort($objects);
 676     reset($objects);
 677
 678     /* Copy objects from small to big indent levels by replacing src_dn by dst_dn */
 679     foreach ($objects as $object => $len){
 680       $src= $object;
 681       $dst= preg_replace("/$src_dn$/", "$dst_dn", $object);
 682       if (!$this->copy($src, $dst)){
 683         return (FALSE);
 684       }
 685     }
 686
 687     /* Remove src_dn */
 688     $ldap->cd($src_dn);
 689     $ldap->recursive_remove();
 690     return (TRUE);
 691   }
 692
 693
 694   function handle_post_events($mode)
 695   {
 696     switch ($mode){
 697       case "add":
 698         $this->postcreate();
 699       break;
 700
 701       case "modify":
 702         $this->postmodify();
 703       break;
 704
 705       case "remove":
 706         $this->postremove();
 707       break;
 708     }
 709   }
 710
 711 }
 712
 713 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 714 ?>