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