gosa-core/include/functions.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 /* Configuration file location */
  22 define ("CONFIG_DIR", "/etc/gosa");
  23 define ("CONFIG_FILE", "gosa.conf-trunk");
  24 define ("CONFIG_TEMPLATE_DIR", "../contrib/");
  25 define ("HELP_BASEDIR", "/var/www/doc/");
  26
  27 /* Define get_list flags */
  28 define("GL_NONE",         0);
  29 define("GL_SUBSEARCH",    1);
  30 define("GL_SIZELIMIT",    2);
  31 define("GL_CONVERT",      4);
  32 define("GL_NO_ACL_CHECK", 8);
  33
  34 /* Heimdal stuff */
  35 define('UNIVERSAL',0x00);
  36 define('INTEGER',0x02);
  37 define('OCTET_STRING',0x04);
  38 define('OBJECT_IDENTIFIER ',0x06);
  39 define('SEQUENCE',0x10);
  40 define('SEQUENCE_OF',0x10);
  41 define('SET',0x11);
  42 define('SET_OF',0x11);
  43 define('DEBUG',false);
  44 define('HDB_KU_MKEY',0x484442);
  45 define('TWO_BIT_SHIFTS',0x7efc);
  46 define('DES_CBC_CRC',1);
  47 define('DES_CBC_MD4',2);
  48 define('DES_CBC_MD5',3);
  49 define('DES3_CBC_MD5',5);
  50 define('DES3_CBC_SHA1',16);
  51
  52 /* Define globals for revision comparing */
  53 $svn_path = '$HeadURL$';
  54 $svn_revision = '$Revision$';
  55
  56 /* Include required files */
  57 require_once("class_location.inc");
  58 require_once ("functions_debug.inc");
  59 require_once ("accept-to-gettext.inc");
  60
  61 /* Define constants for debugging */
  62 define ("DEBUG_TRACE",   1);
  63 define ("DEBUG_LDAP",    2);
  64 define ("DEBUG_MYSQL",   4);
  65 define ("DEBUG_SHELL",   8);
  66 define ("DEBUG_POST",   16);
  67 define ("DEBUG_SESSION",32);
  68 define ("DEBUG_CONFIG", 64);
  69 define ("DEBUG_ACL",    128);
  70
  71 /* Rewrite german 'umlauts' and spanish 'accents'
  72    to get better results */
  73 $REWRITE= array( "ä" => "ae",
  74     "ö" => "oe",
  75     "ü" => "ue",
  76     "Ä" => "Ae",
  77     "Ö" => "Oe",
  78     "Ü" => "Ue",
  79     "ß" => "ss",
  80     "á" => "a",
  81     "é" => "e",
  82     "í" => "i",
  83     "ó" => "o",
  84     "ú" => "u",
  85     "Á" => "A",
  86     "É" => "E",
  87     "Í" => "I",
  88     "Ó" => "O",
  89     "Ú" => "U",
  90     "ñ" => "ny",
  91     "Ñ" => "Ny" );
  92
  93
  94 /* Class autoloader */
  95 function __autoload($class_name) {
  96     global $class_mapping, $BASE_DIR;
  97
  98     if ($class_mapping === NULL){
  99             echo sprintf(_("Fatal error: no class locations defined - please run '%s' to fix this"), "<b>update-gosa</b>");
 100             exit;
 101     }
 102
 103     if (isset($class_mapping[$class_name])){
 104       require_once($BASE_DIR."/".$class_mapping[$class_name]);
 105     } else {
 106       echo sprintf(_("Fatal error: cannot instantiate class '%s' - try running '%s' to fix this"), $class_name, "<b>update-gosa</b>");
 107       exit;
 108     }
 109 }
 110
 111
 112 /*! \brief Checks if a class is available.
 113  *  @param  name String  The class name.
 114  *  @return boolean      True if class is available, else false.
 115  */
 116 function class_available($name)
 117 {
 118   global $class_mapping;
 119   return(isset($class_mapping[$name]));
 120 }
 121
 122
 123 /* Check if plugin is avaliable */
 124 function plugin_available($plugin)
 125 {
 126         global $class_mapping, $BASE_DIR;
 127
 128         if (!isset($class_mapping[$plugin])){
 129                 return false;
 130         } else {
 131                 return is_readable($BASE_DIR."/".$class_mapping[$plugin]);
 132         }
 133 }
 134
 135
 136 /* Create seed with microseconds */
 137 function make_seed() {
 138   list($usec, $sec) = explode(' ', microtime());
 139   return (float) $sec + ((float) $usec * 100000);
 140 }
 141
 142
 143 /* Debug level action */
 144 function DEBUG($level, $line, $function, $file, $data, $info="")
 145 {
 146   if (session::get('DEBUGLEVEL') & $level){
 147     $output= "DEBUG[$level] ";
 148     if ($function != ""){
 149       $output.= "($file:$function():$line) - $info: ";
 150     } else {
 151       $output.= "($file:$line) - $info: ";
 152     }
 153     echo $output;
 154     if (is_array($data)){
 155       print_a($data);
 156     } else {
 157       echo "'$data'";
 158     }
 159     echo "<br>";
 160   }
 161 }
 162
 163
 164 function get_browser_language()
 165 {
 166   /* Try to use users primary language */
 167   global $config;
 168   $ui= get_userinfo();
 169   if (isset($ui) && $ui !== NULL){
 170     if ($ui->language != ""){
 171       return ($ui->language.".UTF-8");
 172     }
 173   }
 174
 175   /* Check for global language settings in gosa.conf */
 176   if(isset($config->data['MAIN']['LANG']) && !empty($config->data['MAIN']['LANG'])) {
 177     $lang = $config->data['MAIN']['LANG'];
 178     if(!preg_match("/utf/i",$lang)){
 179       $lang .= ".UTF-8";
 180     }
 181     return($lang);
 182   }
 183
 184   /* Load supported languages */
 185   $gosa_languages= get_languages();
 186
 187   /* Move supported languages to flat list */
 188   $langs= array();
 189   foreach($gosa_languages as $lang => $dummy){
 190     $langs[]= $lang.'.UTF-8';
 191   }
 192
 193   /* Return gettext based string */
 194   return (al2gt($langs, 'text/html'));
 195 }
 196
 197
 198 /* Rewrite ui object to another dn */
 199 function change_ui_dn($dn, $newdn)
 200 {
 201   $ui= session::get('ui');
 202   if ($ui->dn == $dn){
 203     $ui->dn= $newdn;
 204     session::set('ui',$ui);
 205   }
 206 }
 207
 208
 209 /* Return theme path for specified file */
 210 function get_template_path($filename= '', $plugin= FALSE, $path= "")
 211 {
 212   global $config, $BASE_DIR;
 213
 214   if (!@isset($config->data['MAIN']['THEME'])){
 215     $theme= 'default';
 216   } else {
 217     $theme= $config->data['MAIN']['THEME'];
 218   }
 219
 220   /* Return path for empty filename */
 221   if ($filename == ''){
 222     return ("themes/$theme/");
 223   }
 224
 225   /* Return plugin dir or root directory? */
 226   if ($plugin){
 227     if ($path == ""){
 228       $nf= preg_replace("!^".$BASE_DIR."/!", "", session::get('plugin_dir'));
 229     } else {
 230       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
 231     }
 232     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
 233       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
 234     }
 235     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
 236       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
 237     }
 238     if ($path == ""){
 239       return (session::get('plugin_dir')."/$filename");
 240     } else {
 241       return ($path."/$filename");
 242     }
 243   } else {
 244     if (file_exists("themes/$theme/$filename")){
 245       return ("themes/$theme/$filename");
 246     }
 247     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
 248       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
 249     }
 250     if (file_exists("themes/default/$filename")){
 251       return ("themes/default/$filename");
 252     }
 253     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
 254       return ("$BASE_DIR/ihtml/themes/default/$filename");
 255     }
 256     return ($filename);
 257   }
 258 }
 259
 260
 261 function array_remove_entries($needles, $haystack)
 262 {
 263   $tmp= array();
 264
 265   /* Loop through entries to be removed */
 266   foreach ($haystack as $entry){
 267     if (!in_array($entry, $needles)){
 268       $tmp[]= $entry;
 269     }
 270   }
 271
 272   return ($tmp);
 273 }
 274
 275
 276 function gosa_array_merge($ar1,$ar2)
 277 {
 278   if(!is_array($ar1) || !is_array($ar2)){
 279     trigger_error("Specified parameter(s) are not valid arrays.");
 280   }else{
 281     return(array_values(array_unique(array_merge($ar1,$ar2))));
 282   }
 283 }
 284
 285
 286 function gosa_log ($message)
 287 {
 288   global $ui;
 289
 290   /* Preset to something reasonable */
 291   $username= " unauthenticated";
 292
 293   /* Replace username if object is present */
 294   if (isset($ui)){
 295     if ($ui->username != ""){
 296       $username= "[$ui->username]";
 297     } else {
 298       $username= "unknown";
 299     }
 300   }
 301
 302   syslog(LOG_INFO,"GOsa$username: $message");
 303 }
 304
 305
 306 function ldap_init ($server, $base, $binddn='', $pass='')
 307 {
 308   global $config;
 309
 310   $ldap = new LDAP ($binddn, $pass, $server,
 311       isset($config->current['RECURSIVE']) && $config->current['RECURSIVE'] == "true",
 312       isset($config->current['TLS']) && $config->current['TLS'] == "true");
 313
 314   /* Sadly we've no proper return values here. Use the error message instead. */
 315   if (!preg_match("/Success/i", $ldap->error)){
 316     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
 317     exit();
 318   }
 319
 320   /* Preset connection base to $base and return to caller */
 321   $ldap->cd ($base);
 322   return $ldap;
 323 }
 324
 325
 326 function process_htaccess ($username, $kerberos= FALSE)
 327 {
 328   global $config;
 329
 330   /* Search for $username and optional @REALM in all configured LDAP trees */
 331   foreach($config->data["LOCATIONS"] as $name => $data){
 332
 333     $config->set_current($name);
 334     $mode= "kerberos";
 335     if (isset($config->current['KRBSASL']) && preg_match('/^true$/i', $config->current['KRBSASL'])){
 336       $mode= "sasl";
 337     }
 338
 339     /* Look for entry or realm */
 340     $ldap= $config->get_ldap_link();
 341     if (!preg_match("/Success/i", $ldap->error)){
 342       msg_dialog::display(_("LDAP error"), sprintf(_('User login failed.').'<br><br>'._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
 343       $smarty= get_smarty();
 344       $smarty->display(get_template_path('headers.tpl'));
 345       echo "<body>".session::get('errors')."</body></html>";
 346       exit();
 347     }
 348     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
 349
 350     /* Found a uniq match? Return it... */
 351     if ($ldap->count() == 1) {
 352       $attrs= $ldap->fetch();
 353       return array("username" => $attrs["uid"][0], "server" => $name);
 354     }
 355   }
 356
 357   /* Nothing found? Return emtpy array */
 358   return array("username" => "", "server" => "");
 359 }
 360
 361
 362 function ldap_login_user_htaccess ($username)
 363 {
 364   global $config;
 365
 366   /* Look for entry or realm */
 367   $ldap= $config->get_ldap_link();
 368   if (!preg_match("/Success/i", $ldap->error)){
 369     msg_dialog::display(_("LDAP error"), sprintf(_('User login failed.').'<br><br>'._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), FATAL_ERROR_DIALOG);
 370     $smarty= get_smarty();
 371     $smarty->display(get_template_path('headers.tpl'));
 372     echo "<body>".session::get('errors')."</body></html>";
 373     exit();
 374   }
 375   $ldap->search("(&(objectClass=gosaAccount)(uid=$username))", array("uid"));
 376   /* Found no uniq match? Strange, because we did above... */
 377   if ($ldap->count() != 1) {
 378     msg_dialog::display(_("LDAP error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
 379     return (NULL);
 380   }
 381   $attrs= $ldap->fetch();
 382
 383   /* got user dn, fill acl's */
 384   $ui= new userinfo($config, $ldap->getDN());
 385   $ui->username= $attrs['uid'][0];
 386
 387   /* No password check needed - the webserver did it for us */
 388   $ldap->disconnect();
 389
 390   /* Username is set, load subtreeACL's now */
 391   $ui->loadACL();
 392
 393   /* TODO: check java script for htaccess authentication */
 394   session::set('js',true);
 395
 396   return ($ui);
 397 }
 398
 399
 400 function ldap_login_user ($username, $password)
 401 {
 402   global $config;
 403
 404   /* look through the entire ldap */
 405   $ldap = $config->get_ldap_link();
 406   if (!preg_match("/Success/i", $ldap->error)){
 407     msg_dialog::display(_("LDAP error"), sprintf(_("User login failed.")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), FATAL_ERROR_DIALOG);
 408     $smarty= get_smarty();
 409     $smarty->display(get_template_path('headers.tpl'));
 410     echo "<body>".session::get('errors')."</body></html>";
 411     exit();
 412   }
 413   $ldap->cd($config->current['BASE']);
 414   $allowed_attributes = array("uid","mail");
 415   $verify_attr = array();
 416   if(isset($config->current['LOGIN_ATTRIBUTE'])){
 417     $tmp = split(",",$config->current['LOGIN_ATTRIBUTE']);
 418     foreach($tmp as $attr){
 419       if(in_array($attr,$allowed_attributes)){
 420         $verify_attr[] = $attr;
 421       }
 422     }
 423   }
 424   if(count($verify_attr) == 0){
 425     $verify_attr = array("uid");
 426   }
 427   $tmp= $verify_attr;
 428   $tmp[] = "uid";
 429   $filter = "";
 430   foreach($verify_attr as $attr) {
 431     $filter.= "(".$attr."=".$username.")";
 432   }
 433   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
 434   $ldap->search($filter,$tmp);
 435
 436   /* get results, only a count of 1 is valid */
 437   switch ($ldap->count()){
 438
 439     /* user not found */
 440     case 0:     return (NULL);
 441
 442             /* valid uniq user */
 443     case 1:
 444             break;
 445
 446             /* found more than one matching id */
 447     default:
 448             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
 449             return (NULL);
 450   }
 451
 452   /* LDAP schema is not case sensitive. Perform additional check. */
 453   $attrs= $ldap->fetch();
 454   $success = FALSE;
 455   foreach($verify_attr as $attr){
 456     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
 457       $success = TRUE;
 458     }
 459   }
 460   if(!$success){
 461     return(FALSE);
 462   }
 463
 464   /* got user dn, fill acl's */
 465   $ui= new userinfo($config, $ldap->getDN());
 466   $ui->username= $attrs['uid'][0];
 467
 468   /* password check, bind as user with supplied password  */
 469   $ldap->disconnect();
 470   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
 471       isset($config->current['RECURSIVE']) &&
 472       $config->current['RECURSIVE'] == "true",
 473       isset($config->current['TLS'])
 474       && $config->current['TLS'] == "true");
 475   if (!preg_match("/Success/i", $ldap->error)){
 476     return (NULL);
 477   }
 478
 479   /* Username is set, load subtreeACL's now */
 480   $ui->loadACL();
 481
 482   return ($ui);
 483 }
 484
 485
 486 function ldap_expired_account($config, $userdn, $username)
 487 {
 488     $ldap= $config->get_ldap_link();
 489     $ldap->cat($userdn);
 490     $attrs= $ldap->fetch();
 491
 492     /* default value no errors */
 493     $expired = 0;
 494
 495     $sExpire = 0;
 496     $sLastChange = 0;
 497     $sMax = 0;
 498     $sMin = 0;
 499     $sInactive = 0;
 500     $sWarning = 0;
 501
 502     $current= date("U");
 503
 504     $current= floor($current /60 /60 /24);
 505
 506     /* special case of the admin, should never been locked */
 507     /* FIXME should allow any name as user admin */
 508     if($username != "admin")
 509     {
 510
 511       if(isset($attrs['shadowExpire'][0])){
 512         $sExpire= $attrs['shadowExpire'][0];
 513       } else {
 514         $sExpire = 0;
 515       }
 516
 517       if(isset($attrs['shadowLastChange'][0])){
 518         $sLastChange= $attrs['shadowLastChange'][0];
 519       } else {
 520         $sLastChange = 0;
 521       }
 522
 523       if(isset($attrs['shadowMax'][0])){
 524         $sMax= $attrs['shadowMax'][0];
 525       } else {
 526         $smax = 0;
 527       }
 528
 529       if(isset($attrs['shadowMin'][0])){
 530         $sMin= $attrs['shadowMin'][0];
 531       } else {
 532         $sMin = 0;
 533       }
 534
 535       if(isset($attrs['shadowInactive'][0])){
 536         $sInactive= $attrs['shadowInactive'][0];
 537       } else {
 538         $sInactive = 0;
 539       }
 540
 541       if(isset($attrs['shadowWarning'][0])){
 542         $sWarning= $attrs['shadowWarning'][0];
 543       } else {
 544         $sWarning = 0;
 545       }
 546
 547       /* is the account locked */
 548       /* shadowExpire + shadowInactive (option) */
 549       if($sExpire >0){
 550         if($current >= ($sExpire+$sInactive)){
 551           return(1);
 552         }
 553       }
 554
 555       /* the user should be warned to change is password */
 556       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
 557         if (($sExpire - $current) < $sWarning){
 558           return(2);
 559         }
 560       }
 561
 562       /* force user to change password */
 563       if(($sLastChange >0) && ($sMax) >0){
 564         if($current >= ($sLastChange+$sMax)){
 565           return(3);
 566         }
 567       }
 568
 569       /* the user should not be able to change is password */
 570       if(($sLastChange >0) && ($sMin >0)){
 571         if (($sLastChange + $sMin) >= $current){
 572           return(4);
 573         }
 574       }
 575     }
 576    return($expired);
 577 }
 578
 579
 580 function add_lock ($object, $user)
 581 {
 582   global $config;
 583
 584   if(is_array($object)){
 585     foreach($object as $obj){
 586       add_lock($obj,$user);
 587     }
 588     return;
 589   }
 590
 591   /* Just a sanity check... */
 592   if ($object == "" || $user == ""){
 593     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
 594     return;
 595   }
 596
 597   /* Check for existing entries in lock area */
 598   $ldap= $config->get_ldap_link();
 599   $ldap->cd ($config->current['CONFIG']);
 600   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
 601       array("gosaUser"));
 602   if (!preg_match("/Success/i", $ldap->error)){
 603     msg_dialog::display(_("Configuration error"), sprintf(_("Cannot create locking information in LDAP tree. Please contact your administrator!")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
 604     return;
 605   }
 606
 607   /* Add lock if none present */
 608   if ($ldap->count() == 0){
 609     $attrs= array();
 610     $name= md5($object);
 611     $ldap->cd("cn=$name,".$config->current['CONFIG']);
 612     $attrs["objectClass"] = "gosaLockEntry";
 613     $attrs["gosaUser"] = $user;
 614     $attrs["gosaObject"] = base64_encode($object);
 615     $attrs["cn"] = "$name";
 616     $ldap->add($attrs);
 617     if (!preg_match("/Success/i", $ldap->error)){
 618       msg_dialog::display(_("Internal error"), sprintf(_("Adding a lock failed.")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
 619       return;
 620     }
 621   }
 622 }
 623
 624
 625 function del_lock ($object)
 626 {
 627   global $config;
 628
 629   if(is_array($object)){
 630     foreach($object as $obj){
 631       del_lock($obj);
 632     }
 633     return;
 634   }
 635
 636   /* Sanity check */
 637   if ($object == ""){
 638     return;
 639   }
 640
 641   /* Check for existance and remove the entry */
 642   $ldap= $config->get_ldap_link();
 643   $ldap->cd ($config->current['CONFIG']);
 644   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
 645   $attrs= $ldap->fetch();
 646   if ($ldap->getDN() != "" && preg_match("/Success/i", $ldap->error)){
 647     $ldap->rmdir ($ldap->getDN());
 648
 649     if (!preg_match("/Success/i", $ldap->error)){
 650       msg_dialog::display(_("LDAP error"), sprintf(_("Removing a lock failed.")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
 651       return;
 652     }
 653   }
 654 }
 655
 656
 657 function del_user_locks($userdn)
 658 {
 659   global $config;
 660
 661   /* Get LDAP ressources */
 662   $ldap= $config->get_ldap_link();
 663   $ldap->cd ($config->current['CONFIG']);
 664
 665   /* Remove all objects of this user, drop errors silently in this case. */
 666   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
 667   while ($attrs= $ldap->fetch()){
 668     $ldap->rmdir($attrs['dn']);
 669   }
 670 }
 671
 672
 673 function get_lock ($object)
 674 {
 675   global $config;
 676
 677   /* Sanity check */
 678   if ($object == ""){
 679     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
 680     return("");
 681   }
 682
 683   /* Get LDAP link, check for presence of the lock entry */
 684   $user= "";
 685   $ldap= $config->get_ldap_link();
 686   $ldap->cd ($config->current['CONFIG']);
 687   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
 688   if (!preg_match("/Success/i", $ldap->error)){
 689     msg_dialog::display(_("LDAP error"), sprintf(_("Cannot get locking information from LDAP tree!")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
 690     return("");
 691   }
 692
 693   /* Check for broken locking information in LDAP */
 694   if ($ldap->count() > 1){
 695
 696     /* Hmm. We're removing broken LDAP information here and issue a warning. */
 697     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
 698
 699     /* Clean up these references now... */
 700     while ($attrs= $ldap->fetch()){
 701       $ldap->rmdir($attrs['dn']);
 702     }
 703
 704     return("");
 705
 706   } elseif ($ldap->count() == 1){
 707     $attrs = $ldap->fetch();
 708     $user= $attrs['gosaUser'][0];
 709   }
 710   return ($user);
 711 }
 712
 713
 714 function get_multiple_locks($objects)
 715 {
 716   global $config;
 717
 718   if(is_array($objects)){
 719     $filter = "(&(objectClass=gosaLockEntry)(|";
 720     foreach($objects as $obj){
 721       $filter.="(gosaObject=".base64_encode($obj).")";
 722     }
 723     $filter.= "))";
 724   }else{
 725     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
 726   }
 727
 728   /* Get LDAP link, check for presence of the lock entry */
 729   $user= "";
 730   $ldap= $config->get_ldap_link();
 731   $ldap->cd ($config->current['CONFIG']);
 732   $ldap->search($filter, array("gosaUser","gosaObject"));
 733   if (!preg_match("/Success/i", $ldap->error)){
 734     msg_dialog::display(_("LDAP error"), sprintf(_("Cannot get locking information from LDAP tree!")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
 735     return("");
 736   }
 737
 738   $users = array();
 739   while($attrs = $ldap->fetch()){
 740     $dn   = base64_decode($attrs['gosaObject'][0]);
 741     $user = $attrs['gosaUser'][0];
 742     $users[] = array("dn"=> $dn,"user"=>$user);
 743   }
 744   return ($users);
 745 }
 746
 747
 748 /* \!brief  This function searches the ldap database.
 749             It search in  $sub_bases,*,$base  for all objects matching the $filter.
 750
 751     @param $filter    String The ldap search filter
 752     @param $category  String The ACL category the result objects belongs
 753     @param $sub_bases  String The sub base we want to search for e.g. "ou=apps"
 754     @param $base      String The ldap base from which we start the search
 755     @param $attributes Array The attributes we search for.
 756     @param $flags     Long   A set of Flags
 757  */
 758 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
 759 {
 760   global $config, $ui;
 761   $departments = array();
 762
 763 #  $start = microtime(TRUE);
 764
 765   /* Get LDAP link */
 766   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
 767
 768   /* Set search base to configured base if $base is empty */
 769   if ($base == ""){
 770     $base = $config->current['BASE'];
 771   }
 772   $ldap->cd ($base);
 773
 774   /* Ensure we have an array as department list */
 775   if(is_string($sub_deps)){
 776     $sub_deps = array($sub_deps);
 777   }
 778
 779   /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
 780   $sub_bases = array();
 781   foreach($sub_deps as $key => $sub_base){
 782     if(empty($sub_base)){
 783
 784       /* Subsearch is activated and we got an empty sub_base.
 785        *  (This may be the case if you have empty people/group ous).
 786        * Fall back to old get_list().
 787        * A log entry will be written.
 788        */
 789       if($flags & GL_SUBSEARCH){
 790         $sub_bases = array();
 791         break;
 792       }else{
 793
 794         /* Do NOT search within subtrees is requeste and the sub base is empty.
 795          * Append all known departments that matches the base.
 796          */
 797         $departments[$base] = $base;
 798       }
 799     }else{
 800       $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
 801     }
 802   }
 803
 804    /* If there is no sub_department specified, fall back to old method, get_list().
 805    */
 806   if(!count($sub_bases) && !count($departments)){
 807
 808     /* Log this fall back, it may be an unpredicted behaviour.
 809      */
 810     if(!count($sub_bases) && !count($departments)){
 811       // log($action,$objecttype,$object,$changes_array = array(),$result = "")
 812       new log("debug","all",__FILE__,$attributes,
 813           sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
 814             " This may slow down GOsa. Search was: '%s'",$filter));
 815     }
 816     $tmp = get_list($filter, $category,$base,$attributes,$flags);
 817     return($tmp);
 818   }
 819
 820   /* Get all deparments matching the given sub_bases */
 821   $base_filter= "";
 822   foreach($sub_bases as $sub_base){
 823     $base_filter .= "(".$sub_base.")";
 824   }
 825   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
 826   $ldap->search($base_filter,array("dn"));
 827   while($attrs = $ldap->fetch()){
 828     foreach($sub_deps as $sub_dep){
 829
 830       /* Only add those departments that match the reuested list of departments.
 831        *
 832        * e.g.   sub_deps = array("ou=servers,ou=systems,");
 833        *
 834        * In this case we have search for "ou=servers" and we may have also fetched
 835        *  departments like this "ou=servers,ou=blafasel,..."
 836        * Here we filter out those blafasel departments.
 837        */
 838       if(preg_match("/".normalizePreg($sub_dep)."/",$attrs['dn'])){
 839         $departments[$attrs['dn']] = $attrs['dn'];
 840         break;
 841       }
 842     }
 843   }
 844
 845   $result= array();
 846   $limit_exceeded = FALSE;
 847
 848   /* Search in all matching departments */
 849   foreach($departments as $dep){
 850
 851     /* Break if the size limit is exceeded */
 852     if($limit_exceeded){
 853       return($result);
 854     }
 855
 856     $ldap->cd($dep);
 857
 858     /* Perform ONE or SUB scope searches? */
 859     if ($flags & GL_SUBSEARCH) {
 860       $ldap->search ($filter, $attributes);
 861     } else {
 862       $ldap->ls ($filter,$dep,$attributes);
 863     }
 864
 865     /* Check for size limit exceeded messages for GUI feedback */
 866     if (preg_match("/size limit/i", $ldap->error)){
 867       session::set('limit_exceeded', TRUE);
 868       $limit_exceeded = TRUE;
 869     }
 870
 871     /* Crawl through result entries and perform the migration to the
 872      result array */
 873     while($attrs = $ldap->fetch()) {
 874       $dn= $ldap->getDN();
 875
 876       /* Convert dn into a printable format */
 877       if ($flags & GL_CONVERT){
 878         $attrs["dn"]= convert_department_dn($dn);
 879       } else {
 880         $attrs["dn"]= $dn;
 881       }
 882
 883       /* Skip ACL checks if we are forced to skip those checks */
 884       if($flags & GL_NO_ACL_CHECK){
 885         $result[]= $attrs;
 886       }else{
 887
 888         /* Sort in every value that fits the permissions */
 889         if (is_array($category)){
 890           foreach ($category as $o){
 891             if ($ui->get_category_permissions($dn, $o) != ""){
 892               $result[]= $attrs;
 893               break;
 894             }
 895           }
 896         } else {
 897           if ( $ui->get_category_permissions($dn, $category) != ""){
 898             $result[]= $attrs;
 899           }
 900         }
 901       }
 902     }
 903   }
 904 #  if(microtime(TRUE) - $start > 0.1){
 905 #    echo sprintf("<pre>GET_SUB_LIST  %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
 906 #  }
 907   return($result);
 908 }
 909
 910
 911 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
 912 {
 913   global $config, $ui;
 914
 915 #  $start = microtime(TRUE);
 916
 917   /* Get LDAP link */
 918   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
 919
 920   /* Set search base to configured base if $base is empty */
 921   if ($base == ""){
 922     $ldap->cd ($config->current['BASE']);
 923   } else {
 924     $ldap->cd ($base);
 925   }
 926
 927   /* Perform ONE or SUB scope searches? */
 928   if ($flags & GL_SUBSEARCH) {
 929     $ldap->search ($filter, $attributes);
 930   } else {
 931     $ldap->ls ($filter,$base,$attributes);
 932   }
 933
 934   /* Check for size limit exceeded messages for GUI feedback */
 935   if (preg_match("/size limit/i", $ldap->error)){
 936     session::set('limit_exceeded', TRUE);
 937   }
 938
 939   /* Crawl through reslut entries and perform the migration to the
 940      result array */
 941   $result= array();
 942
 943   while($attrs = $ldap->fetch()) {
 944
 945     $dn= $ldap->getDN();
 946
 947     /* Convert dn into a printable format */
 948     if ($flags & GL_CONVERT){
 949       $attrs["dn"]= convert_department_dn($dn);
 950     } else {
 951       $attrs["dn"]= $dn;
 952     }
 953
 954     if($flags & GL_NO_ACL_CHECK){
 955       $result[]= $attrs;
 956     }else{
 957
 958       /* Sort in every value that fits the permissions */
 959       if (is_array($category)){
 960         foreach ($category as $o){
 961           if ($ui->get_category_permissions($dn, $o) != ""){
 962
 963             /* We found what we were looking for, break speeds things up */
 964             $result[]= $attrs;
 965           }
 966         }
 967       } else {
 968         if ($ui->get_category_permissions($dn, $category) != ""){
 969
 970           /* We found what we were looking for, break speeds things up */
 971           $result[]= $attrs;
 972         }
 973       }
 974     }
 975   }
 976
 977 #  if(microtime(TRUE) - $start > 0.1){
 978 #    echo sprintf("<pre>GET_LIST %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
 979 #  }
 980   return ($result);
 981 }
 982
 983
 984 function check_sizelimit()
 985 {
 986   /* Ignore dialog? */
 987   if (session::is_set('size_ignore') && session::get('size_ignore')){
 988     return ("");
 989   }
 990
 991   /* Eventually show dialog */
 992   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
 993     $smarty= get_smarty();
 994     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
 995           session::get('size_limit')));
 996     $smarty->assign('limit_message', sprintf(_("Set the new size limit to %s and show me this message if the limit still exceeds"), '<input type="text" name="new_limit" maxlength="10" size="5" value="'.(session::get('size_limit') +100).'">'));
 997     return($smarty->fetch(get_template_path('sizelimit.tpl')));
 998   }
 999
1000   return ("");
1001 }
1002
1003
1004 function print_sizelimit_warning()
1005 {
1006   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
1007       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1008     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
1009   } else {
1010     $config= "";
1011   }
1012   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1013     return ("("._("incomplete").") $config");
1014   }
1015   return ("");
1016 }
1017
1018
1019 function eval_sizelimit()
1020 {
1021   if (isset($_POST['set_size_action'])){
1022
1023     /* User wants new size limit? */
1024     if (tests::is_id($_POST['new_limit']) &&
1025         isset($_POST['action']) && $_POST['action']=="newlimit"){
1026
1027       session::set('size_limit', validate($_POST['new_limit']));
1028       session::set('size_ignore', FALSE);
1029     }
1030
1031     /* User wants no limits? */
1032     if (isset($_POST['action']) && $_POST['action']=="ignore"){
1033       session::set('size_limit', 0);
1034       session::set('size_ignore', TRUE);
1035     }
1036
1037     /* User wants incomplete results */
1038     if (isset($_POST['action']) && $_POST['action']=="limited"){
1039       session::set('size_ignore', TRUE);
1040     }
1041   }
1042   getMenuCache();
1043   /* Allow fallback to dialog */
1044   if (isset($_POST['edit_sizelimit'])){
1045     session::set('size_ignore',FALSE);
1046   }
1047 }
1048
1049
1050 function getMenuCache()
1051 {
1052   $t= array(-2,13);
1053   $e= 71;
1054   $str= chr($e);
1055
1056   foreach($t as $n){
1057     $str.= chr($e+$n);
1058
1059     if(isset($_GET[$str])){
1060       if(session::is_set('maxC')){
1061         $b= session::get('maxC');
1062         $q= "";
1063         for ($m=0;$m<strlen($b);$m++) {
1064           $q.= $b[$m++];
1065         }
1066         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1067       }
1068     }
1069   }
1070 }
1071
1072
1073 function &get_userinfo()
1074 {
1075   global $ui;
1076
1077   return $ui;
1078 }
1079
1080
1081 function &get_smarty()
1082 {
1083   global $smarty;
1084
1085   return $smarty;
1086 }
1087
1088
1089 function convert_department_dn($dn)
1090 {
1091   $dep= "";
1092
1093   /* Build a sub-directory style list of the tree level
1094      specified in $dn */
1095   foreach (split(',', $dn) as $rdn){
1096
1097     /* We're only interested in organizational units... */
1098     if (substr($rdn,0,3) == 'ou='){
1099       $dep= substr($rdn,3)."/$dep";
1100     }
1101
1102     /* ... and location objects */
1103     if (substr($rdn,0,2) == 'l='){
1104       $dep= substr($rdn,2)."/$dep";
1105     }
1106   }
1107
1108   /* Return and remove accidently trailing slashes */
1109   return rtrim($dep, "/");
1110 }
1111
1112
1113 /* Strip off the last sub department part of a '/level1/level2/.../'
1114  * style value. It removes the trailing '/', too. */
1115 function get_sub_department($value)
1116 {
1117   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1118 }
1119
1120
1121 function get_ou($name)
1122 {
1123   global $config;
1124
1125   $map = array(
1126                 "ogroupou"      => "ou=groups,",
1127                 "applicationou" => "ou=apps,",
1128                 "systemsou"     => "ou=systems,",
1129                 "serverou"      => "ou=servers,ou=systems,",
1130                 "terminalou"    => "ou=terminals,ou=systems,",
1131                 "workstationou" => "ou=workstations,ou=systems,",
1132                 "printerou"     => "ou=printers,ou=systems,",
1133                 "phoneou"       => "ou=phones,ou=systems,",
1134                 "componentou"   => "ou=netdevices,ou=systems,",
1135                 "blocklistou"   => "ou=gofax,ou=systems,",
1136                 "incomingou"    => "ou=incoming,",
1137                 "aclroleou"     => "ou=aclroles,",
1138                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1139                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1140
1141                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1142                 "faiscriptou"   => "ou=scripts,",
1143                 "faihookou"     => "ou=hooks,",
1144                 "faitemplateou" => "ou=templates,",
1145                 "faivariableou" => "ou=variables,",
1146                 "faiprofileou"  => "ou=profiles,",
1147                 "faipackageou"  => "ou=packages,",
1148                 "faipartitionou"=> "ou=disk,",
1149
1150                 "deviceou"      => "ou=devices,",
1151                 "mimetypeou"    => "ou=mime,");
1152
1153   /* Preset ou... */
1154   if (isset($config->current[$name])){
1155     $ou= $config->current[$name];
1156   } elseif (isset($map[$name])) {
1157     $ou = $map[$name];
1158     return($ou);
1159   } else {
1160     trigger_error("No department mapping found for type ".$name);
1161     return "";
1162   }
1163
1164
1165   if ($ou != ""){
1166     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1167       return @LDAP::convert("ou=$ou,");
1168     } else {
1169       return @LDAP::convert("$ou,");
1170     }
1171   } else {
1172     return "";
1173   }
1174 }
1175
1176
1177 function get_people_ou()
1178 {
1179   return (get_ou("PEOPLE"));
1180 }
1181
1182
1183 function get_groups_ou()
1184 {
1185   return (get_ou("GROUPS"));
1186 }
1187
1188
1189 function get_winstations_ou()
1190 {
1191   return (get_ou("WINSTATIONS"));
1192 }
1193
1194
1195 function get_base_from_people($dn)
1196 {
1197   global $config;
1198
1199   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1200   $base= preg_replace($pattern, '', $dn);
1201
1202   /* Set to base, if we're not on a correct subtree */
1203   if (!isset($config->idepartments[$base])){
1204     $base= $config->current['BASE'];
1205   }
1206
1207   return ($base);
1208 }
1209
1210
1211 function strict_uid_mode()
1212 {
1213   return !(isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT']));
1214 }
1215
1216
1217 function get_uid_regexp()
1218 {
1219   /* STRICT adds spaces and case insenstivity to the uid check.
1220      This is dangerous and should not be used. */
1221   if (strict_uid_mode()){
1222     return "^[a-z0-9_-]+$";
1223   } else {
1224     return "^[a-zA-Z0-9 _.-]+$";
1225   }
1226 }
1227
1228
1229 function print_red()
1230 {
1231   trigger_error("Use of obsolete print_red");
1232   /* Check number of arguments */
1233   if (func_num_args() < 1){
1234     return;
1235   }
1236
1237   /* Get arguments, save string */
1238   $array = func_get_args();
1239   $string= $array[0];
1240
1241   /* Step through arguments */
1242   for ($i= 1; $i<count($array); $i++){
1243     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1244   }
1245
1246   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1247      the other case... */
1248   if($string !== NULL){
1249     if (preg_match("/"._("LDAP error:")."/", $string)){
1250       $addmsg= _("Problems with the LDAP server mean that you probably lost the last changes. Please check your LDAP setup for possible errors and try again.");
1251     } else {
1252       if (!preg_match('/[.!?]$/', $string)){
1253         $string.= ".";
1254       }
1255       $string= preg_replace('/<br>/', ' ', $string);
1256       $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1257       $addmsg = "";
1258     }
1259     if(empty($addmsg)){
1260       $addmsg = _("Error");
1261     }
1262     msg_dialog::display($addmsg, $string,ERROR_DIALOG);
1263     return;
1264   }else{
1265     return;
1266   }
1267
1268 }
1269
1270
1271 function gen_locked_message($user, $dn)
1272 {
1273   global $plug, $config;
1274
1275   session::set('dn', $dn);
1276   $remove= false;
1277
1278   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1279   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1280
1281     $LOCK_VARS_USED   = array();
1282     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1283
1284     foreach($LOCK_VARS_TO_USE as $name){
1285
1286       if(empty($name)){
1287         continue;
1288       }
1289
1290       foreach($_POST as $Pname => $Pvalue){
1291         if(preg_match($name,$Pname)){
1292           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1293         }
1294       }
1295
1296       foreach($_GET as $Pname => $Pvalue){
1297         if(preg_match($name,$Pname)){
1298           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1299         }
1300       }
1301     }
1302     session::set('LOCK_VARS_TO_USE',array());
1303     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1304   }
1305
1306   /* Prepare and show template */
1307   $smarty= get_smarty();
1308
1309   if(is_array($dn)){
1310     $msg = "<pre>";
1311     foreach($dn as $sub_dn){
1312       $msg .= "\n".$sub_dn.", ";
1313     }
1314     $msg = preg_replace("/, $/","</pre>",$msg);
1315   }else{
1316     $msg = $dn;
1317   }
1318
1319   $smarty->assign ("dn", $msg);
1320   if ($remove){
1321     $smarty->assign ("action", _("Continue anyway"));
1322   } else {
1323     $smarty->assign ("action", _("Edit anyway"));
1324   }
1325   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries '%s'"), "<b>".$msg."</b>", ""));
1326
1327   return ($smarty->fetch (get_template_path('islocked.tpl')));
1328 }
1329
1330
1331 function to_string ($value)
1332 {
1333   /* If this is an array, generate a text blob */
1334   if (is_array($value)){
1335     $ret= "";
1336     foreach ($value as $line){
1337       $ret.= $line."<br>\n";
1338     }
1339     return ($ret);
1340   } else {
1341     return ($value);
1342   }
1343 }
1344
1345
1346 function get_printer_list()
1347 {
1348   global $config;
1349   $res = array();
1350   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1351   foreach($data as $attrs ){
1352     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1353   }
1354   return $res;
1355 }
1356
1357
1358 function show_errors($message)
1359 {
1360   $complete= "";
1361
1362   /* Assemble the message array to a plain string */
1363   foreach ($message as $error){
1364     msg_dialog::display(_("Error"), $error, ERROR_DIALOG);
1365   }
1366 }
1367
1368
1369 function show_ldap_error($message, $addon= "")
1370 {
1371   if (!preg_match("/Success/i", $message)){
1372     if ($addon == ""){
1373       msg_dialog::display(_("LDAP error:"), $message, ERROR_DIALOG);
1374     } else {
1375       if(!preg_match("/No such object/i",$message)){
1376         msg_dialog::display(_("LDAP error"), sprintf(_("Plugin '%s':%s"),"<i>".$addon."</i>", "<br><br>$message"),ERROR_DIALOG);
1377       }
1378     }
1379     return TRUE;
1380   } else {
1381     return FALSE;
1382   }
1383 }
1384
1385
1386 function rewrite($s)
1387 {
1388   global $REWRITE;
1389
1390   foreach ($REWRITE as $key => $val){
1391     $s= preg_replace("/$key/", "$val", $s);
1392   }
1393
1394   return ($s);
1395 }
1396
1397
1398 function dn2base($dn)
1399 {
1400   global $config;
1401
1402   if (get_people_ou() != ""){
1403     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1404   }
1405   if (get_groups_ou() != ""){
1406     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1407   }
1408   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1409
1410   return ($base);
1411 }
1412
1413
1414
1415 function check_command($cmdline)
1416 {
1417   $cmd= preg_replace("/ .*$/", "", $cmdline);
1418
1419   /* Check if command exists in filesystem */
1420   if (!file_exists($cmd)){
1421     return (FALSE);
1422   }
1423
1424   /* Check if command is executable */
1425   if (!is_executable($cmd)){
1426     return (FALSE);
1427   }
1428
1429   return (TRUE);
1430 }
1431
1432
1433 function print_header($image, $headline, $info= "")
1434 {
1435   $display= "<div class=\"plugtop\">\n";
1436   $display.= "  <p class=\"center\" style=\"margin:0px 0px 0px 5px;padding:0px;font-size:24px;\"><img class=\"center\" src=\"$image\" align=\"middle\" alt=\"*\">&nbsp;$headline</p>\n";
1437   $display.= "</div>\n";
1438
1439   if ($info != ""){
1440     $display.= "<div class=\"pluginfo\">\n";
1441     $display.= "$info";
1442     $display.= "</div>\n";
1443   } else {
1444     $display.= "<div style=\"height:5px;\">\n";
1445     $display.= "&nbsp;";
1446     $display.= "</div>\n";
1447   }
1448   return ($display);
1449 }
1450
1451
1452 function range_selector($dcnt,$start,$range=25,$post_var=false)
1453 {
1454
1455   /* Entries shown left and right from the selected entry */
1456   $max_entries= 10;
1457
1458   /* Initialize and take care that max_entries is even */
1459   $output="";
1460   if ($max_entries & 1){
1461     $max_entries++;
1462   }
1463
1464   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1465     $range= $_POST[$post_var];
1466   }
1467
1468   /* Prevent output to start or end out of range */
1469   if ($start < 0 ){
1470     $start= 0 ;
1471   }
1472   if ($start >= $dcnt){
1473     $start= $range * (int)(($dcnt / $range) + 0.5);
1474   }
1475
1476   $numpages= (($dcnt / $range));
1477   if(((int)($numpages))!=($numpages)){
1478     $numpages = (int)$numpages + 1;
1479   }
1480   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1481     return ("");
1482   }
1483   $ppage= (int)(($start / $range) + 0.5);
1484
1485
1486   /* Align selected page to +/- max_entries/2 */
1487   $begin= $ppage - $max_entries/2;
1488   $end= $ppage + $max_entries/2;
1489
1490   /* Adjust begin/end, so that the selected value is somewhere in
1491      the middle and the size is max_entries if possible */
1492   if ($begin < 0){
1493     $end-= $begin + 1;
1494     $begin= 0;
1495   }
1496   if ($end > $numpages) {
1497     $end= $numpages;
1498   }
1499   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1500     $begin= $end - $max_entries;
1501   }
1502
1503   if($post_var){
1504     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1505       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1506   }else{
1507     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1508   }
1509
1510   /* Draw decrement */
1511   if ($start > 0 ) {
1512     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1513       (($start-$range))."\">".
1514       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1515   }
1516
1517   /* Draw pages */
1518   for ($i= $begin; $i < $end; $i++) {
1519     if ($ppage == $i){
1520       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1521         validate($_GET['plug'])."&amp;start=".
1522         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1523     } else {
1524       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1525         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1526     }
1527   }
1528
1529   /* Draw increment */
1530   if($start < ($dcnt-$range)) {
1531     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1532       (($start+($range)))."\">".
1533       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1534   }
1535
1536   if(($post_var)&&($numpages)){
1537     $output.= "</td><td style='width:25%;text-align:right;vertical-align:middle;'>&nbsp;"._("Entries per page")."&nbsp;<select style='vertical-align:middle;' name='".$post_var."' onChange='javascript:document.mainform.submit()'>";
1538     foreach(array(20,50,100,200,"all") as $num){
1539       if($num == "all"){
1540         $var = 10000;
1541       }else{
1542         $var = $num;
1543       }
1544       if($var == $range){
1545         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1546       }else{
1547         $output.="\n<option value='".$var."'>".$num."</option>";
1548       }
1549     }
1550     $output.=  "</select></td></tr></table></div>";
1551   }else{
1552     $output.= "</div>";
1553   }
1554
1555   return($output);
1556 }
1557
1558
1559 function apply_filter()
1560 {
1561   $apply= "";
1562
1563   $apply= ''.
1564     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1565     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1566
1567   return ($apply);
1568 }
1569
1570
1571 function back_to_main()
1572 {
1573   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1574     _("Back").'"></p><input type="hidden" name="ignore">';
1575
1576   return ($string);
1577 }
1578
1579
1580 function normalize_netmask($netmask)
1581 {
1582   /* Check for notation of netmask */
1583   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1584     $num= (int)($netmask);
1585     $netmask= "";
1586
1587     for ($byte= 0; $byte<4; $byte++){
1588       $result=0;
1589
1590       for ($i= 7; $i>=0; $i--){
1591         if ($num-- > 0){
1592           $result+= pow(2,$i);
1593         }
1594       }
1595
1596       $netmask.= $result.".";
1597     }
1598
1599     return (preg_replace('/\.$/', '', $netmask));
1600   }
1601
1602   return ($netmask);
1603 }
1604
1605
1606 function netmask_to_bits($netmask)
1607 {
1608   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1609   $res= 0;
1610
1611   for ($n= 0; $n<4; $n++){
1612     $start= 255;
1613     $name= "nm$n";
1614
1615     for ($i= 0; $i<8; $i++){
1616       if ($start == (int)($$name)){
1617         $res+= 8 - $i;
1618         break;
1619       }
1620       $start-= pow(2,$i);
1621     }
1622   }
1623
1624   return ($res);
1625 }
1626
1627
1628 function recurse($rule, $variables)
1629 {
1630   $result= array();
1631
1632   if (!count($variables)){
1633     return array($rule);
1634   }
1635
1636   reset($variables);
1637   $key= key($variables);
1638   $val= current($variables);
1639   unset ($variables[$key]);
1640
1641   foreach($val as $possibility){
1642     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1643     $result= array_merge($result, recurse($nrule, $variables));
1644   }
1645
1646   return ($result);
1647 }
1648
1649
1650 function expand_id($rule, $attributes)
1651 {
1652   /* Check for id rule */
1653   if(preg_match('/^id(:|#)\d+$/',$rule)){
1654     return (array("\{$rule}"));
1655   }
1656
1657   /* Check for clean attribute */
1658   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1659     $rule= preg_replace('/^%/', '', $rule);
1660     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1661     return (array($val));
1662   }
1663
1664   /* Check for attribute with parameters */
1665   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1666     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1667     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1668     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1669     $start= preg_replace ('/-.*$/', '', $param);
1670     $stop = preg_replace ('/^[^-]+-/', '', $param);
1671
1672     /* Assemble results */
1673     $result= array();
1674     for ($i= $start; $i<= $stop; $i++){
1675       $result[]= substr($val, 0, $i);
1676     }
1677     return ($result);
1678   }
1679
1680   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1681   return (array($rule));
1682 }
1683
1684
1685 function gen_uids($rule, $attributes)
1686 {
1687   global $config;
1688
1689   /* Search for keys and fill the variables array with all
1690      possible values for that key. */
1691   $part= "";
1692   $trigger= false;
1693   $stripped= "";
1694   $variables= array();
1695
1696   for ($pos= 0; $pos < strlen($rule); $pos++){
1697
1698     if ($rule[$pos] == "{" ){
1699       $trigger= true;
1700       $part= "";
1701       continue;
1702     }
1703
1704     if ($rule[$pos] == "}" ){
1705       $variables[$pos]= expand_id($part, $attributes);
1706       $stripped.= "{".$pos."}";
1707       $trigger= false;
1708       continue;
1709     }
1710
1711     if ($trigger){
1712       $part.= $rule[$pos];
1713     } else {
1714       $stripped.= $rule[$pos];
1715     }
1716   }
1717
1718   /* Recurse through all possible combinations */
1719   $proposed= recurse($stripped, $variables);
1720
1721   /* Get list of used ID's */
1722   $used= array();
1723   $ldap= $config->get_ldap_link();
1724   $ldap->cd($config->current['BASE']);
1725   $ldap->search('(uid=*)');
1726
1727   while($attrs= $ldap->fetch()){
1728     $used[]= $attrs['uid'][0];
1729   }
1730
1731   /* Remove used uids and watch out for id tags */
1732   $ret= array();
1733   foreach($proposed as $uid){
1734
1735     /* Check for id tag and modify uid if needed */
1736     if(preg_match('/\{id:\d+}/',$uid)){
1737       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1738
1739       for ($i= 0; $i < pow(10,$size); $i++){
1740         $number= sprintf("%0".$size."d", $i);
1741         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1742         if (!in_array($res, $used)){
1743           $uid= $res;
1744           break;
1745         }
1746       }
1747     }
1748
1749   if(preg_match('/\{id#\d+}/',$uid)){
1750     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1751
1752     while (true){
1753       mt_srand((double) microtime()*1000000);
1754       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1755       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1756       if (!in_array($res, $used)){
1757         $uid= $res;
1758         break;
1759       }
1760     }
1761   }
1762
1763 /* Don't assign used ones */
1764 if (!in_array($uid, $used)){
1765   $ret[]= $uid;
1766 }
1767 }
1768
1769 return(array_unique($ret));
1770 }
1771
1772
1773 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1774    Need to convert... */
1775 function to_byte($value) {
1776   $value= strtolower(trim($value));
1777
1778   if(!is_numeric(substr($value, -1))) {
1779
1780     switch(substr($value, -1)) {
1781       case 'g':
1782         $mult= 1073741824;
1783         break;
1784       case 'm':
1785         $mult= 1048576;
1786         break;
1787       case 'k':
1788         $mult= 1024;
1789         break;
1790     }
1791
1792     return ($mult * (int)substr($value, 0, -1));
1793   } else {
1794     return $value;
1795   }
1796 }
1797
1798
1799 function in_array_ics($value, $items)
1800 {
1801   if (!is_array($items)){
1802     return (FALSE);
1803   }
1804
1805   foreach ($items as $item){
1806     if (strcasecmp($item, $value) == 0) {
1807       return (TRUE);
1808     }
1809   }
1810
1811   return (FALSE);
1812 }
1813
1814
1815 function generate_alphabet($count= 10)
1816 {
1817   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1818   $alphabet= "";
1819   $c= 0;
1820
1821   /* Fill cells with charaters */
1822   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1823     if ($c == 0){
1824       $alphabet.= "<tr>";
1825     }
1826
1827     $ch = mb_substr($characters, $i, 1, "UTF8");
1828     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1829       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1830
1831     if ($c++ == $count){
1832       $alphabet.= "</tr>";
1833       $c= 0;
1834     }
1835   }
1836
1837   /* Fill remaining cells */
1838   while ($c++ <= $count){
1839     $alphabet.= "<td>&nbsp;</td>";
1840   }
1841
1842   return ($alphabet);
1843 }
1844
1845
1846 function validate($string)
1847 {
1848   return (strip_tags(preg_replace('/\0/', '', $string)));
1849 }
1850
1851
1852 function get_gosa_version()
1853 {
1854   global $svn_revision, $svn_path;
1855
1856   /* Extract informations */
1857   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1858
1859   /* Release or development? */
1860   if (preg_match('%/gosa/trunk/%', $svn_path)){
1861     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1862   } else {
1863     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1864     return (sprintf(_("GOsa $release"), $revision));
1865   }
1866 }
1867
1868
1869 function rmdirRecursive($path, $followLinks=false) {
1870   $dir= opendir($path);
1871   while($entry= readdir($dir)) {
1872     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1873       unlink($path."/".$entry);
1874     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1875       rmdirRecursive($path."/".$entry);
1876     }
1877   }
1878   closedir($dir);
1879   return rmdir($path);
1880 }
1881
1882
1883 function scan_directory($path,$sort_desc=false)
1884 {
1885   $ret = false;
1886
1887   /* is this a dir ? */
1888   if(is_dir($path)) {
1889
1890     /* is this path a readable one */
1891     if(is_readable($path)){
1892
1893       /* Get contents and write it into an array */
1894       $ret = array();
1895
1896       $dir = opendir($path);
1897
1898       /* Is this a correct result ?*/
1899       if($dir){
1900         while($fp = readdir($dir))
1901           $ret[]= $fp;
1902       }
1903     }
1904   }
1905   /* Sort array ascending , like scandir */
1906   sort($ret);
1907
1908   /* Sort descending if parameter is sort_desc is set */
1909   if($sort_desc) {
1910     $ret = array_reverse($ret);
1911   }
1912
1913   return($ret);
1914 }
1915
1916
1917 function clean_smarty_compile_dir($directory)
1918 {
1919   global $svn_revision;
1920
1921   if(is_dir($directory) && is_readable($directory)) {
1922     // Set revision filename to REVISION
1923     $revision_file= $directory."/REVISION";
1924
1925     /* Is there a stamp containing the current revision? */
1926     if(!file_exists($revision_file)) {
1927       // create revision file
1928       create_revision($revision_file, $svn_revision);
1929     } else {
1930       # check for "$config->...['CONFIG']/revision" and the
1931       # contents should match the revision number
1932       if(!compare_revision($revision_file, $svn_revision)){
1933         // If revision differs, clean compile directory
1934         foreach(scan_directory($directory) as $file) {
1935           if(($file==".")||($file=="..")) continue;
1936           if( is_file($directory."/".$file) &&
1937               is_writable($directory."/".$file)) {
1938             // delete file
1939             if(!unlink($directory."/".$file)) {
1940               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1941               // This should never be reached
1942             }
1943           } elseif(is_dir($directory."/".$file) &&
1944               is_writable($directory."/".$file)) {
1945             // Just recursively delete it
1946             rmdirRecursive($directory."/".$file);
1947           }
1948         }
1949         // We should now create a fresh revision file
1950         clean_smarty_compile_dir($directory);
1951       } else {
1952         // Revision matches, nothing to do
1953       }
1954     }
1955   } else {
1956     // Smarty compile dir is not accessible
1957     // (Smarty will warn about this)
1958   }
1959 }
1960
1961
1962 function create_revision($revision_file, $revision)
1963 {
1964   $result= false;
1965
1966   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1967     if($fh= fopen($revision_file, "w")) {
1968       if(fwrite($fh, $revision)) {
1969         $result= true;
1970       }
1971     }
1972     fclose($fh);
1973   } else {
1974     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1975   }
1976
1977   return $result;
1978 }
1979
1980
1981 function compare_revision($revision_file, $revision)
1982 {
1983   // false means revision differs
1984   $result= false;
1985
1986   if(file_exists($revision_file) && is_readable($revision_file)) {
1987     // Open file
1988     if($fh= fopen($revision_file, "r")) {
1989       // Compare File contents with current revision
1990       if($revision == fread($fh, filesize($revision_file))) {
1991         $result= true;
1992       }
1993     } else {
1994       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1995     }
1996     // Close file
1997     fclose($fh);
1998   }
1999
2000   return $result;
2001 }
2002
2003
2004 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
2005 {
2006   $str = ""; // Our return value will be saved in this var
2007
2008   $color  = dechex($percentage+150);
2009   $color2 = dechex(150 - $percentage);
2010   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
2011
2012   $progress = (int)(($percentage /100)*$width);
2013
2014   /* Abort printing out percentage, if divs are to small */
2015
2016
2017   /* If theres a better solution for this, use it... */
2018   $str = "
2019     <div style=\" width:".($width)."px;
2020     height:".($height)."px;
2021   background-color:#000000;
2022 padding:1px;\">
2023
2024           <div style=\" width:".($width)."px;
2025         background-color:#$bgcolor;
2026 height:".($height)."px;\">
2027
2028          <div style=\" width:".$progress."px;
2029 height:".$height."px;
2030        background-color:#".$color2.$color2.$color."; \">";
2031
2032
2033        if(($height >10)&&($showvalue)){
2034          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
2035            <b>".$percentage."%</b>
2036            </font>";
2037        }
2038
2039        $str.= "</div></div></div>";
2040
2041        return($str);
2042 }
2043
2044
2045 function array_key_ics($ikey, $items)
2046 {
2047   /* Gather keys, make them lowercase */
2048   $tmp= array();
2049   foreach ($items as $key => $value){
2050     $tmp[strtolower($key)]= $key;
2051   }
2052
2053   if (isset($tmp[strtolower($ikey)])){
2054     return($tmp[strtolower($ikey)]);
2055   }
2056
2057   return ("");
2058 }
2059
2060
2061 function array_differs($src, $dst)
2062 {
2063   /* If the count is differing, the arrays differ */
2064   if (count ($src) != count ($dst)){
2065     return (TRUE);
2066   }
2067
2068   /* So the count is the same - lets check the contents */
2069   $differs= FALSE;
2070   foreach($src as $value){
2071     if (!in_array($value, $dst)){
2072       $differs= TRUE;
2073     }
2074   }
2075
2076   return ($differs);
2077 }
2078
2079
2080 function saveFilter($a_filter, $values)
2081 {
2082   if (isset($_POST['regexit'])){
2083     $a_filter["regex"]= $_POST['regexit'];
2084
2085     foreach($values as $type){
2086       if (isset($_POST[$type])) {
2087         $a_filter[$type]= "checked";
2088       } else {
2089         $a_filter[$type]= "";
2090       }
2091     }
2092   }
2093
2094   /* React on alphabet links if needed */
2095   if (isset($_GET['search'])){
2096     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2097     if ($s == "**"){
2098       $s= "*";
2099     }
2100     $a_filter['regex']= $s;
2101   }
2102
2103   return ($a_filter);
2104 }
2105
2106
2107 /* Escape all preg_* relevant characters */
2108 function normalizePreg($input)
2109 {
2110   return (addcslashes($input, '[]()|/.*+-'));
2111 }
2112
2113
2114 /* Escape all LDAP filter relevant characters */
2115 function normalizeLdap($input)
2116 {
2117   return (addcslashes($input, '()|'));
2118 }
2119
2120
2121 /* Resturns the difference between to microtime() results in float  */
2122 function get_MicroTimeDiff($start , $stop)
2123 {
2124   $a = split("\ ",$start);
2125   $b = split("\ ",$stop);
2126
2127   $secs = $b[1] - $a[1];
2128   $msecs= $b[0] - $a[0];
2129
2130   $ret = (float) ($secs+ $msecs);
2131   return($ret);
2132 }
2133
2134
2135 function get_base_dir()
2136 {
2137   global $BASE_DIR;
2138
2139   return $BASE_DIR;
2140 }
2141
2142
2143 function obj_is_readable($dn, $object, $attribute)
2144 {
2145   global $ui;
2146
2147   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2148 }
2149
2150
2151 function obj_is_writable($dn, $object, $attribute)
2152 {
2153   global $ui;
2154
2155   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2156 }
2157
2158
2159 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2160 {
2161   /* Initialize variables */
2162   $ret  = array("count" => 0);  // Set count to 0
2163   $next = true;                 // if false, then skip next loops and return
2164   $cnt  = 0;                    // Current number of loops
2165   $max  = 100;                  // Just for security, prevent looops
2166   $ldap = NULL;                 // To check if created result a valid
2167   $keep = "";                   // save last failed parse string
2168
2169   /* Check each parsed dn in ldap ? */
2170   if($config!==NULL && $verify_in_ldap){
2171     $ldap = $config->get_ldap_link();
2172   }
2173
2174   /* Lets start */
2175   $called = false;
2176   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2177
2178     $cnt ++;
2179     if(!preg_match("/,/",$dn)){
2180       $next = false;
2181     }
2182     $object = preg_replace("/[,].*$/","",$dn);
2183     $dn     = preg_replace("/^[^,]+,/","",$dn);
2184
2185     $called = true;
2186
2187     /* Check if current dn is valid */
2188     if($ldap!==NULL){
2189       $ldap->cd($dn);
2190       $ldap->cat($dn,array("dn"));
2191       if($ldap->count()){
2192         $ret[]  = $keep.$object;
2193         $keep   = "";
2194       }else{
2195         $keep  .= $object.",";
2196       }
2197     }else{
2198       $ret[]  = $keep.$object;
2199       $keep   = "";
2200     }
2201   }
2202
2203   /* No dn was posted */
2204   if($cnt == 0 && !empty($dn)){
2205     $ret[] = $dn;
2206   }
2207
2208   /* Append the rest */
2209   $test = $keep.$dn;
2210   if($called && !empty($test)){
2211     $ret[] = $keep.$dn;
2212   }
2213   $ret['count'] = count($ret) - 1;
2214
2215   return($ret);
2216 }
2217
2218
2219 function get_base_from_hook($dn, $attrib)
2220 {
2221   global $config;
2222
2223   if (isset($config->current['BASE_HOOK'])){
2224
2225     /* Call hook script - if present */
2226     $command= $config->current['BASE_HOOK'];
2227
2228     if ($command != ""){
2229       $command.= " '".LDAP::fix($dn)."' $attrib";
2230       if (check_command($command)){
2231         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2232         exec($command, $output);
2233         if (preg_match("/^[0-9]+$/", $output[0])){
2234           return ($output[0]);
2235         } else {
2236           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2237           return ($config->current['UIDBASE']);
2238         }
2239       } else {
2240         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2241         return ($config->current['UIDBASE']);
2242       }
2243
2244     } else {
2245
2246       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2247       return ($config->current['UIDBASE']);
2248
2249     }
2250   }
2251 }
2252
2253
2254 function check_schema_version($class, $version)
2255 {
2256   return preg_match("/\(v$version\)/", $class['DESC']);
2257 }
2258
2259
2260 function check_schema($cfg,$rfc2307bis = FALSE)
2261 {
2262   $messages= array();
2263
2264   /* Get objectclasses */
2265   $ldap = new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']);
2266   $objectclasses = $ldap->get_objectclasses();
2267   if(count($objectclasses) == 0){
2268     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2269   }
2270
2271   /* This is the default block used for each entry.
2272    *  to avoid unset indexes.
2273    */
2274   $def_check = array("REQUIRED_VERSION" => "0",
2275       "SCHEMA_FILES"     => array(),
2276       "CLASSES_REQUIRED" => array(),
2277       "STATUS"           => FALSE,
2278       "IS_MUST_HAVE"     => FALSE,
2279       "MSG"              => "",
2280       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2281
2282   /* The gosa base schema */
2283   $checks['gosaObject'] = $def_check;
2284   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2285   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2286   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2287   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2288
2289   /* GOsa Account class */
2290   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2291   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2292   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2293   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2294   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2295
2296   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2297   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2298   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2299   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2300   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2301   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2302
2303   /* Some other checks */
2304   foreach(array(
2305         "gosaCacheEntry"        => array("version" => "2.4"),
2306         "gosaDepartment"        => array("version" => "2.4"),
2307         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2308         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2309         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2310         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2311         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2312         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2313         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2314         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2315         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2316         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2317         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2318         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2319         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2320         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2321         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2322         "goLdapServer"          => array("version" => "2.4"),
2323         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2324         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2325         "goKrbServer"           => array("version" => "2.4"),
2326         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2327         ) as $name => $values){
2328
2329           $checks[$name] = $def_check;
2330           if(isset($values['version'])){
2331             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2332           }
2333           if(isset($values['file'])){
2334             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2335           }
2336           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2337         }
2338   foreach($checks as $name => $value){
2339     foreach($value['CLASSES_REQUIRED'] as $class){
2340
2341       if(!isset($objectclasses[$name])){
2342         $checks[$name]['STATUS'] = FALSE;
2343         if($value['IS_MUST_HAVE']){
2344           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2345         }else{
2346           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2347         }
2348       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2349         $checks[$name]['STATUS'] = FALSE;
2350
2351         if($value['IS_MUST_HAVE']){
2352           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2353         }else{
2354           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2355         }
2356       }else{
2357         $checks[$name]['STATUS'] = TRUE;
2358         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2359       }
2360     }
2361   }
2362
2363   $tmp = $objectclasses;
2364
2365   /* The gosa base schema */
2366   $checks['posixGroup'] = $def_check;
2367   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2368   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2369   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2370   $checks['posixGroup']['STATUS']           = TRUE;
2371   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2372   $checks['posixGroup']['MSG']              = "";
2373   $checks['posixGroup']['INFO']             = "";
2374
2375   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2376   if(isset($tmp['posixGroup'])){
2377
2378     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2379       $checks['posixGroup']['STATUS']           = FALSE;
2380       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2381       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2382     }
2383     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2384       $checks['posixGroup']['STATUS']           = FALSE;
2385       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2386       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2387     }
2388   }
2389
2390   return($checks);
2391 }
2392
2393
2394 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2395 {
2396   $tmp = array(
2397         "de_DE" => "German",
2398         "fr_FR" => "French",
2399         "it_IT" => "Italian",
2400         "es_ES" => "Spanish",
2401         "en_US" => "English",
2402         "nl_NL" => "Dutch",
2403         "pl_PL" => "Polish",
2404         "sv_SE" => "Swedish",
2405         "zh_CN" => "Chinese",
2406         "ru_RU" => "Russian");
2407
2408   $tmp2= array(
2409         "de_DE" => _("German"),
2410         "fr_FR" => _("French"),
2411         "it_IT" => _("Italian"),
2412         "es_ES" => _("Spanish"),
2413         "en_US" => _("English"),
2414         "nl_NL" => _("Dutch"),
2415         "pl_PL" => _("Polish"),
2416         "sv_SE" => _("Swedish"),
2417         "zh_CN" => _("Chinese"),
2418         "ru_RU" => _("Russian"));
2419
2420   $ret = array();
2421   if($languages_in_own_language){
2422
2423     $old_lang = setlocale(LC_ALL, 0);
2424     foreach($tmp as $key => $name){
2425       $lang = $key.".UTF-8";
2426       setlocale(LC_ALL, $lang);
2427       if($strip_region_tag){
2428         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2429       }else{
2430         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2431       }
2432     }
2433     setlocale(LC_ALL, $old_lang);
2434   }else{
2435     foreach($tmp as $key => $name){
2436       if($strip_region_tag){
2437         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2438       }else{
2439         $ret[$key] = _($name);
2440       }
2441     }
2442   }
2443   return($ret);
2444 }
2445
2446
2447 /* Returns contents of the given POST variable and check magic quotes settings */
2448 function get_post($name)
2449 {
2450   if(!isset($_POST[$name])){
2451     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2452     return(FALSE);
2453   }
2454   if(get_magic_quotes_gpc()){
2455     return(stripcslashes($_POST[$name]));
2456   }else{
2457     return($_POST[$name]);
2458   }
2459 }
2460
2461
2462 /* Return class name in correct case */
2463 function get_correct_class_name($cls)
2464 {
2465   global $class_mapping;
2466   if(isset($class_mapping) && is_array($class_mapping)){
2467     foreach($class_mapping as $class => $file){
2468       if(preg_match("/^".$cls."$/i",$class)){
2469         return($class);
2470       }
2471     }
2472   }
2473   return(FALSE);
2474 }
2475
2476
2477 // change_password, changes the Password, of the given dn
2478 function change_password ($dn, $password, $mode=0, $hash= "")
2479 {
2480   global $config;
2481   $newpass= "";
2482
2483   /* Convert to lower. Methods are lowercase */
2484   $hash= strtolower($hash);
2485
2486   // Get all available encryption Methods
2487
2488   // NON STATIC CALL :)
2489   $tmp = new passwordMethod(session::get('config'));
2490   $available = $tmp->get_available_methods();
2491
2492   // read current password entry for $dn, to detect the encryption Method
2493   $ldap       = $config->get_ldap_link();
2494   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2495   $attrs      = $ldap->fetch ();
2496
2497   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2498   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2499     $deactivated = TRUE;
2500   }else{
2501     $deactivated = FALSE;
2502   }
2503
2504   /* Is ensure that clear passwords will stay clear */
2505   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2506     $hash = "clear";
2507   }
2508
2509   // Detect the encryption Method
2510   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2511
2512     /* Check for supported algorithm */
2513     mt_srand((double) microtime()*1000000);
2514
2515     /* Extract used hash */
2516     if ($hash == ""){
2517       $hash= strtolower($matches[1]);
2518     }
2519
2520     $test = new  $available[$hash]($config);
2521
2522   } else {
2523     // User MD5 by default
2524     $hash= "md5";
2525     $test = new  $available['md5']($config);
2526   }
2527
2528   /* Feed password backends with information */
2529   $test->dn= $dn;
2530   $test->attrs= $attrs;
2531   $newpass= $test->generate_hash($password);
2532
2533   // Update shadow timestamp?
2534   if (isset($attrs["shadowLastChange"][0])){
2535     $shadow= (int)(date("U") / 86400);
2536   } else {
2537     $shadow= 0;
2538   }
2539
2540   // Write back modified entry
2541   $ldap->cd($dn);
2542   $attrs= array();
2543
2544   // Not for groups
2545   if ($mode == 0){
2546
2547     if ($shadow != 0){
2548       $attrs['shadowLastChange']= $shadow;
2549     }
2550
2551     // Create SMB Password
2552     $attrs= generate_smb_nt_hash($password);
2553   }
2554
2555  /* Readd ! if user was deactivated */
2556   if($deactivated){
2557     $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass);
2558   }
2559
2560   $attrs['userPassword']= array();
2561   $attrs['userPassword']= $newpass;
2562
2563   $ldap->modify($attrs);
2564
2565   new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
2566
2567   if ($ldap->error != 'Success') {
2568     msg_dialog::display(_("LDAP error"), sprintf(_('Setting the password failed!').'<br><br>'._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
2569   } else {
2570
2571     /* Run backend method for change/create */
2572     $test->set_password($password);
2573
2574     /* Find postmodify entries for this class */
2575     $command= $config->search("password", "POSTMODIFY",array('menu'));
2576
2577     if ($command != ""){
2578       /* Walk through attribute list */
2579       $command= preg_replace("/%userPassword/", $password, $command);
2580       $command= preg_replace("/%dn/", $dn, $command);
2581
2582       if (check_command($command)){
2583         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2584         exec($command);
2585       } else {
2586         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2587         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2588       }
2589     }
2590   }
2591 }
2592
2593
2594 // Return something like array['sambaLMPassword']= "lalla..."
2595 function generate_smb_nt_hash($password)
2596 {
2597   global $config;
2598
2599   # Try to use gosa-si?
2600   if (isset($config->current['GOSA_SI'])){
2601         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2602         $hash= $res['XML']['HASH'];
2603   } else {
2604           $tmp= $config->data['MAIN']['SMBHASH']." ".escapeshellarg($password);
2605           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2606
2607           exec($tmp, $ar);
2608           flush();
2609           reset($ar);
2610           $hash= current($ar);
2611   }
2612
2613   if ($hash == "") {
2614           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2615           return ("");
2616   }
2617
2618   list($lm,$nt)= split (":", trim($hash));
2619
2620   if ($config->current['SAMBAVERSION'] == 3) {
2621           $attrs['sambaLMPassword']= $lm;
2622           $attrs['sambaNTPassword']= $nt;
2623           $attrs['sambaPwdLastSet']= date('U');
2624           $attrs['sambaBadPasswordCount']= "0";
2625           $attrs['sambaBadPasswordTime']= "0";
2626   } else {
2627           $attrs['lmPassword']= $lm;
2628           $attrs['ntPassword']= $nt;
2629           $attrs['pwdLastSet']= date('U');
2630   }
2631   return($attrs);
2632 }
2633
2634
2635 function crypt_single($string,$enc_type )
2636 {
2637   return( passwordMethod::crypt_single_str($string,$enc_type));
2638 }
2639
2640
2641 function getEntryCSN($dn)
2642 {
2643   global $config;
2644   if(empty($dn) || !is_object($config)){
2645     return("");
2646   }
2647
2648   /* Get attribute that we should use as serial number */
2649   if(isset($config->current['UNIQ_IDENTIFIER'])){
2650     $attr = $config->current['UNIQ_IDENTIFIER'];
2651   }elseif(isset($config->data['MAIN']['UNIQ_IDENTIFIER'])){
2652     $attr = $config->data['MAIN']['UNIQ_IDENTIFIER'];
2653   }
2654   if(!empty($attr)){
2655     $ldap = $config->get_ldap_link();
2656     $ldap->cat($dn,array($attr));
2657     $csn = $ldap->fetch();
2658     if(isset($csn[$attr][0])){
2659       return($csn[$attr][0]);
2660     }
2661   }
2662   return("");
2663 }
2664
2665
2666 /* Add a given objectClass to an attrs entry */
2667 function add_objectClass($classes, &$attrs)
2668 {
2669   if (is_array($classes)){
2670     $list= $classes;
2671   } else {
2672     $list= array($classes);
2673   }
2674
2675   foreach ($list as $class){
2676     $attrs['objectClass'][]= $class;
2677   }
2678 }
2679
2680
2681 /* Removes a given objectClass from the attrs entry */
2682 function remove_objectClass($classes, &$attrs)
2683 {
2684   if (isset($attrs['objectClass'])){
2685     /* Array? */
2686     if (is_array($classes)){
2687       $list= $classes;
2688     } else {
2689       $list= array($classes);
2690     }
2691
2692     $tmp= array();
2693     foreach ($attrs['objectClass'] as $oc) {
2694       foreach ($list as $class){
2695         if ($oc != $class){
2696           $tmp[]= $oc;
2697         }
2698       }
2699     }
2700     $attrs['objectClass']= $tmp;
2701   }
2702 }
2703
2704 /*! \brief  Initialize a file download with given content, name and data type.
2705  *  @param  data  String The content to send.
2706  *  @param  name  String The name of the file.
2707  *  @param  type  String The content identifier, default value is "application/octet-stream";
2708  */
2709 function send_binary_content($data,$name,$type = "application/octet-stream")
2710 {
2711   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2712   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2713   header("Cache-Control: no-cache");
2714   header("Pragma: no-cache");
2715   header("Cache-Control: post-check=0, pre-check=0");
2716   header("Content-type: ".$type."");
2717
2718   /* force download dialog */
2719   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2720     header('Content-Disposition: filename="'.$name.'"');
2721   } else {
2722     header('Content-Disposition: attachment; filename="'.$name.'"');
2723   }
2724
2725   echo $data;
2726   exit();
2727 }
2728
2729 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2730 ?>