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