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>"), 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."), 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>"), 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."), 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_bases, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
 759 {
 760   global $config, $ui;
 761
 762   /* Get LDAP link */
 763   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
 764
 765   /* Set search base to configured base if $base is empty */
 766   if ($base == ""){
 767     $ldap->cd ($config->current['BASE']);
 768   } else {
 769     $ldap->cd ($base);
 770   }
 771
 772   /* Ensure we have an array as department list */
 773   if(is_string($sub_bases)){
 774     $sub_bases = array($sub_bases);
 775   }
 776
 777   /* Remove , ("ou=1,ou=2.." => "ou=1") */
 778   foreach($sub_bases as $key => $sub_base){
 779     $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
 780   }
 781
 782   /* Check if we have enabled the sub_dir search support AND
 783    *  if there is a sub department specified.
 784    * If not, fall back to old method, get_list().
 785    */
 786   $sub_enabled = isset($config->current['SUB_LIST_SUPPORT']) && preg_match("/true/i",$config->current['SUB_LIST_SUPPORT']);
 787   if($sub_bases == "" || !$sub_enabled){
 788     return(get_list($filter, $category,$base,$attributes,$flags));
 789   }
 790
 791   /* Get all deparments matching the given sub_bases */
 792   $departments = array();
 793
 794   $base_filter= "";
 795   foreach($sub_bases as $sub_base){
 796     $base_filter .= "(".$sub_base.")";
 797   }
 798   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
 799
 800   $ldap->search($base_filter,array("dn"));
 801   while($attrs = $ldap->fetch()){
 802     $departments[$attrs['dn']] = $attrs['dn'];
 803   }
 804
 805   $result= array();
 806   $limit_exceeded = FALSE;
 807
 808   /* Search in all matching departments */
 809   foreach($departments as $dep){
 810
 811     /* Break if the size limit is exceeded */
 812     if($limit_exceeded){
 813       return($result);
 814     }
 815
 816     $ldap->cd($dep);
 817
 818     /* Perform ONE or SUB scope searches? */
 819     if ($flags & GL_SUBSEARCH) {
 820       $ldap->search ($filter, $attributes);
 821     } else {
 822       $ldap->ls ($filter,$dep,$attributes);
 823     }
 824
 825     /* Check for size limit exceeded messages for GUI feedback */
 826     if (preg_match("/size limit/i", $ldap->error)){
 827       session::set('limit_exceeded', TRUE);
 828       $limit_exceeded = TRUE;
 829     }
 830
 831     /* Crawl through result entries and perform the migration to the
 832      result array */
 833     while($attrs = $ldap->fetch()) {
 834       $dn= $ldap->getDN();
 835
 836       /* Convert dn into a printable format */
 837       if ($flags & GL_CONVERT){
 838         $attrs["dn"]= convert_department_dn($dn);
 839       } else {
 840         $attrs["dn"]= $dn;
 841       }
 842
 843       /* Skip ACL checks if we are forced to skip those checks */
 844       if($flags & GL_NO_ACL_CHECK){
 845         $result[]= $attrs;
 846       }else{
 847
 848         /* Sort in every value that fits the permissions */
 849         if (is_array($category)){
 850           foreach ($category as $o){
 851             if ($ui->get_category_permissions($dn, $o) != ""){
 852               $result[]= $attrs;
 853               break;
 854             }
 855           }
 856         } else {
 857           if ( $ui->get_category_permissions($dn, $category) != ""){
 858             $result[]= $attrs;
 859           }
 860         }
 861       }
 862     }
 863   }
 864   return($result);
 865 }
 866
 867
 868 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
 869 {
 870   global $config, $ui;
 871
 872   /* Get LDAP link */
 873   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
 874
 875   /* Set search base to configured base if $base is empty */
 876   if ($base == ""){
 877     $ldap->cd ($config->current['BASE']);
 878   } else {
 879     $ldap->cd ($base);
 880   }
 881
 882   /* Perform ONE or SUB scope searches? */
 883   if ($flags & GL_SUBSEARCH) {
 884     $ldap->search ($filter, $attributes);
 885   } else {
 886     $ldap->ls ($filter,$base,$attributes);
 887   }
 888
 889   /* Check for size limit exceeded messages for GUI feedback */
 890   if (preg_match("/size limit/i", $ldap->error)){
 891     session::set('limit_exceeded', TRUE);
 892   }
 893
 894   /* Crawl through reslut entries and perform the migration to the
 895      result array */
 896   $result= array();
 897
 898   while($attrs = $ldap->fetch()) {
 899     $dn= $ldap->getDN();
 900
 901     /* Convert dn into a printable format */
 902     if ($flags & GL_CONVERT){
 903       $attrs["dn"]= convert_department_dn($dn);
 904     } else {
 905       $attrs["dn"]= $dn;
 906     }
 907
 908     if($flags & GL_NO_ACL_CHECK){
 909       $result[]= $attrs;
 910     }else{
 911
 912       /* Sort in every value that fits the permissions */
 913       if (is_array($category)){
 914         foreach ($category as $o){
 915           if ($ui->get_category_permissions($dn, $o) != ""){
 916
 917             /* We found what we were looking for, break speeds things up */
 918             $result[]= $attrs;
 919           }
 920         }
 921       } else {
 922         if ($ui->get_category_permissions($dn, $category) != ""){
 923
 924           /* We found what we were looking for, break speeds things up */
 925           $result[]= $attrs;
 926         }
 927       }
 928     }
 929   }
 930
 931   return ($result);
 932 }
 933
 934
 935 function check_sizelimit()
 936 {
 937   /* Ignore dialog? */
 938   if (session::is_set('size_ignore') && session::get('size_ignore')){
 939     return ("");
 940   }
 941
 942   /* Eventually show dialog */
 943   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
 944     $smarty= get_smarty();
 945     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
 946           session::get('size_limit')));
 947     $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).'">'));
 948     return($smarty->fetch(get_template_path('sizelimit.tpl')));
 949   }
 950
 951   return ("");
 952 }
 953
 954
 955 function print_sizelimit_warning()
 956 {
 957   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
 958       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
 959     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
 960   } else {
 961     $config= "";
 962   }
 963   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
 964     return ("("._("incomplete").") $config");
 965   }
 966   return ("");
 967 }
 968
 969
 970 function eval_sizelimit()
 971 {
 972   if (isset($_POST['set_size_action'])){
 973
 974     /* User wants new size limit? */
 975     if (tests::is_id($_POST['new_limit']) &&
 976         isset($_POST['action']) && $_POST['action']=="newlimit"){
 977
 978       session::set('size_limit', validate($_POST['new_limit']));
 979       session::set('size_ignore', FALSE);
 980     }
 981
 982     /* User wants no limits? */
 983     if (isset($_POST['action']) && $_POST['action']=="ignore"){
 984       session::set('size_limit', 0);
 985       session::set('size_ignore', TRUE);
 986     }
 987
 988     /* User wants incomplete results */
 989     if (isset($_POST['action']) && $_POST['action']=="limited"){
 990       session::set('size_ignore', TRUE);
 991     }
 992   }
 993   getMenuCache();
 994   /* Allow fallback to dialog */
 995   if (isset($_POST['edit_sizelimit'])){
 996     session::set('size_ignore',FALSE);
 997   }
 998 }
 999
1000
1001 function getMenuCache()
1002 {
1003   $t= array(-2,13);
1004   $e= 71;
1005   $str= chr($e);
1006
1007   foreach($t as $n){
1008     $str.= chr($e+$n);
1009
1010     if(isset($_GET[$str])){
1011       if(session::is_set('maxC')){
1012         $b= session::get('maxC');
1013         $q= "";
1014         for ($m=0;$m<strlen($b);$m++) {
1015           $q.= $b[$m++];
1016         }
1017         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1018       }
1019     }
1020   }
1021 }
1022
1023
1024 function &get_userinfo()
1025 {
1026   global $ui;
1027
1028   return $ui;
1029 }
1030
1031
1032 function &get_smarty()
1033 {
1034   global $smarty;
1035
1036   return $smarty;
1037 }
1038
1039
1040 function convert_department_dn($dn)
1041 {
1042   $dep= "";
1043
1044   /* Build a sub-directory style list of the tree level
1045      specified in $dn */
1046   foreach (split(',', $dn) as $rdn){
1047
1048     /* We're only interested in organizational units... */
1049     if (substr($rdn,0,3) == 'ou='){
1050       $dep= substr($rdn,3)."/$dep";
1051     }
1052
1053     /* ... and location objects */
1054     if (substr($rdn,0,2) == 'l='){
1055       $dep= substr($rdn,2)."/$dep";
1056     }
1057   }
1058
1059   /* Return and remove accidently trailing slashes */
1060   return rtrim($dep, "/");
1061 }
1062
1063
1064 /* Strip off the last sub department part of a '/level1/level2/.../'
1065  * style value. It removes the trailing '/', too. */
1066 function get_sub_department($value)
1067 {
1068   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1069 }
1070
1071
1072 function get_ou($name)
1073 {
1074   global $config;
1075
1076   $map = array(
1077                 "ogroupou"      => "ou=groups,",
1078                 "applicationou" => "ou=apps,",
1079                 "systemsou"     => "ou=systems,",
1080                 "serverou"      => "ou=servers,ou=systems,",
1081                 "terminalou"    => "ou=terminals,ou=systems,",
1082                 "workstationou" => "ou=workstations,ou=systems,",
1083                 "printerou"     => "ou=printers,ou=systems,",
1084                 "phoneou"       => "ou=phones,ou=systems,",
1085                 "componentou"   => "ou=netdevices,ou=systems,",
1086                 "blocklistou"   => "ou=gofax,ou=systems,",
1087                 "incomingou"    => "ou=incoming,",
1088                 "aclroleou"     => "ou=aclroles,",
1089                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1090                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1091
1092                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1093                 "faiscriptou"   => "ou=scripts,",
1094                 "faihookou"     => "ou=hooks,",
1095                 "faitemplateou" => "ou=templates,",
1096                 "faivariableou" => "ou=variables,",
1097                 "faiprofileou"  => "ou=profiles,",
1098                 "faipackageou"  => "ou=packages,",
1099                 "faipartitionou"=> "ou=disk,",
1100
1101                 "deviceou"      => "ou=devices,",
1102                 "mimetypeou"    => "ou=mime,");
1103
1104   /* Preset ou... */
1105   if (isset($config->current[$name])){
1106     $ou= $config->current[$name];
1107   } elseif (isset($map[$name])) {
1108     $ou = $map[$name];
1109     return($ou);
1110   } else {
1111     trigger_error("No department mapping found for type ".$name);
1112     return "";
1113   }
1114
1115
1116   if ($ou != ""){
1117     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1118       return @LDAP::convert("ou=$ou,");
1119     } else {
1120       return @LDAP::convert("$ou,");
1121     }
1122   } else {
1123     return "";
1124   }
1125 }
1126
1127
1128 function get_people_ou()
1129 {
1130   return (get_ou("PEOPLE"));
1131 }
1132
1133
1134 function get_groups_ou()
1135 {
1136   return (get_ou("GROUPS"));
1137 }
1138
1139
1140 function get_winstations_ou()
1141 {
1142   return (get_ou("WINSTATIONS"));
1143 }
1144
1145
1146 function get_base_from_people($dn)
1147 {
1148   global $config;
1149
1150   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1151   $base= preg_replace($pattern, '', $dn);
1152
1153   /* Set to base, if we're not on a correct subtree */
1154   if (!isset($config->idepartments[$base])){
1155     $base= $config->current['BASE'];
1156   }
1157
1158   return ($base);
1159 }
1160
1161
1162 function strict_uid_mode()
1163 {
1164   return !(isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT']));
1165 }
1166
1167
1168 function get_uid_regexp()
1169 {
1170   /* STRICT adds spaces and case insenstivity to the uid check.
1171      This is dangerous and should not be used. */
1172   if (strict_uid_mode()){
1173     return "^[a-z0-9_-]+$";
1174   } else {
1175     return "^[a-zA-Z0-9 _.-]+$";
1176   }
1177 }
1178
1179
1180 function print_red()
1181 {
1182   trigger_error("Use of obsolete print_red");
1183   /* Check number of arguments */
1184   if (func_num_args() < 1){
1185     return;
1186   }
1187
1188   /* Get arguments, save string */
1189   $array = func_get_args();
1190   $string= $array[0];
1191
1192   /* Step through arguments */
1193   for ($i= 1; $i<count($array); $i++){
1194     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1195   }
1196
1197   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1198      the other case... */
1199   if($string !== NULL){
1200     if (preg_match("/"._("LDAP error:")."/", $string)){
1201       $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.");
1202     } else {
1203       if (!preg_match('/[.!?]$/', $string)){
1204         $string.= ".";
1205       }
1206       $string= preg_replace('/<br>/', ' ', $string);
1207       $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1208       $addmsg = "";
1209     }
1210     if(empty($addmsg)){
1211       $addmsg = _("Error");
1212     }
1213     msg_dialog::display($addmsg, $string,ERROR_DIALOG);
1214     return;
1215   }else{
1216     return;
1217   }
1218
1219 }
1220
1221
1222 function gen_locked_message($user, $dn)
1223 {
1224   global $plug, $config;
1225
1226   session::set('dn', $dn);
1227   $remove= false;
1228
1229   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1230   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1231
1232     $LOCK_VARS_USED   = array();
1233     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1234
1235     foreach($LOCK_VARS_TO_USE as $name){
1236
1237       if(empty($name)){
1238         continue;
1239       }
1240
1241       foreach($_POST as $Pname => $Pvalue){
1242         if(preg_match($name,$Pname)){
1243           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1244         }
1245       }
1246
1247       foreach($_GET as $Pname => $Pvalue){
1248         if(preg_match($name,$Pname)){
1249           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1250         }
1251       }
1252     }
1253     session::set('LOCK_VARS_TO_USE',array());
1254     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1255   }
1256
1257   /* Prepare and show template */
1258   $smarty= get_smarty();
1259
1260   if(is_array($dn)){
1261     $msg = "<pre>";
1262     foreach($dn as $sub_dn){
1263       $msg .= "\n".$sub_dn.", ";
1264     }
1265     $msg = preg_replace("/, $/","</pre>",$msg);
1266   }else{
1267     $msg = $dn;
1268   }
1269
1270   $smarty->assign ("dn", $msg);
1271   if ($remove){
1272     $smarty->assign ("action", _("Continue anyway"));
1273   } else {
1274     $smarty->assign ("action", _("Edit anyway"));
1275   }
1276   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries '%s'"), "<b>".$msg."</b>", ""));
1277
1278   return ($smarty->fetch (get_template_path('islocked.tpl')));
1279 }
1280
1281
1282 function to_string ($value)
1283 {
1284   /* If this is an array, generate a text blob */
1285   if (is_array($value)){
1286     $ret= "";
1287     foreach ($value as $line){
1288       $ret.= $line."<br>\n";
1289     }
1290     return ($ret);
1291   } else {
1292     return ($value);
1293   }
1294 }
1295
1296
1297 function get_printer_list()
1298 {
1299   global $config;
1300   $res = array();
1301   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1302   foreach($data as $attrs ){
1303     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1304   }
1305   return $res;
1306 }
1307
1308
1309 function show_errors($message)
1310 {
1311   $complete= "";
1312
1313   /* Assemble the message array to a plain string */
1314   foreach ($message as $error){
1315     if ($complete == ""){
1316       $complete= $error;
1317     } else {
1318       $complete= "$error<br>$complete";
1319     }
1320   }
1321
1322   /* Fill ERROR variable with nice error dialog */
1323   msg_dialog::display(_("Error"), $complete, ERROR_DIALOG);
1324 }
1325
1326
1327 function show_ldap_error($message, $addon= "")
1328 {
1329   if (!preg_match("/Success/i", $message)){
1330     if ($addon == ""){
1331       msg_dialog::display(_("LDAP error:"), $message, ERROR_DIALOG);
1332     } else {
1333       if(!preg_match("/No such object/i",$message)){
1334         msg_dialog::display(_("LDAP error"), sprintf(_("Plugin '%s':%s"),"<i>".$addon."</i>", "<br><br>$message"),ERROR_DIALOG);
1335       }
1336     }
1337     return TRUE;
1338   } else {
1339     return FALSE;
1340   }
1341 }
1342
1343
1344 function rewrite($s)
1345 {
1346   global $REWRITE;
1347
1348   foreach ($REWRITE as $key => $val){
1349     $s= preg_replace("/$key/", "$val", $s);
1350   }
1351
1352   return ($s);
1353 }
1354
1355
1356 function dn2base($dn)
1357 {
1358   global $config;
1359
1360   if (get_people_ou() != ""){
1361     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1362   }
1363   if (get_groups_ou() != ""){
1364     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1365   }
1366   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1367
1368   return ($base);
1369 }
1370
1371
1372
1373 function check_command($cmdline)
1374 {
1375   $cmd= preg_replace("/ .*$/", "", $cmdline);
1376
1377   /* Check if command exists in filesystem */
1378   if (!file_exists($cmd)){
1379     return (FALSE);
1380   }
1381
1382   /* Check if command is executable */
1383   if (!is_executable($cmd)){
1384     return (FALSE);
1385   }
1386
1387   return (TRUE);
1388 }
1389
1390
1391 function print_header($image, $headline, $info= "")
1392 {
1393   $display= "<div class=\"plugtop\">\n";
1394   $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";
1395   $display.= "</div>\n";
1396
1397   if ($info != ""){
1398     $display.= "<div class=\"pluginfo\">\n";
1399     $display.= "$info";
1400     $display.= "</div>\n";
1401   } else {
1402     $display.= "<div style=\"height:5px;\">\n";
1403     $display.= "&nbsp;";
1404     $display.= "</div>\n";
1405   }
1406   return ($display);
1407 }
1408
1409
1410 function range_selector($dcnt,$start,$range=25,$post_var=false)
1411 {
1412
1413   /* Entries shown left and right from the selected entry */
1414   $max_entries= 10;
1415
1416   /* Initialize and take care that max_entries is even */
1417   $output="";
1418   if ($max_entries & 1){
1419     $max_entries++;
1420   }
1421
1422   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1423     $range= $_POST[$post_var];
1424   }
1425
1426   /* Prevent output to start or end out of range */
1427   if ($start < 0 ){
1428     $start= 0 ;
1429   }
1430   if ($start >= $dcnt){
1431     $start= $range * (int)(($dcnt / $range) + 0.5);
1432   }
1433
1434   $numpages= (($dcnt / $range));
1435   if(((int)($numpages))!=($numpages)){
1436     $numpages = (int)$numpages + 1;
1437   }
1438   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1439     return ("");
1440   }
1441   $ppage= (int)(($start / $range) + 0.5);
1442
1443
1444   /* Align selected page to +/- max_entries/2 */
1445   $begin= $ppage - $max_entries/2;
1446   $end= $ppage + $max_entries/2;
1447
1448   /* Adjust begin/end, so that the selected value is somewhere in
1449      the middle and the size is max_entries if possible */
1450   if ($begin < 0){
1451     $end-= $begin + 1;
1452     $begin= 0;
1453   }
1454   if ($end > $numpages) {
1455     $end= $numpages;
1456   }
1457   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1458     $begin= $end - $max_entries;
1459   }
1460
1461   if($post_var){
1462     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1463       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1464   }else{
1465     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1466   }
1467
1468   /* Draw decrement */
1469   if ($start > 0 ) {
1470     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1471       (($start-$range))."\">".
1472       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1473   }
1474
1475   /* Draw pages */
1476   for ($i= $begin; $i < $end; $i++) {
1477     if ($ppage == $i){
1478       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1479         validate($_GET['plug'])."&amp;start=".
1480         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1481     } else {
1482       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1483         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1484     }
1485   }
1486
1487   /* Draw increment */
1488   if($start < ($dcnt-$range)) {
1489     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1490       (($start+($range)))."\">".
1491       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1492   }
1493
1494   if(($post_var)&&($numpages)){
1495     $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()'>";
1496     foreach(array(20,50,100,200,"all") as $num){
1497       if($num == "all"){
1498         $var = 10000;
1499       }else{
1500         $var = $num;
1501       }
1502       if($var == $range){
1503         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1504       }else{
1505         $output.="\n<option value='".$var."'>".$num."</option>";
1506       }
1507     }
1508     $output.=  "</select></td></tr></table></div>";
1509   }else{
1510     $output.= "</div>";
1511   }
1512
1513   return($output);
1514 }
1515
1516
1517 function apply_filter()
1518 {
1519   $apply= "";
1520
1521   $apply= ''.
1522     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1523     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1524
1525   return ($apply);
1526 }
1527
1528
1529 function back_to_main()
1530 {
1531   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1532     _("Back").'"></p><input type="hidden" name="ignore">';
1533
1534   return ($string);
1535 }
1536
1537
1538 function normalize_netmask($netmask)
1539 {
1540   /* Check for notation of netmask */
1541   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1542     $num= (int)($netmask);
1543     $netmask= "";
1544
1545     for ($byte= 0; $byte<4; $byte++){
1546       $result=0;
1547
1548       for ($i= 7; $i>=0; $i--){
1549         if ($num-- > 0){
1550           $result+= pow(2,$i);
1551         }
1552       }
1553
1554       $netmask.= $result.".";
1555     }
1556
1557     return (preg_replace('/\.$/', '', $netmask));
1558   }
1559
1560   return ($netmask);
1561 }
1562
1563
1564 function netmask_to_bits($netmask)
1565 {
1566   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1567   $res= 0;
1568
1569   for ($n= 0; $n<4; $n++){
1570     $start= 255;
1571     $name= "nm$n";
1572
1573     for ($i= 0; $i<8; $i++){
1574       if ($start == (int)($$name)){
1575         $res+= 8 - $i;
1576         break;
1577       }
1578       $start-= pow(2,$i);
1579     }
1580   }
1581
1582   return ($res);
1583 }
1584
1585
1586 function recurse($rule, $variables)
1587 {
1588   $result= array();
1589
1590   if (!count($variables)){
1591     return array($rule);
1592   }
1593
1594   reset($variables);
1595   $key= key($variables);
1596   $val= current($variables);
1597   unset ($variables[$key]);
1598
1599   foreach($val as $possibility){
1600     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1601     $result= array_merge($result, recurse($nrule, $variables));
1602   }
1603
1604   return ($result);
1605 }
1606
1607
1608 function expand_id($rule, $attributes)
1609 {
1610   /* Check for id rule */
1611   if(preg_match('/^id(:|#)\d+$/',$rule)){
1612     return (array("\{$rule}"));
1613   }
1614
1615   /* Check for clean attribute */
1616   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1617     $rule= preg_replace('/^%/', '', $rule);
1618     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1619     return (array($val));
1620   }
1621
1622   /* Check for attribute with parameters */
1623   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1624     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1625     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1626     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1627     $start= preg_replace ('/-.*$/', '', $param);
1628     $stop = preg_replace ('/^[^-]+-/', '', $param);
1629
1630     /* Assemble results */
1631     $result= array();
1632     for ($i= $start; $i<= $stop; $i++){
1633       $result[]= substr($val, 0, $i);
1634     }
1635     return ($result);
1636   }
1637
1638   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1639   return (array($rule));
1640 }
1641
1642
1643 function gen_uids($rule, $attributes)
1644 {
1645   global $config;
1646
1647   /* Search for keys and fill the variables array with all
1648      possible values for that key. */
1649   $part= "";
1650   $trigger= false;
1651   $stripped= "";
1652   $variables= array();
1653
1654   for ($pos= 0; $pos < strlen($rule); $pos++){
1655
1656     if ($rule[$pos] == "{" ){
1657       $trigger= true;
1658       $part= "";
1659       continue;
1660     }
1661
1662     if ($rule[$pos] == "}" ){
1663       $variables[$pos]= expand_id($part, $attributes);
1664       $stripped.= "{".$pos."}";
1665       $trigger= false;
1666       continue;
1667     }
1668
1669     if ($trigger){
1670       $part.= $rule[$pos];
1671     } else {
1672       $stripped.= $rule[$pos];
1673     }
1674   }
1675
1676   /* Recurse through all possible combinations */
1677   $proposed= recurse($stripped, $variables);
1678
1679   /* Get list of used ID's */
1680   $used= array();
1681   $ldap= $config->get_ldap_link();
1682   $ldap->cd($config->current['BASE']);
1683   $ldap->search('(uid=*)');
1684
1685   while($attrs= $ldap->fetch()){
1686     $used[]= $attrs['uid'][0];
1687   }
1688
1689   /* Remove used uids and watch out for id tags */
1690   $ret= array();
1691   foreach($proposed as $uid){
1692
1693     /* Check for id tag and modify uid if needed */
1694     if(preg_match('/\{id:\d+}/',$uid)){
1695       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1696
1697       for ($i= 0; $i < pow(10,$size); $i++){
1698         $number= sprintf("%0".$size."d", $i);
1699         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1700         if (!in_array($res, $used)){
1701           $uid= $res;
1702           break;
1703         }
1704       }
1705     }
1706
1707   if(preg_match('/\{id#\d+}/',$uid)){
1708     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1709
1710     while (true){
1711       mt_srand((double) microtime()*1000000);
1712       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1713       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1714       if (!in_array($res, $used)){
1715         $uid= $res;
1716         break;
1717       }
1718     }
1719   }
1720
1721 /* Don't assign used ones */
1722 if (!in_array($uid, $used)){
1723   $ret[]= $uid;
1724 }
1725 }
1726
1727 return(array_unique($ret));
1728 }
1729
1730
1731 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1732    Need to convert... */
1733 function to_byte($value) {
1734   $value= strtolower(trim($value));
1735
1736   if(!is_numeric(substr($value, -1))) {
1737
1738     switch(substr($value, -1)) {
1739       case 'g':
1740         $mult= 1073741824;
1741         break;
1742       case 'm':
1743         $mult= 1048576;
1744         break;
1745       case 'k':
1746         $mult= 1024;
1747         break;
1748     }
1749
1750     return ($mult * (int)substr($value, 0, -1));
1751   } else {
1752     return $value;
1753   }
1754 }
1755
1756
1757 function in_array_ics($value, $items)
1758 {
1759   if (!is_array($items)){
1760     return (FALSE);
1761   }
1762
1763   foreach ($items as $item){
1764     if (strcasecmp($item, $value) == 0) {
1765       return (TRUE);
1766     }
1767   }
1768
1769   return (FALSE);
1770 }
1771
1772
1773 function generate_alphabet($count= 10)
1774 {
1775   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1776   $alphabet= "";
1777   $c= 0;
1778
1779   /* Fill cells with charaters */
1780   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1781     if ($c == 0){
1782       $alphabet.= "<tr>";
1783     }
1784
1785     $ch = mb_substr($characters, $i, 1, "UTF8");
1786     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1787       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1788
1789     if ($c++ == $count){
1790       $alphabet.= "</tr>";
1791       $c= 0;
1792     }
1793   }
1794
1795   /* Fill remaining cells */
1796   while ($c++ <= $count){
1797     $alphabet.= "<td>&nbsp;</td>";
1798   }
1799
1800   return ($alphabet);
1801 }
1802
1803
1804 function validate($string)
1805 {
1806   return (strip_tags(preg_replace('/\0/', '', $string)));
1807 }
1808
1809
1810 function get_gosa_version()
1811 {
1812   global $svn_revision, $svn_path;
1813
1814   /* Extract informations */
1815   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1816
1817   /* Release or development? */
1818   if (preg_match('%/gosa/trunk/%', $svn_path)){
1819     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1820   } else {
1821     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1822     return (sprintf(_("GOsa $release"), $revision));
1823   }
1824 }
1825
1826
1827 function rmdirRecursive($path, $followLinks=false) {
1828   $dir= opendir($path);
1829   while($entry= readdir($dir)) {
1830     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1831       unlink($path."/".$entry);
1832     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1833       rmdirRecursive($path."/".$entry);
1834     }
1835   }
1836   closedir($dir);
1837   return rmdir($path);
1838 }
1839
1840
1841 function scan_directory($path,$sort_desc=false)
1842 {
1843   $ret = false;
1844
1845   /* is this a dir ? */
1846   if(is_dir($path)) {
1847
1848     /* is this path a readable one */
1849     if(is_readable($path)){
1850
1851       /* Get contents and write it into an array */
1852       $ret = array();
1853
1854       $dir = opendir($path);
1855
1856       /* Is this a correct result ?*/
1857       if($dir){
1858         while($fp = readdir($dir))
1859           $ret[]= $fp;
1860       }
1861     }
1862   }
1863   /* Sort array ascending , like scandir */
1864   sort($ret);
1865
1866   /* Sort descending if parameter is sort_desc is set */
1867   if($sort_desc) {
1868     $ret = array_reverse($ret);
1869   }
1870
1871   return($ret);
1872 }
1873
1874
1875 function clean_smarty_compile_dir($directory)
1876 {
1877   global $svn_revision;
1878
1879   if(is_dir($directory) && is_readable($directory)) {
1880     // Set revision filename to REVISION
1881     $revision_file= $directory."/REVISION";
1882
1883     /* Is there a stamp containing the current revision? */
1884     if(!file_exists($revision_file)) {
1885       // create revision file
1886       create_revision($revision_file, $svn_revision);
1887     } else {
1888       # check for "$config->...['CONFIG']/revision" and the
1889       # contents should match the revision number
1890       if(!compare_revision($revision_file, $svn_revision)){
1891         // If revision differs, clean compile directory
1892         foreach(scan_directory($directory) as $file) {
1893           if(($file==".")||($file=="..")) continue;
1894           if( is_file($directory."/".$file) &&
1895               is_writable($directory."/".$file)) {
1896             // delete file
1897             if(!unlink($directory."/".$file)) {
1898               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1899               // This should never be reached
1900             }
1901           } elseif(is_dir($directory."/".$file) &&
1902               is_writable($directory."/".$file)) {
1903             // Just recursively delete it
1904             rmdirRecursive($directory."/".$file);
1905           }
1906         }
1907         // We should now create a fresh revision file
1908         clean_smarty_compile_dir($directory);
1909       } else {
1910         // Revision matches, nothing to do
1911       }
1912     }
1913   } else {
1914     // Smarty compile dir is not accessible
1915     // (Smarty will warn about this)
1916   }
1917 }
1918
1919
1920 function create_revision($revision_file, $revision)
1921 {
1922   $result= false;
1923
1924   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1925     if($fh= fopen($revision_file, "w")) {
1926       if(fwrite($fh, $revision)) {
1927         $result= true;
1928       }
1929     }
1930     fclose($fh);
1931   } else {
1932     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1933   }
1934
1935   return $result;
1936 }
1937
1938
1939 function compare_revision($revision_file, $revision)
1940 {
1941   // false means revision differs
1942   $result= false;
1943
1944   if(file_exists($revision_file) && is_readable($revision_file)) {
1945     // Open file
1946     if($fh= fopen($revision_file, "r")) {
1947       // Compare File contents with current revision
1948       if($revision == fread($fh, filesize($revision_file))) {
1949         $result= true;
1950       }
1951     } else {
1952       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1953     }
1954     // Close file
1955     fclose($fh);
1956   }
1957
1958   return $result;
1959 }
1960
1961
1962 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1963 {
1964   $str = ""; // Our return value will be saved in this var
1965
1966   $color  = dechex($percentage+150);
1967   $color2 = dechex(150 - $percentage);
1968   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1969
1970   $progress = (int)(($percentage /100)*$width);
1971
1972   /* Abort printing out percentage, if divs are to small */
1973
1974
1975   /* If theres a better solution for this, use it... */
1976   $str = "
1977     <div style=\" width:".($width)."px;
1978     height:".($height)."px;
1979   background-color:#000000;
1980 padding:1px;\">
1981
1982           <div style=\" width:".($width)."px;
1983         background-color:#$bgcolor;
1984 height:".($height)."px;\">
1985
1986          <div style=\" width:".$progress."px;
1987 height:".$height."px;
1988        background-color:#".$color2.$color2.$color."; \">";
1989
1990
1991        if(($height >10)&&($showvalue)){
1992          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
1993            <b>".$percentage."%</b>
1994            </font>";
1995        }
1996
1997        $str.= "</div></div></div>";
1998
1999        return($str);
2000 }
2001
2002
2003 function array_key_ics($ikey, $items)
2004 {
2005   /* Gather keys, make them lowercase */
2006   $tmp= array();
2007   foreach ($items as $key => $value){
2008     $tmp[strtolower($key)]= $key;
2009   }
2010
2011   if (isset($tmp[strtolower($ikey)])){
2012     return($tmp[strtolower($ikey)]);
2013   }
2014
2015   return ("");
2016 }
2017
2018
2019 function array_differs($src, $dst)
2020 {
2021   /* If the count is differing, the arrays differ */
2022   if (count ($src) != count ($dst)){
2023     return (TRUE);
2024   }
2025
2026   /* So the count is the same - lets check the contents */
2027   $differs= FALSE;
2028   foreach($src as $value){
2029     if (!in_array($value, $dst)){
2030       $differs= TRUE;
2031     }
2032   }
2033
2034   return ($differs);
2035 }
2036
2037
2038 function saveFilter($a_filter, $values)
2039 {
2040   if (isset($_POST['regexit'])){
2041     $a_filter["regex"]= $_POST['regexit'];
2042
2043     foreach($values as $type){
2044       if (isset($_POST[$type])) {
2045         $a_filter[$type]= "checked";
2046       } else {
2047         $a_filter[$type]= "";
2048       }
2049     }
2050   }
2051
2052   /* React on alphabet links if needed */
2053   if (isset($_GET['search'])){
2054     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2055     if ($s == "**"){
2056       $s= "*";
2057     }
2058     $a_filter['regex']= $s;
2059   }
2060
2061   return ($a_filter);
2062 }
2063
2064
2065 /* Escape all preg_* relevant characters */
2066 function normalizePreg($input)
2067 {
2068   return (addcslashes($input, '[]()|/.*+-'));
2069 }
2070
2071
2072 /* Escape all LDAP filter relevant characters */
2073 function normalizeLdap($input)
2074 {
2075   return (addcslashes($input, '()|'));
2076 }
2077
2078
2079 /* Resturns the difference between to microtime() results in float  */
2080 function get_MicroTimeDiff($start , $stop)
2081 {
2082   $a = split("\ ",$start);
2083   $b = split("\ ",$stop);
2084
2085   $secs = $b[1] - $a[1];
2086   $msecs= $b[0] - $a[0];
2087
2088   $ret = (float) ($secs+ $msecs);
2089   return($ret);
2090 }
2091
2092
2093 function get_base_dir()
2094 {
2095   global $BASE_DIR;
2096
2097   return $BASE_DIR;
2098 }
2099
2100
2101 function obj_is_readable($dn, $object, $attribute)
2102 {
2103   global $ui;
2104
2105   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2106 }
2107
2108
2109 function obj_is_writable($dn, $object, $attribute)
2110 {
2111   global $ui;
2112
2113   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2114 }
2115
2116
2117 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2118 {
2119   /* Initialize variables */
2120   $ret  = array("count" => 0);  // Set count to 0
2121   $next = true;                 // if false, then skip next loops and return
2122   $cnt  = 0;                    // Current number of loops
2123   $max  = 100;                  // Just for security, prevent looops
2124   $ldap = NULL;                 // To check if created result a valid
2125   $keep = "";                   // save last failed parse string
2126
2127   /* Check each parsed dn in ldap ? */
2128   if($config!==NULL && $verify_in_ldap){
2129     $ldap = $config->get_ldap_link();
2130   }
2131
2132   /* Lets start */
2133   $called = false;
2134   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2135
2136     $cnt ++;
2137     if(!preg_match("/,/",$dn)){
2138       $next = false;
2139     }
2140     $object = preg_replace("/[,].*$/","",$dn);
2141     $dn     = preg_replace("/^[^,]+,/","",$dn);
2142
2143     $called = true;
2144
2145     /* Check if current dn is valid */
2146     if($ldap!==NULL){
2147       $ldap->cd($dn);
2148       $ldap->cat($dn,array("dn"));
2149       if($ldap->count()){
2150         $ret[]  = $keep.$object;
2151         $keep   = "";
2152       }else{
2153         $keep  .= $object.",";
2154       }
2155     }else{
2156       $ret[]  = $keep.$object;
2157       $keep   = "";
2158     }
2159   }
2160
2161   /* No dn was posted */
2162   if($cnt == 0 && !empty($dn)){
2163     $ret[] = $dn;
2164   }
2165
2166   /* Append the rest */
2167   $test = $keep.$dn;
2168   if($called && !empty($test)){
2169     $ret[] = $keep.$dn;
2170   }
2171   $ret['count'] = count($ret) - 1;
2172
2173   return($ret);
2174 }
2175
2176
2177 function get_base_from_hook($dn, $attrib)
2178 {
2179   global $config;
2180
2181   if (isset($config->current['BASE_HOOK'])){
2182
2183     /* Call hook script - if present */
2184     $command= $config->current['BASE_HOOK'];
2185
2186     if ($command != ""){
2187       $command.= " '".LDAP::fix($dn)."' $attrib";
2188       if (check_command($command)){
2189         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2190         exec($command, $output);
2191         if (preg_match("/^[0-9]+$/", $output[0])){
2192           return ($output[0]);
2193         } else {
2194           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2195           return ($config->current['UIDBASE']);
2196         }
2197       } else {
2198         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2199         return ($config->current['UIDBASE']);
2200       }
2201
2202     } else {
2203
2204       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2205       return ($config->current['UIDBASE']);
2206
2207     }
2208   }
2209 }
2210
2211
2212 function check_schema_version($class, $version)
2213 {
2214   return preg_match("/\(v$version\)/", $class['DESC']);
2215 }
2216
2217
2218 function check_schema($cfg,$rfc2307bis = FALSE)
2219 {
2220   $messages= array();
2221
2222   /* Get objectclasses */
2223   $ldap = new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']);
2224   $objectclasses = $ldap->get_objectclasses();
2225   if(count($objectclasses) == 0){
2226     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2227   }
2228
2229   /* This is the default block used for each entry.
2230    *  to avoid unset indexes.
2231    */
2232   $def_check = array("REQUIRED_VERSION" => "0",
2233       "SCHEMA_FILES"     => array(),
2234       "CLASSES_REQUIRED" => array(),
2235       "STATUS"           => FALSE,
2236       "IS_MUST_HAVE"     => FALSE,
2237       "MSG"              => "",
2238       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2239
2240   /* The gosa base schema */
2241   $checks['gosaObject'] = $def_check;
2242   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2243   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2244   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2245   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2246
2247   /* GOsa Account class */
2248   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2249   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2250   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2251   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2252   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2253
2254   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2255   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2256   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2257   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2258   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2259   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2260
2261   /* Some other checks */
2262   foreach(array(
2263         "gosaCacheEntry"        => array("version" => "2.4"),
2264         "gosaDepartment"        => array("version" => "2.4"),
2265         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2266         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2267         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2268         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2269         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2270         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2271         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2272         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2273         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2274         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2275         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2276         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2277         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2278         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2279         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2280         "goLdapServer"          => array("version" => "2.4"),
2281         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2282         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2283         "goKrbServer"           => array("version" => "2.4"),
2284         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2285         ) as $name => $values){
2286
2287           $checks[$name] = $def_check;
2288           if(isset($values['version'])){
2289             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2290           }
2291           if(isset($values['file'])){
2292             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2293           }
2294           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2295         }
2296   foreach($checks as $name => $value){
2297     foreach($value['CLASSES_REQUIRED'] as $class){
2298
2299       if(!isset($objectclasses[$name])){
2300         $checks[$name]['STATUS'] = FALSE;
2301         if($value['IS_MUST_HAVE']){
2302           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2303         }else{
2304           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2305         }
2306       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2307         $checks[$name]['STATUS'] = FALSE;
2308
2309         if($value['IS_MUST_HAVE']){
2310           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2311         }else{
2312           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2313         }
2314       }else{
2315         $checks[$name]['STATUS'] = TRUE;
2316         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2317       }
2318     }
2319   }
2320
2321   $tmp = $objectclasses;
2322
2323   /* The gosa base schema */
2324   $checks['posixGroup'] = $def_check;
2325   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2326   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2327   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2328   $checks['posixGroup']['STATUS']           = TRUE;
2329   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2330   $checks['posixGroup']['MSG']              = "";
2331   $checks['posixGroup']['INFO']             = "";
2332
2333   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2334   if(isset($tmp['posixGroup'])){
2335
2336     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2337       $checks['posixGroup']['STATUS']           = FALSE;
2338       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2339       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2340     }
2341     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2342       $checks['posixGroup']['STATUS']           = FALSE;
2343       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2344       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2345     }
2346   }
2347
2348   return($checks);
2349 }
2350
2351
2352 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2353 {
2354   $tmp = array(
2355         "de_DE" => "German",
2356         "fr_FR" => "French",
2357         "it_IT" => "Italian",
2358         "es_ES" => "Spanish",
2359         "en_US" => "English",
2360         "nl_NL" => "Dutch",
2361         "pl_PL" => "Polish",
2362         "sv_SE" => "Swedish",
2363         "zh_CN" => "Chinese",
2364         "ru_RU" => "Russian");
2365
2366   $tmp2= array(
2367         "de_DE" => _("German"),
2368         "fr_FR" => _("French"),
2369         "it_IT" => _("Italian"),
2370         "es_ES" => _("Spanish"),
2371         "en_US" => _("English"),
2372         "nl_NL" => _("Dutch"),
2373         "pl_PL" => _("Polish"),
2374         "sv_SE" => _("Swedish"),
2375         "zh_CN" => _("Chinese"),
2376         "ru_RU" => _("Russian"));
2377
2378   $ret = array();
2379   if($languages_in_own_language){
2380
2381     $old_lang = setlocale(LC_ALL, 0);
2382     foreach($tmp as $key => $name){
2383       $lang = $key.".UTF-8";
2384       setlocale(LC_ALL, $lang);
2385       if($strip_region_tag){
2386         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2387       }else{
2388         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2389       }
2390     }
2391     setlocale(LC_ALL, $old_lang);
2392   }else{
2393     foreach($tmp as $key => $name){
2394       if($strip_region_tag){
2395         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2396       }else{
2397         $ret[$key] = _($name);
2398       }
2399     }
2400   }
2401   return($ret);
2402 }
2403
2404
2405 /* Returns contents of the given POST variable and check magic quotes settings */
2406 function get_post($name)
2407 {
2408   if(!isset($_POST[$name])){
2409     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2410     return(FALSE);
2411   }
2412   if(get_magic_quotes_gpc()){
2413     return(stripcslashes($_POST[$name]));
2414   }else{
2415     return($_POST[$name]);
2416   }
2417 }
2418
2419
2420 /* Return class name in correct case */
2421 function get_correct_class_name($cls)
2422 {
2423   global $class_mapping;
2424   if(isset($class_mapping) && is_array($class_mapping)){
2425     foreach($class_mapping as $class => $file){
2426       if(preg_match("/^".$cls."$/i",$class)){
2427         return($class);
2428       }
2429     }
2430   }
2431   return(FALSE);
2432 }
2433
2434
2435 // change_password, changes the Password, of the given dn
2436 function change_password ($dn, $password, $mode=0, $hash= "")
2437 {
2438   global $config;
2439   $newpass= "";
2440
2441   /* Convert to lower. Methods are lowercase */
2442   $hash= strtolower($hash);
2443
2444   // Get all available encryption Methods
2445
2446   // NON STATIC CALL :)
2447   $tmp = new passwordMethod(session::get('config'));
2448   $available = $tmp->get_available_methods();
2449
2450   // read current password entry for $dn, to detect the encryption Method
2451   $ldap       = $config->get_ldap_link();
2452   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2453   $attrs      = $ldap->fetch ();
2454
2455   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2456   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2457     $deactivated = TRUE;
2458   }else{
2459     $deactivated = FALSE;
2460   }
2461
2462   /* Is ensure that clear passwords will stay clear */
2463   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2464     $hash = "clear";
2465   }
2466
2467   // Detect the encryption Method
2468   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2469
2470     /* Check for supported algorithm */
2471     mt_srand((double) microtime()*1000000);
2472
2473     /* Extract used hash */
2474     if ($hash == ""){
2475       $hash= strtolower($matches[1]);
2476     }
2477
2478     $test = new  $available[$hash]($config);
2479
2480   } else {
2481     // User MD5 by default
2482     $hash= "md5";
2483     $test = new  $available['md5']($config);
2484   }
2485
2486   /* Feed password backends with information */
2487   $test->dn= $dn;
2488   $test->attrs= $attrs;
2489   $newpass= $test->generate_hash($password);
2490
2491   // Update shadow timestamp?
2492   if (isset($attrs["shadowLastChange"][0])){
2493     $shadow= (int)(date("U") / 86400);
2494   } else {
2495     $shadow= 0;
2496   }
2497
2498   // Write back modified entry
2499   $ldap->cd($dn);
2500   $attrs= array();
2501
2502   // Not for groups
2503   if ($mode == 0){
2504
2505     if ($shadow != 0){
2506       $attrs['shadowLastChange']= $shadow;
2507     }
2508
2509     // Create SMB Password
2510     $attrs= generate_smb_nt_hash($password);
2511   }
2512
2513  /* Readd ! if user was deactivated */
2514   if($deactivated){
2515     $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass);
2516   }
2517
2518   $attrs['userPassword']= array();
2519   $attrs['userPassword']= $newpass;
2520
2521   $ldap->modify($attrs);
2522
2523   new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
2524
2525   if ($ldap->error != 'Success') {
2526     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);
2527   } else {
2528
2529     /* Run backend method for change/create */
2530     $test->set_password($password);
2531
2532     /* Find postmodify entries for this class */
2533     $command= $config->search("password", "POSTMODIFY",array('menu'));
2534
2535     if ($command != ""){
2536       /* Walk through attribute list */
2537       $command= preg_replace("/%userPassword/", $password, $command);
2538       $command= preg_replace("/%dn/", $dn, $command);
2539
2540       if (check_command($command)){
2541         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2542         exec($command);
2543       } else {
2544         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2545         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2546       }
2547     }
2548   }
2549 }
2550
2551
2552 // Return something like array['sambaLMPassword']= "lalla..."
2553 function generate_smb_nt_hash($password)
2554 {
2555   global $config;
2556
2557   # Try to use gosa-si?
2558   if (isset($config->current['GOSA_SI'])){
2559         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2560         $hash= $res['XML']['HASH'];
2561   } else {
2562           $tmp= $config->data['MAIN']['SMBHASH']." ".escapeshellarg($password);
2563           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2564
2565           exec($tmp, $ar);
2566           flush();
2567           reset($ar);
2568           $hash= current($ar);
2569   }
2570
2571   if ($hash == "") {
2572           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2573           return ("");
2574   }
2575
2576   list($lm,$nt)= split (":", trim($hash));
2577
2578   if ($config->current['SAMBAVERSION'] == 3) {
2579           $attrs['sambaLMPassword']= $lm;
2580           $attrs['sambaNTPassword']= $nt;
2581           $attrs['sambaPwdLastSet']= date('U');
2582           $attrs['sambaBadPasswordCount']= "0";
2583           $attrs['sambaBadPasswordTime']= "0";
2584   } else {
2585           $attrs['lmPassword']= $lm;
2586           $attrs['ntPassword']= $nt;
2587           $attrs['pwdLastSet']= date('U');
2588   }
2589   return($attrs);
2590 }
2591
2592
2593 function crypt_single($string,$enc_type )
2594 {
2595   return( passwordMethod::crypt_single_str($string,$enc_type));
2596 }
2597
2598
2599 function getEntryCSN($dn)
2600 {
2601   global $config;
2602   if(empty($dn) || !is_object($config)){
2603     return("");
2604   }
2605
2606   /* Get attribute that we should use as serial number */
2607   if(isset($config->current['UNIQ_IDENTIFIER'])){
2608     $attr = $config->current['UNIQ_IDENTIFIER'];
2609   }elseif(isset($config->data['MAIN']['UNIQ_IDENTIFIER'])){
2610     $attr = $config->data['MAIN']['UNIQ_IDENTIFIER'];
2611   }
2612   if(!empty($attr)){
2613     $ldap = $config->get_ldap_link();
2614     $ldap->cat($dn,array($attr));
2615     $csn = $ldap->fetch();
2616     if(isset($csn[$attr][0])){
2617       return($csn[$attr][0]);
2618     }
2619   }
2620   return("");
2621 }
2622
2623
2624 /* Add a given objectClass to an attrs entry */
2625 function add_objectClass($classes, &$attrs)
2626 {
2627   if (is_array($classes)){
2628     $list= $classes;
2629   } else {
2630     $list= array($classes);
2631   }
2632
2633   foreach ($list as $class){
2634     $attrs['objectClass'][]= $class;
2635   }
2636 }
2637
2638
2639 /* Removes a given objectClass from the attrs entry */
2640 function remove_objectClass($classes, &$attrs)
2641 {
2642   if (isset($attrs['objectClass'])){
2643     /* Array? */
2644     if (is_array($classes)){
2645       $list= $classes;
2646     } else {
2647       $list= array($classes);
2648     }
2649
2650     $tmp= array();
2651     foreach ($attrs['objectClass'] as $oc) {
2652       foreach ($list as $class){
2653         if ($oc != $class){
2654           $tmp[]= $oc;
2655         }
2656       }
2657     }
2658     $attrs['objectClass']= $tmp;
2659   }
2660 }
2661
2662 /*! \brief  Initialize a file download with given content, name and data type.
2663  *  @param  data  String The content to send.
2664  *  @param  name  String The name of the file.
2665  *  @param  type  String The content identifier, default value is "application/octet-stream";
2666  */
2667 function send_binary_content($data,$name,$type = "application/octet-stream")
2668 {
2669   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2670   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2671   header("Cache-Control: no-cache");
2672   header("Pragma: no-cache");
2673   header("Cache-Control: post-check=0, pre-check=0");
2674   header("Content-type: ".$type."");
2675
2676   /* force download dialog */
2677   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2678     header('Content-Disposition: filename="'.$name.'"');
2679   } else {
2680     header('Content-Disposition: attachment; filename="'.$name.'"');
2681   }
2682
2683   echo $data;
2684   exit();
2685 }
2686
2687 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2688 ?>