X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=gosa-core%2Finclude%2Ffunctions.inc;h=21813350df90975a6d736eae9f2b96a658cba1d3;hb=ed2e61f01da6d459cbfc9bda3aaeaa61db00eac8;hp=18d72a7a66b66c0e0c00d8e637aa39a196ef7dad;hpb=618d3f0e3f307488956083dc50562e08ee808e24;p=gosa.git diff --git a/gosa-core/include/functions.inc b/gosa-core/include/functions.inc index 18d72a7a6..21813350d 100644 --- a/gosa-core/include/functions.inc +++ b/gosa-core/include/functions.inc @@ -3,7 +3,7 @@ * This code is part of GOsa (http://www.gosa-project.org) * Copyright (C) 2003-2008 GONICUS GmbH * - * ID: $$Id$$ + * ID: $$Id: functions.inc 13100 2008-12-01 14:07:48Z hickert $$ * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -20,11 +20,10 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -/* Configuration file location */ +/*! \file + * Common functions and named definitions. */ -/* Allow setting the config patj in the apache configuration - e.g. SetEnv CONFIG_FILE /etc/path - */ +/* Configuration file location */ if(!isset($_SERVER['CONFIG_DIR'])){ define ("CONFIG_DIR", "/etc/gosa"); }else{ @@ -32,7 +31,7 @@ if(!isset($_SERVER['CONFIG_DIR'])){ } /* Allow setting the config file in the apache configuration - e.g. SetEnv CONFIG_FILE gosa.conf.2.5 + e.g. SetEnv CONFIG_FILE gosa.conf.2.6 */ if(!isset($_SERVER['CONFIG_FILE'])){ define ("CONFIG_FILE", "gosa.conf"); @@ -40,6 +39,7 @@ if(!isset($_SERVER['CONFIG_FILE'])){ define ("CONFIG_FILE",$_SERVER['CONFIG_FILE']); } +/* Define common locatitions */ define ("CONFIG_TEMPLATE_DIR", "../contrib"); define ("TEMP_DIR","/var/cache/gosa/tmp"); @@ -69,8 +69,8 @@ define('DES3_CBC_MD5',5); define('DES3_CBC_SHA1',16); /* Define globals for revision comparing */ -$svn_path = '$HeadURL: https://oss.gonicus.de/repositories/gosa/trunk/gosa-core/include/functions.inc $'; -$svn_revision = '$Revision: 9246 $'; +$svn_path = '$HeadURL$'; +$svn_revision = '$Revision$'; /* Include required files */ require_once("class_location.inc"); @@ -78,15 +78,17 @@ require_once ("functions_debug.inc"); require_once ("accept-to-gettext.inc"); /* Define constants for debugging */ -define ("DEBUG_TRACE", 1); -define ("DEBUG_LDAP", 2); -define ("DEBUG_MYSQL", 4); -define ("DEBUG_SHELL", 8); -define ("DEBUG_POST", 16); -define ("DEBUG_SESSION",32); -define ("DEBUG_CONFIG", 64); -define ("DEBUG_ACL", 128); -define ("DEBUG_SI", 256); +define ("DEBUG_TRACE", 1); /*! Debug level for tracing of common actions (save, check, etc.) */ +define ("DEBUG_LDAP", 2); /*! Debug level for LDAP queries */ +define ("DEBUG_MYSQL", 4); /*! Debug level for mysql operations */ +define ("DEBUG_SHELL", 8); /*! Debug level for shell commands */ +define ("DEBUG_POST", 16); /*! Debug level for POST content */ +define ("DEBUG_SESSION",32); /*! Debug level for SESSION content */ +define ("DEBUG_CONFIG", 64); /*! Debug level for CONFIG information */ +define ("DEBUG_ACL", 128); /*! Debug level for ACL infos */ +define ("DEBUG_SI", 256); /*! Debug level for communication with gosa-si */ +define ("DEBUG_MAIL", 512); /*! Debug level for all about mail (mailAccounts, imap, sieve etc.) */ +define ("DEBUG_FAI", 1024); // FAI (incomplete) /* Rewrite german 'umlauts' and spanish 'accents' to get better results */ @@ -111,8 +113,14 @@ $REWRITE= array( "ä" => "ae", "Ã" => "Ny" ); -/* Class autoloader */ -function __autoload($class_name) { +/*! \brief Does autoloading for classes used in GOsa. + * + * Takes the list generated by 'update-gosa' and loads the + * file containing the requested class. + * + * \param string 'class_name' The currently requested class + */ +function __gosa_autoload($class_name) { global $class_mapping, $BASE_DIR; if ($class_mapping === NULL){ @@ -127,11 +135,12 @@ function __autoload($class_name) { exit; } } +spl_autoload_register('__gosa_autoload'); /*! \brief Checks if a class is available. - * @param name String The class name. - * @return boolean True if class is available, else false. + * \param string 'name' The subject of the test + * \return boolean True if class is available, else false. */ function class_available($name) { @@ -140,7 +149,13 @@ function class_available($name) } -/* Check if plugin is avaliable */ +/*! \brief Check if plugin is available + * + * Checks if a given plugin is available and readable. + * + * \param string 'plugin' the subject of the check + * \return boolean True if plugin is available, else FALSE. + */ function plugin_available($plugin) { global $class_mapping, $BASE_DIR; @@ -153,17 +168,42 @@ function plugin_available($plugin) } -/* Create seed with microseconds */ +/*! \brief Create seed with microseconds + * + * Example: + * \code + * srand(make_seed()); + * $random = rand(); + * \endcode + * + * \return float a floating point number which can be used to feed srand() with it + * */ function make_seed() { list($usec, $sec) = explode(' ', microtime()); return (float) $sec + ((float) $usec * 100000); } -/* Debug level action */ +/*! \brief Debug level action + * + * Print a DEBUG level if specified debug level of the level matches the + * the configured debug level. + * + * \param int 'level' The log level of the message (should use the constants, + * defined in functions.in (DEBUG_TRACE, DEBUG_LDAP, etc.) + * \param int 'line' Define the line of the logged action (using __LINE__ is common) + * \param string 'function' Define the function where the logged action happened in + * (using __FUNCTION__ is common) + * \param string 'file' Define the file where the logged action happend in + * (using __FILE__ is common) + * \param mixed 'data' The data to log. Can be a message or an array, which is printed + * with print_a + * \param string 'info' Optional: Additional information + * + * */ function DEBUG($level, $line, $function, $file, $data, $info="") { - if (session::get('DEBUGLEVEL') & $level){ + if (session::global_get('DEBUGLEVEL') & $level){ $output= "DEBUG[$level] "; if ($function != ""){ $output.= "($file:$function():$line) - $info: "; @@ -181,6 +221,18 @@ function DEBUG($level, $line, $function, $file, $data, $info="") } +/*! \brief Determine which language to show to the user + * + * Determines which language should be used to present gosa content + * to the user. It does so by looking at several possibilites and returning + * the first setting that can be found. + * + * -# Language configured by the user + * -# Global configured language + * -# Language as returned by al2gt (as configured in the browser) + * + * \return string gettext locale string + */ function get_browser_language() { /* Try to use users primary language */ @@ -215,18 +267,41 @@ function get_browser_language() } -/* Rewrite ui object to another dn */ +/*! \brief Rewrite ui object to another dn + * + * Usually used when a user is renamed. In this case the dn + * in the user object must be updated in order to point + * to the correct DN. + * + * \param string 'dn' the old DN + * \param string 'newdn' the new DN + * */ function change_ui_dn($dn, $newdn) { - $ui= session::get('ui'); + $ui= session::global_get('ui'); if ($ui->dn == $dn){ $ui->dn= $newdn; - session::set('ui',$ui); + session::global_set('ui',$ui); } } -/* Return theme path for specified file */ +/*! \brief Return themed path for specified base file + * + * Depending on its parameters, this function returns the full + * path of a template file. First match wins while searching + * in this order: + * + * - load theme depending file + * - load global theme depending file + * - load default theme file + * - load global default theme file + * + * \param string 'filename' The base file name + * \param boolean 'plugin' Flag to take the plugin directory as search base + * \param string 'path' User specified path to take as search base + * \return string Full path to the template file + */ function get_template_path($filename= '', $plugin= FALSE, $path= "") { global $config, $BASE_DIR; @@ -246,7 +321,7 @@ function get_template_path($filename= '', $plugin= FALSE, $path= "") /* Return plugin dir or root directory? */ if ($plugin){ if ($path == ""){ - $nf= preg_replace("!^".$BASE_DIR."/!", "", session::get('plugin_dir')); + $nf= preg_replace("!^".$BASE_DIR."/!", "", preg_replace('/^\.\.\//', '', session::global_get('plugin_dir'))); } else { $nf= preg_replace("!^".$BASE_DIR."/!", "", $path); } @@ -257,7 +332,7 @@ function get_template_path($filename= '', $plugin= FALSE, $path= "") return ("$BASE_DIR/ihtml/themes/default/$nf/$filename"); } if ($path == ""){ - return (session::get('plugin_dir')."/$filename"); + return (session::global_get('plugin_dir')."/$filename"); } else { return ($path."/$filename"); } @@ -279,36 +354,39 @@ function get_template_path($filename= '', $plugin= FALSE, $path= "") } +/*! \brief Remove multiple entries from an array + * + * Removes every element that is in $needles from the + * array given as $haystack + * + * \param array 'needles' array of the entries to remove + * \param array 'haystack' original array to remove the entries from + */ function array_remove_entries($needles, $haystack) { - $tmp= array(); - - /* Loop through entries to be removed */ - foreach ($haystack as $entry){ - if (!in_array($entry, $needles)){ - $tmp[]= $entry; - } - } - - return ($tmp); + return (array_merge(array_diff($haystack, $needles))); } +/*! \brief Remove multiple entries from an array (case-insensitive) + * + * Same as array_remove_entries(), but case-insensitive. */ function array_remove_entries_ics($needles, $haystack) { - $tmp= array(); - - /* Loop through entries to be removed */ - foreach ($haystack as $entry){ - if (!in_array_ics($entry, $needles)){ - $tmp[]= $entry; - } - } - - return ($tmp); + // strcasecmp will work, because we only compare ASCII values here + return (array_merge(array_udiff($haystack, $needles, 'strcasecmp'))); } +/*! Merge to array but remove duplicate entries + * + * Merges two arrays and removes duplicate entries. Triggers + * an error if first or second parametre is not an array. + * + * \param array 'ar1' first array + * \param array 'ar2' second array- + * \return array + */ function gosa_array_merge($ar1,$ar2) { if(!is_array($ar1) || !is_array($ar2)){ @@ -319,19 +397,25 @@ function gosa_array_merge($ar1,$ar2) } +/*! \brief Generate a system log info + * + * Creates a syslog message, containing user information. + * + * \param string 'message' the message to log + * */ function gosa_log ($message) { global $ui; /* Preset to something reasonable */ - $username= " unauthenticated"; + $username= "[unauthenticated]"; /* Replace username if object is present */ if (isset($ui)){ if ($ui->username != ""){ $username= "[$ui->username]"; } else { - $username= "unknown"; + $username= "[unknown]"; } } @@ -339,6 +423,17 @@ function gosa_log ($message) } +/*! \brief Initialize a LDAP connection + * + * Initializes a LDAP connection. + * + * \param string 'server' + * \param string 'base' + * \param string 'binddn' Default: empty + * \param string 'pass' Default: empty + * + * \return LDAP object + */ function ldap_init ($server, $base, $binddn='', $pass='') { global $config; @@ -361,6 +456,7 @@ function ldap_init ($server, $base, $binddn='', $pass='') } +/* \brief Process htaccess authentication */ function process_htaccess ($username, $kerberos= FALSE) { global $config; @@ -396,6 +492,15 @@ function process_htaccess ($username, $kerberos= FALSE) } +/*! \brief Verify user login against htaccess + * + * Checks if the specified username is available in apache, maps the user + * to an LDAP user. The password has been checked by apache already. + * + * \param string 'username' + * \return + * - TRUE on SUCCESS, NULL or FALSE on error + */ function ldap_login_user_htaccess ($username) { global $config; @@ -420,6 +525,12 @@ function ldap_login_user_htaccess ($username) $ui= new userinfo($config, $ldap->getDN()); $ui->username= $attrs['uid'][0]; + /* Bail out if we have login restrictions set, for security reasons + the message is the same than failed user/pw */ + if (!$ui->loginAllowed()){ + return (NULL); + } + /* No password check needed - the webserver did it for us */ $ldap->disconnect(); @@ -427,12 +538,22 @@ function ldap_login_user_htaccess ($username) $ui->loadACL(); /* TODO: check java script for htaccess authentication */ - session::set('js',true); + session::global_set('js', true); return ($ui); } +/*! \brief Verify user login against LDAP directory + * + * Checks if the specified username is in the LDAP and verifies if the + * password is correct by binding to the LDAP with the given credentials. + * + * \param string 'username' + * \param string 'password' + * \return + * - TRUE on SUCCESS, NULL or FALSE on error + */ function ldap_login_user ($username, $password) { global $config; @@ -449,7 +570,7 @@ function ldap_login_user ($username, $password) $allowed_attributes = array("uid","mail"); $verify_attr = array(); if($config->get_cfg_value("loginAttribute") != ""){ - $tmp = split(",", $config->get_cfg_value("loginAttribute")); + $tmp = explode(",", $config->get_cfg_value("loginAttribute")); foreach($tmp as $attr){ if(in_array($attr,$allowed_attributes)){ $verify_attr[] = $attr; @@ -500,6 +621,12 @@ function ldap_login_user ($username, $password) $ui= new userinfo($config, $ldap->getDN()); $ui->username= $attrs['uid'][0]; + /* Bail out if we have login restrictions set, for security reasons + the message is the same than failed user/pw */ + if (!$ui->loginAllowed()){ + return (NULL); + } + /* password check, bind as user with supplied password */ $ldap->disconnect(); $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'], @@ -518,6 +645,17 @@ function ldap_login_user ($username, $password) } +/*! \brief Test if account is about to expire + * + * \param string 'userdn' the DN of the user + * \param string 'username' the username + * \return int Can be one of the following values: + * - 1 the account is locked + * - 2 warn the user that the password is about to expire and he should change + * his password + * - 3 force the user to change his password + * - 4 user should not be able to change his password + * */ function ldap_expired_account($config, $userdn, $username) { $ldap= $config->get_ldap_link(); @@ -612,10 +750,24 @@ function ldap_expired_account($config, $userdn, $username) } -function add_lock ($object, $user) +/*! \brief Add a lock for object(s) + * + * Adds a lock by the specified user for one ore multiple objects. + * If the lock for that object already exists, an error is triggered. + * + * \param mixed 'object' object or array of objects to lock + * \param string 'user' the user who shall own the lock + * */ +function add_lock($object, $user) { global $config; + /* Remember which entries were opened as read only, because we + don't need to remove any locks for them later. + */ + if(!session::global_is_set("LOCK_CACHE")){ + session::global_set("LOCK_CACHE",array("")); + } if(is_array($object)){ foreach($object as $obj){ add_lock($obj,$user); @@ -623,6 +775,16 @@ function add_lock ($object, $user) return; } + $cache = &session::global_get("LOCK_CACHE"); + if(isset($_POST['open_readonly'])){ + $cache['READ_ONLY'][$object] = TRUE; + return; + } + if(isset($cache['READ_ONLY'][$object])){ + unset($cache['READ_ONLY'][$object]); + } + + /* Just a sanity check... */ if ($object == "" || $user == ""){ msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG); @@ -657,6 +819,12 @@ function add_lock ($object, $user) } +/*! \brief Remove a lock for object(s) + * + * Does the opposite of add_lock(). + * + * \param mixed 'object' object or array of objects for which a lock shall be removed + * */ function del_lock ($object) { global $config; @@ -673,6 +841,17 @@ function del_lock ($object) return; } + /* If this object was opened in read only mode then + skip removing the lock entry, there wasn't any lock created. + */ + if(session::global_is_set("LOCK_CACHE")){ + $cache = &session::global_get("LOCK_CACHE"); + if(isset($cache['READ_ONLY'][$object])){ + unset($cache['READ_ONLY'][$object]); + return; + } + } + /* Check for existance and remove the entry */ $ldap= $config->get_ldap_link(); $ldap->cd ($config->get_cfg_value("config")); @@ -689,6 +868,13 @@ function del_lock ($object) } +/*! \brief Remove all locks owned by a specific userdn + * + * For a given userdn remove all existing locks. This is usually + * called on logout. + * + * \param string 'userdn' the subject whose locks shall be deleted + */ function del_user_locks($userdn) { global $config; @@ -705,6 +891,14 @@ function del_user_locks($userdn) } +/*! \brief Get a lock for a specific object + * + * Searches for a lock on a given object. + * + * \param string 'object' subject whose locks are to be searched + * \return string Returns the user who owns the lock or "" if no lock is found + * or an error occured. + */ function get_lock ($object) { global $config; @@ -715,6 +909,9 @@ function get_lock ($object) return(""); } + /* Allow readonly access, the plugin::plugin will restrict the acls */ + if(isset($_POST['open_readonly'])) return(""); + /* Get LDAP link, check for presence of the lock entry */ $user= ""; $ldap= $config->get_ldap_link(); @@ -746,6 +943,14 @@ function get_lock ($object) } +/*! Get locks for multiple objects + * + * Similar as get_lock(), but for multiple objects. + * + * \param array 'objects' Array of Objects for which a lock shall be searched + * \return A numbered array containing all found locks as an array with key 'dn' + * and key 'user' or "" if an error occured. + */ function get_multiple_locks($objects) { global $config; @@ -780,15 +985,16 @@ function get_multiple_locks($objects) } -/* \!brief This function searches the ldap database. - It search in $sub_bases,*,$base for all objects matching the $filter. - - @param $filter String The ldap search filter - @param $category String The ACL category the result objects belongs - @param $sub_bases String The sub base we want to search for e.g. "ou=apps" - @param $base String The ldap base from which we start the search - @param $attributes Array The attributes we search for. - @param $flags Long A set of Flags +/*! \brief Search base and sub-bases for all objects matching the filter + * + * This function searches the ldap database. It searches in $sub_bases,*,$base + * for all objects matching the $filter. + * \param string 'filter' The ldap search filter + * \param string 'category' The ACL category the result objects belongs + * \param string 'sub_bases' The sub base we want to search for e.g. "ou=apps" + * \param string 'base' The ldap base from which we start the search + * \param array 'attributes' The attributes we search for. + * \param long 'flags' A set of Flags */ function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH) { @@ -870,7 +1076,7 @@ function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= arra * departments like this "ou=servers,ou=blafasel,..." * Here we filter out those blafasel departments. */ - if(preg_match("/".normalizePreg($sub_dep)."/",$attrs['dn'])){ + if(preg_match("/".preg_quote($sub_dep, '/')."/",$attrs['dn'])){ $departments[$attrs['dn']] = $attrs['dn']; break; } @@ -941,6 +1147,10 @@ function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= arra } +/*! \brief Search base for all objects matching the filter + * + * Just like get_sub_list(), but without sub base search. + * */ function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH) { global $config, $ui; @@ -1009,10 +1219,11 @@ function get_list($filter, $category, $base= "", $attributes= array(), $flags= G } +/*! \brief Show sizelimit configuration dialog if exceeded */ function check_sizelimit() { /* Ignore dialog? */ - if (session::is_set('size_ignore') && session::get('size_ignore')){ + if (session::global_is_set('size_ignore') && session::global_get('size_ignore')){ return (""); } @@ -1020,18 +1231,18 @@ function check_sizelimit() if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){ $smarty= get_smarty(); $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"), - session::get('size_limit'))); - $smarty->assign('limit_message', sprintf(_("Set the new size limit to %s and show me this message if the limit still exceeds"), '')); + session::global_get('size_limit'))); + $smarty->assign('limit_message', sprintf(_("Set the new size limit to %s and show me this message if the limit still exceeds"), '')); return($smarty->fetch(get_template_path('sizelimit.tpl'))); } return (""); } - +/*! \brief Print a sizelimit warning */ function print_sizelimit_warning() { - if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 || + if (session::global_is_set('size_limit') && session::global_get('size_limit') >= 10000000 || (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){ $config= ""; } else { @@ -1044,6 +1255,7 @@ function print_sizelimit_warning() } +/*! \brief Handle sizelimit dialog related posts */ function eval_sizelimit() { if (isset($_POST['set_size_action'])){ @@ -1052,25 +1264,25 @@ function eval_sizelimit() if (tests::is_id($_POST['new_limit']) && isset($_POST['action']) && $_POST['action']=="newlimit"){ - session::set('size_limit', validate($_POST['new_limit'])); + session::global_set('size_limit', validate($_POST['new_limit'])); session::set('size_ignore', FALSE); } /* User wants no limits? */ if (isset($_POST['action']) && $_POST['action']=="ignore"){ - session::set('size_limit', 0); - session::set('size_ignore', TRUE); + session::global_set('size_limit', 0); + session::global_set('size_ignore', TRUE); } /* User wants incomplete results */ if (isset($_POST['action']) && $_POST['action']=="limited"){ - session::set('size_ignore', TRUE); + session::global_set('size_ignore', TRUE); } } getMenuCache(); /* Allow fallback to dialog */ if (isset($_POST['edit_sizelimit'])){ - session::set('size_ignore',FALSE); + session::global_set('size_ignore',FALSE); } } @@ -1098,6 +1310,7 @@ function getMenuCache() } +/*! \brief Return the current userinfo object */ function &get_userinfo() { global $ui; @@ -1106,6 +1319,7 @@ function &get_userinfo() } +/*! \brief Get global smarty object */ function &get_smarty() { global $smarty; @@ -1114,6 +1328,21 @@ function &get_smarty() } +/*! \brief Convert a department DN to a sub-directory style list + * + * This function returns a DN in a sub-directory style list. + * Examples: + * - ou=1.1.1,ou=limux becomes limux/1.1.1 + * - cn=bla,ou=foo,dc=local becomes foo/bla or foo/bla/local, depending + * on the value for $base. + * + * If the specified DN contains a basedn which either matches + * the specified base or $config->current['BASE'] it is stripped. + * + * \param string 'dn' the subject for the conversion + * \param string 'base' the base dn, default: $this->config->current['BASE'] + * \return a string in the form as described above + */ function convert_department_dn($dn, $base = NULL) { global $config; @@ -1124,12 +1353,12 @@ function convert_department_dn($dn, $base = NULL) /* Build a sub-directory style list of the tree level specified in $dn */ - $dn = preg_replace("/".normalizePreg($base)."$/i","",$dn); + $dn = preg_replace("/".preg_quote($base, '/')."$/i","",$dn); if(empty($dn)) return("/"); $dep= ""; - foreach (split(',', $dn) as $rdn){ + foreach (explode(',', $dn) as $rdn){ $dep = preg_replace("/^[^=]+=/","",$rdn)."/".$dep; } @@ -1138,19 +1367,46 @@ function convert_department_dn($dn, $base = NULL) } -/* Strip off the last sub department part of a '/level1/level2/.../' - * style value. It removes the trailing '/', too. */ +/*! \brief Return the last sub department part of a '/level1/level2/.../' style value. + * + * Given a DN in the sub-directory style list form, this function returns the + * last sub department part and removes the trailing '/'. + * + * Example: + * \code + * print get_sub_department('local/foo/bar'); + * # Prints 'bar' + * print get_sub_department('local/foo/bar/'); + * # Also prints 'bar' + * \endcode + * + * \param string 'value' the full department string in sub-directory-style + */ function get_sub_department($value) { - return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value))); + return (LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value))); } +/*! \brief Get the OU of a certain RDN + * + * Given a certain RDN name (ogroupRDN, applicationRDN etc.) this + * function returns either a configured OU or the default + * for the given RDN. + * + * Example: + * \code + * # Determine LDAP base where systems are stored + * $base = get_ou('systemRDN') . $this->config->current['BASE']; + * $ldap->cd($base); + * \endcode + * */ function get_ou($name) { global $config; $map = array( + "roleRDN" => "ou=roles,", "ogroupRDN" => "ou=groups,", "applicationRDN" => "ou=apps,", "systemRDN" => "ou=systems,", @@ -1193,7 +1449,6 @@ function get_ou($name) return ""; } - if ($ou != ""){ if (!preg_match('/^[^=]+=[^=]+/', $ou)){ $ou = @LDAP::convert("ou=$ou"); @@ -1201,7 +1456,7 @@ function get_ou($name) $ou = @LDAP::convert("$ou"); } - if(preg_match("/".normalizePreg($config->current['BASE'])."$/",$ou)){ + if(preg_match("/".preg_quote($config->current['BASE'], '/')."$/",$ou)){ return($ou); }else{ return("$ou,"); @@ -1213,29 +1468,50 @@ function get_ou($name) } +/*! \brief Get the OU for users + * + * Frontend for get_ou() with userRDN + * */ function get_people_ou() { return (get_ou("userRDN")); } +/*! \brief Get the OU for groups + * + * Frontend for get_ou() with groupRDN + */ function get_groups_ou() { return (get_ou("groupRDN")); } +/*! \brief Get the OU for winstations + * + * Frontend for get_ou() with sambaMachineAccountRDN + */ function get_winstations_ou() { return (get_ou("sambaMachineAccountRDN")); } +/*! \brief Return a base from a given user DN + * + * \code + * get_base_from_people('cn=Max Muster,dc=local') + * # Result is 'dc=local' + * \endcode + * + * \param string 'dn' a DN + * */ function get_base_from_people($dn) { global $config; - $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i"; + $pattern= "/^[^,]+,".preg_quote(get_people_ou(), '/')."/i"; $base= preg_replace($pattern, '', $dn); /* Set to base, if we're not on a correct subtree */ @@ -1247,6 +1523,14 @@ function get_base_from_people($dn) } +/*! \brief Check if strict naming rules are configured + * + * Return TRUE or FALSE depending on weither strictNamingRules + * are configured or not. + * + * \return Returns TRUE if strictNamingRules is set to true or if the + * config object is not available, otherwise FALSE. + */ function strict_uid_mode() { global $config; @@ -1258,6 +1542,10 @@ function strict_uid_mode() } +/*! \brief Get regular expression for checking uids based on the naming + * rules. + * \return string Returns the desired regular expression + */ function get_uid_regexp() { /* STRICT adds spaces and case insenstivity to the uid check. @@ -1270,7 +1558,28 @@ function get_uid_regexp() } -function gen_locked_message($user, $dn) +/*! \brief Generate a lock message + * + * This message shows a warning to the user, that a certain object is locked + * and presents some choices how the user can proceed. By default this + * is 'Cancel' or 'Edit anyway', but depending on the function call + * its possible to allow readonly access, too. + * + * Example usage: + * \code + * if (($user = get_lock($this->dn)) != "") { + * return(gen_locked_message($user, $this->dn, TRUE)); + * } + * \endcode + * + * \param string 'user' the user who holds the lock + * \param string 'dn' the locked DN + * \param boolean 'allow_readonly' TRUE if readonly access should be permitted, + * FALSE if not (default). + * + * + */ +function gen_locked_message($user, $dn, $allow_readonly = FALSE) { global $plug, $config; @@ -1280,7 +1589,9 @@ function gen_locked_message($user, $dn) /* Save variables from LOCK_VARS_TO_USE in session - for further editing */ if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){ - $LOCK_VARS_USED = array(); + $LOCK_VARS_USED_GET = array(); + $LOCK_VARS_USED_POST = array(); + $LOCK_VARS_USED_REQUEST = array(); $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE'); foreach($LOCK_VARS_TO_USE as $name){ @@ -1291,23 +1602,31 @@ function gen_locked_message($user, $dn) foreach($_POST as $Pname => $Pvalue){ if(preg_match($name,$Pname)){ - $LOCK_VARS_USED[$Pname] = $_POST[$Pname]; + $LOCK_VARS_USED_POST[$Pname] = $_POST[$Pname]; } } foreach($_GET as $Pname => $Pvalue){ if(preg_match($name,$Pname)){ - $LOCK_VARS_USED[$Pname] = $_GET[$Pname]; + $LOCK_VARS_USED_GET[$Pname] = $_GET[$Pname]; + } + } + + foreach($_REQUEST as $Pname => $Pvalue){ + if(preg_match($name,$Pname)){ + $LOCK_VARS_USED_REQUEST[$Pname] = $_REQUEST[$Pname]; } } } session::set('LOCK_VARS_TO_USE',array()); - session::set('LOCK_VARS_USED' , $LOCK_VARS_USED); + session::set('LOCK_VARS_USED_GET' , $LOCK_VARS_USED_GET); + session::set('LOCK_VARS_USED_POST' , $LOCK_VARS_USED_POST); + session::set('LOCK_VARS_USED_REQUEST' , $LOCK_VARS_USED_REQUEST); } /* Prepare and show template */ $smarty= get_smarty(); - + $smarty->assign("allow_readonly",$allow_readonly); if(is_array($dn)){ $msg = "
"; foreach($dn as $sub_dn){ @@ -1330,6 +1649,17 @@ function gen_locked_message($user, $dn) } +/*! \brief Return a string/HTML representation of an array + * + * This returns a string representation of a given value. + * It can be used to dump arrays, where every value is printed + * on its own line. The output is targetted at HTML output, it uses + * '
' for line breaks. If the value is already a string its + * returned unchanged. + * + * \param mixed 'value' Whatever needs to be printed. + * \return string + */ function to_string ($value) { /* If this is an array, generate a text blob */ @@ -1345,6 +1675,19 @@ function to_string ($value) } +/*! \brief Return a list of all printers in the current base + * + * Returns an array with the CNs of all printers (objects with + * objectClass gotoPrinter) in the current base. + * ($config->current['BASE']). + * + * Example: + * \code + * $this->printerList = get_printer_list(); + * \endcode + * + * \return array an array with the CNs of the printers as key and value. + * */ function get_printer_list() { global $config; @@ -1357,18 +1700,30 @@ function get_printer_list() } +/*! \brief Function to rewrite some problematic characters + * + * This function takes a string and replaces all possibly characters in it + * with less problematic characters, as defined in $REWRITE. + * + * \param string 's' the string to rewrite + * \return string 's' the result of the rewrite + * */ function rewrite($s) { global $REWRITE; foreach ($REWRITE as $key => $val){ - $s= preg_replace("/$key/", "$val", $s); + $s= str_replace("$key", "$val", $s); } return ($s); } +/*! \brief Return the base of a given DN + * + * \param string 'dn' a DN + * */ function dn2base($dn) { global $config; @@ -1385,7 +1740,14 @@ function dn2base($dn) } - +/*! \brief Check if a given command exists and is executable + * + * Test if a given cmdline contains an executable command. Strips + * arguments from the given cmdline. + * + * \param string 'cmdline' the cmdline to check + * \return TRUE if command exists and is executable, otherwise FALSE. + * */ function check_command($cmdline) { $cmd= preg_replace("/ .*$/", "", $cmdline); @@ -1404,6 +1766,12 @@ function check_command($cmdline) } +/*! \brief Print plugin HTML header + * + * \param string 'image' the path of the image to be used next to the headline + * \param string 'image' the headline + * \param string 'info' additional information to print + */ function print_header($image, $headline, $info= "") { $display= "\n"; @@ -1423,6 +1791,13 @@ function print_header($image, $headline, $info= "") } +/*! \brief Print page number selector for paged lists + * + * \param int 'dcnt' Number of entries + * \param int 'start' Page to start + * \param int 'range' Number of entries per page + * \param string 'post_var' POST variable to check for range + */ function range_selector($dcnt,$start,$range=25,$post_var=false) { @@ -1530,6 +1905,7 @@ function range_selector($dcnt,$start,$range=25,$post_var=false) } +/*! \brief Generate HTML for the 'Apply filter' button */ function apply_filter() { $apply= ""; @@ -1542,6 +1918,7 @@ function apply_filter() } +/*! \brief Generate HTML for the 'Back' button */ function back_to_main() { $string= 'get_ldap_link(); $ldap->cd($config->current['BASE']); - $ldap->search('(uid=*)'); - - while($attrs= $ldap->fetch()){ - $used[]= $attrs['uid'][0]; - } /* Remove used uids and watch out for id tags */ $ret= array(); foreach($proposed as $uid){ /* Check for id tag and modify uid if needed */ - if(preg_match('/\{id:\d+}/',$uid)){ - $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid); + if(preg_match('/\{id(:|!)\d+}/',$uid, $m)){ + $size= preg_replace('/^.*{id(:|!)(\d+)}.*$/', '\\2', $uid); - for ($i= 0, $p= pow(10,$size); $i < $p; $i++){ - $number= sprintf("%0".$size."d", $i); - $res= preg_replace('/{id:(\d+)}/', $number, $uid); - if (!in_array($res, $used)){ + $start= $m[1]==":"?0:-1; + for ($i= $start, $p= pow(10,$size)-1; $i < $p; $i++){ + if ($i == -1) { + $number= ""; + } else { + $number= sprintf("%0".$size."d", $i+1); + } + $res= preg_replace('/{id(:|!)\d+}/', $number, $uid); + + $ldap->search("(uid=".preg_replace('/[{}]/', '', $res).")",array('dn')); + if($ldap->count() == 0){ $uid= $res; break; } } + + /* Remove link if nothing has been found */ + $uid= preg_replace('/{id(:|!)\d+}/', '', $uid); } - if(preg_match('/\{id#\d+}/',$uid)){ - $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid); + if(preg_match('/\{id#\d+}/',$uid)){ + $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid); - while (true){ - mt_srand((double) microtime()*1000000); - $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1)); - $res= preg_replace('/{id#(\d+)}/', $number, $uid); - if (!in_array($res, $used)){ - $uid= $res; - break; + while (true){ + mt_srand((double) microtime()*1000000); + $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1)); + $res= preg_replace('/{id#(\d+)}/', $number, $uid); + $ldap->search("(uid=".preg_replace('/[{}]/', '', $res).")",array('dn')); + if($ldap->count() == 0){ + $uid= $res; + break; + } } + + /* Remove link if nothing has been found */ + $uid= preg_replace('/{id#\d+}/', '', $uid); } - } -/* Don't assign used ones */ -if (!in_array($uid, $used)){ - $ret[]= $uid; -} -} + /* Don't assign used ones */ + $ldap->search("(uid=".preg_replace('/[{}]/', '', $uid).")",array('dn')); + if($ldap->count() == 0){ + /* Add uid, but remove {} first. These are invalid anyway. */ + $ret[]= preg_replace('/[{}]/', '', $uid); + } + } -return(array_unique($ret)); + return(array_unique($ret)); } -/* Sadly values like memory_limit are perpended by K, M, G, etc. - Need to convert... */ +/*! \brief Convert various data sizes to bytes + * + * Given a certain value in the format n(g|m|k), where n + * is a value and (g|m|k) stands for Gigabyte, Megabyte and Kilobyte + * this function returns the byte value. + * + * \param string 'value' a value in the above specified format + * \return a byte value or the original value if specified string is simply + * a numeric value + * + */ function to_byte($value) { $value= strtolower(trim($value)); @@ -1770,12 +2207,21 @@ function to_byte($value) { } +/*! \brief Check if a value exists in an array (case-insensitive) + * + * This is just as http://php.net/in_array except that the comparison + * is case-insensitive. + * + * \param string 'value' needle + * \param array 'items' haystack + */ function in_array_ics($value, $items) { return preg_grep('/^'.preg_quote($value, '/').'$/i', $items); } +/*! \brief Generate a clickable alphabet */ function generate_alphabet($count= 10) { $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"); @@ -1807,12 +2253,14 @@ function generate_alphabet($count= 10) } +/*! \brief Removes malicious characters from a (POST) string. */ function validate($string) { - return (strip_tags(preg_replace('/\0/', '', $string))); + return (strip_tags(str_replace('\0', '', $string))); } +/*! \brief Evaluate the current GOsa version from the build in revision string */ function get_gosa_version() { global $svn_revision, $svn_path; @@ -1830,6 +2278,15 @@ function get_gosa_version() } +/*! \brief Recursively delete a path in the file system + * + * Will delete the given path and all its files recursively. + * Can also follow links if told so. + * + * \param string 'path' + * \param boolean 'followLinks' TRUE to follow links, FALSE (default) + * for not following links + */ function rmdirRecursive($path, $followLinks=false) { $dir= opendir($path); while($entry= readdir($dir)) { @@ -1844,6 +2301,14 @@ function rmdirRecursive($path, $followLinks=false) { } +/*! \brief Get directory content information + * + * Returns the content of a directory as an array in an + * ascended sorted manner. + * + * \param string 'path' + * \param boolean weither to sort the content descending. + */ function scan_directory($path,$sort_desc=false) { $ret = false; @@ -1878,6 +2343,7 @@ function scan_directory($path,$sort_desc=false) } +/*! \brief Clean the smarty compile dir */ function clean_smarty_compile_dir($directory) { global $svn_revision; @@ -1965,61 +2431,55 @@ function compare_revision($revision_file, $revision) } +/*! \brief Return HTML for a progressbar + * + * \code + * $smarty->assign("installprogress", progressbar($current_progress_in_percent),100,15,true); + * \endcode + * + * \param int 'percentage' Value to display + * \param int 'width' width of the resulting output + * \param int 'height' height of the resulting output + * \param boolean 'showvalue' weither to show the percentage in the progressbar or not + * */ function progressbar($percentage,$width=100,$height=15,$showvalue=false) { - $str = ""; // Our return value will be saved in this var - - $color = dechex($percentage+150); - $color2 = dechex(150 - $percentage); - $bgcolor= $showvalue?"FFFFFF":"DDDDDD"; - - $progress = (int)(($percentage /100)*$width); - - /* If theres a better solution for this, use it... */ - $str = "\n
"; - - $str.= "\n"; - - return($str); + return(""; - - if(($height >10)&&($showvalue)){ - $str.= "\n "; - $str.= "\n ".$percentage."% "; - $str.= "\n "; - } - - $str.= "\n"; - $str.= "\n"; - $str.= "\n"; - $str.= "\n"); } +/*! \brief Lookup a key in an array case-insensitive + * + * Given an associative array this can lookup the value of + * a certain key, regardless of the case. + * + * \code + * $items = array ('FOO' => 'blub', 'bar' => 'blub'); + * array_key_ics('foo', $items); # Returns 'blub' + * array_key_ics('BAR', $items); # Returns 'blub' + * \endcode + * + * \param string 'key' needle + * \param array 'items' haystack + */ function array_key_ics($ikey, $items) { - /* Gather keys, make them lowercase */ - $tmp= array(); - foreach ($items as $key => $value){ - $tmp[strtolower($key)]= $key; - } - - if (isset($tmp[strtolower($ikey)])){ - return($tmp[strtolower($ikey)]); + $tmp= array_change_key_case($items, CASE_LOWER); + $ikey= strtolower($ikey); + if (isset($tmp[$ikey])){ + return($tmp[$ikey]); } - return (""); + return (''); } +/*! \brief Determine if two arrays are different + * + * \param array 'src' + * \param array 'dst' + * \return boolean TRUE or FALSE + * */ function array_differs($src, $dst) { /* If the count is differing, the arrays differ */ @@ -2027,15 +2487,7 @@ function array_differs($src, $dst) return (TRUE); } - /* So the count is the same - lets check the contents */ - $differs= FALSE; - foreach($src as $value){ - if (!in_array($value, $dst)){ - $differs= TRUE; - } - } - - return ($differs); + return (count(array_diff($src, $dst)) != 0); } @@ -2066,34 +2518,14 @@ function saveFilter($a_filter, $values) } -/* Escape all preg_* relevant characters */ -function normalizePreg($input) -{ - return (addcslashes($input, '[]()|/.*+-')); -} - - -/* Escape all LDAP filter relevant characters */ +/*! \brief Escape all LDAP filter relevant characters */ function normalizeLdap($input) { return (addcslashes($input, '()|')); } -/* Resturns the difference between to microtime() results in float */ -function get_MicroTimeDiff($start , $stop) -{ - $a = split("\ ",$start); - $b = split("\ ",$stop); - - $secs = $b[1] - $a[1]; - $msecs= $b[0] - $a[0]; - - $ret = (float) ($secs+ $msecs); - return($ret); -} - - +/*! \brief Return the gosa base directory */ function get_base_dir() { global $BASE_DIR; @@ -2102,6 +2534,7 @@ function get_base_dir() } +/*! \brief Test weither we are allowed to read the object */ function obj_is_readable($dn, $object, $attribute) { global $ui; @@ -2110,6 +2543,7 @@ function obj_is_readable($dn, $object, $attribute) } +/*! \brief Test weither we are allowed to change the object */ function obj_is_writable($dn, $object, $attribute) { global $ui; @@ -2118,6 +2552,16 @@ function obj_is_writable($dn, $object, $attribute) } +/*! \brief Explode a DN into its parts + * + * Similar to explode (http://php.net/explode), but a bit more specific + * for the needs when splitting, exploding LDAP DNs. + * + * \param string 'dn' the DN to split + * \param config-object a config object. only neeeded if DN shall be verified in the LDAP + * \param boolean verify_in_ldap check weither DN is valid + * + */ function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false) { /* Initialize variables */ @@ -2213,12 +2657,14 @@ function get_base_from_hook($dn, $attrib) } +/*! \brief Check if schema version matches the requirements */ function check_schema_version($class, $version) { return preg_match("/\(v$version\)/", $class['DESC']); } +/*! \brief Check if LDAP schema matches the requirements */ function check_schema($cfg,$rfc2307bis = FALSE) { $messages= array(); @@ -2243,49 +2689,49 @@ function check_schema($cfg,$rfc2307bis = FALSE) /* The gosa base schema */ $checks['gosaObject'] = $def_check; - $checks['gosaObject']['REQUIRED_VERSION'] = "2.4"; - $checks['gosaObject']['SCHEMA_FILES'] = array("gosa+samba3.schema","gosa.schema"); + $checks['gosaObject']['REQUIRED_VERSION'] = "2.6.1"; + $checks['gosaObject']['SCHEMA_FILES'] = array("gosa-samba3.schema","gosa-samba2.schema"); $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject"); $checks['gosaObject']['IS_MUST_HAVE'] = TRUE; /* GOsa Account class */ - $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4"; - $checks["gosaAccount"]["SCHEMA_FILES"] = array("gosa+samba3.schema","gosa.schema"); + $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.6.6"; + $checks["gosaAccount"]["SCHEMA_FILES"] = array("gosa-samba3.schema","gosa-samba2.schema"); $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount"); $checks["gosaAccount"]["IS_MUST_HAVE"] = TRUE; $checks["gosaAccount"]["INFO"] = _("Used to store account specific informations."); /* GOsa lock entry, used to mark currently edited objects as 'in use' */ - $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4"; - $checks["gosaLockEntry"]["SCHEMA_FILES"] = array("gosa+samba3.schema","gosa.schema"); + $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.6.1"; + $checks["gosaLockEntry"]["SCHEMA_FILES"] = array("gosa-samba3.schema","gosa-samba2.schema"); $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry"); $checks["gosaLockEntry"]["IS_MUST_HAVE"] = TRUE; $checks["gosaLockEntry"]["INFO"] = _("Used to lock currently edited entries to avoid multiple changes at the same time."); /* Some other checks */ foreach(array( - "gosaCacheEntry" => array("version" => "2.4"), - "gosaDepartment" => array("version" => "2.4"), + "gosaCacheEntry" => array("version" => "2.6.1", "class" => "gosaAccount"), + "gosaDepartment" => array("version" => "2.6.1", "class" => "gosaAccount"), "goFaxAccount" => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"), "goFaxSBlock" => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"), "goFaxRBlock" => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"), - "gosaUserTemplate" => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"), - "gosaMailAccount" => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"), - "gosaProxyAccount" => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"), - "gosaApplication" => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"), - "gosaApplicationGroup" => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"), - "GOhard" => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"), - "gotoTerminal" => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"), - "goServer" => array("version" => "2.4","class" => "server","file" => "goserver.schema"), - "goTerminalServer" => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"), - "goShareServer" => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"), - "goNtpServer" => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"), - "goSyslogServer" => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"), - "goLdapServer" => array("version" => "2.4"), - "goCupsServer" => array("version" => "2.4", "class" => array("posixAccount", "terminals"),), - "goImapServer" => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3. schema"), - "goKrbServer" => array("version" => "2.4"), - "goFaxServer" => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"), + "gosaUserTemplate" => array("version" => "2.6.1", "class" => "posixAccount","file" => "nis.schema"), + "gosaMailAccount" => array("version" => "2.6.1", "class" => "mailAccount","file" => "gosa-samba3.schema"), + "gosaProxyAccount" => array("version" => "2.6.1", "class" => "proxyAccount","file" => "gosa-samba3.schema"), + "gosaApplication" => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"), + "gosaApplicationGroup" => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"), + "GOhard" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"), + "gotoTerminal" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"), + "goServer" => array("version" => "2.6.1", "class" => "server","file" => "goserver.schema"), + "goTerminalServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"), + "goShareServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"), + "goNtpServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"), + "goSyslogServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"), + "goLdapServer" => array("version" => "2.6.1", "class" => "goServer"), + "goCupsServer" => array("version" => "2.6.1", "class" => array("posixAccount", "terminals"),), + "goImapServer" => array("version" => "2.6.1", "class" => array("mailAccount", "mailgroup"),"file" => "gosa-samba3.schema"), + "goKrbServer" => array("version" => "2.6.1", "class" => "goServer"), + "goFaxServer" => array("version" => "2.6.1", "class" => "gofaxAccount","file" => "gofax.schema"), ) as $name => $values){ $checks[$name] = $def_check; @@ -2295,26 +2741,25 @@ function check_schema($cfg,$rfc2307bis = FALSE) if(isset($values['file'])){ $checks[$name]["SCHEMA_FILES"] = array($values['file']); } - $checks[$name]["CLASSES_REQUIRED"] = array($name); + if (isset($values['class'])) { + $checks[$name]["CLASSES_REQUIRED"] = is_array($values['class'])?$values['class']:array($values['class']); + } } foreach($checks as $name => $value){ foreach($value['CLASSES_REQUIRED'] as $class){ if(!isset($objectclasses[$name])){ - $checks[$name]['STATUS'] = FALSE; if($value['IS_MUST_HAVE']){ + $checks[$name]['STATUS'] = FALSE; $checks[$name]['MSG'] = sprintf(_("Missing required object class '%s'!"),$class); - }else{ + } else { + $checks[$name]['STATUS'] = TRUE; $checks[$name]['MSG'] = sprintf(_("Missing optional object class '%s'!"),$class); } }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){ $checks[$name]['STATUS'] = FALSE; - if($value['IS_MUST_HAVE']){ - $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class, $value['REQUIRED_VERSION']); - }else{ - $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class, $value['REQUIRED_VERSION']); - } + $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class, $value['REQUIRED_VERSION']); }else{ $checks[$name]['STATUS'] = TRUE; $checks[$name]['MSG'] = sprintf(_("Class(es) available")); @@ -2326,8 +2771,8 @@ function check_schema($cfg,$rfc2307bis = FALSE) /* The gosa base schema */ $checks['posixGroup'] = $def_check; - $checks['posixGroup']['REQUIRED_VERSION'] = "2.4"; - $checks['posixGroup']['SCHEMA_FILES'] = array("gosa+samba3.schema","gosa.schema"); + $checks['posixGroup']['REQUIRED_VERSION'] = "2.6.1"; + $checks['posixGroup']['SCHEMA_FILES'] = array("gosa-samba3.schema","gosa-samba2.schema"); $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup"); $checks['posixGroup']['STATUS'] = TRUE; $checks['posixGroup']['IS_MUST_HAVE'] = TRUE; @@ -2418,22 +2863,30 @@ function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FA } -/* Returns contents of the given POST variable and check magic quotes settings */ +/*! \brief Returns contents of the given POST variable and check magic quotes settings + * + * Depending on the magic quotes settings this returns a stripclashed'ed version of + * a certain POST variable. + * + * \param string 'name' the POST var to return ($_POST[$name]) + * \return string + * */ function get_post($name) { if(!isset($_POST[$name])){ trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message."); return(FALSE); } + if(get_magic_quotes_gpc()){ - return(stripcslashes($_POST[$name])); + return(stripcslashes(validate($_POST[$name]))); }else{ - return($_POST[$name]); + return(validate($_POST[$name])); } } -/* Return class name in correct case */ +/*! \brief Return class name in correct case */ function get_correct_class_name($cls) { global $class_mapping; @@ -2448,7 +2901,17 @@ function get_correct_class_name($cls) } -// change_password, changes the Password, of the given dn +/*! \brief Change the password of a given DN + * + * Change the password of a given DN with the specified hash. + * + * \param string 'dn' the DN whose password shall be changed + * \param string 'password' the password + * \param int mode + * \param string 'hash' which hash to use to encrypt it, default is empty + * for cleartext storage. + * \return boolean TRUE on success FALSE on error + */ function change_password ($dn, $password, $mode=0, $hash= "") { global $config; @@ -2468,13 +2931,6 @@ function change_password ($dn, $password, $mode=0, $hash= "") $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid")); $attrs = $ldap->fetch (); - // Check if user account was deactivated, indicated by ! after } ... {crypt}!### - if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){ - $deactivated = TRUE; - }else{ - $deactivated = FALSE; - } - /* Is ensure that clear passwords will stay clear */ if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){ $hash = "clear"; @@ -2500,76 +2956,88 @@ function change_password ($dn, $password, $mode=0, $hash= "") $test = new $available['md5']($config); } - /* Feed password backends with information */ - $test->dn= $dn; - $test->attrs= $attrs; - $newpass= $test->generate_hash($password); - - // Update shadow timestamp? - if (isset($attrs["shadowLastChange"][0])){ - $shadow= (int)(date("U") / 86400); - } else { - $shadow= 0; - } + if($test instanceOf passwordMethod){ - // Write back modified entry - $ldap->cd($dn); - $attrs= array(); + $deactivated = $test->is_locked($config,$dn); - // Not for groups - if ($mode == 0){ + /* Feed password backends with information */ + $test->dn= $dn; + $test->attrs= $attrs; + $newpass= $test->generate_hash($password); - if ($shadow != 0){ - $attrs['shadowLastChange']= $shadow; + // Update shadow timestamp? + if (isset($attrs["shadowLastChange"][0])){ + $shadow= (int)(date("U") / 86400); + } else { + $shadow= 0; } - // Create SMB Password - $attrs= generate_smb_nt_hash($password); - } - - /* Read ! if user was deactivated */ - if($deactivated){ - $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass); - } + // Write back modified entry + $ldap->cd($dn); + $attrs= array(); - $attrs['userPassword']= array(); - $attrs['userPassword']= $newpass; + // Not for groups + if ($mode == 0){ + // Create SMB Password + $attrs= generate_smb_nt_hash($password); - $ldap->modify($attrs); + if ($shadow != 0){ + $attrs['shadowLastChange']= $shadow; + } + } - new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error()); + $attrs['userPassword']= array(); + $attrs['userPassword']= $newpass; - if (!$ldap->success()) { - msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG)); - } else { + $ldap->modify($attrs); - /* Run backend method for change/create */ - if(!$test->set_password($password)){ - return(FALSE); + /* Read ! if user was deactivated */ + if($deactivated){ + $test->lock_account($config,$dn); } - /* Find postmodify entries for this class */ - $command= $config->search("password", "POSTMODIFY",array('menu')); + new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error()); - if ($command != ""){ - /* Walk through attribute list */ - $command= preg_replace("/%userPassword/", $password, $command); - $command= preg_replace("/%dn/", $dn, $command); + if (!$ldap->success()) { + msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG)); + } else { - if (check_command($command)){ - @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute"); - exec($command); - } else { - $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password"); - msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG); + /* Run backend method for change/create */ + if(!$test->set_password($password)){ + return(FALSE); + } + + /* Find postmodify entries for this class */ + $command= $config->search("password", "POSTMODIFY",array('menu')); + + if ($command != ""){ + /* Walk through attribute list */ + $command= preg_replace("/%userPassword/", $password, $command); + $command= preg_replace("/%dn/", $dn, $command); + + if (check_command($command)){ + @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute"); + exec($command); + } else { + $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password"); + msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG); + } } } + return(TRUE); } - return(TRUE); } -// Return something like array['sambaLMPassword']= "lalla..." +/*! \brief Generate samba hashes + * + * Given a certain password this constructs an array like + * array['sambaLMPassword'] etc. + * + * \param string 'password' + * \return array contains several keys for lmPassword, ntPassword, pwdLastSet, etc. depending + * on the samba version + */ function generate_smb_nt_hash($password) { global $config; @@ -2582,6 +3050,11 @@ function generate_smb_nt_hash($password) } else { $hash= ""; } + + if ($hash == "") { + msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG); + return (""); + } } else { $tmp= $config->get_cfg_value('sambaHashHook')." ".escapeshellarg($password); @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute"); @@ -2590,30 +3063,34 @@ function generate_smb_nt_hash($password) flush(); reset($ar); $hash= current($ar); - } - if ($hash == "") { - msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG); - return (""); + if ($hash == "") { + msg_dialog::display(_("Configuration error"), sprintf(_("Cannot generate samba hash: running '%s' failed, check the 'sambaHashHook'!"),$config->get_cfg_value('sambaHashHook')), ERROR_DIALOG); + return (""); + } } - list($lm,$nt)= split (":", trim($hash)); + list($lm,$nt)= explode(":", trim($hash)); - if ($config->get_cfg_value("sambaversion") == 3) { - $attrs['sambaLMPassword']= $lm; - $attrs['sambaNTPassword']= $nt; - $attrs['sambaPwdLastSet']= date('U'); - $attrs['sambaBadPasswordCount']= "0"; - $attrs['sambaBadPasswordTime']= "0"; - } else { - $attrs['lmPassword']= $lm; - $attrs['ntPassword']= $nt; - $attrs['pwdLastSet']= date('U'); - } + $attrs['sambaLMPassword']= $lm; + $attrs['sambaNTPassword']= $nt; + $attrs['sambaPwdLastSet']= date('U'); + $attrs['sambaBadPasswordCount']= "0"; + $attrs['sambaBadPasswordTime']= "0"; return($attrs); } +/*! \brief Get the Change Sequence Number of a certain DN + * + * To verify if a given object has been changed outside of Gosa + * in the meanwhile, this function can be used to get the entryCSN + * from the LDAP directory. It uses the attribute as configured + * in modificationDetectionAttribute + * + * \param string 'dn' + * \return either the result or "" in any other case + */ function getEntryCSN($dn) { global $config; @@ -2635,7 +3112,16 @@ function getEntryCSN($dn) } -/* Add a given objectClass to an attrs entry */ +/*! \brief Add (a) given objectClass(es) to an attrs entry + * + * The function adds the specified objectClass(es) to the given + * attrs entry. + * + * \param mixed 'classes' Either a single objectClass or several objectClasses + * as an array + * \param array 'attrs' The attrs array to be modified. + * + * */ function add_objectClass($classes, &$attrs) { if (is_array($classes)){ @@ -2650,7 +3136,11 @@ function add_objectClass($classes, &$attrs) } -/* Removes a given objectClass from the attrs entry */ +/*! \brief Removes a given objectClass from the attrs entry + * + * Similar to add_objectClass, except that it removes the given + * objectClasses. See it for the params. + * */ function remove_objectClass($classes, &$attrs) { if (isset($attrs['objectClass'])){ @@ -2673,10 +3163,11 @@ function remove_objectClass($classes, &$attrs) } } + /*! \brief Initialize a file download with given content, name and data type. - * @param data String The content to send. - * @param name String The name of the file. - * @param type String The content identifier, default value is "application/octet-stream"; + * \param string data The content to send. + * \param string name The name of the file. + * \param string type The content identifier, default value is "application/octet-stream"; */ function send_binary_content($data,$name,$type = "application/octet-stream") { @@ -2721,8 +3212,8 @@ function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8") /*! \brief Encode special string characters so we can use the string in \ HTML output, without breaking quotes. - @param The String we want to encode. - @return The encoded String + \param string The String we want to encode. + \return string The encoded String */ function xmlentities($str) { @@ -2754,8 +3245,8 @@ function xmlentities($str) /*! \brief Updates all accessTo attributes from a given value to a new one. For example if a host is renamed. - @param String $from The source accessTo name. - @param String $to The destination accessTo name. + \param String $from The source accessTo name. + \param String $to The destination accessTo name. */ function update_accessTo($from,$to) { @@ -2788,6 +3279,7 @@ function update_accessTo($from,$to) } +/*! \brief Returns a random char */ function get_random_char () { $randno = rand (0, 63); if ($randno < 12) { @@ -2809,6 +3301,7 @@ function cred_encrypt($input, $password) { } + function cred_decrypt($input,$password) { $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC); $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM); @@ -2817,5 +3310,268 @@ function cred_decrypt($input,$password) { } +function get_object_info() +{ + return(session::get('objectinfo')); +} + + +function set_object_info($str = "") +{ + session::set('objectinfo',$str); +} + + +function isIpInNet($ip, $net, $mask) { + // Move to long ints + $ip= ip2long($ip); + $net= ip2long($net); + $mask= ip2long($mask); + + // Mask given IP with mask. If it returns "net", we're in... + $res= $ip & $mask; + + return ($res == $net); +} + + +function get_next_id($attrib, $dn) +{ + global $config; + + switch ($config->get_cfg_value("idAllocationMethod", "traditional")){ + case "pool": + return get_next_id_pool($attrib); + case "traditional": + return get_next_id_traditional($attrib, $dn); + } + + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("unknown idAllocation method!"), ERROR_DIALOG); + return null; +} + + +function get_next_id_pool($attrib) { + global $config; + + /* Fill informational values */ + $min= $config->get_cfg_value("${attrib}PoolMin", 10000); + $max= $config->get_cfg_value("${attrib}PoolMax", 40000); + + /* Sanity check */ + if ($min >= $max) { + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." ".sprintf(_("%sPoolMin >= %sPoolMax!"), $attrib), ERROR_DIALOG); + return null; + } + + /* ID to skip */ + $ldap= $config->get_ldap_link(); + $id= null; + + /* Try to allocate the ID several times before failing */ + $tries= 3; + while ($tries--) { + + /* Look for ID map entry */ + $ldap->cd ($config->current['BASE']); + $ldap->search ("(&(objectClass=sambaUnixIdPool)($attrib=*))", array("$attrib")); + + /* If it does not exist, create one with these defaults */ + if ($ldap->count() == 0) { + /* Fill informational values */ + $minUserId= $config->get_cfg_value("uidPoolMin", 10000); + $minGroupId= $config->get_cfg_value("gidPoolMin", 10000); + + /* Add as default */ + $attrs= array("objectClass" => array("organizationalUnit", "sambaUnixIdPool")); + $attrs["ou"]= "idmap"; + $attrs["uidNumber"]= $minUserId; + $attrs["gidNumber"]= $minGroupId; + $ldap->cd("ou=idmap,".$config->current['BASE']); + $ldap->add($attrs); + if ($ldap->error != "Success") { + msg_dialog::display(_("Error"), _("Cannot create sambaUnixIdPool entry!"), ERROR_DIALOG); + return null; + } + $tries++; + continue; + } + /* Bail out if it's not unique */ + if ($ldap->count() != 1) { + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("sambaUnixIdPool is not unique!"), ERROR_DIALOG); + return null; + } + + /* Store old attrib and generate new */ + $attrs= $ldap->fetch(); + $dn= $ldap->getDN(); + $oldAttr= $attrs[$attrib][0]; + $newAttr= $oldAttr + 1; + + /* Sanity check */ + if ($newAttr >= $max) { + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("no ID available!"), ERROR_DIALOG); + return null; + } + if ($newAttr < $min) { + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("no ID available!"), ERROR_DIALOG); + return null; + } + + #FIXME: PHP is not able to do a modification of "del: .../add: ...", so this + # is completely unsafe in the moment. + #/* Remove old attr, add new attr */ + #$attrs= array($attrib => $oldAttr); + #$ldap->rm($attrs, $dn); + #if ($ldap->error != "Success") { + # continue; + #} + $ldap->cd($dn); + $ldap->modify(array($attrib => $newAttr)); + if ($ldap->error != "Success") { + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." ".$ldap->get_error(), ERROR_DIALOG); + return null; + } else { + return $oldAttr; + } + } + + /* Bail out if we had problems getting the next id */ + if (!$tries) { + msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("maximum tries exceeded!"), ERROR_DIALOG); + } + + return $id; +} + + +function get_next_id_traditional($attrib, $dn) +{ + global $config; + + $ids= array(); + $ldap= $config->get_ldap_link(); + + $ldap->cd ($config->current['BASE']); + if (preg_match('/gidNumber/i', $attrib)){ + $oc= "posixGroup"; + } else { + $oc= "posixAccount"; + } + $ldap->search ("(&(objectClass=$oc)($attrib=*))", array("$attrib")); + + /* Get list of ids */ + while ($attrs= $ldap->fetch()){ + $ids[]= (int)$attrs["$attrib"][0]; + } + + /* Add the nobody id */ + $ids[]= 65534; + + /* get the ranges */ + $tmp = array('0'=> 1000); + if (preg_match('/posixAccount/', $oc) && $config->get_cfg_value("uidNumberBase") != ""){ + $tmp= explode('-',$config->get_cfg_value("uidNumberBase")); + } elseif($config->get_cfg_value("gidNumberBase") != ""){ + $tmp= explode('-',$config->get_cfg_value("gidNumberBase")); + } + + /* Set hwm to max if not set - for backward compatibility */ + $lwm= $tmp[0]; + if (isset($tmp[1])){ + $hwm= $tmp[1]; + } else { + $hwm= pow(2,32); + } + /* Find out next free id near to UID_BASE */ + if ($config->get_cfg_value("baseIdHook") == ""){ + $base= $lwm; + } else { + /* Call base hook */ + $base= get_base_from_hook($dn, $attrib); + } + for ($id= $base; $id++; $id < pow(2,32)){ + if (!in_array($id, $ids)){ + return ($id); + } + } + + /* Should not happen */ + if ($id == $hwm){ + msg_dialog::display(_("Error"), _("Cannot allocate a free ID!"), ERROR_DIALOG); + exit; + } +} + + +/* Mark the occurance of a string with a span */ +function mark($needle, $haystack, $ignorecase= true) +{ + $result= ""; + + while (preg_match('/^(.*)('.preg_quote($needle).')(.*)$/i', $haystack, $matches)) { + $result.= $matches[1]."".$matches[2].""; + $haystack= $matches[3]; + } + + return $result.$haystack; +} + + +/* Return an image description using the path */ +function image($path, $label= null, $action= "", $title= "", $align= "middle") +{ + global $config; + global $BASE_DIR; + + // Bail out, if there's no style file + if(!session::global_is_set("img-styles")){ + + // Get theme + if (isset ($config)){ + $theme= $config->get_cfg_value("theme", "default"); + } else { + # For debuging - avoid that there's no theme set + die("config not set!"); + $theme= "default"; + } + + if (!file_exists("$BASE_DIR/ihtml/themes/$theme/img.styles")){ + die ("No img.style for this theme found!"); + } + + session::global_set('img-styles', unserialize(file_get_contents("$BASE_DIR/ihtml/themes/$theme/img.styles"))); + } + $styles= session::global_get('img-styles'); + + $lbl= ""; + if ($label) { + if (isset($styles["images/label-".$label.".png"])) { + $lbl= ""; + } else { + die("Invalid label specified: $label\n"); + } + } + + // Non middle layout? + if ($align == "middle") { + $align= ""; + } else { + $align= ";vertical-align:$align"; + } + + // Clickable image or not? + if ($title != "") { + $title= "title='$title'"; + } + if ($action == "") { + return "
$lbl"; + } else { + return ""; + } +} + + + // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler: ?>