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