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