gosa-core/include/functions.inc

   1 <?php
   2 /*
   3  * This code is part of GOsa (http://www.gosa-project.org)
   4  * Copyright (C) 2003-2008 GONICUS GmbH
   5  *
   6  * ID: $$Id: functions.inc 13100 2008-12-01 14:07:48Z hickert $$
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /*! \file
  24  * Common functions and named definitions. */
  25
  26 /* Configuration file location */
  27 if(!isset($_SERVER['CONFIG_DIR'])){
  28   define ("CONFIG_DIR", "/etc/gosa");
  29 }else{
  30   define ("CONFIG_DIR",$_SERVER['CONFIG_DIR']);
  31 }
  32
  33 /* Allow setting the config file in the apache configuration
  34     e.g.  SetEnv CONFIG_FILE gosa.conf.2.6
  35  */
  36 if(!isset($_SERVER['CONFIG_FILE'])){
  37   define ("CONFIG_FILE", "gosa.conf");
  38 }else{
  39   define ("CONFIG_FILE",$_SERVER['CONFIG_FILE']);
  40 }
  41
  42 /* Define common locatitions */
  43 define ("CONFIG_TEMPLATE_DIR", "../contrib");
  44 define ("TEMP_DIR","/var/cache/gosa/tmp");
  45
  46 /* Define get_list flags */
  47 define("GL_NONE",         0);
  48 define("GL_SUBSEARCH",    1);
  49 define("GL_SIZELIMIT",    2);
  50 define("GL_CONVERT",      4);
  51 define("GL_NO_ACL_CHECK", 8);
  52
  53 /* Heimdal stuff */
  54 define('UNIVERSAL',0x00);
  55 define('INTEGER',0x02);
  56 define('OCTET_STRING',0x04);
  57 define('OBJECT_IDENTIFIER ',0x06);
  58 define('SEQUENCE',0x10);
  59 define('SEQUENCE_OF',0x10);
  60 define('SET',0x11);
  61 define('SET_OF',0x11);
  62 define('DEBUG',false);
  63 define('HDB_KU_MKEY',0x484442);
  64 define('TWO_BIT_SHIFTS',0x7efc);
  65 define('DES_CBC_CRC',1);
  66 define('DES_CBC_MD4',2);
  67 define('DES_CBC_MD5',3);
  68 define('DES3_CBC_MD5',5);
  69 define('DES3_CBC_SHA1',16);
  70
  71 /* Define globals for revision comparing */
  72 $svn_path = '$HeadURL$';
  73 $svn_revision = '$Revision$';
  74
  75 /* Include required files */
  76 require_once("class_location.inc");
  77 require_once ("functions_debug.inc");
  78 require_once ("accept-to-gettext.inc");
  79
  80 /* Define constants for debugging */
  81 define ("DEBUG_TRACE",   1); /*! Debug level for tracing of common actions (save, check, etc.) */
  82 define ("DEBUG_LDAP",    2); /*! Debug level for LDAP queries */
  83 define ("DEBUG_MYSQL",   4); /*! Debug level for mysql operations */
  84 define ("DEBUG_SHELL",   8); /*! Debug level for shell commands */
  85 define ("DEBUG_POST",   16); /*! Debug level for POST content */
  86 define ("DEBUG_SESSION",32); /*! Debug level for SESSION content */
  87 define ("DEBUG_CONFIG", 64); /*! Debug level for CONFIG information */
  88 define ("DEBUG_ACL",    128); /*! Debug level for ACL infos */
  89 define ("DEBUG_SI",     256); /*! Debug level for communication with gosa-si */
  90 define ("DEBUG_MAIL",   512); /*! Debug level for all about mail (mailAccounts, imap, sieve etc.) */
  91 define ("DEBUG_FAI",   1024); // FAI (incomplete)
  92
  93 /* Rewrite german 'umlauts' and spanish 'accents'
  94    to get better results */
  95 $REWRITE= array( "ä" => "ae",
  96     "ö" => "oe",
  97     "ü" => "ue",
  98     "Ä" => "Ae",
  99     "Ö" => "Oe",
 100     "Ü" => "Ue",
 101     "ß" => "ss",
 102     "á" => "a",
 103     "é" => "e",
 104     "í" => "i",
 105     "ó" => "o",
 106     "ú" => "u",
 107     "Á" => "A",
 108     "É" => "E",
 109     "Í" => "I",
 110     "Ó" => "O",
 111     "Ú" => "U",
 112     "ñ" => "ny",
 113     "Ñ" => "Ny" );
 114
 115
 116 /*! \brief Does autoloading for classes used in GOsa.
 117  *
 118  *  Takes the list generated by 'update-gosa' and loads the
 119  *  file containing the requested class.
 120  *
 121  *  \param  string 'class_name' The currently requested class
 122  */
 123 function __gosa_autoload($class_name) {
 124     global $class_mapping, $BASE_DIR;
 125
 126     if ($class_mapping === NULL){
 127             echo sprintf(_("Fatal error: no class locations defined - please run '%s' to fix this"), "<b>update-gosa</b>");
 128             exit;
 129     }
 130
 131     if (isset($class_mapping["$class_name"])){
 132       require_once($BASE_DIR."/".$class_mapping["$class_name"]);
 133     } else {
 134       echo sprintf(_("Fatal error: cannot instantiate class '%s' - try running '%s' to fix this"), $class_name, "<b>update-gosa</b>");
 135       exit;
 136     }
 137 }
 138 spl_autoload_register('__gosa_autoload');
 139
 140
 141 /*! \brief Checks if a class is available.
 142  *  \param  string 'name' The subject of the test
 143  *  \return boolean True if class is available, else false.
 144  */
 145 function class_available($name)
 146 {
 147   global $class_mapping;
 148   return(isset($class_mapping[$name]));
 149 }
 150
 151
 152 /*! \brief Check if plugin is available
 153  *
 154  * Checks if a given plugin is available and readable.
 155  *
 156  * \param string 'plugin' the subject of the check
 157  * \return boolean True if plugin is available, else FALSE.
 158  */
 159 function plugin_available($plugin)
 160 {
 161         global $class_mapping, $BASE_DIR;
 162
 163         if (!isset($class_mapping[$plugin])){
 164                 return false;
 165         } else {
 166                 return is_readable($BASE_DIR."/".$class_mapping[$plugin]);
 167         }
 168 }
 169
 170
 171 /*! \brief Create seed with microseconds
 172  *
 173  * Example:
 174  * \code
 175  * srand(make_seed());
 176  * $random = rand();
 177  * \endcode
 178  *
 179  * \return float a floating point number which can be used to feed srand() with it
 180  * */
 181 function make_seed() {
 182   list($usec, $sec) = explode(' ', microtime());
 183   return (float) $sec + ((float) $usec * 100000);
 184 }
 185
 186
 187 /*! \brief Debug level action
 188  *
 189  * Print a DEBUG level if specified debug level of the level matches the
 190  * the configured debug level.
 191  *
 192  * \param int 'level' The log level of the message (should use the constants,
 193  * defined in functions.in (DEBUG_TRACE, DEBUG_LDAP, etc.)
 194  * \param int 'line' Define the line of the logged action (using __LINE__ is common)
 195  * \param string 'function' Define the function where the logged action happened in
 196  * (using __FUNCTION__ is common)
 197  * \param string 'file' Define the file where the logged action happend in
 198  * (using __FILE__ is common)
 199  * \param mixed 'data' The data to log. Can be a message or an array, which is printed
 200  * with print_a
 201  * \param string 'info' Optional: Additional information
 202  *
 203  * */
 204 function DEBUG($level, $line, $function, $file, $data, $info="")
 205 {
 206   if (session::global_get('DEBUGLEVEL') & $level){
 207     $output= "DEBUG[$level] ";
 208     if ($function != ""){
 209       $output.= "($file:$function():$line) - $info: ";
 210     } else {
 211       $output.= "($file:$line) - $info: ";
 212     }
 213     echo $output;
 214     if (is_array($data)){
 215       print_a($data);
 216     } else {
 217       echo "'$data'";
 218     }
 219     echo "<br>";
 220   }
 221 }
 222
 223
 224 /*! \brief Determine which language to show to the user
 225  *
 226  * Determines which language should be used to present gosa content
 227  * to the user. It does so by looking at several possibilites and returning
 228  * the first setting that can be found.
 229  *
 230  * -# Language configured by the user
 231  * -# Global configured language
 232  * -# Language as returned by al2gt (as configured in the browser)
 233  *
 234  * \return string gettext locale string
 235  */
 236 function get_browser_language()
 237 {
 238   /* Try to use users primary language */
 239   global $config;
 240   $ui= get_userinfo();
 241   if (isset($ui) && $ui !== NULL){
 242     if ($ui->language != ""){
 243       return ($ui->language.".UTF-8");
 244     }
 245   }
 246
 247   /* Check for global language settings in gosa.conf */
 248   if (isset ($config) && $config->get_cfg_value('language') != ""){
 249     $lang = $config->get_cfg_value('language');
 250     if(!preg_match("/utf/i",$lang)){
 251       $lang .= ".UTF-8";
 252     }
 253     return($lang);
 254   }
 255
 256   /* Load supported languages */
 257   $gosa_languages= get_languages();
 258
 259   /* Move supported languages to flat list */
 260   $langs= array();
 261   foreach($gosa_languages as $lang => $dummy){
 262     $langs[]= $lang.'.UTF-8';
 263   }
 264
 265   /* Return gettext based string */
 266   return (al2gt($langs, 'text/html'));
 267 }
 268
 269
 270 /*! \brief Rewrite ui object to another dn
 271  *
 272  * Usually used when a user is renamed. In this case the dn
 273  * in the user object must be updated in order to point
 274  * to the correct DN.
 275  *
 276  * \param string 'dn' the old DN
 277  * \param string 'newdn' the new DN
 278  * */
 279 function change_ui_dn($dn, $newdn)
 280 {
 281   $ui= session::global_get('ui');
 282   if ($ui->dn == $dn){
 283     $ui->dn= $newdn;
 284     session::global_set('ui',$ui);
 285   }
 286 }
 287
 288
 289 /*! \brief Return themed path for specified base file
 290  *
 291  *  Depending on its parameters, this function returns the full
 292  *  path of a template file. First match wins while searching
 293  *  in this order:
 294  *
 295  *  - load theme depending file
 296  *  - load global theme depending file
 297  *  - load default theme file
 298  *  - load global default theme file
 299  *
 300  *  \param  string 'filename' The base file name
 301  *  \param  boolean 'plugin' Flag to take the plugin directory as search base
 302  *  \param  string 'path' User specified path to take as search base
 303  *  \return string Full path to the template file
 304  */
 305 function get_template_path($filename= '', $plugin= FALSE, $path= "")
 306 {
 307   global $config, $BASE_DIR;
 308
 309   /* Set theme */
 310   if (isset ($config)){
 311         $theme= $config->get_cfg_value("theme", "default");
 312   } else {
 313         $theme= "default";
 314   }
 315
 316   /* Return path for empty filename */
 317   if ($filename == ''){
 318     return ("themes/$theme/");
 319   }
 320
 321   /* Return plugin dir or root directory? */
 322   if ($plugin){
 323     if ($path == ""){
 324       $nf= preg_replace("!^".$BASE_DIR."/!", "", preg_replace('/^\.\.\//', '', session::global_get('plugin_dir')));
 325     } else {
 326       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
 327     }
 328     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
 329       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
 330     }
 331     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
 332       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
 333     }
 334     if ($path == ""){
 335       return (session::global_get('plugin_dir')."/$filename");
 336     } else {
 337       return ($path."/$filename");
 338     }
 339   } else {
 340     if (file_exists("themes/$theme/$filename")){
 341       return ("themes/$theme/$filename");
 342     }
 343     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
 344       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
 345     }
 346     if (file_exists("themes/default/$filename")){
 347       return ("themes/default/$filename");
 348     }
 349     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
 350       return ("$BASE_DIR/ihtml/themes/default/$filename");
 351     }
 352     return ($filename);
 353   }
 354 }
 355
 356
 357 /*! \brief Remove multiple entries from an array
 358  *
 359  * Removes every element that is in $needles from the
 360  * array given as $haystack
 361  *
 362  * \param array 'needles' array of the entries to remove
 363  * \param array 'haystack' original array to remove the entries from
 364  */
 365 function array_remove_entries($needles, $haystack)
 366 {
 367   return (array_merge(array_diff($haystack, $needles)));
 368 }
 369
 370
 371 /*! \brief Remove multiple entries from an array (case-insensitive)
 372  *
 373  * Same as array_remove_entries(), but case-insensitive. */
 374 function array_remove_entries_ics($needles, $haystack)
 375 {
 376   // strcasecmp will work, because we only compare ASCII values here
 377   return (array_merge(array_udiff($haystack, $needles, 'strcasecmp')));
 378 }
 379
 380
 381 /*! Merge to array but remove duplicate entries
 382  *
 383  * Merges two arrays and removes duplicate entries. Triggers
 384  * an error if first or second parametre is not an array.
 385  *
 386  * \param array 'ar1' first array
 387  * \param array 'ar2' second array-
 388  * \return array
 389  */
 390 function gosa_array_merge($ar1,$ar2)
 391 {
 392   if(!is_array($ar1) || !is_array($ar2)){
 393     trigger_error("Specified parameter(s) are not valid arrays.");
 394   }else{
 395     return(array_values(array_unique(array_merge($ar1,$ar2))));
 396   }
 397 }
 398
 399
 400 /*! \brief Generate a system log info
 401  *
 402  * Creates a syslog message, containing user information.
 403  *
 404  * \param string 'message' the message to log
 405  * */
 406 function gosa_log ($message)
 407 {
 408   global $ui;
 409
 410   /* Preset to something reasonable */
 411   $username= "[unauthenticated]";
 412
 413   /* Replace username if object is present */
 414   if (isset($ui)){
 415     if ($ui->username != ""){
 416       $username= "[$ui->username]";
 417     } else {
 418       $username= "[unknown]";
 419     }
 420   }
 421
 422   syslog(LOG_INFO,"GOsa$username: $message");
 423 }
 424
 425
 426 /*! \brief Initialize a LDAP connection
 427  *
 428  * Initializes a LDAP connection.
 429  *
 430  * \param string 'server'
 431  * \param string 'base'
 432  * \param string 'binddn' Default: empty
 433  * \param string 'pass' Default: empty
 434  *
 435  * \return LDAP object
 436  */
 437 function ldap_init ($server, $base, $binddn='', $pass='')
 438 {
 439   global $config;
 440
 441   $ldap = new LDAP ($binddn, $pass, $server,
 442       isset($config->current['LDAPFOLLOWREFERRALS']) && $config->current['LDAPFOLLOWREFERRALS'] == "true",
 443       isset($config->current['LDAPTLS']) && $config->current['LDAPTLS'] == "true");
 444
 445   /* Sadly we've no proper return values here. Use the error message instead. */
 446   if (!$ldap->success()){
 447     msg_dialog::display(_("Fatal error"),
 448         sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error()),
 449         FATAL_ERROR_DIALOG);
 450     exit();
 451   }
 452
 453   /* Preset connection base to $base and return to caller */
 454   $ldap->cd ($base);
 455   return $ldap;
 456 }
 457
 458
 459 /* \brief Process htaccess authentication */
 460 function process_htaccess ($username, $kerberos= FALSE)
 461 {
 462   global $config;
 463
 464   /* Search for $username and optional @REALM in all configured LDAP trees */
 465   foreach($config->data["LOCATIONS"] as $name => $data){
 466
 467     $config->set_current($name);
 468     $mode= "kerberos";
 469     if ($config->get_cfg_value("useSaslForKerberos") == "true"){
 470       $mode= "sasl";
 471     }
 472
 473     /* Look for entry or realm */
 474     $ldap= $config->get_ldap_link();
 475     if (!$ldap->success()){
 476       msg_dialog::display(_("LDAP error"),
 477           msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH)."<br><br>".session::get('errors'),
 478           FATAL_ERROR_DIALOG);
 479       exit();
 480     }
 481     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
 482
 483     /* Found a uniq match? Return it... */
 484     if ($ldap->count() == 1) {
 485       $attrs= $ldap->fetch();
 486       return array("username" => $attrs["uid"][0], "server" => $name);
 487     }
 488   }
 489
 490   /* Nothing found? Return emtpy array */
 491   return array("username" => "", "server" => "");
 492 }
 493
 494
 495 /*! \brief Verify user login against htaccess
 496  *
 497  * Checks if the specified username is available in apache, maps the user
 498  * to an LDAP user. The password has been checked by apache already.
 499  *
 500  * \param string 'username'
 501  * \return
 502  *  - TRUE on SUCCESS, NULL or FALSE on error
 503  */
 504 function ldap_login_user_htaccess ($username)
 505 {
 506   global $config;
 507
 508   /* Look for entry or realm */
 509   $ldap= $config->get_ldap_link();
 510   if (!$ldap->success()){
 511     msg_dialog::display(_("LDAP error"),
 512         msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH)."<br><br>".session::get('errors'),
 513         FATAL_ERROR_DIALOG);
 514     exit();
 515   }
 516   $ldap->search("(&(objectClass=gosaAccount)(uid=$username))", array("uid"));
 517   /* Found no uniq match? Strange, because we did above... */
 518   if ($ldap->count() != 1) {
 519     msg_dialog::display(_("LDAP error"), _("Username / UID is not unique inside the LDAP tree!"), FATAL_ERROR_DIALOG);
 520     return (NULL);
 521   }
 522   $attrs= $ldap->fetch();
 523
 524   /* got user dn, fill acl's */
 525   $ui= new userinfo($config, $ldap->getDN());
 526   $ui->username= $attrs['uid'][0];
 527
 528   /* Bail out if we have login restrictions set, for security reasons
 529      the message is the same than failed user/pw */
 530   if (!$ui->loginAllowed()){
 531     new log("security","login","",array(),"Login restriction for user \"$username\", login not permitted");
 532     return (NULL);
 533   }
 534
 535   /* No password check needed - the webserver did it for us */
 536   $ldap->disconnect();
 537
 538   /* Username is set, load subtreeACL's now */
 539   $ui->loadACL();
 540
 541   /* TODO: check java script for htaccess authentication */
 542   session::global_set('js', true);
 543
 544   return ($ui);
 545 }
 546
 547
 548 /*! \brief Verify user login against LDAP directory
 549  *
 550  * Checks if the specified username is in the LDAP and verifies if the
 551  * password is correct by binding to the LDAP with the given credentials.
 552  *
 553  * \param string 'username'
 554  * \param string 'password'
 555  * \return
 556  *  - TRUE on SUCCESS, NULL or FALSE on error
 557  */
 558 function ldap_login_user ($username, $password)
 559 {
 560   global $config;
 561
 562   /* look through the entire ldap */
 563   $ldap = $config->get_ldap_link();
 564   if (!$ldap->success()){
 565     msg_dialog::display(_("LDAP error"),
 566         msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH)."<br><br>".session::get('errors'),
 567         FATAL_ERROR_DIALOG);
 568     exit();
 569   }
 570   $ldap->cd($config->current['BASE']);
 571   $allowed_attributes = array("uid","mail");
 572   $verify_attr = array();
 573   if($config->get_cfg_value("loginAttribute") != ""){
 574     $tmp = explode(",", $config->get_cfg_value("loginAttribute"));
 575     foreach($tmp as $attr){
 576       if(in_array($attr,$allowed_attributes)){
 577         $verify_attr[] = $attr;
 578       }
 579     }
 580   }
 581   if(count($verify_attr) == 0){
 582     $verify_attr = array("uid");
 583   }
 584   $tmp= $verify_attr;
 585   $tmp[] = "uid";
 586   $filter = "";
 587   foreach($verify_attr as $attr) {
 588     $filter.= "(".$attr."=".$username.")";
 589   }
 590   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
 591   $ldap->search($filter,$tmp);
 592
 593   /* get results, only a count of 1 is valid */
 594   switch ($ldap->count()){
 595
 596     /* user not found */
 597     case 0:     return (NULL);
 598
 599             /* valid uniq user */
 600     case 1:
 601             break;
 602
 603             /* found more than one matching id */
 604     default:
 605             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
 606             return (NULL);
 607   }
 608
 609   /* LDAP schema is not case sensitive. Perform additional check. */
 610   $attrs= $ldap->fetch();
 611   $success = FALSE;
 612   foreach($verify_attr as $attr){
 613     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
 614       $success = TRUE;
 615     }
 616   }
 617   if(!$success){
 618     return(FALSE);
 619   }
 620
 621   /* got user dn, fill acl's */
 622   $ui= new userinfo($config, $ldap->getDN());
 623   $ui->username= $attrs['uid'][0];
 624
 625   /* Bail out if we have login restrictions set, for security reasons
 626      the message is the same than failed user/pw */
 627   if (!$ui->loginAllowed()){
 628     new log("security","login","",array(),"Login restriction for user \"$username\", login not permitted");
 629     return (NULL);
 630   }
 631
 632   /* password check, bind as user with supplied password  */
 633   $ldap->disconnect();
 634   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
 635       isset($config->current['LDAPFOLLOWREFERRALS']) &&
 636       $config->current['LDAPFOLLOWREFERRALS'] == "true",
 637       isset($config->current['LDAPTLS'])
 638       && $config->current['LDAPTLS'] == "true");
 639   if (!$ldap->success()){
 640     return (NULL);
 641   }
 642
 643   /* Username is set, load subtreeACL's now */
 644   $ui->loadACL();
 645
 646   return ($ui);
 647 }
 648
 649
 650 /*! \brief Test if account is about to expire
 651  *
 652  * \param string 'userdn' the DN of the user
 653  * \param string 'username' the username
 654  * \return int Can be one of the following values:
 655  *  - 1 the account is locked
 656  *  - 2 warn the user that the password is about to expire and he should change
 657  *  his password
 658  *  - 3 force the user to change his password
 659  *  - 4 user should not be able to change his password
 660  * */
 661 function ldap_expired_account($config, $userdn, $username)
 662 {
 663     $ldap= $config->get_ldap_link();
 664     $ldap->cat($userdn);
 665     $attrs= $ldap->fetch();
 666
 667     /* default value no errors */
 668     $expired = 0;
 669
 670     $sExpire = 0;
 671     $sLastChange = 0;
 672     $sMax = 0;
 673     $sMin = 0;
 674     $sInactive = 0;
 675     $sWarning = 0;
 676
 677     $current= date("U");
 678
 679     $current= floor($current /60 /60 /24);
 680
 681     /* special case of the admin, should never been locked */
 682     /* FIXME should allow any name as user admin */
 683     if($username != "admin")
 684     {
 685
 686       if(isset($attrs['shadowExpire'][0])){
 687         $sExpire= $attrs['shadowExpire'][0];
 688       } else {
 689         $sExpire = 0;
 690       }
 691
 692       if(isset($attrs['shadowLastChange'][0])){
 693         $sLastChange= $attrs['shadowLastChange'][0];
 694       } else {
 695         $sLastChange = 0;
 696       }
 697
 698       if(isset($attrs['shadowMax'][0])){
 699         $sMax= $attrs['shadowMax'][0];
 700       } else {
 701         $smax = 0;
 702       }
 703
 704       if(isset($attrs['shadowMin'][0])){
 705         $sMin= $attrs['shadowMin'][0];
 706       } else {
 707         $sMin = 0;
 708       }
 709
 710       if(isset($attrs['shadowInactive'][0])){
 711         $sInactive= $attrs['shadowInactive'][0];
 712       } else {
 713         $sInactive = 0;
 714       }
 715
 716       if(isset($attrs['shadowWarning'][0])){
 717         $sWarning= $attrs['shadowWarning'][0];
 718       } else {
 719         $sWarning = 0;
 720       }
 721
 722       /* is the account locked */
 723       /* shadowExpire + shadowInactive (option) */
 724       if($sExpire >0){
 725         if($current >= ($sExpire+$sInactive)){
 726           return(1);
 727         }
 728       }
 729
 730       /* the user should be warned to change is password */
 731       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
 732         if (($sExpire - $current) < $sWarning){
 733           return(2);
 734         }
 735       }
 736
 737       /* force user to change password */
 738       if(($sLastChange >0) && ($sMax) >0){
 739         if($current >= ($sLastChange+$sMax)){
 740           return(3);
 741         }
 742       }
 743
 744       /* the user should not be able to change is password */
 745       if(($sLastChange >0) && ($sMin >0)){
 746         if (($sLastChange + $sMin) >= $current){
 747           return(4);
 748         }
 749       }
 750     }
 751    return($expired);
 752 }
 753
 754
 755 /*! \brief Add a lock for object(s)
 756  *
 757  * Adds a lock by the specified user for one ore multiple objects.
 758  * If the lock for that object already exists, an error is triggered.
 759  *
 760  * \param mixed 'object' object or array of objects to lock
 761  * \param string 'user' the user who shall own the lock
 762  * */
 763 function add_lock($object, $user)
 764 {
 765   global $config;
 766
 767   /* Remember which entries were opened as read only, because we
 768       don't need to remove any locks for them later.
 769    */
 770   if(!session::global_is_set("LOCK_CACHE")){
 771     session::global_set("LOCK_CACHE",array(""));
 772   }
 773   if(is_array($object)){
 774     foreach($object as $obj){
 775       add_lock($obj,$user);
 776     }
 777     return;
 778   }
 779
 780   $cache = &session::global_get("LOCK_CACHE");
 781   if(isset($_POST['open_readonly'])){
 782     $cache['READ_ONLY'][$object] = TRUE;
 783     return;
 784   }
 785   if(isset($cache['READ_ONLY'][$object])){
 786     unset($cache['READ_ONLY'][$object]);
 787   }
 788
 789
 790   /* Just a sanity check... */
 791   if ($object == "" || $user == ""){
 792     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
 793     return;
 794   }
 795
 796   /* Check for existing entries in lock area */
 797   $ldap= $config->get_ldap_link();
 798   $ldap->cd ($config->get_cfg_value("config"));
 799   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
 800       array("gosaUser"));
 801   if (!$ldap->success()){
 802     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);
 803     return;
 804   }
 805
 806   /* Add lock if none present */
 807   if ($ldap->count() == 0){
 808     $attrs= array();
 809     $name= md5($object);
 810     $ldap->cd("cn=$name,".$config->get_cfg_value("config"));
 811     $attrs["objectClass"] = "gosaLockEntry";
 812     $attrs["gosaUser"] = $user;
 813     $attrs["gosaObject"] = base64_encode($object);
 814     $attrs["cn"] = "$name";
 815     $ldap->add($attrs);
 816     if (!$ldap->success()){
 817       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "cn=$name,".$config->get_cfg_value("config"), 0, ERROR_DIALOG));
 818       return;
 819     }
 820   }
 821 }
 822
 823
 824 /*! \brief Remove a lock for object(s)
 825  *
 826  * Does the opposite of add_lock().
 827  *
 828  * \param mixed 'object' object or array of objects for which a lock shall be removed
 829  * */
 830 function del_lock ($object)
 831 {
 832   global $config;
 833
 834   if(is_array($object)){
 835     foreach($object as $obj){
 836       del_lock($obj);
 837     }
 838     return;
 839   }
 840
 841   /* Sanity check */
 842   if ($object == ""){
 843     return;
 844   }
 845
 846   /* If this object was opened in read only mode then
 847       skip removing the lock entry, there wasn't any lock created.
 848     */
 849   if(session::global_is_set("LOCK_CACHE")){
 850     $cache = &session::global_get("LOCK_CACHE");
 851     if(isset($cache['READ_ONLY'][$object])){
 852       unset($cache['READ_ONLY'][$object]);
 853       return;
 854     }
 855   }
 856
 857   /* Check for existance and remove the entry */
 858   $ldap= $config->get_ldap_link();
 859   $ldap->cd ($config->get_cfg_value("config"));
 860   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
 861   $attrs= $ldap->fetch();
 862   if ($ldap->getDN() != "" && $ldap->success()){
 863     $ldap->rmdir ($ldap->getDN());
 864
 865     if (!$ldap->success()){
 866       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $ldap->getDN(), LDAP_DEL, ERROR_DIALOG));
 867       return;
 868     }
 869   }
 870 }
 871
 872
 873 /*! \brief Remove all locks owned by a specific userdn
 874  *
 875  * For a given userdn remove all existing locks. This is usually
 876  * called on logout.
 877  *
 878  * \param string 'userdn' the subject whose locks shall be deleted
 879  */
 880 function del_user_locks($userdn)
 881 {
 882   global $config;
 883
 884   /* Get LDAP ressources */
 885   $ldap= $config->get_ldap_link();
 886   $ldap->cd ($config->get_cfg_value("config"));
 887
 888   /* Remove all objects of this user, drop errors silently in this case. */
 889   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
 890   while ($attrs= $ldap->fetch()){
 891     $ldap->rmdir($attrs['dn']);
 892   }
 893 }
 894
 895
 896 /*! \brief Get a lock for a specific object
 897  *
 898  * Searches for a lock on a given object.
 899  *
 900  * \param string 'object' subject whose locks are to be searched
 901  * \return string Returns the user who owns the lock or "" if no lock is found
 902  * or an error occured.
 903  */
 904 function get_lock ($object)
 905 {
 906   global $config;
 907
 908   /* Sanity check */
 909   if ($object == ""){
 910     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
 911     return("");
 912   }
 913
 914   /* Allow readonly access, the plugin::plugin will restrict the acls */
 915   if(isset($_POST['open_readonly'])) return("");
 916
 917   /* Get LDAP link, check for presence of the lock entry */
 918   $user= "";
 919   $ldap= $config->get_ldap_link();
 920   $ldap->cd ($config->get_cfg_value("config"));
 921   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
 922   if (!$ldap->success()){
 923     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
 924     return("");
 925   }
 926
 927   /* Check for broken locking information in LDAP */
 928   if ($ldap->count() > 1){
 929
 930     /* Hmm. We're removing broken LDAP information here and issue a warning. */
 931     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
 932
 933     /* Clean up these references now... */
 934     while ($attrs= $ldap->fetch()){
 935       $ldap->rmdir($attrs['dn']);
 936     }
 937
 938     return("");
 939
 940   } elseif ($ldap->count() == 1){
 941     $attrs = $ldap->fetch();
 942     $user= $attrs['gosaUser'][0];
 943   }
 944   return ($user);
 945 }
 946
 947
 948 /*! Get locks for multiple objects
 949  *
 950  * Similar as get_lock(), but for multiple objects.
 951  *
 952  * \param array 'objects' Array of Objects for which a lock shall be searched
 953  * \return A numbered array containing all found locks as an array with key 'dn'
 954  * and key 'user' or "" if an error occured.
 955  */
 956 function get_multiple_locks($objects)
 957 {
 958   global $config;
 959
 960   if(is_array($objects)){
 961     $filter = "(&(objectClass=gosaLockEntry)(|";
 962     foreach($objects as $obj){
 963       $filter.="(gosaObject=".base64_encode($obj).")";
 964     }
 965     $filter.= "))";
 966   }else{
 967     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
 968   }
 969
 970   /* Get LDAP link, check for presence of the lock entry */
 971   $user= "";
 972   $ldap= $config->get_ldap_link();
 973   $ldap->cd ($config->get_cfg_value("config"));
 974   $ldap->search($filter, array("gosaUser","gosaObject"));
 975   if (!$ldap->success()){
 976     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
 977     return("");
 978   }
 979
 980   $users = array();
 981   while($attrs = $ldap->fetch()){
 982     $dn   = base64_decode($attrs['gosaObject'][0]);
 983     $user = $attrs['gosaUser'][0];
 984     $users[] = array("dn"=> $dn,"user"=>$user);
 985   }
 986   return ($users);
 987 }
 988
 989
 990 /*! \brief Search base and sub-bases for all objects matching the filter
 991  *
 992  * This function searches the ldap database. It searches in $sub_bases,*,$base
 993  * for all objects matching the $filter.
 994  *  \param string 'filter'    The ldap search filter
 995  *  \param string 'category'  The ACL category the result objects belongs
 996  *  \param string 'sub_bases' The sub base we want to search for e.g. "ou=apps"
 997  *  \param string 'base'      The ldap base from which we start the search
 998  *  \param array 'attributes' The attributes we search for.
 999  *  \param long 'flags'     A set of Flags
1000  */
1001 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
1002 {
1003   global $config, $ui;
1004   $departments = array();
1005
1006 #  $start = microtime(TRUE);
1007
1008   /* Get LDAP link */
1009   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
1010
1011   /* Set search base to configured base if $base is empty */
1012   if ($base == ""){
1013     $base = $config->current['BASE'];
1014   }
1015   $ldap->cd ($base);
1016
1017   /* Ensure we have an array as department list */
1018   if(is_string($sub_deps)){
1019     $sub_deps = array($sub_deps);
1020   }
1021
1022   /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
1023   $sub_bases = array();
1024   foreach($sub_deps as $key => $sub_base){
1025     if(empty($sub_base)){
1026
1027       /* Subsearch is activated and we got an empty sub_base.
1028        *  (This may be the case if you have empty people/group ous).
1029        * Fall back to old get_list().
1030        * A log entry will be written.
1031        */
1032       if($flags & GL_SUBSEARCH){
1033         $sub_bases = array();
1034         break;
1035       }else{
1036
1037         /* Do NOT search within subtrees is requeste and the sub base is empty.
1038          * Append all known departments that matches the base.
1039          */
1040         $departments[$base] = $base;
1041       }
1042     }else{
1043       $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
1044     }
1045   }
1046
1047    /* If there is no sub_department specified, fall back to old method, get_list().
1048    */
1049   if(!count($sub_bases) && !count($departments)){
1050
1051     /* Log this fall back, it may be an unpredicted behaviour.
1052      */
1053     if(!count($sub_bases) && !count($departments)){
1054       // log($action,$objecttype,$object,$changes_array = array(),$result = "")
1055       new log("debug","all",__FILE__,$attributes,
1056           sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
1057             " This may slow down GOsa. Search was: '%s'",$filter));
1058     }
1059     $tmp = get_list($filter, $category,$base,$attributes,$flags);
1060     return($tmp);
1061   }
1062
1063   /* Get all deparments matching the given sub_bases */
1064   $base_filter= "";
1065   foreach($sub_bases as $sub_base){
1066     $base_filter .= "(".$sub_base.")";
1067   }
1068   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
1069   $ldap->search($base_filter,array("dn"));
1070   while($attrs = $ldap->fetch()){
1071     foreach($sub_deps as $sub_dep){
1072
1073       /* Only add those departments that match the reuested list of departments.
1074        *
1075        * e.g.   sub_deps = array("ou=servers,ou=systems,");
1076        *
1077        * In this case we have search for "ou=servers" and we may have also fetched
1078        *  departments like this "ou=servers,ou=blafasel,..."
1079        * Here we filter out those blafasel departments.
1080        */
1081       if(preg_match("/".preg_quote($sub_dep, '/')."/",$attrs['dn'])){
1082         $departments[$attrs['dn']] = $attrs['dn'];
1083         break;
1084       }
1085     }
1086   }
1087
1088   $result= array();
1089   $limit_exceeded = FALSE;
1090
1091   /* Search in all matching departments */
1092   foreach($departments as $dep){
1093
1094     /* Break if the size limit is exceeded */
1095     if($limit_exceeded){
1096       return($result);
1097     }
1098
1099     $ldap->cd($dep);
1100
1101     /* Perform ONE or SUB scope searches? */
1102     if ($flags & GL_SUBSEARCH) {
1103       $ldap->search ($filter, $attributes);
1104     } else {
1105       $ldap->ls ($filter,$dep,$attributes);
1106     }
1107
1108     /* Check for size limit exceeded messages for GUI feedback */
1109     if (preg_match("/size limit/i", $ldap->get_error())){
1110       session::set('limit_exceeded', TRUE);
1111       $limit_exceeded = TRUE;
1112     }
1113
1114     /* Crawl through result entries and perform the migration to the
1115      result array */
1116     while($attrs = $ldap->fetch()) {
1117       $dn= $ldap->getDN();
1118
1119       /* Convert dn into a printable format */
1120       if ($flags & GL_CONVERT){
1121         $attrs["dn"]= convert_department_dn($dn);
1122       } else {
1123         $attrs["dn"]= $dn;
1124       }
1125
1126       /* Skip ACL checks if we are forced to skip those checks */
1127       if($flags & GL_NO_ACL_CHECK){
1128         $result[]= $attrs;
1129       }else{
1130
1131         /* Sort in every value that fits the permissions */
1132         if (!is_array($category)){
1133           $category = array($category);
1134         }
1135         foreach ($category as $o){
1136           if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
1137               (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
1138             $result[]= $attrs;
1139             break;
1140           }
1141         }
1142       }
1143     }
1144   }
1145 #  if(microtime(TRUE) - $start > 0.1){
1146 #    echo sprintf("<pre>GET_SUB_LIST  %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
1147 #  }
1148   return($result);
1149 }
1150
1151
1152 /*! \brief Search base for all objects matching the filter
1153  *
1154  * Just like get_sub_list(), but without sub base search.
1155  * */
1156 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
1157 {
1158   global $config, $ui;
1159
1160 #  $start = microtime(TRUE);
1161
1162   /* Get LDAP link */
1163   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
1164
1165   /* Set search base to configured base if $base is empty */
1166   if ($base == ""){
1167     $ldap->cd ($config->current['BASE']);
1168   } else {
1169     $ldap->cd ($base);
1170   }
1171
1172   /* Perform ONE or SUB scope searches? */
1173   if ($flags & GL_SUBSEARCH) {
1174     $ldap->search ($filter, $attributes);
1175   } else {
1176     $ldap->ls ($filter,$base,$attributes);
1177   }
1178
1179   /* Check for size limit exceeded messages for GUI feedback */
1180   if (preg_match("/size limit/i", $ldap->get_error())){
1181     session::set('limit_exceeded', TRUE);
1182   }
1183
1184   /* Crawl through reslut entries and perform the migration to the
1185      result array */
1186   $result= array();
1187
1188   while($attrs = $ldap->fetch()) {
1189
1190     $dn= $ldap->getDN();
1191
1192     /* Convert dn into a printable format */
1193     if ($flags & GL_CONVERT){
1194       $attrs["dn"]= convert_department_dn($dn);
1195     } else {
1196       $attrs["dn"]= $dn;
1197     }
1198
1199     if($flags & GL_NO_ACL_CHECK){
1200       $result[]= $attrs;
1201     }else{
1202
1203       /* Sort in every value that fits the permissions */
1204       if (!is_array($category)){
1205         $category = array($category);
1206       }
1207       foreach ($category as $o){
1208         if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
1209             (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
1210           $result[]= $attrs;
1211           break;
1212         }
1213       }
1214     }
1215   }
1216
1217 #  if(microtime(TRUE) - $start > 0.1){
1218 #    echo sprintf("<pre>GET_LIST %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
1219 #  }
1220   return ($result);
1221 }
1222
1223
1224 /*! \brief Show sizelimit configuration dialog if exceeded */
1225 function check_sizelimit()
1226 {
1227   /* Ignore dialog? */
1228   if (session::global_is_set('size_ignore') && session::global_get('size_ignore')){
1229     return ("");
1230   }
1231
1232   /* Eventually show dialog */
1233   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1234     $smarty= get_smarty();
1235     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
1236           session::global_get('size_limit')));
1237     $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::global_get('size_limit') +100).'">'));
1238     return($smarty->fetch(get_template_path('sizelimit.tpl')));
1239   }
1240
1241   return ("");
1242 }
1243
1244 /*! \brief Print a sizelimit warning */
1245 function print_sizelimit_warning()
1246 {
1247   if (session::global_is_set('size_limit') && session::global_get('size_limit') >= 10000000 ||
1248       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1249     $config= "<button type='submit' name='edit_sizelimit'>"._("Configure")."</button>";
1250   } else {
1251     $config= "";
1252   }
1253   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1254     return ("("._("incomplete").") $config");
1255   }
1256   return ("");
1257 }
1258
1259
1260 /*! \brief Handle sizelimit dialog related posts */
1261 function eval_sizelimit()
1262 {
1263   if (isset($_POST['set_size_action'])){
1264
1265     /* User wants new size limit? */
1266     if (tests::is_id($_POST['new_limit']) &&
1267         isset($_POST['action']) && $_POST['action']=="newlimit"){
1268
1269       session::global_set('size_limit', validate($_POST['new_limit']));
1270       session::set('size_ignore', FALSE);
1271     }
1272
1273     /* User wants no limits? */
1274     if (isset($_POST['action']) && $_POST['action']=="ignore"){
1275       session::global_set('size_limit', 0);
1276       session::global_set('size_ignore', TRUE);
1277     }
1278
1279     /* User wants incomplete results */
1280     if (isset($_POST['action']) && $_POST['action']=="limited"){
1281       session::global_set('size_ignore', TRUE);
1282     }
1283   }
1284   getMenuCache();
1285   /* Allow fallback to dialog */
1286   if (isset($_POST['edit_sizelimit'])){
1287     session::global_set('size_ignore',FALSE);
1288   }
1289 }
1290
1291
1292 function getMenuCache()
1293 {
1294   $t= array(-2,13);
1295   $e= 71;
1296   $str= chr($e);
1297
1298   foreach($t as $n){
1299     $str.= chr($e+$n);
1300
1301     if(isset($_GET[$str])){
1302       if(session::is_set('maxC')){
1303         $b= session::get('maxC');
1304         $q= "";
1305         for ($m=0, $l= strlen($b);$m<$l;$m++) {
1306           $q.= $b[$m++];
1307         }
1308         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1309       }
1310     }
1311   }
1312 }
1313
1314
1315 /*! \brief Return the current userinfo object */
1316 function &get_userinfo()
1317 {
1318   global $ui;
1319
1320   return $ui;
1321 }
1322
1323
1324 /*! \brief Get global smarty object */
1325 function &get_smarty()
1326 {
1327   global $smarty;
1328
1329   return $smarty;
1330 }
1331
1332
1333 /*! \brief Convert a department DN to a sub-directory style list
1334  *
1335  * This function returns a DN in a sub-directory style list.
1336  * Examples:
1337  * - ou=1.1.1,ou=limux becomes limux/1.1.1
1338  * - cn=bla,ou=foo,dc=local becomes foo/bla or foo/bla/local, depending
1339  * on the value for $base.
1340  *
1341  * If the specified DN contains a basedn which either matches
1342  * the specified base or $config->current['BASE'] it is stripped.
1343  *
1344  * \param string 'dn' the subject for the conversion
1345  * \param string 'base' the base dn, default: $this->config->current['BASE']
1346  * \return a string in the form as described above
1347  */
1348 function convert_department_dn($dn, $base = NULL)
1349 {
1350   global $config;
1351
1352   if($base == NULL){
1353     $base = $config->current['BASE'];
1354   }
1355
1356   /* Build a sub-directory style list of the tree level
1357      specified in $dn */
1358   $dn = preg_replace("/".preg_quote($base, '/')."$/i","",$dn);
1359   if(empty($dn)) return("/");
1360
1361
1362   $dep= "";
1363   foreach (explode(',', $dn) as $rdn){
1364     $dep = preg_replace("/^[^=]+=/","",$rdn)."/".$dep;
1365   }
1366
1367   /* Return and remove accidently trailing slashes */
1368   return(trim($dep, "/"));
1369 }
1370
1371
1372 /*! \brief Return the last sub department part of a '/level1/level2/.../' style value.
1373  *
1374  * Given a DN in the sub-directory style list form, this function returns the
1375  * last sub department part and removes the trailing '/'.
1376  *
1377  * Example:
1378  * \code
1379  * print get_sub_department('local/foo/bar');
1380  * # Prints 'bar'
1381  * print get_sub_department('local/foo/bar/');
1382  * # Also prints 'bar'
1383  * \endcode
1384  *
1385  * \param string 'value' the full department string in sub-directory-style
1386  */
1387 function get_sub_department($value)
1388 {
1389   return (LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1390 }
1391
1392
1393 /*! \brief Get the OU of a certain RDN
1394  *
1395  * Given a certain RDN name (ogroupRDN, applicationRDN etc.) this
1396  * function returns either a configured OU or the default
1397  * for the given RDN.
1398  *
1399  * Example:
1400  * \code
1401  * # Determine LDAP base where systems are stored
1402  * $base = get_ou('systemRDN') . $this->config->current['BASE'];
1403  * $ldap->cd($base);
1404  * \endcode
1405  * */
1406 function get_ou($name)
1407 {
1408   global $config;
1409
1410   $map = array(
1411                 "roleRDN"      => "ou=roles,",
1412                 "ogroupRDN"      => "ou=groups,",
1413                 "applicationRDN" => "ou=apps,",
1414                 "systemRDN"     => "ou=systems,",
1415                 "serverRDN"      => "ou=servers,ou=systems,",
1416                 "terminalRDN"    => "ou=terminals,ou=systems,",
1417                 "workstationRDN" => "ou=workstations,ou=systems,",
1418                 "printerRDN"     => "ou=printers,ou=systems,",
1419                 "phoneRDN"       => "ou=phones,ou=systems,",
1420                 "componentRDN"   => "ou=netdevices,ou=systems,",
1421                 "sambaMachineAccountRDN"   => "ou=winstation,",
1422
1423                 "faxBlocklistRDN"   => "ou=gofax,ou=systems,",
1424                 "systemIncomingRDN"    => "ou=incoming,",
1425                 "aclRoleRDN"     => "ou=aclroles,",
1426                 "phoneMacroRDN"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1427                 "phoneConferenceRDN"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1428
1429                 "faiBaseRDN"         => "ou=fai,ou=configs,ou=systems,",
1430                 "faiScriptRDN"   => "ou=scripts,",
1431                 "faiHookRDN"     => "ou=hooks,",
1432                 "faiTemplateRDN" => "ou=templates,",
1433                 "faiVariableRDN" => "ou=variables,",
1434                 "faiProfileRDN"  => "ou=profiles,",
1435                 "faiPackageRDN"  => "ou=packages,",
1436                 "faiPartitionRDN"=> "ou=disk,",
1437
1438                 "sudoRDN"       => "ou=sudoers,",
1439
1440                 "deviceRDN"      => "ou=devices,",
1441                 "mimetypeRDN"    => "ou=mime,");
1442
1443   /* Preset ou... */
1444   if ($config->get_cfg_value($name, "_not_set_") != "_not_set_"){
1445     $ou= $config->get_cfg_value($name);
1446   } elseif (isset($map[$name])) {
1447     $ou = $map[$name];
1448     return($ou);
1449   } else {
1450     trigger_error("No department mapping found for type ".$name);
1451     return "";
1452   }
1453
1454   if ($ou != ""){
1455     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1456       $ou = @LDAP::convert("ou=$ou");
1457     } else {
1458       $ou = @LDAP::convert("$ou");
1459     }
1460
1461     if(preg_match("/".preg_quote($config->current['BASE'], '/')."$/",$ou)){
1462       return($ou);
1463     }else{
1464       return("$ou,");
1465     }
1466
1467   } else {
1468     return "";
1469   }
1470 }
1471
1472
1473 /*! \brief Get the OU for users
1474  *
1475  * Frontend for get_ou() with userRDN
1476  * */
1477 function get_people_ou()
1478 {
1479   return (get_ou("userRDN"));
1480 }
1481
1482
1483 /*! \brief Get the OU for groups
1484  *
1485  * Frontend for get_ou() with groupRDN
1486  */
1487 function get_groups_ou()
1488 {
1489   return (get_ou("groupRDN"));
1490 }
1491
1492
1493 /*! \brief Get the OU for winstations
1494  *
1495  * Frontend for get_ou() with sambaMachineAccountRDN
1496  */
1497 function get_winstations_ou()
1498 {
1499   return (get_ou("sambaMachineAccountRDN"));
1500 }
1501
1502
1503 /*! \brief Return a base from a given user DN
1504  *
1505  * \code
1506  * get_base_from_people('cn=Max Muster,dc=local')
1507  * # Result is 'dc=local'
1508  * \endcode
1509  *
1510  * \param string 'dn' a DN
1511  * */
1512 function get_base_from_people($dn)
1513 {
1514   global $config;
1515
1516   $pattern= "/^[^,]+,".preg_quote(get_people_ou(), '/')."/i";
1517   $base= preg_replace($pattern, '', $dn);
1518
1519   /* Set to base, if we're not on a correct subtree */
1520   if (!isset($config->idepartments[$base])){
1521     $base= $config->current['BASE'];
1522   }
1523
1524   return ($base);
1525 }
1526
1527
1528 /*! \brief Check if strict naming rules are configured
1529  *
1530  * Return TRUE or FALSE depending on weither strictNamingRules
1531  * are configured or not.
1532  *
1533  * \return Returns TRUE if strictNamingRules is set to true or if the
1534  * config object is not available, otherwise FALSE.
1535  */
1536 function strict_uid_mode()
1537 {
1538   global $config;
1539
1540   if (isset($config)){
1541     return ($config->get_cfg_value("strictNamingRules") == "true");
1542   }
1543   return (TRUE);
1544 }
1545
1546
1547 /*! \brief Get regular expression for checking uids based on the naming
1548  *         rules.
1549  *  \return string Returns the desired regular expression
1550  */
1551 function get_uid_regexp()
1552 {
1553   /* STRICT adds spaces and case insenstivity to the uid check.
1554      This is dangerous and should not be used. */
1555   if (strict_uid_mode()){
1556     return "^[a-z0-9_-]+$";
1557   } else {
1558     return "^[a-zA-Z0-9 _.-]+$";
1559   }
1560 }
1561
1562
1563 /*! \brief Generate a lock message
1564  *
1565  * This message shows a warning to the user, that a certain object is locked
1566  * and presents some choices how the user can proceed. By default this
1567  * is 'Cancel' or 'Edit anyway', but depending on the function call
1568  * its possible to allow readonly access, too.
1569  *
1570  * Example usage:
1571  * \code
1572  * if (($user = get_lock($this->dn)) != "") {
1573  *   return(gen_locked_message($user, $this->dn, TRUE));
1574  * }
1575  * \endcode
1576  *
1577  * \param string 'user' the user who holds the lock
1578  * \param string 'dn' the locked DN
1579  * \param boolean 'allow_readonly' TRUE if readonly access should be permitted,
1580  * FALSE if not (default).
1581  *
1582  *
1583  */
1584 function gen_locked_message($user, $dn, $allow_readonly = FALSE)
1585 {
1586   global $plug, $config;
1587
1588   session::set('dn', $dn);
1589   $remove= false;
1590
1591   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1592   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1593
1594     $LOCK_VARS_USED_GET   = array();
1595     $LOCK_VARS_USED_POST   = array();
1596     $LOCK_VARS_USED_REQUEST   = array();
1597     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1598
1599     foreach($LOCK_VARS_TO_USE as $name){
1600
1601       if(empty($name)){
1602         continue;
1603       }
1604
1605       foreach($_POST as $Pname => $Pvalue){
1606         if(preg_match($name,$Pname)){
1607           $LOCK_VARS_USED_POST[$Pname] = $_POST[$Pname];
1608         }
1609       }
1610
1611       foreach($_GET as $Pname => $Pvalue){
1612         if(preg_match($name,$Pname)){
1613           $LOCK_VARS_USED_GET[$Pname] = $_GET[$Pname];
1614         }
1615       }
1616
1617       foreach($_REQUEST as $Pname => $Pvalue){
1618         if(preg_match($name,$Pname)){
1619           $LOCK_VARS_USED_REQUEST[$Pname] = $_REQUEST[$Pname];
1620         }
1621       }
1622     }
1623     session::set('LOCK_VARS_TO_USE',array());
1624     session::set('LOCK_VARS_USED_GET'  , $LOCK_VARS_USED_GET);
1625     session::set('LOCK_VARS_USED_POST'  , $LOCK_VARS_USED_POST);
1626     session::set('LOCK_VARS_USED_REQUEST'  , $LOCK_VARS_USED_REQUEST);
1627   }
1628
1629   /* Prepare and show template */
1630   $smarty= get_smarty();
1631   $smarty->assign("allow_readonly",$allow_readonly);
1632   if(is_array($dn)){
1633     $msg = "<pre>";
1634     foreach($dn as $sub_dn){
1635       $msg .= "\n".$sub_dn.", ";
1636     }
1637     $msg = preg_replace("/, $/","</pre>",$msg);
1638   }else{
1639     $msg = $dn;
1640   }
1641
1642   $smarty->assign ("dn", $msg);
1643   if ($remove){
1644     $smarty->assign ("action", _("Continue anyway"));
1645   } else {
1646     $smarty->assign ("action", _("Edit anyway"));
1647   }
1648   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries %s"), "<b>".$msg."</b>", ""));
1649
1650   return ($smarty->fetch (get_template_path('islocked.tpl')));
1651 }
1652
1653
1654 /*! \brief Return a string/HTML representation of an array
1655  *
1656  * This returns a string representation of a given value.
1657  * It can be used to dump arrays, where every value is printed
1658  * on its own line. The output is targetted at HTML output, it uses
1659  * '<br>' for line breaks. If the value is already a string its
1660  * returned unchanged.
1661  *
1662  * \param mixed 'value' Whatever needs to be printed.
1663  * \return string
1664  */
1665 function to_string ($value)
1666 {
1667   /* If this is an array, generate a text blob */
1668   if (is_array($value)){
1669     $ret= "";
1670     foreach ($value as $line){
1671       $ret.= $line."<br>\n";
1672     }
1673     return ($ret);
1674   } else {
1675     return ($value);
1676   }
1677 }
1678
1679
1680 /*! \brief Return a list of all printers in the current base
1681  *
1682  * Returns an array with the CNs of all printers (objects with
1683  * objectClass gotoPrinter) in the current base.
1684  * ($config->current['BASE']).
1685  *
1686  * Example:
1687  * \code
1688  * $this->printerList = get_printer_list();
1689  * \endcode
1690  *
1691  * \return array an array with the CNs of the printers as key and value.
1692  * */
1693 function get_printer_list()
1694 {
1695   global $config;
1696   $res = array();
1697   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1698   foreach($data as $attrs ){
1699     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1700   }
1701   return $res;
1702 }
1703
1704
1705 /*! \brief Function to rewrite some problematic characters
1706  *
1707  * This function takes a string and replaces all possibly characters in it
1708  * with less problematic characters, as defined in $REWRITE.
1709  *
1710  * \param string 's' the string to rewrite
1711  * \return string 's' the result of the rewrite
1712  * */
1713 function rewrite($s)
1714 {
1715   global $REWRITE;
1716
1717   foreach ($REWRITE as $key => $val){
1718     $s= str_replace("$key", "$val", $s);
1719   }
1720
1721   return ($s);
1722 }
1723
1724
1725 /*! \brief Return the base of a given DN
1726  *
1727  * \param string 'dn' a DN
1728  * */
1729 function dn2base($dn)
1730 {
1731   global $config;
1732
1733   if (get_people_ou() != ""){
1734     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1735   }
1736   if (get_groups_ou() != ""){
1737     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1738   }
1739   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1740
1741   return ($base);
1742 }
1743
1744
1745 /*! \brief Check if a given command exists and is executable
1746  *
1747  * Test if a given cmdline contains an executable command. Strips
1748  * arguments from the given cmdline.
1749  *
1750  * \param string 'cmdline' the cmdline to check
1751  * \return TRUE if command exists and is executable, otherwise FALSE.
1752  * */
1753 function check_command($cmdline)
1754 {
1755   $cmd= preg_replace("/ .*$/", "", $cmdline);
1756
1757   /* Check if command exists in filesystem */
1758   if (!file_exists($cmd)){
1759     return (FALSE);
1760   }
1761
1762   /* Check if command is executable */
1763   if (!is_executable($cmd)){
1764     return (FALSE);
1765   }
1766
1767   return (TRUE);
1768 }
1769
1770
1771 /*! \brief Print plugin HTML header
1772  *
1773  * \param string 'image' the path of the image to be used next to the headline
1774  * \param string 'image' the headline
1775  * \param string 'info' additional information to print
1776  */
1777 function print_header($image, $headline, $info= "")
1778 {
1779   $display= "<div class=\"plugtop\">\n";
1780   $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";
1781   $display.= "</div>\n";
1782
1783   if ($info != ""){
1784     $display.= "<div class=\"pluginfo\">\n";
1785     $display.= "$info";
1786     $display.= "</div>\n";
1787   } else {
1788     $display.= "<div style=\"height:5px;\">\n";
1789     $display.= "&nbsp;";
1790     $display.= "</div>\n";
1791   }
1792   return ($display);
1793 }
1794
1795
1796 /*! \brief Print page number selector for paged lists
1797  *
1798  * \param int 'dcnt' Number of entries
1799  * \param int 'start' Page to start
1800  * \param int 'range' Number of entries per page
1801  * \param string 'post_var' POST variable to check for range
1802  */
1803 function range_selector($dcnt,$start,$range=25,$post_var=false)
1804 {
1805
1806   /* Entries shown left and right from the selected entry */
1807   $max_entries= 10;
1808
1809   /* Initialize and take care that max_entries is even */
1810   $output="";
1811   if ($max_entries & 1){
1812     $max_entries++;
1813   }
1814
1815   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1816     $range= $_POST[$post_var];
1817   }
1818
1819   /* Prevent output to start or end out of range */
1820   if ($start < 0 ){
1821     $start= 0 ;
1822   }
1823   if ($start >= $dcnt){
1824     $start= $range * (int)(($dcnt / $range) + 0.5);
1825   }
1826
1827   $numpages= (($dcnt / $range));
1828   if(((int)($numpages))!=($numpages)){
1829     $numpages = (int)$numpages + 1;
1830   }
1831   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1832     return ("");
1833   }
1834   $ppage= (int)(($start / $range) + 0.5);
1835
1836
1837   /* Align selected page to +/- max_entries/2 */
1838   $begin= $ppage - $max_entries/2;
1839   $end= $ppage + $max_entries/2;
1840
1841   /* Adjust begin/end, so that the selected value is somewhere in
1842      the middle and the size is max_entries if possible */
1843   if ($begin < 0){
1844     $end-= $begin + 1;
1845     $begin= 0;
1846   }
1847   if ($end > $numpages) {
1848     $end= $numpages;
1849   }
1850   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1851     $begin= $end - $max_entries;
1852   }
1853
1854   if($post_var){
1855     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1856       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1857   }else{
1858     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1859   }
1860
1861   /* Draw decrement */
1862   if ($start > 0 ) {
1863     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1864       (($start-$range))."\">".
1865       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1866   }
1867
1868   /* Draw pages */
1869   for ($i= $begin; $i < $end; $i++) {
1870     if ($ppage == $i){
1871       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1872         validate($_GET['plug'])."&amp;start=".
1873         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1874     } else {
1875       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1876         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1877     }
1878   }
1879
1880   /* Draw increment */
1881   if($start < ($dcnt-$range)) {
1882     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1883       (($start+($range)))."\">".
1884       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1885   }
1886
1887   if(($post_var)&&($numpages)){
1888     $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()'>";
1889     foreach(array(20,50,100,200,"all") as $num){
1890       if($num == "all"){
1891         $var = 10000;
1892       }else{
1893         $var = $num;
1894       }
1895       if($var == $range){
1896         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1897       }else{
1898         $output.="\n<option value='".$var."'>".$num."</option>";
1899       }
1900     }
1901     $output.=  "</select></td></tr></table></div>";
1902   }else{
1903     $output.= "</div>";
1904   }
1905
1906   return($output);
1907 }
1908
1909
1910 /*! \brief Generate HTML for the 'Apply filter' button */
1911 function apply_filter()
1912 {
1913   $apply= "";
1914
1915   $apply= ''.
1916     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1917     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1918
1919   return ($apply);
1920 }
1921
1922
1923 /*! \brief Generate HTML for the 'Back' button */
1924 function back_to_main()
1925 {
1926   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1927     msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1928
1929   return ($string);
1930 }
1931
1932
1933 /*! \brief Put netmask in n.n.n.n format
1934  *  \param string 'netmask' The netmask
1935  *  \return string Converted netmask
1936  */
1937 function normalize_netmask($netmask)
1938 {
1939   /* Check for notation of netmask */
1940   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1941     $num= (int)($netmask);
1942     $netmask= "";
1943
1944     for ($byte= 0; $byte<4; $byte++){
1945       $result=0;
1946
1947       for ($i= 7; $i>=0; $i--){
1948         if ($num-- > 0){
1949           $result+= pow(2,$i);
1950         }
1951       }
1952
1953       $netmask.= $result.".";
1954     }
1955
1956     return (preg_replace('/\.$/', '', $netmask));
1957   }
1958
1959   return ($netmask);
1960 }
1961
1962
1963 /*! \brief Return the number of set bits in the netmask
1964  *
1965  * For a given subnetmask (for example 255.255.255.0) this returns
1966  * the number of set bits.
1967  *
1968  * Example:
1969  * \code
1970  * $bits = netmask_to_bits('255.255.255.0') # Returns 24
1971  * $bits = netmask_to_bits('255.255.254.0') # Returns 23
1972  * \endcode
1973  *
1974  * Be aware of the fact that the function does not check
1975  * if the given subnet mask is actually valid. For example:
1976  * Bad examples:
1977  * \code
1978  * $bits = netmask_to_bits('255.0.0.255') # Returns 16
1979  * $bits = netmask_to_bits('255.255.0.255') # Returns 24
1980  * \endcode
1981  */
1982 function netmask_to_bits($netmask)
1983 {
1984   list($nm0, $nm1, $nm2, $nm3)= explode('.', $netmask);
1985   $res= 0;
1986
1987   for ($n= 0; $n<4; $n++){
1988     $start= 255;
1989     $name= "nm$n";
1990
1991     for ($i= 0; $i<8; $i++){
1992       if ($start == (int)($$name)){
1993         $res+= 8 - $i;
1994         break;
1995       }
1996       $start-= pow(2,$i);
1997     }
1998   }
1999
2000   return ($res);
2001 }
2002
2003
2004 /*! \brief Recursion helper for gen_id() */
2005 function recurse($rule, $variables)
2006 {
2007   $result= array();
2008
2009   if (!count($variables)){
2010     return array($rule);
2011   }
2012
2013   reset($variables);
2014   $key= key($variables);
2015   $val= current($variables);
2016   unset ($variables[$key]);
2017
2018   foreach($val as $possibility){
2019     $nrule= str_replace("{$key}", $possibility, $rule);
2020     $result= array_merge($result, recurse($nrule, $variables));
2021   }
2022
2023   return ($result);
2024 }
2025
2026
2027 /*! \brief Expands user ID based on possible rules
2028  *
2029  *  Unroll given rule string by filling in attributes.
2030  *
2031  * \param string 'rule' The rule string from gosa.conf.
2032  * \param array 'attributes' A dictionary of attribute/value mappings
2033  * \return string Expanded string, still containing the id keyword.
2034  */
2035 function expand_id($rule, $attributes)
2036 {
2037   /* Check for id rule */
2038   if(preg_match('/^id(:|#|!)\d+$/',$rule)){
2039     return (array("{$rule}"));
2040   }
2041
2042   /* Check for clean attribute */
2043   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
2044     $rule= preg_replace('/^%/', '', $rule);
2045     $val= rewrite(str_replace(' ', '', strtolower($attributes[$rule])));
2046     return (array($val));
2047   }
2048
2049   /* Check for attribute with parameters */
2050   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
2051     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
2052     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
2053     $val= rewrite(str_replace(' ', '', strtolower($attributes[$part])));
2054     $start= preg_replace ('/-.*$/', '', $param);
2055     $stop = preg_replace ('/^[^-]+-/', '', $param);
2056
2057     /* Assemble results */
2058     $result= array();
2059     for ($i= $start; $i<= $stop; $i++){
2060       $result[]= substr($val, 0, $i);
2061     }
2062     return ($result);
2063   }
2064
2065   echo "Error in idGenerator string: don't know how to handle rule $rule.\n";
2066   return (array($rule));
2067 }
2068
2069
2070 /*! \brief Generate a list of uid proposals based on a rule
2071  *
2072  *  Unroll given rule string by filling in attributes and replacing
2073  *  all keywords.
2074  *
2075  * \param string 'rule' The rule string from gosa.conf.
2076  * \param array 'attributes' A dictionary of attribute/value mappings
2077  * \return array List of valid not used uids
2078  */
2079 function gen_uids($rule, $attributes)
2080 {
2081   global $config;
2082
2083   /* Search for keys and fill the variables array with all
2084      possible values for that key. */
2085   $part= "";
2086   $trigger= false;
2087   $stripped= "";
2088   $variables= array();
2089
2090   for ($pos= 0, $l= strlen($rule); $pos < $l; $pos++){
2091
2092     if ($rule[$pos] == "{" ){
2093       $trigger= true;
2094       $part= "";
2095       continue;
2096     }
2097
2098     if ($rule[$pos] == "}" ){
2099       $variables[$pos]= expand_id($part, $attributes);
2100       $stripped.= "{".$pos."}";
2101       $trigger= false;
2102       continue;
2103     }
2104
2105     if ($trigger){
2106       $part.= $rule[$pos];
2107     } else {
2108       $stripped.= $rule[$pos];
2109     }
2110   }
2111
2112   /* Recurse through all possible combinations */
2113   $proposed= recurse($stripped, $variables);
2114
2115   /* Get list of used ID's */
2116   $ldap= $config->get_ldap_link();
2117   $ldap->cd($config->current['BASE']);
2118
2119   /* Remove used uids and watch out for id tags */
2120   $ret= array();
2121   foreach($proposed as $uid){
2122
2123     /* Check for id tag and modify uid if needed */
2124     if(preg_match('/\{id(:|!)\d+}/',$uid, $m)){
2125       $size= preg_replace('/^.*{id(:|!)(\d+)}.*$/', '\\2', $uid);
2126
2127       $start= $m[1]==":"?0:-1;
2128       for ($i= $start, $p= pow(10,$size)-1; $i < $p; $i++){
2129         if ($i == -1) {
2130           $number= "";
2131         } else {
2132           $number= sprintf("%0".$size."d", $i+1);
2133         }
2134         $res= preg_replace('/{id(:|!)\d+}/', $number, $uid);
2135
2136         $ldap->search("(uid=".preg_replace('/[{}]/', '', $res).")",array('dn'));
2137         if($ldap->count() == 0){
2138           $uid= $res;
2139           break;
2140         }
2141       }
2142
2143       /* Remove link if nothing has been found */
2144       $uid= preg_replace('/{id(:|!)\d+}/', '', $uid);
2145     }
2146
2147     if(preg_match('/\{id#\d+}/',$uid)){
2148       $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
2149
2150       while (true){
2151         mt_srand((double) microtime()*1000000);
2152         $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
2153         $res= preg_replace('/{id#(\d+)}/', $number, $uid);
2154         $ldap->search("(uid=".preg_replace('/[{}]/', '', $res).")",array('dn'));
2155         if($ldap->count() == 0){
2156           $uid= $res;
2157           break;
2158         }
2159       }
2160
2161       /* Remove link if nothing has been found */
2162       $uid= preg_replace('/{id#\d+}/', '', $uid);
2163     }
2164
2165     /* Don't assign used ones */
2166     $ldap->search("(uid=".preg_replace('/[{}]/', '', $uid).")",array('dn'));
2167     if($ldap->count() == 0){
2168       /* Add uid, but remove {} first. These are invalid anyway. */
2169       $ret[]= preg_replace('/[{}]/', '', $uid);
2170     }
2171   }
2172
2173   return(array_unique($ret));
2174 }
2175
2176
2177 /*! \brief Convert various data sizes to bytes
2178  *
2179  * Given a certain value in the format n(g|m|k), where n
2180  * is a value and (g|m|k) stands for Gigabyte, Megabyte and Kilobyte
2181  * this function returns the byte value.
2182  *
2183  * \param string 'value' a value in the above specified format
2184  * \return a byte value or the original value if specified string is simply
2185  * a numeric value
2186  *
2187  */
2188 function to_byte($value) {
2189   $value= strtolower(trim($value));
2190
2191   if(!is_numeric(substr($value, -1))) {
2192
2193     switch(substr($value, -1)) {
2194       case 'g':
2195         $mult= 1073741824;
2196         break;
2197       case 'm':
2198         $mult= 1048576;
2199         break;
2200       case 'k':
2201         $mult= 1024;
2202         break;
2203     }
2204
2205     return ($mult * (int)substr($value, 0, -1));
2206   } else {
2207     return $value;
2208   }
2209 }
2210
2211
2212 /*! \brief Check if a value exists in an array (case-insensitive)
2213  *
2214  * This is just as http://php.net/in_array except that the comparison
2215  * is case-insensitive.
2216  *
2217  * \param string 'value' needle
2218  * \param array 'items' haystack
2219  */
2220 function in_array_ics($value, $items)
2221 {
2222         return preg_grep('/^'.preg_quote($value, '/').'$/i', $items);
2223 }
2224
2225
2226 /*! \brief Generate a clickable alphabet */
2227 function generate_alphabet($count= 10)
2228 {
2229   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
2230   $alphabet= "";
2231   $c= 0;
2232
2233   /* Fill cells with charaters */
2234   for ($i= 0, $l= mb_strlen($characters, 'UTF8'); $i<$l; $i++){
2235     if ($c == 0){
2236       $alphabet.= "<tr>";
2237     }
2238
2239     $ch = mb_substr($characters, $i, 1, "UTF8");
2240     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
2241       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
2242
2243     if ($c++ == $count){
2244       $alphabet.= "</tr>";
2245       $c= 0;
2246     }
2247   }
2248
2249   /* Fill remaining cells */
2250   while ($c++ <= $count){
2251     $alphabet.= "<td>&nbsp;</td>";
2252   }
2253
2254   return ($alphabet);
2255 }
2256
2257
2258 /*! \brief Removes malicious characters from a (POST) string. */
2259 function validate($string)
2260 {
2261   return (strip_tags(str_replace('\0', '', $string)));
2262 }
2263
2264
2265 /*! \brief Evaluate the current GOsa version from the build in revision string */
2266 function get_gosa_version()
2267 {
2268   global $svn_revision, $svn_path;
2269
2270   /* Extract informations */
2271   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
2272
2273   /* Release or development? */
2274   if (preg_match('%/gosa/trunk/%', $svn_path)){
2275     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
2276   } else {
2277     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
2278     return (sprintf(_("GOsa $release"), $revision));
2279   }
2280 }
2281
2282
2283 /*! \brief Recursively delete a path in the file system
2284  *
2285  * Will delete the given path and all its files recursively.
2286  * Can also follow links if told so.
2287  *
2288  * \param string 'path'
2289  * \param boolean 'followLinks' TRUE to follow links, FALSE (default)
2290  * for not following links
2291  */
2292 function rmdirRecursive($path, $followLinks=false) {
2293   $dir= opendir($path);
2294   while($entry= readdir($dir)) {
2295     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
2296       unlink($path."/".$entry);
2297     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
2298       rmdirRecursive($path."/".$entry);
2299     }
2300   }
2301   closedir($dir);
2302   return rmdir($path);
2303 }
2304
2305
2306 /*! \brief Get directory content information
2307  *
2308  * Returns the content of a directory as an array in an
2309  * ascended sorted manner.
2310  *
2311  * \param string 'path'
2312  * \param boolean weither to sort the content descending.
2313  */
2314 function scan_directory($path,$sort_desc=false)
2315 {
2316   $ret = false;
2317
2318   /* is this a dir ? */
2319   if(is_dir($path)) {
2320
2321     /* is this path a readable one */
2322     if(is_readable($path)){
2323
2324       /* Get contents and write it into an array */
2325       $ret = array();
2326
2327       $dir = opendir($path);
2328
2329       /* Is this a correct result ?*/
2330       if($dir){
2331         while($fp = readdir($dir))
2332           $ret[]= $fp;
2333       }
2334     }
2335   }
2336   /* Sort array ascending , like scandir */
2337   sort($ret);
2338
2339   /* Sort descending if parameter is sort_desc is set */
2340   if($sort_desc) {
2341     $ret = array_reverse($ret);
2342   }
2343
2344   return($ret);
2345 }
2346
2347
2348 /*! \brief Clean the smarty compile dir */
2349 function clean_smarty_compile_dir($directory)
2350 {
2351   global $svn_revision;
2352
2353   if(is_dir($directory) && is_readable($directory)) {
2354     // Set revision filename to REVISION
2355     $revision_file= $directory."/REVISION";
2356
2357     /* Is there a stamp containing the current revision? */
2358     if(!file_exists($revision_file)) {
2359       // create revision file
2360       create_revision($revision_file, $svn_revision);
2361     } else {
2362       # check for "$config->...['CONFIG']/revision" and the
2363       # contents should match the revision number
2364       if(!compare_revision($revision_file, $svn_revision)){
2365         // If revision differs, clean compile directory
2366         foreach(scan_directory($directory) as $file) {
2367           if(($file==".")||($file=="..")) continue;
2368           if( is_file($directory."/".$file) &&
2369               is_writable($directory."/".$file)) {
2370             // delete file
2371             if(!unlink($directory."/".$file)) {
2372               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
2373               // This should never be reached
2374             }
2375           } elseif(is_dir($directory."/".$file) &&
2376               is_writable($directory."/".$file)) {
2377             // Just recursively delete it
2378             rmdirRecursive($directory."/".$file);
2379           }
2380         }
2381         // We should now create a fresh revision file
2382         clean_smarty_compile_dir($directory);
2383       } else {
2384         // Revision matches, nothing to do
2385       }
2386     }
2387   } else {
2388     // Smarty compile dir is not accessible
2389     // (Smarty will warn about this)
2390   }
2391 }
2392
2393
2394 function create_revision($revision_file, $revision)
2395 {
2396   $result= false;
2397
2398   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
2399     if($fh= fopen($revision_file, "w")) {
2400       if(fwrite($fh, $revision)) {
2401         $result= true;
2402       }
2403     }
2404     fclose($fh);
2405   } else {
2406     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
2407   }
2408
2409   return $result;
2410 }
2411
2412
2413 function compare_revision($revision_file, $revision)
2414 {
2415   // false means revision differs
2416   $result= false;
2417
2418   if(file_exists($revision_file) && is_readable($revision_file)) {
2419     // Open file
2420     if($fh= fopen($revision_file, "r")) {
2421       // Compare File contents with current revision
2422       if($revision == fread($fh, filesize($revision_file))) {
2423         $result= true;
2424       }
2425     } else {
2426       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
2427     }
2428     // Close file
2429     fclose($fh);
2430   }
2431
2432   return $result;
2433 }
2434
2435
2436 /*! \brief Return HTML for a progressbar
2437  *
2438  * \code
2439  * $smarty->assign("installprogress", progressbar($current_progress_in_percent),100,15,true);
2440  * \endcode
2441  *
2442  * \param int 'percentage' Value to display
2443  * \param int 'width' width of the resulting output
2444  * \param int 'height' height of the resulting output
2445  * \param boolean 'showtext' weither to show the percentage in the progressbar or not
2446  * */
2447 function progressbar($percentage, $width= 200, $height= 14, $showText= false, $colorize= true, $id= "")
2448 {
2449   $text= "";
2450   $class= "";
2451   $style= "width:${width}px;height:${height}px;";
2452
2453   // Fix percentage range
2454   $percentage= floor($percentage);
2455   if ($percentage > 100) {
2456     $percentage= 100;
2457   }
2458   if ($percentage < 0) {
2459     $percentage= 0;
2460   }
2461
2462   // Only show text if we're above 10px height
2463   if ($showText && $height>10){
2464     $text= $percentage."%";
2465   }
2466
2467   // Set font size
2468   $style.= "font-size:".($height-3)."px;";
2469
2470   // Set color
2471   if ($colorize){
2472     if ($percentage < 70) {
2473       $class= " progress-low";
2474     } elseif ($percentage < 80) {
2475       $class= " progress-mid";
2476     } elseif ($percentage < 90) {
2477       $class= " progress-high";
2478     } else {
2479       $class= " progress-full";
2480     }
2481   }
2482
2483   // Apply gradients
2484   $hoffset= floor($height / 2) + 4;
2485   $woffset= floor(($width+5) * (100-$percentage) / 100);
2486   foreach (array("-moz-box-shadow", "-webkit-box-shadow", "box-shadow") as $type) {
2487     $style.="$type:
2488                    0 0 2px rgba(255, 255, 255, 0.4) inset,
2489                    0 4px 6px rgba(255, 255, 255, 0.4) inset,
2490                    0 ".$hoffset."px 0 -2px rgba(255, 255, 255, 0.2) inset,
2491                    -".$woffset."px 0 0 -2px rgba(255, 255, 255, 0.2) inset,
2492                    -".($woffset+1)."px 0 0 -2px rgba(0, 0, 0, 0.6) inset,
2493                    0pt ".($hoffset+1)."px 8px rgba(0, 0, 0, 0.3) inset,
2494                    0pt 1px 0px rgba(0, 0, 0, 0.2);";
2495   }
2496
2497   // Set ID
2498   if ($id != ""){
2499     $id= "id='$id'";
2500   }
2501
2502   return "<div class='progress$class' $id style='$style'>$text</div>";
2503 }
2504
2505
2506 /*! \brief Lookup a key in an array case-insensitive
2507  *
2508  * Given an associative array this can lookup the value of
2509  * a certain key, regardless of the case.
2510  *
2511  * \code
2512  * $items = array ('FOO' => 'blub', 'bar' => 'blub');
2513  * array_key_ics('foo', $items); # Returns 'blub'
2514  * array_key_ics('BAR', $items); # Returns 'blub'
2515  * \endcode
2516  *
2517  * \param string 'key' needle
2518  * \param array 'items' haystack
2519  */
2520 function array_key_ics($ikey, $items)
2521 {
2522   $tmp= array_change_key_case($items, CASE_LOWER);
2523   $ikey= strtolower($ikey);
2524   if (isset($tmp[$ikey])){
2525     return($tmp[$ikey]);
2526   }
2527
2528   return ('');
2529 }
2530
2531
2532 /*! \brief Determine if two arrays are different
2533  *
2534  * \param array 'src'
2535  * \param array 'dst'
2536  * \return boolean TRUE or FALSE
2537  * */
2538 function array_differs($src, $dst)
2539 {
2540   /* If the count is differing, the arrays differ */
2541   if (count ($src) != count ($dst)){
2542     return (TRUE);
2543   }
2544
2545   return (count(array_diff($src, $dst)) != 0);
2546 }
2547
2548
2549 function saveFilter($a_filter, $values)
2550 {
2551   if (isset($_POST['regexit'])){
2552     $a_filter["regex"]= $_POST['regexit'];
2553
2554     foreach($values as $type){
2555       if (isset($_POST[$type])) {
2556         $a_filter[$type]= "checked";
2557       } else {
2558         $a_filter[$type]= "";
2559       }
2560     }
2561   }
2562
2563   /* React on alphabet links if needed */
2564   if (isset($_GET['search'])){
2565     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2566     if ($s == "**"){
2567       $s= "*";
2568     }
2569     $a_filter['regex']= $s;
2570   }
2571
2572   return ($a_filter);
2573 }
2574
2575
2576 /*! \brief Escape all LDAP filter relevant characters */
2577 function normalizeLdap($input)
2578 {
2579   return (addcslashes($input, '()|'));
2580 }
2581
2582
2583 /*! \brief Return the gosa base directory */
2584 function get_base_dir()
2585 {
2586   global $BASE_DIR;
2587
2588   return $BASE_DIR;
2589 }
2590
2591
2592 /*! \brief Test weither we are allowed to read the object */
2593 function obj_is_readable($dn, $object, $attribute)
2594 {
2595   global $ui;
2596
2597   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2598 }
2599
2600
2601 /*! \brief Test weither we are allowed to change the object */
2602 function obj_is_writable($dn, $object, $attribute)
2603 {
2604   global $ui;
2605
2606   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2607 }
2608
2609
2610 /*! \brief Explode a DN into its parts
2611  *
2612  * Similar to explode (http://php.net/explode), but a bit more specific
2613  * for the needs when splitting, exploding LDAP DNs.
2614  *
2615  * \param string 'dn' the DN to split
2616  * \param config-object a config object. only neeeded if DN shall be verified in the LDAP
2617  * \param boolean verify_in_ldap check weither DN is valid
2618  *
2619  */
2620 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2621 {
2622   /* Initialize variables */
2623   $ret  = array("count" => 0);  // Set count to 0
2624   $next = true;                 // if false, then skip next loops and return
2625   $cnt  = 0;                    // Current number of loops
2626   $max  = 100;                  // Just for security, prevent looops
2627   $ldap = NULL;                 // To check if created result a valid
2628   $keep = "";                   // save last failed parse string
2629
2630   /* Check each parsed dn in ldap ? */
2631   if($config!==NULL && $verify_in_ldap){
2632     $ldap = $config->get_ldap_link();
2633   }
2634
2635   /* Lets start */
2636   $called = false;
2637   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2638
2639     $cnt ++;
2640     if(!preg_match("/,/",$dn)){
2641       $next = false;
2642     }
2643     $object = preg_replace("/[,].*$/","",$dn);
2644     $dn     = preg_replace("/^[^,]+,/","",$dn);
2645
2646     $called = true;
2647
2648     /* Check if current dn is valid */
2649     if($ldap!==NULL){
2650       $ldap->cd($dn);
2651       $ldap->cat($dn,array("dn"));
2652       if($ldap->count()){
2653         $ret[]  = $keep.$object;
2654         $keep   = "";
2655       }else{
2656         $keep  .= $object.",";
2657       }
2658     }else{
2659       $ret[]  = $keep.$object;
2660       $keep   = "";
2661     }
2662   }
2663
2664   /* No dn was posted */
2665   if($cnt == 0 && !empty($dn)){
2666     $ret[] = $dn;
2667   }
2668
2669   /* Append the rest */
2670   $test = $keep.$dn;
2671   if($called && !empty($test)){
2672     $ret[] = $keep.$dn;
2673   }
2674   $ret['count'] = count($ret) - 1;
2675
2676   return($ret);
2677 }
2678
2679
2680 function get_base_from_hook($dn, $attrib)
2681 {
2682   global $config;
2683
2684   if ($config->get_cfg_value("baseIdHook") != ""){
2685
2686     /* Call hook script - if present */
2687     $command= $config->get_cfg_value("baseIdHook");
2688
2689     if ($command != ""){
2690       $command.= " '".LDAP::fix($dn)."' $attrib";
2691       if (check_command($command)){
2692         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2693         exec($command, $output);
2694         if (preg_match("/^[0-9]+$/", $output[0])){
2695           return ($output[0]);
2696         } else {
2697           msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2698           return ($config->get_cfg_value("uidNumberBase"));
2699         }
2700       } else {
2701         msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2702         return ($config->get_cfg_value("uidNumberBase"));
2703       }
2704
2705     } else {
2706
2707       msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2708       return ($config->get_cfg_value("uidNumberBase"));
2709
2710     }
2711   }
2712 }
2713
2714
2715 /*! \brief Check if schema version matches the requirements */
2716 function check_schema_version($class, $version)
2717 {
2718   return preg_match("/\(v$version\)/", $class['DESC']);
2719 }
2720
2721
2722 /*! \brief Check if LDAP schema matches the requirements */
2723 function check_schema($cfg,$rfc2307bis = FALSE)
2724 {
2725   $messages= array();
2726
2727   /* Get objectclasses */
2728   $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE, $cfg['tls']));
2729   $objectclasses = $ldap->get_objectclasses();
2730   if(count($objectclasses) == 0){
2731     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2732   }
2733
2734   /* This is the default block used for each entry.
2735    *  to avoid unset indexes.
2736    */
2737   $def_check = array("REQUIRED_VERSION" => "0",
2738       "SCHEMA_FILES"     => array(),
2739       "CLASSES_REQUIRED" => array(),
2740       "STATUS"           => FALSE,
2741       "IS_MUST_HAVE"     => FALSE,
2742       "MSG"              => "",
2743       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2744
2745   /* The gosa base schema */
2746   $checks['gosaObject'] = $def_check;
2747   $checks['gosaObject']['REQUIRED_VERSION'] = "2.6.1";
2748   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa-samba3.schema","gosa-samba2.schema");
2749   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2750   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2751
2752   /* GOsa Account class */
2753   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.6.6";
2754   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa-samba3.schema","gosa-samba2.schema");
2755   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2756   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2757   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2758
2759   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2760   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.6.1";
2761   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa-samba3.schema","gosa-samba2.schema");
2762   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2763   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2764   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2765
2766   /* Some other checks */
2767   foreach(array(
2768         "gosaCacheEntry"        => array("version" => "2.6.1", "class" => "gosaAccount"),
2769         "gosaDepartment"        => array("version" => "2.6.1", "class" => "gosaAccount"),
2770         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2771         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2772         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2773         "gosaUserTemplate"      => array("version" => "2.6.1", "class" => "posixAccount","file" => "nis.schema"),
2774         "gosaMailAccount"       => array("version" => "2.6.1", "class" => "mailAccount","file" => "gosa-samba3.schema"),
2775         "gosaProxyAccount"      => array("version" => "2.6.1", "class" => "proxyAccount","file" => "gosa-samba3.schema"),
2776         "gosaApplication"       => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"),
2777         "gosaApplicationGroup"  => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"),
2778         "GOhard"                => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2779         "gotoTerminal"          => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2780         "goServer"              => array("version" => "2.6.1", "class" => "server","file" => "goserver.schema"),
2781         "goTerminalServer"      => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2782         "goShareServer"         => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2783         "goNtpServer"           => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2784         "goSyslogServer"        => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2785         "goLdapServer"          => array("version" => "2.6.1", "class" => "goServer"),
2786         "goCupsServer"          => array("version" => "2.6.1", "class" => array("posixAccount", "terminals"),),
2787         "goImapServer"          => array("version" => "2.6.1", "class" => array("mailAccount", "mailgroup"),"file" => "gosa-samba3.schema"),
2788         "goKrbServer"           => array("version" => "2.6.1", "class" => "goServer"),
2789         "goFaxServer"           => array("version" => "2.6.1", "class" => "gofaxAccount","file" => "gofax.schema"),
2790         ) as $name => $values){
2791
2792           $checks[$name] = $def_check;
2793           if(isset($values['version'])){
2794             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2795           }
2796           if(isset($values['file'])){
2797             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2798           }
2799           if (isset($values['class'])) {
2800             $checks[$name]["CLASSES_REQUIRED"] = is_array($values['class'])?$values['class']:array($values['class']);
2801           }
2802         }
2803   foreach($checks as $name => $value){
2804     foreach($value['CLASSES_REQUIRED'] as $class){
2805
2806       if(!isset($objectclasses[$name])){
2807         if($value['IS_MUST_HAVE']){
2808           $checks[$name]['STATUS'] = FALSE;
2809           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2810         } else {
2811           $checks[$name]['STATUS'] = TRUE;
2812           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2813         }
2814       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2815         $checks[$name]['STATUS'] = FALSE;
2816
2817         $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2818       }else{
2819         $checks[$name]['STATUS'] = TRUE;
2820         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2821       }
2822     }
2823   }
2824
2825   $tmp = $objectclasses;
2826
2827   /* The gosa base schema */
2828   $checks['posixGroup'] = $def_check;
2829   $checks['posixGroup']['REQUIRED_VERSION'] = "2.6.1";
2830   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa-samba3.schema","gosa-samba2.schema");
2831   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2832   $checks['posixGroup']['STATUS']           = TRUE;
2833   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2834   $checks['posixGroup']['MSG']              = "";
2835   $checks['posixGroup']['INFO']             = "";
2836
2837   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2838   if(isset($tmp['posixGroup'])){
2839
2840     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2841       $checks['posixGroup']['STATUS']           = FALSE;
2842       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2843       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2844     }
2845     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2846       $checks['posixGroup']['STATUS']           = FALSE;
2847       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2848       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2849     }
2850   }
2851
2852   return($checks);
2853 }
2854
2855
2856 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2857 {
2858   $tmp = array(
2859         "de_DE" => "German",
2860         "fr_FR" => "French",
2861         "it_IT" => "Italian",
2862         "es_ES" => "Spanish",
2863         "en_US" => "English",
2864         "nl_NL" => "Dutch",
2865         "pl_PL" => "Polish",
2866         "pt_BR" => "Brazilian Portuguese",
2867         #"sv_SE" => "Swedish",
2868         "zh_CN" => "Chinese",
2869         "vi_VN" => "Vietnamese",
2870         "ru_RU" => "Russian");
2871
2872   $tmp2= array(
2873         "de_DE" => _("German"),
2874         "fr_FR" => _("French"),
2875         "it_IT" => _("Italian"),
2876         "es_ES" => _("Spanish"),
2877         "en_US" => _("English"),
2878         "nl_NL" => _("Dutch"),
2879         "pl_PL" => _("Polish"),
2880         "pt_BR" => _("Brazilian Portuguese"),
2881         #"sv_SE" => _("Swedish"),
2882         "zh_CN" => _("Chinese"),
2883         "vi_VN" => _("Vietnamese"),
2884         "ru_RU" => _("Russian"));
2885
2886   $ret = array();
2887   if($languages_in_own_language){
2888
2889     $old_lang = setlocale(LC_ALL, 0);
2890
2891     /* If the locale wasn't correclty set before, there may be an incorrect
2892         locale returned. Something like this:
2893           C_CTYPE=de_DE.UTF-8;LC_NUMERIC=C;LC_TIME=de_DE.UTF-8;LC ...
2894         Extract the locale name from this string and use it to restore old locale.
2895      */
2896     if(preg_match("/LC_CTYPE/",$old_lang)){
2897       $old_lang = preg_replace("/^.*LC_CTYPE=([^;]*).*$/","\\1",$old_lang);
2898     }
2899
2900     foreach($tmp as $key => $name){
2901       $lang = $key.".UTF-8";
2902       setlocale(LC_ALL, $lang);
2903       if($strip_region_tag){
2904         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2905       }else{
2906         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2907       }
2908     }
2909     setlocale(LC_ALL, $old_lang);
2910   }else{
2911     foreach($tmp as $key => $name){
2912       if($strip_region_tag){
2913         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2914       }else{
2915         $ret[$key] = _($name);
2916       }
2917     }
2918   }
2919   return($ret);
2920 }
2921
2922
2923 /*! \brief Returns contents of the given POST variable and check magic quotes settings
2924  *
2925  * Depending on the magic quotes settings this returns a stripclashed'ed version of
2926  * a certain POST variable.
2927  *
2928  * \param string 'name' the POST var to return ($_POST[$name])
2929  * \return string
2930  * */
2931 function get_post($name)
2932 {
2933   if(!isset($_POST[$name])){
2934     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2935     return(FALSE);
2936   }
2937
2938   if(get_magic_quotes_gpc()){
2939     return(stripcslashes(validate($_POST[$name])));
2940   }else{
2941     return(validate($_POST[$name]));
2942   }
2943 }
2944
2945
2946 /*! \brief Return class name in correct case */
2947 function get_correct_class_name($cls)
2948 {
2949   global $class_mapping;
2950   if(isset($class_mapping) && is_array($class_mapping)){
2951     foreach($class_mapping as $class => $file){
2952       if(preg_match("/^".$cls."$/i",$class)){
2953         return($class);
2954       }
2955     }
2956   }
2957   return(FALSE);
2958 }
2959
2960
2961 /*! \brief Change the password of a given DN
2962  *
2963  * Change the password of a given DN with the specified hash.
2964  *
2965  * \param string 'dn' the DN whose password shall be changed
2966  * \param string 'password' the password
2967  * \param int mode
2968  * \param string 'hash' which hash to use to encrypt it, default is empty
2969  * for cleartext storage.
2970  * \return boolean TRUE on success FALSE on error
2971  */
2972 function change_password ($dn, $password, $mode=0, $hash= "")
2973 {
2974   global $config;
2975   $newpass= "";
2976
2977   /* Convert to lower. Methods are lowercase */
2978   $hash= strtolower($hash);
2979
2980   // Get all available encryption Methods
2981
2982   // NON STATIC CALL :)
2983   $methods = new passwordMethod(session::get('config'));
2984   $available = $methods->get_available_methods();
2985
2986   // read current password entry for $dn, to detect the encryption Method
2987   $ldap       = $config->get_ldap_link();
2988   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2989   $attrs      = $ldap->fetch ();
2990
2991   /* Is ensure that clear passwords will stay clear */
2992   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2993     $hash = "clear";
2994   }
2995
2996   // Detect the encryption Method
2997   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2998
2999     /* Check for supported algorithm */
3000     mt_srand((double) microtime()*1000000);
3001
3002     /* Extract used hash */
3003     if ($hash == ""){
3004       $test = passwordMethod::get_method($attrs['userPassword'][0],$dn);
3005     } else {
3006       $test = new $available[$hash]($config,$dn);
3007       $test->set_hash($hash);
3008     }
3009
3010   } else {
3011     // User MD5 by default
3012     $hash= "md5";
3013     $test = new  $available['md5']($config);
3014   }
3015
3016   if($test instanceOf passwordMethod){
3017
3018     $deactivated = $test->is_locked($config,$dn);
3019
3020     /* Feed password backends with information */
3021     $test->dn= $dn;
3022     $test->attrs= $attrs;
3023     $newpass= $test->generate_hash($password);
3024
3025     // Update shadow timestamp?
3026     if (isset($attrs["shadowLastChange"][0])){
3027       $shadow= (int)(date("U") / 86400);
3028     } else {
3029       $shadow= 0;
3030     }
3031
3032     // Write back modified entry
3033     $ldap->cd($dn);
3034     $attrs= array();
3035
3036     // Not for groups
3037     if ($mode == 0){
3038       // Create SMB Password
3039       $attrs= generate_smb_nt_hash($password);
3040
3041       if ($shadow != 0){
3042         $attrs['shadowLastChange']= $shadow;
3043       }
3044     }
3045
3046     $attrs['userPassword']= array();
3047     $attrs['userPassword']= $newpass;
3048
3049     $ldap->modify($attrs);
3050
3051     /* Read ! if user was deactivated */
3052     if($deactivated){
3053       $test->lock_account($config,$dn);
3054     }
3055
3056     new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
3057
3058     if (!$ldap->success()) {
3059       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG));
3060     } else {
3061
3062       /* Run backend method for change/create */
3063       if(!$test->set_password($password)){
3064         return(FALSE);
3065       }
3066
3067       /* Find postmodify entries for this class */
3068       $command= $config->search("password", "POSTMODIFY",array('menu'));
3069
3070       if ($command != ""){
3071         /* Walk through attribute list */
3072         $command= preg_replace("/%userPassword/", $password, $command);
3073         $command= preg_replace("/%dn/", $dn, $command);
3074
3075         if (check_command($command)){
3076           @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
3077           exec($command);
3078         } else {
3079           $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
3080           msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
3081         }
3082       }
3083     }
3084     return(TRUE);
3085   }
3086 }
3087
3088
3089 /*! \brief Generate samba hashes
3090  *
3091  * Given a certain password this constructs an array like
3092  * array['sambaLMPassword'] etc.
3093  *
3094  * \param string 'password'
3095  * \return array contains several keys for lmPassword, ntPassword, pwdLastSet, etc. depending
3096  * on the samba version
3097  */
3098 function generate_smb_nt_hash($password)
3099 {
3100   global $config;
3101
3102   # Try to use gosa-si?
3103   if ($config->get_cfg_value("gosaSupportURI") != ""){
3104         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
3105     if (isset($res['XML']['HASH'])){
3106         $hash= $res['XML']['HASH'];
3107     } else {
3108       $hash= "";
3109     }
3110
3111     if ($hash == "") {
3112       msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
3113       return ("");
3114     }
3115   } else {
3116           $tmp= $config->get_cfg_value('sambaHashHook')." ".escapeshellarg($password);
3117           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
3118
3119           exec($tmp, $ar);
3120           flush();
3121           reset($ar);
3122           $hash= current($ar);
3123
3124     if ($hash == "") {
3125       msg_dialog::display(_("Configuration error"), sprintf(_("Cannot generate samba hash: running '%s' failed, check the 'sambaHashHook'!"),$config->get_cfg_value('sambaHashHook')), ERROR_DIALOG);
3126       return ("");
3127     }
3128   }
3129
3130   list($lm,$nt)= explode(":", trim($hash));
3131
3132   $attrs['sambaLMPassword']= $lm;
3133   $attrs['sambaNTPassword']= $nt;
3134   $attrs['sambaPwdLastSet']= date('U');
3135   $attrs['sambaBadPasswordCount']= "0";
3136   $attrs['sambaBadPasswordTime']= "0";
3137   return($attrs);
3138 }
3139
3140
3141 /*! \brief Get the Change Sequence Number of a certain DN
3142  *
3143  * To verify if a given object has been changed outside of Gosa
3144  * in the meanwhile, this function can be used to get the entryCSN
3145  * from the LDAP directory. It uses the attribute as configured
3146  * in modificationDetectionAttribute
3147  *
3148  * \param string 'dn'
3149  * \return either the result or "" in any other case
3150  */
3151 function getEntryCSN($dn)
3152 {
3153   global $config;
3154   if(empty($dn) || !is_object($config)){
3155     return("");
3156   }
3157
3158   /* Get attribute that we should use as serial number */
3159   $attr= $config->get_cfg_value("modificationDetectionAttribute");
3160   if($attr != ""){
3161     $ldap = $config->get_ldap_link();
3162     $ldap->cat($dn,array($attr));
3163     $csn = $ldap->fetch();
3164     if(isset($csn[$attr][0])){
3165       return($csn[$attr][0]);
3166     }
3167   }
3168   return("");
3169 }
3170
3171
3172 /*! \brief Add (a) given objectClass(es) to an attrs entry
3173  *
3174  * The function adds the specified objectClass(es) to the given
3175  * attrs entry.
3176  *
3177  * \param mixed 'classes' Either a single objectClass or several objectClasses
3178  * as an array
3179  * \param array 'attrs' The attrs array to be modified.
3180  *
3181  * */
3182 function add_objectClass($classes, &$attrs)
3183 {
3184   if (is_array($classes)){
3185     $list= $classes;
3186   } else {
3187     $list= array($classes);
3188   }
3189
3190   foreach ($list as $class){
3191     $attrs['objectClass'][]= $class;
3192   }
3193 }
3194
3195
3196 /*! \brief Removes a given objectClass from the attrs entry
3197  *
3198  * Similar to add_objectClass, except that it removes the given
3199  * objectClasses. See it for the params.
3200  * */
3201 function remove_objectClass($classes, &$attrs)
3202 {
3203   if (isset($attrs['objectClass'])){
3204     /* Array? */
3205     if (is_array($classes)){
3206       $list= $classes;
3207     } else {
3208       $list= array($classes);
3209     }
3210
3211     $tmp= array();
3212     foreach ($attrs['objectClass'] as $oc) {
3213       foreach ($list as $class){
3214         if (strtolower($oc) != strtolower($class)){
3215           $tmp[]= $oc;
3216         }
3217       }
3218     }
3219     $attrs['objectClass']= $tmp;
3220   }
3221 }
3222
3223
3224 /*! \brief  Initialize a file download with given content, name and data type.
3225  *  \param  string data The content to send.
3226  *  \param  string name The name of the file.
3227  *  \param  string type The content identifier, default value is "application/octet-stream";
3228  */
3229 function send_binary_content($data,$name,$type = "application/octet-stream")
3230 {
3231   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
3232   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
3233   header("Cache-Control: no-cache");
3234   header("Pragma: no-cache");
3235   header("Cache-Control: post-check=0, pre-check=0");
3236   header("Content-type: ".$type."");
3237
3238   $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
3239
3240   /* Strip name if it is a complete path */
3241   if (preg_match ("/\//", $name)) {
3242         $name= basename($name);
3243   }
3244
3245   /* force download dialog */
3246   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
3247     header('Content-Disposition: filename="'.$name.'"');
3248   } else {
3249     header('Content-Disposition: attachment; filename="'.$name.'"');
3250   }
3251
3252   echo $data;
3253   exit();
3254 }
3255
3256
3257 function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8")
3258 {
3259   if(is_string($str)){
3260     return(htmlentities($str,$type,$charset));
3261   }elseif(is_array($str)){
3262     foreach($str as $name => $value){
3263       $str[$name] = reverse_html_entities($value,$type,$charset);
3264     }
3265   }
3266   return($str);
3267 }
3268
3269
3270 /*! \brief Encode special string characters so we can use the string in \
3271            HTML output, without breaking quotes.
3272     \param string The String we want to encode.
3273     \return string The encoded String
3274  */
3275 function xmlentities($str)
3276 {
3277   if(is_string($str)){
3278
3279     static $asc2uni= array();
3280     if (!count($asc2uni)){
3281       for($i=128;$i<256;$i++){
3282     #    $asc2uni[chr($i)] = "&#x".dechex($i).";";
3283       }
3284     }
3285
3286     $str = str_replace("&", "&amp;", $str);
3287     $str = str_replace("<", "&lt;", $str);
3288     $str = str_replace(">", "&gt;", $str);
3289     $str = str_replace("'", "&apos;", $str);
3290     $str = str_replace("\"", "&quot;", $str);
3291     $str = str_replace("\r", "", $str);
3292     $str = strtr($str,$asc2uni);
3293     return $str;
3294   }elseif(is_array($str)){
3295     foreach($str as $name => $value){
3296       $str[$name] = xmlentities($value);
3297     }
3298   }
3299   return($str);
3300 }
3301
3302
3303 /*! \brief  Updates all accessTo attributes from a given value to a new one.
3304             For example if a host is renamed.
3305     \param  String  $from The source accessTo name.
3306     \param  String  $to   The destination accessTo name.
3307 */
3308 function update_accessTo($from,$to)
3309 {
3310   global $config;
3311   $ldap = $config->get_ldap_link();
3312   $ldap->cd($config->current['BASE']);
3313   $ldap->search("(&(objectClass=trustAccount)(accessTo=".$from."))",array("objectClass","accessTo"));
3314   while($attrs = $ldap->fetch()){
3315     $new_attrs = array("accessTo" => array());
3316     $dn = $attrs['dn'];
3317     for($i = 0 ; $i < $attrs['objectClass']['count']; $i++){
3318       $new_attrs['objectClass'][] =  $attrs['objectClass'][$i];
3319     }
3320     for($i = 0 ; $i < $attrs['accessTo']['count']; $i++){
3321       if($attrs['accessTo'][$i] == $from){
3322         if(!empty($to)){
3323           $new_attrs['accessTo'][] =  $to;
3324         }
3325       }else{
3326         $new_attrs['accessTo'][] =  $attrs['accessTo'][$i];
3327       }
3328     }
3329     $ldap->cd($dn);
3330     $ldap->modify($new_attrs);
3331     if (!$ldap->success()){
3332       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, "update_accessTo($from,$to)"));
3333     }
3334     new log("modify","update_accessTo($from,$to)",$dn,array_keys($new_attrs),$ldap->get_error());
3335   }
3336 }
3337
3338
3339 /*! \brief Returns a random char */
3340 function get_random_char () {
3341      $randno = rand (0, 63);
3342      if ($randno < 12) {
3343          return (chr ($randno + 46)); // Digits, '/' and '.'
3344      } else if ($randno < 38) {
3345          return (chr ($randno + 53)); // Uppercase
3346      } else {
3347          return (chr ($randno + 59)); // Lowercase
3348      }
3349 }
3350
3351
3352 function cred_encrypt($input, $password) {
3353
3354   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
3355   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
3356
3357   return bin2hex(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $password, $input, MCRYPT_MODE_ECB, $iv));
3358
3359 }
3360
3361
3362 function cred_decrypt($input,$password) {
3363   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
3364   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
3365
3366   return mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $password, pack("H*", $input), MCRYPT_MODE_ECB, $iv);
3367 }
3368
3369
3370 function get_object_info()
3371 {
3372   return(session::get('objectinfo'));
3373 }
3374
3375
3376 function set_object_info($str = "")
3377 {
3378   session::set('objectinfo',$str);
3379 }
3380
3381
3382 function isIpInNet($ip, $net, $mask) {
3383    // Move to long ints
3384    $ip= ip2long($ip);
3385    $net= ip2long($net);
3386    $mask= ip2long($mask);
3387
3388    // Mask given IP with mask. If it returns "net", we're in...
3389    $res= $ip & $mask;
3390
3391    return ($res == $net);
3392 }
3393
3394
3395 function get_next_id($attrib, $dn)
3396 {
3397   global $config;
3398
3399   switch ($config->get_cfg_value("idAllocationMethod", "traditional")){
3400     case "pool":
3401       return get_next_id_pool($attrib);
3402     case "traditional":
3403       return get_next_id_traditional($attrib, $dn);
3404   }
3405
3406   msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("unknown idAllocation method!"), ERROR_DIALOG);
3407   return null;
3408 }
3409
3410
3411 function get_next_id_pool($attrib) {
3412   global $config;
3413
3414   /* Fill informational values */
3415   $min= $config->get_cfg_value("${attrib}PoolMin", 10000);
3416   $max= $config->get_cfg_value("${attrib}PoolMax", 40000);
3417
3418   /* Sanity check */
3419   if ($min >= $max) {
3420     msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." ".sprintf(_("%sPoolMin >= %sPoolMax!"), $attrib), ERROR_DIALOG);
3421     return null;
3422   }
3423
3424   /* ID to skip */
3425   $ldap= $config->get_ldap_link();
3426   $id= null;
3427
3428   /* Try to allocate the ID several times before failing */
3429   $tries= 3;
3430   while ($tries--) {
3431
3432     /* Look for ID map entry */
3433     $ldap->cd ($config->current['BASE']);
3434     $ldap->search ("(&(objectClass=sambaUnixIdPool)($attrib=*))", array("$attrib"));
3435
3436     /* If it does not exist, create one with these defaults */
3437     if ($ldap->count() == 0) {
3438       /* Fill informational values */
3439       $minUserId= $config->get_cfg_value("uidPoolMin", 10000);
3440       $minGroupId= $config->get_cfg_value("gidPoolMin", 10000);
3441
3442       /* Add as default */
3443       $attrs= array("objectClass" => array("organizationalUnit", "sambaUnixIdPool"));
3444       $attrs["ou"]= "idmap";
3445       $attrs["uidNumber"]= $minUserId;
3446       $attrs["gidNumber"]= $minGroupId;
3447       $ldap->cd("ou=idmap,".$config->current['BASE']);
3448       $ldap->add($attrs);
3449       if ($ldap->error != "Success") {
3450         msg_dialog::display(_("Error"), _("Cannot create sambaUnixIdPool entry!"), ERROR_DIALOG);
3451         return null;
3452       }
3453       $tries++;
3454       continue;
3455     }
3456     /* Bail out if it's not unique */
3457     if ($ldap->count() != 1) {
3458       msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("sambaUnixIdPool is not unique!"), ERROR_DIALOG);
3459       return null;
3460     }
3461
3462     /* Store old attrib and generate new */
3463     $attrs= $ldap->fetch();
3464     $dn= $ldap->getDN();
3465     $oldAttr= $attrs[$attrib][0];
3466     $newAttr= $oldAttr + 1;
3467
3468     /* Sanity check */
3469     if ($newAttr >= $max) {
3470       msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("no ID available!"), ERROR_DIALOG);
3471       return null;
3472     }
3473     if ($newAttr < $min) {
3474       msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("no ID available!"), ERROR_DIALOG);
3475       return null;
3476     }
3477
3478     #FIXME: PHP is not able to do a modification of "del: .../add: ...", so this
3479     #       is completely unsafe in the moment.
3480     #/* Remove old attr, add new attr */
3481     #$attrs= array($attrib => $oldAttr);
3482     #$ldap->rm($attrs, $dn);
3483     #if ($ldap->error != "Success") {
3484     #  continue;
3485     #}
3486     $ldap->cd($dn);
3487     $ldap->modify(array($attrib => $newAttr));
3488     if ($ldap->error != "Success") {
3489       msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." ".$ldap->get_error(), ERROR_DIALOG);
3490       return null;
3491     } else {
3492       return $oldAttr;
3493     }
3494   }
3495
3496   /* Bail out if we had problems getting the next id */
3497   if (!$tries) {
3498     msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("maximum tries exceeded!"), ERROR_DIALOG);
3499   }
3500
3501   return $id;
3502 }
3503
3504
3505 function get_next_id_traditional($attrib, $dn)
3506 {
3507   global $config;
3508
3509   $ids= array();
3510   $ldap= $config->get_ldap_link();
3511
3512   $ldap->cd ($config->current['BASE']);
3513   if (preg_match('/gidNumber/i', $attrib)){
3514     $oc= "posixGroup";
3515   } else {
3516     $oc= "posixAccount";
3517   }
3518   $ldap->search ("(&(objectClass=$oc)($attrib=*))", array("$attrib"));
3519
3520   /* Get list of ids */
3521   while ($attrs= $ldap->fetch()){
3522     $ids[]= (int)$attrs["$attrib"][0];
3523   }
3524
3525   /* Add the nobody id */
3526   $ids[]= 65534;
3527
3528   /* get the ranges */
3529   $tmp = array('0'=> 1000);
3530   if (preg_match('/posixAccount/', $oc) && $config->get_cfg_value("uidNumberBase") != ""){
3531     $tmp= explode('-',$config->get_cfg_value("uidNumberBase"));
3532   } elseif($config->get_cfg_value("gidNumberBase") != ""){
3533     $tmp= explode('-',$config->get_cfg_value("gidNumberBase"));
3534   }
3535
3536   /* Set hwm to max if not set - for backward compatibility */
3537   $lwm= $tmp[0];
3538   if (isset($tmp[1])){
3539     $hwm= $tmp[1];
3540   } else {
3541     $hwm= pow(2,32);
3542   }
3543   /* Find out next free id near to UID_BASE */
3544   if ($config->get_cfg_value("baseIdHook") == ""){
3545     $base= $lwm;
3546   } else {
3547     /* Call base hook */
3548     $base= get_base_from_hook($dn, $attrib);
3549   }
3550   for ($id= $base; $id++; $id < pow(2,32)){
3551     if (!in_array($id, $ids)){
3552       return ($id);
3553     }
3554   }
3555
3556   /* Should not happen */
3557   if ($id == $hwm){
3558     msg_dialog::display(_("Error"), _("Cannot allocate a free ID!"), ERROR_DIALOG);
3559     exit;
3560   }
3561 }
3562
3563
3564 /* Mark the occurance of a string with a span */
3565 function mark($needle, $haystack, $ignorecase= true)
3566 {
3567   $result= "";
3568
3569   while (preg_match('/^(.*)('.preg_quote($needle).')(.*)$/i', $haystack, $matches)) {
3570     $result.= $matches[1]."<span class='mark'>".$matches[2]."</span>";
3571     $haystack= $matches[3];
3572   }
3573
3574   return $result.$haystack;
3575 }
3576
3577
3578 /* Return an image description using the path */
3579 function image($path, $action= "", $title= "", $align= "middle")
3580 {
3581   global $config;
3582   global $BASE_DIR;
3583   $label= null;
3584
3585   // Bail out, if there's no style file
3586   if(!session::global_is_set("img-styles")){
3587
3588     // Get theme
3589     if (isset ($config)){
3590       $theme= $config->get_cfg_value("theme", "default");
3591     } else {
3592       # For debuging - avoid that there's no theme set
3593       die("config not set!");
3594       $theme= "default";
3595     }
3596
3597     if (!file_exists("$BASE_DIR/ihtml/themes/$theme/img.styles")){
3598       die ("No img.style for this theme found!");
3599     }
3600
3601     session::global_set('img-styles', unserialize(file_get_contents("$BASE_DIR/ihtml/themes/$theme/img.styles")));
3602   }
3603   $styles= session::global_get('img-styles');
3604
3605   /* Extract labels from path */
3606   if (preg_match("/\.png\[(.*)\]$/", $path, $matches)) {
3607     $label= $matches[1];
3608   }
3609
3610   $lbl= "";
3611   if ($label) {
3612     if (isset($styles["images/label-".$label.".png"])) {
3613       $lbl= "<div style='".$styles["images/label-".$label.".png"]."'></div>";
3614     } else {
3615       die("Invalid label specified: $label\n");
3616     }
3617
3618     $path= preg_replace("/\[.*\]$/", "", $path);
3619   }
3620
3621   // Non middle layout?
3622   if ($align == "middle") {
3623     $align= "";
3624   } else {
3625     $align= ";vertical-align:$align";
3626   }
3627
3628   // Clickable image or not?
3629   if ($title != "") {
3630     $title= "title='$title'";
3631   }
3632   if ($action == "") {
3633     return "<div class='img' $title style='".$styles[$path]."$align'>$lbl</div>";
3634   } else {
3635     return "<input type='submit' class='img' id='$action' value='' name='$action' $title style='".$styles[$path]."$align'>";
3636   }
3637 }
3638
3639
3640 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
3641 ?>