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 /* Define globals for revision comparing */
  27 $svn_path = '$HeadURL$';
  28 $svn_revision = '$Revision$';
  29
  30 /* Configuration file location */
  31 if(!isset($_SERVER['CONFIG_DIR'])){
  32   define ("CONFIG_DIR", "/etc/gosa");
  33 }else{
  34   define ("CONFIG_DIR",$_SERVER['CONFIG_DIR']);
  35 }
  36
  37 /* Allow setting the config file in the apache configuration
  38     e.g.  SetEnv CONFIG_FILE gosa.conf.2.6
  39  */
  40 if(!isset($_SERVER['CONFIG_FILE'])){
  41   define ("CONFIG_FILE", "gosa.conf");
  42 }else{
  43   define ("CONFIG_FILE",$_SERVER['CONFIG_FILE']);
  44 }
  45
  46 /* Define common locatitions */
  47 define ("CONFIG_TEMPLATE_DIR", "../contrib");
  48 define ("TEMP_DIR","/var/cache/gosa/tmp");
  49
  50 /* Define get_list flags */
  51 define("GL_NONE",         0);
  52 define("GL_SUBSEARCH",    1);
  53 define("GL_SIZELIMIT",    2);
  54 define("GL_CONVERT",      4);
  55 define("GL_NO_ACL_CHECK", 8);
  56
  57 /* Heimdal stuff */
  58 define('UNIVERSAL',0x00);
  59 define('INTEGER',0x02);
  60 define('OCTET_STRING',0x04);
  61 define('OBJECT_IDENTIFIER ',0x06);
  62 define('SEQUENCE',0x10);
  63 define('SEQUENCE_OF',0x10);
  64 define('SET',0x11);
  65 define('SET_OF',0x11);
  66 define('DEBUG',false);
  67 define('HDB_KU_MKEY',0x484442);
  68 define('TWO_BIT_SHIFTS',0x7efc);
  69 define('DES_CBC_CRC',1);
  70 define('DES_CBC_MD4',2);
  71 define('DES_CBC_MD5',3);
  72 define('DES3_CBC_MD5',5);
  73 define('DES3_CBC_SHA1',16);
  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', get_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   return(TRUE);
1747   $cmd= preg_replace("/ .*$/", "", $cmdline);
1748
1749   /* Check if command exists in filesystem */
1750   if (!file_exists($cmd)){
1751     return (FALSE);
1752   }
1753
1754   /* Check if command is executable */
1755   if (!is_executable($cmd)){
1756     return (FALSE);
1757   }
1758
1759   return (TRUE);
1760 }
1761
1762
1763 /*! \brief Print plugin HTML header
1764  *
1765  * \param string 'image' the path of the image to be used next to the headline
1766  * \param string 'image' the headline
1767  * \param string 'info' additional information to print
1768  */
1769 function print_header($image, $headline, $info= "")
1770 {
1771   $display= "<div class=\"plugtop\">\n";
1772   $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";
1773   $display.= "</div>\n";
1774
1775   if ($info != ""){
1776     $display.= "<div class=\"pluginfo\">\n";
1777     $display.= "$info";
1778     $display.= "</div>\n";
1779   } else {
1780     $display.= "<div style=\"height:5px;\">\n";
1781     $display.= "&nbsp;";
1782     $display.= "</div>\n";
1783   }
1784   return ($display);
1785 }
1786
1787
1788 /*! \brief Print page number selector for paged lists
1789  *
1790  * \param int 'dcnt' Number of entries
1791  * \param int 'start' Page to start
1792  * \param int 'range' Number of entries per page
1793  * \param string 'post_var' POST variable to check for range
1794  */
1795 function range_selector($dcnt,$start,$range=25,$post_var=false)
1796 {
1797
1798   /* Entries shown left and right from the selected entry */
1799   $max_entries= 10;
1800
1801   /* Initialize and take care that max_entries is even */
1802   $output="";
1803   if ($max_entries & 1){
1804     $max_entries++;
1805   }
1806
1807   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1808     $range= $_POST[$post_var];
1809   }
1810
1811   /* Prevent output to start or end out of range */
1812   if ($start < 0 ){
1813     $start= 0 ;
1814   }
1815   if ($start >= $dcnt){
1816     $start= $range * (int)(($dcnt / $range) + 0.5);
1817   }
1818
1819   $numpages= (($dcnt / $range));
1820   if(((int)($numpages))!=($numpages)){
1821     $numpages = (int)$numpages + 1;
1822   }
1823   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1824     return ("");
1825   }
1826   $ppage= (int)(($start / $range) + 0.5);
1827
1828
1829   /* Align selected page to +/- max_entries/2 */
1830   $begin= $ppage - $max_entries/2;
1831   $end= $ppage + $max_entries/2;
1832
1833   /* Adjust begin/end, so that the selected value is somewhere in
1834      the middle and the size is max_entries if possible */
1835   if ($begin < 0){
1836     $end-= $begin + 1;
1837     $begin= 0;
1838   }
1839   if ($end > $numpages) {
1840     $end= $numpages;
1841   }
1842   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1843     $begin= $end - $max_entries;
1844   }
1845
1846   if($post_var){
1847     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1848       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1849   }else{
1850     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1851   }
1852
1853   /* Draw decrement */
1854   if ($start > 0 ) {
1855     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1856       (($start-$range))."\">".
1857       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1858   }
1859
1860   /* Draw pages */
1861   for ($i= $begin; $i < $end; $i++) {
1862     if ($ppage == $i){
1863       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1864         validate($_GET['plug'])."&amp;start=".
1865         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1866     } else {
1867       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1868         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1869     }
1870   }
1871
1872   /* Draw increment */
1873   if($start < ($dcnt-$range)) {
1874     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1875       (($start+($range)))."\">".
1876       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1877   }
1878
1879   if(($post_var)&&($numpages)){
1880     $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()'>";
1881     foreach(array(20,50,100,200,"all") as $num){
1882       if($num == "all"){
1883         $var = 10000;
1884       }else{
1885         $var = $num;
1886       }
1887       if($var == $range){
1888         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1889       }else{
1890         $output.="\n<option value='".$var."'>".$num."</option>";
1891       }
1892     }
1893     $output.=  "</select></td></tr></table></div>";
1894   }else{
1895     $output.= "</div>";
1896   }
1897
1898   return($output);
1899 }
1900
1901
1902
1903 /*! \brief Generate HTML for the 'Back' button */
1904 function back_to_main()
1905 {
1906   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1907     msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1908
1909   return ($string);
1910 }
1911
1912
1913 /*! \brief Put netmask in n.n.n.n format
1914  *  \param string 'netmask' The netmask
1915  *  \return string Converted netmask
1916  */
1917 function normalize_netmask($netmask)
1918 {
1919   /* Check for notation of netmask */
1920   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1921     $num= (int)($netmask);
1922     $netmask= "";
1923
1924     for ($byte= 0; $byte<4; $byte++){
1925       $result=0;
1926
1927       for ($i= 7; $i>=0; $i--){
1928         if ($num-- > 0){
1929           $result+= pow(2,$i);
1930         }
1931       }
1932
1933       $netmask.= $result.".";
1934     }
1935
1936     return (preg_replace('/\.$/', '', $netmask));
1937   }
1938
1939   return ($netmask);
1940 }
1941
1942
1943 /*! \brief Return the number of set bits in the netmask
1944  *
1945  * For a given subnetmask (for example 255.255.255.0) this returns
1946  * the number of set bits.
1947  *
1948  * Example:
1949  * \code
1950  * $bits = netmask_to_bits('255.255.255.0') # Returns 24
1951  * $bits = netmask_to_bits('255.255.254.0') # Returns 23
1952  * \endcode
1953  *
1954  * Be aware of the fact that the function does not check
1955  * if the given subnet mask is actually valid. For example:
1956  * Bad examples:
1957  * \code
1958  * $bits = netmask_to_bits('255.0.0.255') # Returns 16
1959  * $bits = netmask_to_bits('255.255.0.255') # Returns 24
1960  * \endcode
1961  */
1962 function netmask_to_bits($netmask)
1963 {
1964   list($nm0, $nm1, $nm2, $nm3)= explode('.', $netmask);
1965   $res= 0;
1966
1967   for ($n= 0; $n<4; $n++){
1968     $start= 255;
1969     $name= "nm$n";
1970
1971     for ($i= 0; $i<8; $i++){
1972       if ($start == (int)($$name)){
1973         $res+= 8 - $i;
1974         break;
1975       }
1976       $start-= pow(2,$i);
1977     }
1978   }
1979
1980   return ($res);
1981 }
1982
1983
1984 /*! \brief Convert various data sizes to bytes
1985  *
1986  * Given a certain value in the format n(g|m|k), where n
1987  * is a value and (g|m|k) stands for Gigabyte, Megabyte and Kilobyte
1988  * this function returns the byte value.
1989  *
1990  * \param string 'value' a value in the above specified format
1991  * \return a byte value or the original value if specified string is simply
1992  * a numeric value
1993  *
1994  */
1995 function to_byte($value) {
1996   $value= strtolower(trim($value));
1997
1998   if(!is_numeric(substr($value, -1))) {
1999
2000     switch(substr($value, -1)) {
2001       case 'g':
2002         $mult= 1073741824;
2003         break;
2004       case 'm':
2005         $mult= 1048576;
2006         break;
2007       case 'k':
2008         $mult= 1024;
2009         break;
2010     }
2011
2012     return ($mult * (int)substr($value, 0, -1));
2013   } else {
2014     return $value;
2015   }
2016 }
2017
2018
2019 /*! \brief Check if a value exists in an array (case-insensitive)
2020  *
2021  * This is just as http://php.net/in_array except that the comparison
2022  * is case-insensitive.
2023  *
2024  * \param string 'value' needle
2025  * \param array 'items' haystack
2026  */
2027 function in_array_ics($value, $items)
2028 {
2029         return preg_grep('/^'.preg_quote($value, '/').'$/i', $items);
2030 }
2031
2032
2033 /*! \brief Removes malicious characters from a (POST) string. */
2034 function validate($string)
2035 {
2036   return (strip_tags(str_replace('\0', '', $string)));
2037 }
2038
2039
2040 /*! \brief Evaluate the current GOsa version from the build in revision string */
2041 function get_gosa_version()
2042 {
2043     global $svn_revision, $svn_path;
2044
2045     /* Extract informations */
2046     $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
2047
2048     // Extract the relevant part out of the svn url
2049     $release= preg_replace('%^.*/gosa/(.*)/include/functions.inc.*$%', '\1', $svn_path);
2050
2051     // Remove stuff which is not interesting
2052     if(preg_match("/gosa-core/i", $release)) $release = preg_replace("/[\/]gosa-core/i","",$release);
2053
2054     // A Tagged Version
2055     if(preg_match("#/tags/#i", $svn_path)){
2056         $release = preg_replace("/tags[\/]*/i","",$release);
2057         $release = preg_replace("/\//","",$release) ;
2058         return (sprintf(_("GOsa %s"),$release));
2059     }
2060
2061     // A Branched Version
2062     if(preg_match("#/branches/#i", $svn_path)){
2063         $release = preg_replace("/branches[\/]*/i","",$release);
2064         $release = preg_replace("/\//","",$release) ;
2065         return (sprintf(_("GOsa %s snapshot (Rev %s)"),$release , bold($revision)));
2066     }
2067
2068     // The trunk version
2069     if(preg_match("#/trunk/#i", $svn_path)){
2070         return (sprintf(_("GOsa development snapshot (Rev %s)"), bold($revision)));
2071     }
2072
2073     return (sprintf(_("GOsa $release"), $revision));
2074 }
2075
2076
2077 /*! \brief Recursively delete a path in the file system
2078  *
2079  * Will delete the given path and all its files recursively.
2080  * Can also follow links if told so.
2081  *
2082  * \param string 'path'
2083  * \param boolean 'followLinks' TRUE to follow links, FALSE (default)
2084  * for not following links
2085  */
2086 function rmdirRecursive($path, $followLinks=false) {
2087   $dir= opendir($path);
2088   while($entry= readdir($dir)) {
2089     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
2090       unlink($path."/".$entry);
2091     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
2092       rmdirRecursive($path."/".$entry);
2093     }
2094   }
2095   closedir($dir);
2096   return rmdir($path);
2097 }
2098
2099
2100 /*! \brief Get directory content information
2101  *
2102  * Returns the content of a directory as an array in an
2103  * ascended sorted manner.
2104  *
2105  * \param string 'path'
2106  * \param boolean weither to sort the content descending.
2107  */
2108 function scan_directory($path,$sort_desc=false)
2109 {
2110   $ret = false;
2111
2112   /* is this a dir ? */
2113   if(is_dir($path)) {
2114
2115     /* is this path a readable one */
2116     if(is_readable($path)){
2117
2118       /* Get contents and write it into an array */
2119       $ret = array();
2120
2121       $dir = opendir($path);
2122
2123       /* Is this a correct result ?*/
2124       if($dir){
2125         while($fp = readdir($dir))
2126           $ret[]= $fp;
2127       }
2128     }
2129   }
2130   /* Sort array ascending , like scandir */
2131   sort($ret);
2132
2133   /* Sort descending if parameter is sort_desc is set */
2134   if($sort_desc) {
2135     $ret = array_reverse($ret);
2136   }
2137
2138   return($ret);
2139 }
2140
2141
2142 /*! \brief Clean the smarty compile dir */
2143 function clean_smarty_compile_dir($directory)
2144 {
2145   global $svn_revision;
2146
2147   if(is_dir($directory) && is_readable($directory)) {
2148     // Set revision filename to REVISION
2149     $revision_file= $directory."/REVISION";
2150
2151     /* Is there a stamp containing the current revision? */
2152     if(!file_exists($revision_file)) {
2153       // create revision file
2154       create_revision($revision_file, $svn_revision);
2155     } else {
2156       # check for "$config->...['CONFIG']/revision" and the
2157       # contents should match the revision number
2158       if(!compare_revision($revision_file, $svn_revision)){
2159         // If revision differs, clean compile directory
2160         foreach(scan_directory($directory) as $file) {
2161           if(($file==".")||($file=="..")) continue;
2162           if( is_file($directory."/".$file) &&
2163               is_writable($directory."/".$file)) {
2164             // delete file
2165             if(!unlink($directory."/".$file)) {
2166               msg_dialog::display(_("Internal error"), sprintf(_("File %s cannot be deleted!"), bold($directory."/".$file)), ERROR_DIALOG);
2167               // This should never be reached
2168             }
2169           }
2170         }
2171         // We should now create a fresh revision file
2172         clean_smarty_compile_dir($directory);
2173       } else {
2174         // Revision matches, nothing to do
2175       }
2176     }
2177   } else {
2178     // Smarty compile dir is not accessible
2179     // (Smarty will warn about this)
2180   }
2181 }
2182
2183
2184 function create_revision($revision_file, $revision)
2185 {
2186   $result= false;
2187
2188   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
2189     if($fh= fopen($revision_file, "w")) {
2190       if(fwrite($fh, $revision)) {
2191         $result= true;
2192       }
2193     }
2194     fclose($fh);
2195   } else {
2196     msg_dialog::display(_("Internal error"), _("Cannot write revision file!"), ERROR_DIALOG);
2197   }
2198
2199   return $result;
2200 }
2201
2202
2203 function compare_revision($revision_file, $revision)
2204 {
2205   // false means revision differs
2206   $result= false;
2207
2208   if(file_exists($revision_file) && is_readable($revision_file)) {
2209     // Open file
2210     if($fh= fopen($revision_file, "r")) {
2211       // Compare File contents with current revision
2212       if($revision == fread($fh, filesize($revision_file))) {
2213         $result= true;
2214       }
2215     } else {
2216       msg_dialog::display(_("Internal error"), _("Cannot write revision file!"), ERROR_DIALOG);
2217     }
2218     // Close file
2219     fclose($fh);
2220   }
2221
2222   return $result;
2223 }
2224
2225
2226 /*! \brief Return HTML for a progressbar
2227  *
2228  * \code
2229  * $smarty->assign("installprogress", progressbar($current_progress_in_percent),100,15,true);
2230  * \endcode
2231  *
2232  * \param int 'percentage' Value to display
2233  * \param int 'width' width of the resulting output
2234  * \param int 'height' height of the resulting output
2235  * \param boolean 'showtext' weither to show the percentage in the progressbar or not
2236  * */
2237 function progressbar($percentage, $width= 200, $height= 14, $showText= false, $colorize= true, $id= "")
2238 {
2239   $text= "";
2240   $class= "";
2241   $style= "width:${width}px;height:${height}px;";
2242
2243   // Fix percentage range
2244   $percentage= floor($percentage);
2245   if ($percentage > 100) {
2246     $percentage= 100;
2247   }
2248   if ($percentage < 0) {
2249     $percentage= 0;
2250   }
2251
2252   // Only show text if we're above 10px height
2253   if ($showText && $height>10){
2254     $text= $percentage."%";
2255   }
2256
2257   // Set font size
2258   $style.= "font-size:".($height-3)."px;";
2259
2260   // Set color
2261   if ($colorize){
2262     if ($percentage < 70) {
2263       $class= " progress-low";
2264     } elseif ($percentage < 80) {
2265       $class= " progress-mid";
2266     } elseif ($percentage < 90) {
2267       $class= " progress-high";
2268     } else {
2269       $class= " progress-full";
2270     }
2271   }
2272
2273   // Apply gradients
2274   $hoffset= floor($height / 2) + 4;
2275   $woffset= floor(($width+5) * (100-$percentage) / 100);
2276   foreach (array("-moz-box-shadow", "-webkit-box-shadow", "box-shadow") as $type) {
2277     $style.="$type:
2278                    0 0 2px rgba(255, 255, 255, 0.4) inset,
2279                    0 4px 6px rgba(255, 255, 255, 0.4) inset,
2280                    0 ".$hoffset."px 0 -2px rgba(255, 255, 255, 0.2) inset,
2281                    -".$woffset."px 0 0 -2px rgba(255, 255, 255, 0.2) inset,
2282                    -".($woffset+1)."px 0 0 -2px rgba(0, 0, 0, 0.6) inset,
2283                    0pt ".($hoffset+1)."px 8px rgba(0, 0, 0, 0.3) inset,
2284                    0pt 1px 0px rgba(0, 0, 0, 0.2);";
2285   }
2286
2287   // Set ID
2288   if ($id != ""){
2289     $id= "id='$id'";
2290   }
2291
2292   return "<div class='progress$class' $id style='$style'>$text</div>";
2293 }
2294
2295
2296 /*! \brief Lookup a key in an array case-insensitive
2297  *
2298  * Given an associative array this can lookup the value of
2299  * a certain key, regardless of the case.
2300  *
2301  * \code
2302  * $items = array ('FOO' => 'blub', 'bar' => 'blub');
2303  * array_key_ics('foo', $items); # Returns 'blub'
2304  * array_key_ics('BAR', $items); # Returns 'blub'
2305  * \endcode
2306  *
2307  * \param string 'key' needle
2308  * \param array 'items' haystack
2309  */
2310 function array_key_ics($ikey, $items)
2311 {
2312   $tmp= array_change_key_case($items, CASE_LOWER);
2313   $ikey= strtolower($ikey);
2314   if (isset($tmp[$ikey])){
2315     return($tmp[$ikey]);
2316   }
2317
2318   return ('');
2319 }
2320
2321
2322 /*! \brief Determine if two arrays are different
2323  *
2324  * \param array 'src'
2325  * \param array 'dst'
2326  * \return boolean TRUE or FALSE
2327  * */
2328 function array_differs($src, $dst)
2329 {
2330   /* If the count is differing, the arrays differ */
2331   if (count ($src) != count ($dst)){
2332     return (TRUE);
2333   }
2334
2335   return (count(array_diff($src, $dst)) != 0);
2336 }
2337
2338
2339 function saveFilter($a_filter, $values)
2340 {
2341   if (isset($_POST['regexit'])){
2342     $a_filter["regex"]= $_POST['regexit'];
2343
2344     foreach($values as $type){
2345       if (isset($_POST[$type])) {
2346         $a_filter[$type]= "checked";
2347       } else {
2348         $a_filter[$type]= "";
2349       }
2350     }
2351   }
2352
2353   /* React on alphabet links if needed */
2354   if (isset($_GET['search'])){
2355     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2356     if ($s == "**"){
2357       $s= "*";
2358     }
2359     $a_filter['regex']= $s;
2360   }
2361
2362   return ($a_filter);
2363 }
2364
2365
2366 /*! \brief Escape all LDAP filter relevant characters */
2367 function normalizeLdap($input)
2368 {
2369   return (addcslashes($input, '()|'));
2370 }
2371
2372
2373 /*! \brief Return the gosa base directory */
2374 function get_base_dir()
2375 {
2376   global $BASE_DIR;
2377
2378   return $BASE_DIR;
2379 }
2380
2381
2382 /*! \brief Test weither we are allowed to read the object */
2383 function obj_is_readable($dn, $object, $attribute)
2384 {
2385   global $ui;
2386
2387   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2388 }
2389
2390
2391 /*! \brief Test weither we are allowed to change the object */
2392 function obj_is_writable($dn, $object, $attribute)
2393 {
2394   global $ui;
2395
2396   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2397 }
2398
2399
2400 /*! \brief Explode a DN into its parts
2401  *
2402  * Similar to explode (http://php.net/explode), but a bit more specific
2403  * for the needs when splitting, exploding LDAP DNs.
2404  *
2405  * \param string 'dn' the DN to split
2406  * \param config-object a config object. only neeeded if DN shall be verified in the LDAP
2407  * \param boolean verify_in_ldap check weither DN is valid
2408  *
2409  */
2410 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2411 {
2412   /* Initialize variables */
2413   $ret  = array("count" => 0);  // Set count to 0
2414   $next = true;                 // if false, then skip next loops and return
2415   $cnt  = 0;                    // Current number of loops
2416   $max  = 100;                  // Just for security, prevent looops
2417   $ldap = NULL;                 // To check if created result a valid
2418   $keep = "";                   // save last failed parse string
2419
2420   /* Check each parsed dn in ldap ? */
2421   if($config!==NULL && $verify_in_ldap){
2422     $ldap = $config->get_ldap_link();
2423   }
2424
2425   /* Lets start */
2426   $called = false;
2427   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2428
2429     $cnt ++;
2430     if(!preg_match("/,/",$dn)){
2431       $next = false;
2432     }
2433     $object = preg_replace("/[,].*$/","",$dn);
2434     $dn     = preg_replace("/^[^,]+,/","",$dn);
2435
2436     $called = true;
2437
2438     /* Check if current dn is valid */
2439     if($ldap!==NULL){
2440       $ldap->cd($dn);
2441       $ldap->cat($dn,array("dn"));
2442       if($ldap->count()){
2443         $ret[]  = $keep.$object;
2444         $keep   = "";
2445       }else{
2446         $keep  .= $object.",";
2447       }
2448     }else{
2449       $ret[]  = $keep.$object;
2450       $keep   = "";
2451     }
2452   }
2453
2454   /* No dn was posted */
2455   if($cnt == 0 && !empty($dn)){
2456     $ret[] = $dn;
2457   }
2458
2459   /* Append the rest */
2460   $test = $keep.$dn;
2461   if($called && !empty($test)){
2462     $ret[] = $keep.$dn;
2463   }
2464   $ret['count'] = count($ret) - 1;
2465
2466   return($ret);
2467 }
2468
2469
2470 function get_base_from_hook($dn, $attrib)
2471 {
2472   global $config;
2473
2474   if ($config->get_cfg_value("core","baseIdHook") != ""){
2475
2476     /* Call hook script - if present */
2477     $command= $config->get_cfg_value("core","baseIdHook");
2478
2479     if ($command != ""){
2480       $command.= " '".LDAP::fix($dn)."' $attrib";
2481       if (check_command($command)){
2482         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2483         exec($command, $output);
2484         if (preg_match("/^[0-9]+$/", $output[0])){
2485           return ($output[0]);
2486         } else {
2487           msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2488           return ($config->get_cfg_value("core","uidNumberBase"));
2489         }
2490       } else {
2491         msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2492         return ($config->get_cfg_value("core","uidNumberBase"));
2493       }
2494
2495     } else {
2496
2497       msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2498       return ($config->get_cfg_value("core","uidNumberBase"));
2499
2500     }
2501   }
2502 }
2503
2504
2505 /*! \brief Check if schema version matches the requirements */
2506 function check_schema_version($class, $version)
2507 {
2508   return preg_match("/\(v$version\)/", $class['DESC']);
2509 }
2510
2511
2512 /*! \brief Check if LDAP schema matches the requirements */
2513 function check_schema($cfg,$rfc2307bis = FALSE)
2514 {
2515   $messages= array();
2516
2517   /* Get objectclasses */
2518   $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE, $cfg['tls']));
2519   $objectclasses = $ldap->get_objectclasses();
2520   if(count($objectclasses) == 0){
2521     msg_dialog::display(_("Warning"), _("Cannot read schema information from LDAP. Schema validation is not possible!"), WARNING_DIALOG);
2522   }
2523
2524   /* This is the default block used for each entry.
2525    *  to avoid unset indexes.
2526    */
2527   $def_check = array("REQUIRED_VERSION" => "0",
2528       "SCHEMA_FILES"     => array(),
2529       "CLASSES_REQUIRED" => array(),
2530       "STATUS"           => FALSE,
2531       "IS_MUST_HAVE"     => FALSE,
2532       "MSG"              => "",
2533       "INFO"             => "");
2534
2535   /* The gosa base schema */
2536   $checks['gosaObject'] = $def_check;
2537   $checks['gosaObject']['REQUIRED_VERSION'] = "2.6.1";
2538   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa-samba3.schema");
2539   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2540   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2541
2542   /* GOsa Account class */
2543   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.6.6";
2544   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa-samba3.schema");
2545   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2546   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2547   $checks["gosaAccount"]["INFO"]            = _("This class is used to make users appear in GOsa.");
2548
2549   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2550   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.6.1";
2551   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa-samba3.schema");
2552   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2553   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2554   $checks["gosaLockEntry"]["INFO"]             = _("This class is used to lock entries in order to prevent multiple edits at a time.");
2555
2556   /* Some other checks */
2557   foreach(array(
2558         "gosaCacheEntry"        => array("version" => "2.6.1", "class" => "gosaAccount"),
2559         "gosaDepartment"        => array("version" => "2.6.1", "class" => "gosaAccount"),
2560         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2561         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2562         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2563         "gosaUserTemplate"      => array("version" => "2.6.1", "class" => "posixAccount","file" => "nis.schema"),
2564         "gosaMailAccount"       => array("version" => "2.6.1", "class" => "mailAccount","file" => "gosa-samba3.schema"),
2565         "gosaProxyAccount"      => array("version" => "2.6.1", "class" => "proxyAccount","file" => "gosa-samba3.schema"),
2566         "gosaApplication"       => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"),
2567         "gosaApplicationGroup"  => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"),
2568         "GOhard"                => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2569         "gotoTerminal"          => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2570         "goServer"              => array("version" => "2.6.1", "class" => "server","file" => "goserver.schema"),
2571         "goTerminalServer"      => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2572         "goShareServer"         => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2573         "goNtpServer"           => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2574         "goSyslogServer"        => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2575         "goLdapServer"          => array("version" => "2.6.1", "class" => "goServer"),
2576         "goCupsServer"          => array("version" => "2.6.1", "class" => array("posixAccount", "terminals"),),
2577         "goImapServer"          => array("version" => "2.6.1", "class" => array("mailAccount", "mailgroup"),"file" => "gosa-samba3.schema"),
2578         "goKrbServer"           => array("version" => "2.6.1", "class" => "goServer"),
2579         "goFaxServer"           => array("version" => "2.6.1", "class" => "gofaxAccount","file" => "gofax.schema"),
2580         ) as $name => $values){
2581
2582           $checks[$name] = $def_check;
2583           if(isset($values['version'])){
2584             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2585           }
2586           if(isset($values['file'])){
2587             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2588           }
2589           if (isset($values['class'])) {
2590             $checks[$name]["CLASSES_REQUIRED"] = is_array($values['class'])?$values['class']:array($values['class']);
2591           }
2592         }
2593   foreach($checks as $name => $value){
2594     foreach($value['CLASSES_REQUIRED'] as $class){
2595
2596       if(!isset($objectclasses[$name])){
2597         if($value['IS_MUST_HAVE']){
2598           $checks[$name]['STATUS'] = FALSE;
2599           $checks[$name]['MSG']    = sprintf(_("Required object class %s is missing!"), bold($class));
2600         } else {
2601           $checks[$name]['STATUS'] = TRUE;
2602           $checks[$name]['MSG']    = sprintf(_("Optional object class %s is missing!"), bold($class));
2603         }
2604       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2605         $checks[$name]['STATUS'] = FALSE;
2606
2607         $checks[$name]['MSG'] = sprintf(_("Wrong version of required object class %s (!=%s) detected!"), bold($class), bold($value['REQUIRED_VERSION']));
2608       }else{
2609         $checks[$name]['STATUS'] = TRUE;
2610         $checks[$name]['MSG'] = sprintf(_("Class available"));
2611       }
2612     }
2613   }
2614
2615   $tmp = $objectclasses;
2616
2617   /* The gosa base schema */
2618   $checks['posixGroup'] = $def_check;
2619   $checks['posixGroup']['REQUIRED_VERSION'] = "2.6.1";
2620   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa-samba3.schema","gosa-samba2.schema");
2621   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2622   $checks['posixGroup']['STATUS']           = TRUE;
2623   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2624   $checks['posixGroup']['MSG']              = "";
2625   $checks['posixGroup']['INFO']             = "";
2626
2627   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2628   if(isset($tmp['posixGroup'])){
2629
2630     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2631       $checks['posixGroup']['STATUS']           = FALSE;
2632       $checks['posixGroup']['MSG']              = _("RFC2307bis schema is enabled, but the current LDAP configuration does not support it!");
2633       $checks['posixGroup']['INFO']             = _("To use RFC2307bis groups, the objectClass 'posixGroup' must be AUXILIARY.");
2634     }
2635     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2636       $checks['posixGroup']['STATUS']           = FALSE;
2637       $checks['posixGroup']['MSG']              = _("RFC2307bis schema is disabled, but the current LDAP configuration supports it!");
2638       $checks['posixGroup']['INFO']             = _("To correct this, the objectClass 'posixGroup' must be STRUCTURAL.");
2639     }
2640   }
2641
2642   return($checks);
2643 }
2644
2645
2646 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2647 {
2648   $tmp = array(
2649         "de_DE" => "German",
2650         "fr_FR" => "French",
2651         "it_IT" => "Italian",
2652         "es_ES" => "Spanish",
2653         "en_US" => "English",
2654         "nl_NL" => "Dutch",
2655         "pl_PL" => "Polish",
2656         "pt_BR" => "Brazilian Portuguese",
2657         #"sv_SE" => "Swedish",
2658         "zh_CN" => "Chinese",
2659         "vi_VN" => "Vietnamese",
2660         "ru_RU" => "Russian");
2661
2662   $tmp2= array(
2663         "de_DE" => _("German"),
2664         "fr_FR" => _("French"),
2665         "it_IT" => _("Italian"),
2666         "es_ES" => _("Spanish"),
2667         "en_US" => _("English"),
2668         "nl_NL" => _("Dutch"),
2669         "pl_PL" => _("Polish"),
2670         "pt_BR" => _("Brazilian Portuguese"),
2671         #"sv_SE" => _("Swedish"),
2672         "zh_CN" => _("Chinese"),
2673         "vi_VN" => _("Vietnamese"),
2674         "ru_RU" => _("Russian"));
2675
2676   $ret = array();
2677   if($languages_in_own_language){
2678
2679     $old_lang = setlocale(LC_ALL, 0);
2680
2681     /* If the locale wasn't correclty set before, there may be an incorrect
2682         locale returned. Something like this:
2683           C_CTYPE=de_DE.UTF-8;LC_NUMERIC=C;LC_TIME=de_DE.UTF-8;LC ...
2684         Extract the locale name from this string and use it to restore old locale.
2685      */
2686     if(preg_match("/LC_CTYPE/",$old_lang)){
2687       $old_lang = preg_replace("/^.*LC_CTYPE=([^;]*).*$/","\\1",$old_lang);
2688     }
2689
2690     foreach($tmp as $key => $name){
2691       $lang = $key.".UTF-8";
2692       setlocale(LC_ALL, $lang);
2693       if($strip_region_tag){
2694         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2695       }else{
2696         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2697       }
2698     }
2699     setlocale(LC_ALL, $old_lang);
2700   }else{
2701     foreach($tmp as $key => $name){
2702       if($strip_region_tag){
2703         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2704       }else{
2705         $ret[$key] = _($name);
2706       }
2707     }
2708   }
2709   return($ret);
2710 }
2711
2712
2713 /*! \brief Returns contents of the given POST variable and check magic quotes settings
2714  *
2715  * Depending on the magic quotes settings this returns a stripclashed'ed version of
2716  * a certain POST variable.
2717  *
2718  * \param string 'name' the POST var to return ($_POST[$name])
2719  * \return string
2720  * */
2721 function get_post($name)
2722 {
2723     if(!isset($_POST[$name])){
2724         trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2725         return(FALSE);
2726     }
2727
2728     // Handle Posted Arrays
2729     $tmp = array();
2730     if(is_array($_POST[$name]) && !is_string($_POST[$name])){
2731         foreach($_POST[$name] as $key => $val){
2732             if(get_magic_quotes_gpc()){
2733                 $val = stripcslashes($val);
2734             }
2735             $tmp[$key] = $val;
2736         }
2737         return($tmp);
2738     }else{
2739
2740         if(get_magic_quotes_gpc()){
2741             $val = stripcslashes($_POST[$name]);
2742         }else{
2743             $val = $_POST[$name];
2744         }
2745     }
2746   return($val);
2747 }
2748
2749
2750 /*! \brief Returns contents of the given POST variable and check magic quotes settings
2751  *
2752  * Depending on the magic quotes settings this returns a stripclashed'ed version of
2753  * a certain POST variable.
2754  *
2755  * \param string 'name' the POST var to return ($_POST[$name])
2756  * \return string
2757  * */
2758 function get_binary_post($name)
2759 {
2760   if(!isset($_POST[$name])){
2761     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2762     return(FALSE);
2763   }
2764
2765   $p = str_replace('\0', '', $_POST[$name]);
2766   if(get_magic_quotes_gpc()){
2767     return(stripcslashes($p));
2768   }else{
2769     return($_POST[$p]);
2770   }
2771 }
2772
2773 function set_post($value)
2774 {
2775     // Take care of array, recursivly convert each array entry.
2776     if(is_array($value)){
2777         foreach($value as $key => $val){
2778             $value[$key] = set_post($val);
2779         }
2780         return($value);
2781     }
2782
2783     // Do not touch boolean values, we may break them.
2784     if($value === TRUE || $value === FALSE ) return($value);
2785
2786     // Return a fixed string which can then be used in HTML fields without
2787     //  breaking the layout or the values. This allows to use '"<> in input fields.
2788     return(htmlentities($value, ENT_QUOTES, 'utf-8'));
2789 }
2790
2791
2792 /*! \brief Return class name in correct case */
2793 function get_correct_class_name($cls)
2794 {
2795   global $class_mapping;
2796   if(isset($class_mapping) && is_array($class_mapping)){
2797     foreach($class_mapping as $class => $file){
2798       if(preg_match("/^".$cls."$/i",$class)){
2799         return($class);
2800       }
2801     }
2802   }
2803   return(FALSE);
2804 }
2805
2806
2807 /*! \brief  Change the password for a given object ($dn).
2808  *          This method uses the specified hashing method to generate a new password
2809  *           for the object and it also takes care of sambaHashes, if enabled.
2810  *          Finally the postmodify hook of the class 'user' will be called, if it is set.
2811  *
2812  * @param   String   The DN whose password shall be changed.
2813  * @param   String   The new password.
2814  * @param   Boolean  Skip adding samba hashes to the target (sambaNTPassword,sambaLMPassword)
2815  * @param   String   The hashin method to use, default is the global configured default.
2816  * @param   String   The users old password, this allows script based rollback mechanisms,
2817  *                    the prehook will then be called witch switched newPassword/oldPassword.
2818  * @return  Boolean  TRUE on success else FALSE.
2819  */
2820 function change_password ($dn, $password, $mode=FALSE, $hash= "", $old_password = "", &$message = "")
2821 {
2822     global $config;
2823     $newpass= "";
2824
2825     // Not sure, why this is here, but maybe some encryption methods require it.
2826     mt_srand((double) microtime()*1000000);
2827
2828     // Get a list of all available password encryption methods.
2829     $methods = new passwordMethod(session::get('config'),$dn);
2830     $available = $methods->get_available_methods();
2831
2832     // Fetch the current object data, to be able to detect the current hashing method
2833     //  and to be able to rollback changes once has an error occured.
2834     $ldap = $config->get_ldap_link();
2835     $ldap->cat ($dn, array("shadowLastChange", "userPassword","sambaNTPassword","sambaLMPassword", "uid"));
2836     $attrs = $ldap->fetch ();
2837     $initialAttrs = $attrs;
2838
2839     // If no hashing method is enforced, then detect what method we've to use.
2840     $hash = strtolower($hash);
2841     if(empty($hash)){
2842
2843         // Do we need clear-text password for this object?
2844         if(isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2845             $hash = "clear";
2846             $test = new $available[$hash]($config,$dn);
2847             $test->set_hash($hash);
2848         }
2849
2850         // If we've still no valid hashing method detected, then try to extract if from the userPassword attribute.
2851         elseif(isset($attrs['userPassword'][0]) && preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)){
2852             $test = passwordMethod::get_method($attrs['userPassword'][0],$dn);
2853             $hash = $test->get_hash_name();
2854         }
2855
2856         // No current password was found and no hash is enforced, so we've to use the config default here.
2857         $hash = $config->get_cfg_value('core','passwordDefaultHash');
2858         $test = new $available[$hash]($config,$dn);
2859         $test->set_hash($hash);
2860     }else{
2861         $test = new $available[$hash]($config,$dn);
2862         $test->set_hash($hash);
2863     }
2864
2865     // We've now a valid password-method-handle and can create the new password hash or don't we?
2866     if(!$test instanceOf passwordMethod){
2867         $message = _("Cannot detect password hash!");
2868     }else{
2869
2870         // Feed password backends with object information.
2871         $test->dn = $dn;
2872         $test->attrs = $attrs;
2873         $newpass= $test->generate_hash($password);
2874
2875         // Do we have to append samba attributes too?
2876         // - sambaNTPassword / sambaLMPassword
2877         $tmp = $config->get_cfg_value('core','sambaHashHook');
2878         $attrs= array();
2879         if (!$mode && !empty($tmp)){
2880             $attrs= generate_smb_nt_hash($password);
2881             $shadow = (isset($attrs["shadowLastChange"][0]))?(int)(date("U") / 86400):0;
2882             if ($shadow != 0){
2883                 $attrs['shadowLastChange']= $shadow;
2884             }
2885         }
2886
2887         // Write back the new password hash
2888         $ldap->cd($dn);
2889         $attrs['userPassword']= $newpass;
2890
2891         // Prepare a special attribute list, which will be used for event hook calls
2892         $attrsEvent = array();
2893         foreach($initialAttrs as $name => $value){
2894             if(!is_numeric($name))
2895                 $attrsEvent[$name] = escapeshellarg($value[0]);
2896         }
2897         $attrsEvent['dn'] = escapeshellarg($initialAttrs['dn']);
2898         foreach($attrs as $name => $value){
2899             $attrsEvent[$name] = escapeshellarg($value);
2900         }
2901         $attrsEvent['current_password'] = escapeshellarg($old_password);
2902         $attrsEvent['new_password'] = escapeshellarg($password);
2903
2904         // Call the premodify hook now
2905         $passwordPlugin = new password($config,$dn);
2906         plugin::callHook($passwordPlugin, 'PREMODIFY', $attrsEvent, $output,$retCode,$error, $directlyPrintError = FALSE);
2907         if($retCode === 0 && count($output)){
2908             $message = sprintf(_("Pre-event hook reported a problem: %s. Password change canceled!"),implode($output));
2909             return(FALSE);
2910         }
2911
2912         // Perform ldap operations
2913         $ldap->modify($attrs);
2914
2915         // Check if the object was locked before, if it was, lock it again!
2916         $deactivated = $test->is_locked($config,$dn);
2917         if($deactivated){
2918             $test->lock_account($config,$dn);
2919         }
2920
2921         // Check if everything went fine and then call the post event hooks.
2922         // If an error occures, then try to rollback the complete actions done.
2923         $preRollback = FALSE;
2924         $ldapRollback = FALSE;
2925         $success = TRUE;
2926         if (!$ldap->success()) {
2927             new log("modify","users/passwordMethod",$dn,array(),"Password change - ldap modifications! - FAILED");
2928             $success =FALSE;
2929             $message = msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD);
2930             $preRollback  =TRUE;
2931         } else {
2932
2933             // Now call the passwordMethod change mechanism.
2934             if(!$test->set_password($password)){
2935                 $ldapRollback = TRUE;
2936                 $preRollback  =TRUE;
2937                 $success = FALSE;
2938                 new log("modify","users/passwordMethod",$dn,array(),"Password change - set_password! - FAILED");
2939                 $message = _("Password change failed!");
2940             }else{
2941
2942                 // Execute the password hook
2943                 plugin::callHook($passwordPlugin, 'POSTMODIFY', $attrsEvent, $output,$retCode,$error, $directlyPrintError = FALSE);
2944                 if($retCode === 0){
2945                     if(count($output)){
2946                         new log("modify","users/passwordMethod",$dn,array(),"Password change - Post modify hook reported! - FAILED!");
2947                         $message = sprintf(_("Post-event hook reported a problem: %s. Password change canceled!"),implode($output));
2948                         $ldapRollback = TRUE;
2949                         $preRollback = TRUE;
2950                         $success = FALSE;
2951                     }else{
2952                         #new log("modify","users/passwordMethod",$dn,array(),"Password change - successfull!");
2953                     }
2954                 }else{
2955                     $ldapRollback = TRUE;
2956                     $preRollback = TRUE;
2957                     $success = FALSE;
2958                     new log("modify","users/passwordMethod",$dn,array(),"Password change - postmodify hook execution! - FAILED");
2959                     new log("modify","users/passwordMethod",$dn,array(),$error);
2960
2961                     // Call password method again and send in old password to
2962                     //  keep the database consistency
2963                     $test->set_password($old_password);
2964                 }
2965             }
2966         }
2967
2968         // Setting the password in the ldap database or further operation failed, we should now execute
2969         //  the plugins pre-event hook, using switched passwords, new/old password.
2970         // This ensures that passwords which were set outside of GOsa, will be reset to its
2971         //  starting value.
2972         if($preRollback){
2973             new log("modify","users/passwordMethod",$dn,array(),"Rolling back premodify hook!");
2974             $oldpass= $test->generate_hash($old_password);
2975             $attrsEvent['current_password'] = escapeshellarg($password);
2976             $attrsEvent['new_password'] = escapeshellarg($old_password);
2977             foreach(array("userPassword","sambaNTPassword","sambaLMPassword") as $attr){
2978                 if(isset($initialAttrs[$attr][0])) $attrsEvent[$attr] = $initialAttrs[$attr][0];
2979             }
2980
2981             plugin::callHook($passwordPlugin, 'PREMODIFY', $attrsEvent, $output,$retCode,$error, $directlyPrintError = FALSE);
2982             if($retCode === 0 && count($output)){
2983                 $message = sprintf(_("Pre-event hook reported a problem: %s. Password change canceled!"),implode($output));
2984                 new log("modify","users/passwordMethod",$dn,array(),"Rolling back premodify hook! - FAILED!");
2985             }
2986         }
2987
2988         // We've written the password to the ldap database, but executing the postmodify hook failed.
2989         // Now, we've to rollback all password related ldap operations.
2990         if($ldapRollback){
2991             new log("modify","users/passwordMethod",$dn,array(),"Rolling back ldap modifications!");
2992             $attrs = array();
2993             foreach(array("userPassword","sambaNTPassword","sambaLMPassword") as $attr){
2994                 if(isset($initialAttrs[$attr][0])) $attrs[$attr] = $initialAttrs[$attr][0];
2995             }
2996             $ldap->cd($dn);
2997             $ldap->modify($attrs);
2998             if(!$ldap->success()){
2999                 $message = msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD);
3000                 new log("modify","users/passwordMethod",$dn,array(),"Rolling back ldap modifications! - FAILED");
3001             }
3002         }
3003
3004         // Log action.
3005         if($success){
3006             stats::log('global', 'global', array('users'),  $action = 'change_password', $amount = 1, 0, $test->get_hash());
3007             new log("modify","users/passwordMethod",$dn,array(),"Password change - successfull!");
3008         }else{
3009             new log("modify","users/passwordMethod",$dn,array(),"Password change - FAILED!");
3010         }
3011
3012         return($success);
3013     }
3014 }
3015
3016
3017 /*! \brief Generate samba hashes
3018  *
3019  * Given a certain password this constructs an array like
3020  * array['sambaLMPassword'] etc.
3021  *
3022  * \param string 'password'
3023  * \return array contains several keys for lmPassword, ntPassword, pwdLastSet, etc. depending
3024  * on the samba version
3025  */
3026 function generate_smb_nt_hash($password)
3027 {
3028   global $config;
3029
3030   // First try to retrieve values via RPC
3031   if ($config->get_cfg_value("core","gosaRpcServer") != ""){
3032
3033     $rpc = $config->getRpcHandle();
3034     $hash = $rpc->mksmbhash($password);
3035     if(!$rpc->success()){
3036         msg_dialog::display(_("Error"),msgPool::rpcError($rpc->get_error()),ERROR_DIALOG);
3037         return("");
3038     }
3039
3040   }elseif ($config->get_cfg_value("core","gosaSupportURI") != ""){
3041
3042     // Try using gosa-si
3043         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
3044     if (isset($res['XML']['HASH'])){
3045         $hash= $res['XML']['HASH'];
3046     } else {
3047       $hash= "";
3048     }
3049
3050     if ($hash == "") {
3051       msg_dialog::display(_("Configuration error"), _("Cannot generate SAMBA hash!"), ERROR_DIALOG);
3052       return ("");
3053     }
3054   } else {
3055           $tmp = $config->get_cfg_value("core",'sambaHashHook');
3056       $tmp = preg_replace("/%userPassword/", escapeshellarg($password), $tmp);
3057       $tmp = preg_replace("/%password/", escapeshellarg($password), $tmp);
3058           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
3059
3060           exec($tmp, $ar);
3061           flush();
3062           reset($ar);
3063           $hash= current($ar);
3064
3065     if ($hash == "") {
3066       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);
3067       return ("");
3068     }
3069   }
3070
3071   list($lm,$nt)= explode(":", trim($hash));
3072
3073   $attrs['sambaLMPassword']= $lm;
3074   $attrs['sambaNTPassword']= $nt;
3075   $attrs['sambaPwdLastSet']= date('U');
3076   $attrs['sambaBadPasswordCount']= "0";
3077   $attrs['sambaBadPasswordTime']= "0";
3078   return($attrs);
3079 }
3080
3081
3082 /*! \brief Get the Change Sequence Number of a certain DN
3083  *
3084  * To verify if a given object has been changed outside of Gosa
3085  * in the meanwhile, this function can be used to get the entryCSN
3086  * from the LDAP directory. It uses the attribute as configured
3087  * in modificationDetectionAttribute
3088  *
3089  * \param string 'dn'
3090  * \return either the result or "" in any other case
3091  */
3092 function getEntryCSN($dn)
3093 {
3094   global $config;
3095   if(empty($dn) || !is_object($config)){
3096     return("");
3097   }
3098
3099   /* Get attribute that we should use as serial number */
3100   $attr= $config->get_cfg_value("core","modificationDetectionAttribute");
3101   if($attr != ""){
3102     $ldap = $config->get_ldap_link();
3103     $ldap->cat($dn,array($attr));
3104     $csn = $ldap->fetch();
3105     if(isset($csn[$attr][0])){
3106       return($csn[$attr][0]);
3107     }
3108   }
3109   return("");
3110 }
3111
3112
3113 /*! \brief Add (a) given objectClass(es) to an attrs entry
3114  *
3115  * The function adds the specified objectClass(es) to the given
3116  * attrs entry.
3117  *
3118  * \param mixed 'classes' Either a single objectClass or several objectClasses
3119  * as an array
3120  * \param array 'attrs' The attrs array to be modified.
3121  *
3122  * */
3123 function add_objectClass($classes, &$attrs)
3124 {
3125   if (is_array($classes)){
3126     $list= $classes;
3127   } else {
3128     $list= array($classes);
3129   }
3130
3131   foreach ($list as $class){
3132     $attrs['objectClass'][]= $class;
3133   }
3134 }
3135
3136
3137 /*! \brief Removes a given objectClass from the attrs entry
3138  *
3139  * Similar to add_objectClass, except that it removes the given
3140  * objectClasses. See it for the params.
3141  * */
3142 function remove_objectClass($classes, &$attrs)
3143 {
3144   if (isset($attrs['objectClass'])){
3145     /* Array? */
3146     if (is_array($classes)){
3147       $list= $classes;
3148     } else {
3149       $list= array($classes);
3150     }
3151
3152     $tmp= array();
3153     foreach ($attrs['objectClass'] as $oc) {
3154       foreach ($list as $class){
3155         if (strtolower($oc) != strtolower($class)){
3156           $tmp[]= $oc;
3157         }
3158       }
3159     }
3160     $attrs['objectClass']= $tmp;
3161   }
3162 }
3163
3164
3165 /*! \brief  Initialize a file download with given content, name and data type.
3166  *  \param  string data The content to send.
3167  *  \param  string name The name of the file.
3168  *  \param  string type The content identifier, default value is "application/octet-stream";
3169  */
3170 function send_binary_content($data,$name,$type = "application/octet-stream")
3171 {
3172   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
3173   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
3174   header("Cache-Control: no-cache");
3175   header("Pragma: no-cache");
3176   header("Cache-Control: post-check=0, pre-check=0");
3177   header("Content-type: ".$type."");
3178
3179   $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
3180
3181   /* Strip name if it is a complete path */
3182   if (preg_match ("/\//", $name)) {
3183         $name= basename($name);
3184   }
3185
3186   /* force download dialog */
3187   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
3188     header('Content-Disposition: filename="'.$name.'"');
3189   } else {
3190     header('Content-Disposition: attachment; filename="'.$name.'"');
3191   }
3192
3193   echo $data;
3194   exit();
3195 }
3196
3197
3198 function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8")
3199 {
3200   if(is_string($str)){
3201     return(htmlentities($str,$type,$charset));
3202   }elseif(is_array($str)){
3203     foreach($str as $name => $value){
3204       $str[$name] = reverse_html_entities($value,$type,$charset);
3205     }
3206   }
3207   return($str);
3208 }
3209
3210
3211 /*! \brief Encode special string characters so we can use the string in \
3212            HTML output, without breaking quotes.
3213     \param string The String we want to encode.
3214     \return string The encoded String
3215  */
3216 function xmlentities($str)
3217 {
3218   if(is_string($str)){
3219
3220     static $asc2uni= array();
3221     if (!count($asc2uni)){
3222       for($i=128;$i<256;$i++){
3223     #    $asc2uni[chr($i)] = "&#x".dechex($i).";";
3224       }
3225     }
3226
3227     $str = str_replace("&", "&amp;", $str);
3228     $str = str_replace("<", "&lt;", $str);
3229     $str = str_replace(">", "&gt;", $str);
3230     $str = str_replace("'", "&apos;", $str);
3231     $str = str_replace("\"", "&quot;", $str);
3232     $str = str_replace("\r", "", $str);
3233     $str = strtr($str,$asc2uni);
3234     return $str;
3235   }elseif(is_array($str)){
3236     foreach($str as $name => $value){
3237       $str[$name] = xmlentities($value);
3238     }
3239   }
3240   return($str);
3241 }
3242
3243
3244 /*! \brief  Updates all accessTo attributes from a given value to a new one.
3245             For example if a host is renamed.
3246     \param  String  $from The source accessTo name.
3247     \param  String  $to   The destination accessTo name.
3248 */
3249 function update_accessTo($from,$to)
3250 {
3251   global $config;
3252   $ldap = $config->get_ldap_link();
3253   $ldap->cd($config->current['BASE']);
3254   $ldap->search("(&(objectClass=trustAccount)(accessTo=".$from."))",array("objectClass","accessTo"));
3255   while($attrs = $ldap->fetch()){
3256     $new_attrs = array("accessTo" => array());
3257     $dn = $attrs['dn'];
3258     for($i = 0 ; $i < $attrs['accessTo']['count']; $i++){
3259       if($attrs['accessTo'][$i] == $from){
3260         if(!empty($to)){
3261           $new_attrs['accessTo'][] =  $to;
3262         }
3263       }else{
3264         $new_attrs['accessTo'][] =  $attrs['accessTo'][$i];
3265       }
3266     }
3267     $ldap->cd($dn);
3268     $ldap->modify($new_attrs);
3269     if (!$ldap->success()){
3270       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, "update_accessTo($from,$to)"));
3271     }
3272     new log("modify","update_accessTo($from,$to)",$dn,array_keys($new_attrs),$ldap->get_error());
3273   }
3274 }
3275
3276
3277 /*! \brief Returns a random char */
3278 function get_random_char () {
3279      $randno = rand (0, 63);
3280      if ($randno < 12) {
3281          return (chr ($randno + 46)); // Digits, '/' and '.'
3282      } else if ($randno < 38) {
3283          return (chr ($randno + 53)); // Uppercase
3284      } else {
3285          return (chr ($randno + 59)); // Lowercase
3286      }
3287 }
3288
3289
3290 function cred_encrypt($input, $password) {
3291
3292   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
3293   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
3294
3295   return bin2hex(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $password, $input, MCRYPT_MODE_ECB, $iv));
3296
3297 }
3298
3299
3300 function cred_decrypt($input,$password) {
3301   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
3302   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
3303
3304   return mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $password, pack("H*", $input), MCRYPT_MODE_ECB, $iv);
3305 }
3306
3307
3308 function get_object_info()
3309 {
3310   return(session::get('objectinfo'));
3311 }
3312
3313
3314 function set_object_info($str = "")
3315 {
3316   session::set('objectinfo',$str);
3317 }
3318
3319
3320 function isIpInNet($ip, $net, $mask) {
3321    // Move to long ints
3322    $ip= ip2long($ip);
3323    $net= ip2long($net);
3324    $mask= ip2long($mask);
3325
3326    // Mask given IP with mask. If it returns "net", we're in...
3327    $res= $ip & $mask;
3328
3329    return ($res == $net);
3330 }
3331
3332
3333 function get_next_id($attrib, $dn)
3334 {
3335   global $config;
3336
3337   switch ($config->get_cfg_value("core","idAllocationMethod")){
3338     case "pool":
3339       return get_next_id_pool($attrib);
3340     case "traditional":
3341       return get_next_id_traditional($attrib, $dn);
3342   }
3343
3344   msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." "._("unknown idAllocation method!"), ERROR_DIALOG);
3345   return null;
3346 }
3347
3348
3349 function get_next_id_pool($attrib) {
3350   global $config;
3351
3352   /* Fill informational values */
3353   $min= $config->get_cfg_value("core","${attrib}PoolMin");
3354   $max= $config->get_cfg_value("core","${attrib}PoolMax");
3355
3356   /* Sanity check */
3357   if ($min >= $max) {
3358     msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." ".sprintf(_("%sPoolMin >= %sPoolMax!"), bold($attrib), bold($attrib)), ERROR_DIALOG);
3359     return null;
3360   }
3361
3362   /* ID to skip */
3363   $ldap= $config->get_ldap_link();
3364   $id= null;
3365
3366   /* Try to allocate the ID several times before failing */
3367   $tries= 3;
3368   while ($tries--) {
3369
3370     /* Look for ID map entry */
3371     $ldap->cd ($config->current['BASE']);
3372     $ldap->search ("(&(objectClass=sambaUnixIdPool)($attrib=*))", array("$attrib"));
3373
3374     /* If it does not exist, create one with these defaults */
3375     if ($ldap->count() == 0) {
3376       /* Fill informational values */
3377       $minUserId= $config->get_cfg_value("core","uidNumberPoolMin");
3378       $minGroupId= $config->get_cfg_value("core","gidNumberPoolMin");
3379
3380       /* Add as default */
3381       $attrs= array("objectClass" => array("organizationalUnit", "sambaUnixIdPool"));
3382       $attrs["ou"]= "idmap";
3383       $attrs["uidNumber"]= $minUserId;
3384       $attrs["gidNumber"]= $minGroupId;
3385       $ldap->cd("ou=idmap,".$config->current['BASE']);
3386       $ldap->add($attrs);
3387       if ($ldap->error != "Success") {
3388         msg_dialog::display(_("Error"), _("Cannot create sambaUnixIdPool entry!"), ERROR_DIALOG);
3389         return null;
3390       }
3391       $tries++;
3392       continue;
3393     }
3394     /* Bail out if it's not unique */
3395     if ($ldap->count() != 1) {
3396       msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." "._("sambaUnixIdPool is not unique!"), ERROR_DIALOG);
3397       return null;
3398     }
3399
3400     /* Store old attrib and generate new */
3401     $attrs= $ldap->fetch();
3402     $dn= $ldap->getDN();
3403     $oldAttr= $attrs[$attrib][0];
3404     $newAttr= $oldAttr + 1;
3405
3406     /* Sanity check */
3407     if ($newAttr >= $max) {
3408       msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." "._("no ID available!"), ERROR_DIALOG);
3409       return null;
3410     }
3411     if ($newAttr < $min) {
3412       msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." "._("no ID available!"), ERROR_DIALOG);
3413       return null;
3414     }
3415
3416     #FIXME: PHP is not able to do a modification of "del: .../add: ...", so this
3417     #       is completely unsafe in the moment.
3418     #/* Remove old attr, add new attr */
3419     #$attrs= array($attrib => $oldAttr);
3420     #$ldap->rm($attrs, $dn);
3421     #if ($ldap->error != "Success") {
3422     #  continue;
3423     #}
3424     $ldap->cd($dn);
3425     $ldap->modify(array($attrib => $newAttr));
3426     if ($ldap->error != "Success") {
3427       msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." ".$ldap->get_error(), ERROR_DIALOG);
3428       return null;
3429     } else {
3430       return $oldAttr;
3431     }
3432   }
3433
3434   /* Bail out if we had problems getting the next id */
3435   if (!$tries) {
3436     msg_dialog::display(_("Error"), _("Cannot allocate free ID:")." "._("maximum number of tries exceeded!"), ERROR_DIALOG);
3437   }
3438
3439   return $id;
3440 }
3441
3442
3443 function get_next_id_traditional($attrib, $dn)
3444 {
3445   global $config;
3446
3447   $ids= array();
3448   $ldap= $config->get_ldap_link();
3449
3450   $ldap->cd ($config->current['BASE']);
3451   if (preg_match('/gidNumber/i', $attrib)){
3452     $oc= "posixGroup";
3453   } else {
3454     $oc= "posixAccount";
3455   }
3456   $ldap->search ("(&(objectClass=$oc)($attrib=*))", array("$attrib"));
3457
3458   /* Get list of ids */
3459   while ($attrs= $ldap->fetch()){
3460     $ids[]= (int)$attrs["$attrib"][0];
3461   }
3462
3463   /* Add the nobody id */
3464   $ids[]= 65534;
3465
3466   /* get the ranges */
3467   $tmp = array('0'=> 1000);
3468   if (preg_match('/posixAccount/', $oc) && $config->get_cfg_value("core","uidNumberBase") != ""){
3469     $tmp= explode('-',$config->get_cfg_value("core","uidNumberBase"));
3470   } elseif($config->get_cfg_value("core","gidNumberBase") != ""){
3471     $tmp= explode('-',$config->get_cfg_value("core","gidNumberBase"));
3472   }
3473
3474   /* Set hwm to max if not set - for backward compatibility */
3475   $lwm= $tmp[0];
3476   if (isset($tmp[1])){
3477     $hwm= $tmp[1];
3478   } else {
3479     $hwm= pow(2,32);
3480   }
3481   /* Find out next free id near to UID_BASE */
3482   if ($config->get_cfg_value("core","baseIdHook") == ""){
3483     $base= $lwm;
3484   } else {
3485     /* Call base hook */
3486     $base= get_base_from_hook($dn, $attrib);
3487   }
3488   for ($id= $base; $id++; $id < pow(2,32)){
3489     if (!in_array($id, $ids)){
3490       return ($id);
3491     }
3492   }
3493
3494   /* Should not happen */
3495   if ($id == $hwm){
3496     msg_dialog::display(_("Error"), _("Cannot allocate free ID!"), ERROR_DIALOG);
3497     exit;
3498   }
3499 }
3500
3501
3502 /* Mark the occurance of a string with a span */
3503 function mark($needle, $haystack, $ignorecase= true)
3504 {
3505   $result= "";
3506
3507   while (preg_match('/^(.*)('.preg_quote($needle).')(.*)$/i', $haystack, $matches)) {
3508     $result.= $matches[1]."<span class='mark'>".$matches[2]."</span>";
3509     $haystack= $matches[3];
3510   }
3511
3512   return $result.$haystack;
3513 }
3514
3515
3516 /* Return an image description using the path */
3517 function image($path, $action= "", $title= "", $align= "middle")
3518 {
3519   global $config;
3520   global $BASE_DIR;
3521   $label= null;
3522
3523   // Bail out, if there's no style file
3524   if(!session::global_is_set("img-styles")){
3525
3526     // Get theme
3527     if (isset ($config)){
3528       $theme= $config->get_cfg_value("core","theme");
3529     } else {
3530
3531       // Fall back to default theme
3532       $theme= "default";
3533     }
3534
3535     if (!file_exists("$BASE_DIR/ihtml/themes/$theme/img.styles")){
3536       die ("No img.style for this theme found!");
3537     }
3538
3539     session::global_set('img-styles', unserialize(file_get_contents("$BASE_DIR/ihtml/themes/$theme/img.styles")));
3540   }
3541   $styles= session::global_get('img-styles');
3542
3543   /* Extract labels from path */
3544   if (preg_match("/\.png\[(.*)\]$/", $path, $matches)) {
3545     $label= $matches[1];
3546   }
3547
3548   $lbl= "";
3549   if ($label) {
3550     if (isset($styles["images/label-".$label.".png"])) {
3551       $lbl= "<div style='".$styles["images/label-".$label.".png"]."'></div>";
3552     } else {
3553       die("Invalid label specified: $label\n");
3554     }
3555
3556     $path= preg_replace("/\[.*\]$/", "", $path);
3557   }
3558
3559   // Non middle layout?
3560   if ($align == "middle") {
3561     $align= "";
3562   } else {
3563     $align= ";vertical-align:$align";
3564   }
3565
3566   // Clickable image or not?
3567   if ($title != "") {
3568     $title= "title='$title'";
3569   }
3570   if ($action == "") {
3571     return "<div class='img' $title style='".$styles[$path]."$align'>$lbl</div>";
3572   } else {
3573     return "<input type='submit' class='img' id='$action' value='' name='$action' $title style='".$styles[$path]."$align'>";
3574   }
3575 }
3576
3577 /*! \brief    Encodes a complex string to be useable in HTML posts.
3578  */
3579 function postEncode($str)
3580 {
3581   return(preg_replace("/=/","_", base64_encode($str)));
3582 }
3583
3584 /*! \brief    Decodes a string encoded by postEncode
3585  */
3586 function postDecode($str)
3587 {
3588   return(base64_decode(preg_replace("/_/","=", $str)));
3589 }
3590
3591
3592 /*! \brief    Generate styled output
3593  */
3594 function bold($str)
3595 {
3596   return "<span class='highlight'>$str</span>";
3597 }
3598
3599
3600
3601 /*! \brief  Detect the special character handling for the currently used ldap database.
3602  *          For example some convert , to \2C or " to \22.
3603  *
3604  *  @param      Config  The GOsa configuration object.
3605  *  @return     Array   An array containing a character mapping the use.
3606  */
3607 function detectLdapSpecialCharHandling()
3608 {
3609     // The list of chars to test for
3610     global $config;
3611     if(!$config) return(NULL);
3612
3613     // In the DN we've to use escaped characters, but the object name (o)
3614     //  has the be un-escaped.
3615     $name = 'GOsaLdapEncoding_,_"_(_)_+';
3616     $dnName = 'GOsaLdapEncoding_\,_\"_(_)_\+';
3617
3618     // Prapare name to be useable in filters
3619     $fixed= normalizeLdap(str_replace('\\\\', '\\\\\\', $name));
3620     $filterName = str_replace('\\,', '\\\\,', $fixed);
3621
3622     // Create the target dn
3623     $oDN = "o={$dnName},".$config->current['BASE'];
3624
3625     // Get ldap connection and check if we've already created the character
3626     //  detection object.
3627     $ldapCID = ldap_connect($config->current['SERVER']);
3628     ldap_set_option($ldapCID, LDAP_OPT_PROTOCOL_VERSION, 3);
3629     ldap_bind($ldapCID, $config->current['ADMINDN'],$config->current['ADMINPASSWORD']);
3630     $res = ldap_list($ldapCID, $config->current['BASE'],
3631             "(&(o=".$filterName.")(objectClass=organization))",
3632             array('dn'));
3633
3634     // If we haven't created the character-detection object, then create it now.
3635     $cnt = ldap_count_entries($ldapCID, $res);
3636     if(!$cnt){
3637         $obj = array();
3638         $obj['objectClass'] = array('top','organization');
3639         $obj['o'] = $name;
3640         $obj['description'] = 'GOsa character encoding test-object.';
3641         if(!@ldap_add($ldapCID, $oDN, $obj)){
3642             trigger_error("GOsa couldn't detect the special character handling used by your ldap!");
3643             return(NULL);
3644         }
3645     }
3646
3647     // Read the character-handling detection entry from the ldap.
3648     $res = ldap_list($ldapCID, $config->current['BASE'],
3649             "(&(o=".$filterName.")(objectClass=organization))",
3650             array('dn','o'));
3651     $cnt = ldap_count_entries($ldapCID, $res);
3652     if($cnt != 1 || !$res){
3653         trigger_error("GOsa couldn't detect the special character handling used by your ldap!");
3654         return(NULL);
3655     }else{
3656
3657         // Get the character handling entry from the ldap and check how the
3658         //  values were written. Compare them with what
3659         //  we've initially intended to write and create a mapping out
3660         //  of the results.
3661         $re = ldap_first_entry($ldapCID, $res);
3662         $attrs = ldap_get_attributes($ldapCID, $re);
3663
3664         // Extract the interessting characters out of the dn and the
3665         //  initially used $name for the entry.
3666         $mapDNstr = preg_replace("/^o=GOsaLdapEncoding_([^,]*),.*$/","\\1", trim(ldap_get_dn($ldapCID, $re)));
3667         $mapDN = preg_split("/_/", $mapDNstr,0, PREG_SPLIT_NO_EMPTY);
3668
3669         $mapNameStr = preg_replace("/^GOsaLdapEncoding_/","",$dnName);
3670         $mapName = preg_split("/_/", $mapNameStr,0, PREG_SPLIT_NO_EMPTY);
3671
3672         // Create a mapping out of the results.
3673         $map = array();
3674         foreach($mapName as $key => $entry){
3675             $map[$entry] = $mapDN[$key];
3676         }
3677         return($map);
3678     }
3679     return(NULL);
3680 }
3681
3682
3683 /*! \brief  Replaces placeholder in a given string.
3684  *          For example:
3685  *            '%uid@gonicus.de'         Replaces '%uid' with 'uid'.
3686  *            '{%uid[0]@gonicus.de}'    Replaces '%uid[0]' with the first char of 'uid'.
3687  *            '%uid[2-4]@gonicus.de'    Replaces '%uid[2-4]' with three chars from 'uid' starting from the second.
3688  *
3689  *          The surrounding {} in example 2 are optional.
3690  *
3691  *  @param  String  The string to perform the action on.
3692  *  @param  Array   An array of replacements.
3693  *  @return     The resulting string.
3694  */
3695 function fillReplacements($str, $attrs, $shellArg = FALSE, $default = "")
3696 {
3697     // Search for '{%...[n-m]}
3698     // Get all matching parts of the given string and sort them by
3699     //  length, to avoid replacing strings like '%uidNumber' with 'uid'
3700     //  instead of 'uidNumber'; The longest tring at first.
3701     preg_match_all('/(\{?%([a-z0-9]+)(\[(([0-9]+)(\-([0-9]+))?)\])?\}?)/i', $str ,$matches, PREG_SET_ORDER);
3702     $hits = array();
3703     foreach($matches as $match){
3704         $hits[strlen($match[2]).$match[0]] = $match;
3705     }
3706     krsort($hits);
3707
3708     // Replace the placeholder in the given string now.
3709     foreach($hits as $match){
3710
3711         // Avoid errors about undefined index.
3712         $name = $match[2];
3713         if(!isset($attrs[$name])) $attrs[$name] = $default;
3714
3715         // Calculate the replacement
3716         $start = (isset($match[5])) ? $match[5] : 0;
3717         $end = strlen($attrs[$name]);
3718         if(isset($match[5]) && !isset($match[7])){
3719             $end = 1;
3720         }elseif(isset($match[5]) && isset($match[7])){
3721             $end = ($match[7]-$start+1);
3722         }
3723         $value  = substr($attrs[$name], $start, $end);
3724
3725         // Use values which are valid for shell execution?
3726         if($shellArg) $value = escapeshellarg($value);
3727
3728         // Replace the placeholder within the string.
3729         $str = preg_replace("/".preg_quote($match[0],'/')."/", $value, $str);
3730     }
3731     return($str);
3732 }
3733
3734
3735 /*! \brief Generate a list of uid proposals based on a rule
3736  *
3737  *  Unroll given rule string by filling in attributes and replacing
3738  *  all keywords.
3739  *
3740  * \param string 'rule' The rule string from gosa.conf.
3741  * \param array 'attributes' A dictionary of attribute/value mappings
3742  * \return array List of valid not used uids
3743  */
3744 function gen_uids($rule, $attributes)
3745 {
3746     global $config;
3747     $ldap = $config->get_ldap_link();
3748     $ldap->cd($config->current['BASE']);
3749
3750
3751     // Strip out non ascii chars
3752     foreach($attributes as $name => $value){
3753         $value = iconv('UTF-8', 'US-ASCII//TRANSLIT', $value);
3754         $value = preg_replace('/[^(\x20-\x7F)]*/','',$value);
3755         $attributes[$name] = strtolower($value);
3756     }
3757
3758     // Search for '{%...[n-m]}
3759     // Get all matching parts of the given string and sort them by
3760     //  length, to avoid replacing strings like '%uidNumber' with 'uid'
3761     //  instead of 'uidNumber'; The longest tring at first.
3762     preg_match_all('/(\{?%([a-z0-9]+)(\[(([0-9]+)(\-([0-9]+))?)\])?\}?)/i', $rule ,$matches, PREG_SET_ORDER);
3763     $replacements = array();
3764     foreach($matches as $match){
3765
3766         // No start position given, then add the complete value
3767         if(!isset($match[5])){
3768             $replacements[$match[0]][] = $attributes[$match[2]];
3769
3770         // Start given but no end, so just add a simple character
3771         }elseif(!isset($match[7])){
3772             if(isset($attributes[$match[2]][$match[5]])){
3773                 $replacements[$match[0]][] = $attributes[$match[2]][$match[5]];
3774             }
3775
3776         // Add all values in range
3777         }else{
3778             $str = "";
3779             for($i=$match[5]; $i<= $match[7]; $i++){
3780                 if(isset($attributes[$match[2]][$i])){
3781                     $str .= $attributes[$match[2]][$i];
3782                     $replacements[$match[0]][] = $str;
3783                 }
3784             }
3785         }
3786     }
3787
3788     // Create proposal array
3789     $rules = array($rule);
3790     foreach($replacements as $tag => $values){
3791         $rules = gen_uid_proposals($rules, $tag,$values);
3792     }
3793
3794
3795     // Search for id tags {id:3} / {id#3}
3796     preg_match_all('/\{id(#|:)([0-9])+\}/i', $rule ,$matches, PREG_SET_ORDER);
3797     $idReplacements = array();
3798     foreach($matches as $match){
3799         if(count($match) != 3) continue;
3800
3801         // Generate random number
3802         if($match[1] == '#'){
3803             foreach($rules as $id => $ruleStr){
3804                 $genID = rand(pow(10,$match[2] -1),pow(10, ($match[2])) - 1);
3805                 $rules[$id] = preg_replace("/".preg_quote($match[0],'/')."/", $genID,$ruleStr);
3806             }
3807         }
3808
3809         // Search for next free id
3810         if($match[1] == ':'){
3811
3812             // Walk through rules and replace all occurences of {id:..}
3813             foreach($rules as $id => $ruleStr){
3814                 $genID = 0;
3815                 $start = TRUE;
3816                 while($start || $ldap->count()){
3817                     $start = FALSE;
3818                     $number= sprintf("%0".$match[2]."d", $genID);
3819                     $testRule = preg_replace("/".preg_quote($match[0],'/')."/",$number,$ruleStr);
3820                     $ldap->search('uid='.normalizeLdap($testRule));
3821                     $genID ++;
3822                 }
3823                 $rules[$id] = preg_replace("/".preg_quote($match[0],'/')."/",$number,$ruleStr);
3824             }
3825         }
3826     }
3827
3828     // Create result set by checking which uid is already used and which is free.
3829     $ret = array();
3830     foreach($rules as $rule){
3831         $ldap->search('uid='.normalizeLdap($rule));
3832         if(!$ldap->count()){
3833             $ret[] =  $rule;
3834         }
3835     }
3836
3837     return($ret);
3838 }
3839
3840
3841 function gen_uid_proposals(&$rules, $tag, $values)
3842 {
3843     $newRules = array();
3844     foreach($rules as $rule){
3845         foreach($values as $value){
3846             $newRules[] = preg_replace("/".preg_quote($tag,'/')."/", $value, $rule);
3847         }
3848     }
3849     return($newRules);
3850 }
3851
3852
3853 function gen_uuid()
3854 {
3855     return sprintf( '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
3856         // 32 bits for "time_low"
3857         mt_rand( 0, 0xffff ), mt_rand( 0, 0xffff ),
3858
3859         // 16 bits for "time_mid"
3860         mt_rand( 0, 0xffff ),
3861
3862         // 16 bits for "time_hi_and_version",
3863         // four most significant bits holds version number 4
3864         mt_rand( 0, 0x0fff ) | 0x4000,
3865
3866         // 16 bits, 8 bits for "clk_seq_hi_res",
3867         // 8 bits for "clk_seq_low",
3868         // two most significant bits holds zero and one for variant DCE1.1
3869         mt_rand( 0, 0x3fff ) | 0x8000,
3870
3871         // 48 bits for "node"
3872         mt_rand( 0, 0xffff ), mt_rand( 0, 0xffff ), mt_rand( 0, 0xffff )
3873     );
3874 }
3875
3876 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
3877 ?>