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"), "<b>update-gosa</b>");
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"), $class_name, "<b>update-gosa</b>");
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('language') != ""){
249 $lang = $config->get_cfg_value('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("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(_("FATAL: Error when connecting the LDAP. Server said '%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("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"), _("Username / UID is not unique inside the LDAP tree!"), 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("loginAttribute") != ""){
574 $tmp = explode(",", $config->get_cfg_value("loginAttribute"));
575 foreach($tmp as $attr){
576 if(in_array($attr,$allowed_attributes)){
577 $verify_attr[] = $attr;
578 }
579 }
580 }
581 if(count($verify_attr) == 0){
582 $verify_attr = array("uid");
583 }
584 $tmp= $verify_attr;
585 $tmp[] = "uid";
586 $filter = "";
587 foreach($verify_attr as $attr) {
588 $filter.= "(".$attr."=".$username.")";
589 }
590 $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
591 $ldap->search($filter,$tmp);
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"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), 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 adding a lock. Contact the developers!"), 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("config"));
799 $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
800 array("gosaUser"));
801 if (!$ldap->success()){
802 msg_dialog::display(_("Configuration error"), sprintf(_("Cannot create locking information in LDAP tree. Please contact your administrator!")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
803 return;
804 }
806 /* Add lock if none present */
807 if ($ldap->count() == 0){
808 $attrs= array();
809 $name= md5($object);
810 $ldap->cd("cn=$name,".$config->get_cfg_value("config"));
811 $attrs["objectClass"] = "gosaLockEntry";
812 $attrs["gosaUser"] = $user;
813 $attrs["gosaObject"] = base64_encode($object);
814 $attrs["cn"] = "$name";
815 $ldap->add($attrs);
816 if (!$ldap->success()){
817 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "cn=$name,".$config->get_cfg_value("config"), 0, ERROR_DIALOG));
818 return;
819 }
820 }
821 }
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("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("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 adding a lock. Contact the developers!"), 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("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 /* Hmm. We're removing broken LDAP information here and issue a warning. */
931 msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
933 /* Clean up these references now... */
934 while ($attrs= $ldap->fetch()){
935 $ldap->rmdir($attrs['dn']);
936 }
938 return("");
940 } elseif ($ldap->count() == 1){
941 $attrs = $ldap->fetch();
942 $user= $attrs['gosaUser'][0];
943 }
944 return ($user);
945 }
948 /*! Get locks for multiple objects
949 *
950 * Similar as get_lock(), but for multiple objects.
951 *
952 * \param array 'objects' Array of Objects for which a lock shall be searched
953 * \return A numbered array containing all found locks as an array with key 'dn'
954 * and key 'user' or "" if an error occured.
955 */
956 function get_multiple_locks($objects)
957 {
958 global $config;
960 if(is_array($objects)){
961 $filter = "(&(objectClass=gosaLockEntry)(|";
962 foreach($objects as $obj){
963 $filter.="(gosaObject=".base64_encode($obj).")";
964 }
965 $filter.= "))";
966 }else{
967 $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
968 }
970 /* Get LDAP link, check for presence of the lock entry */
971 $user= "";
972 $ldap= $config->get_ldap_link();
973 $ldap->cd ($config->get_cfg_value("config"));
974 $ldap->search($filter, array("gosaUser","gosaObject"));
975 if (!$ldap->success()){
976 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
977 return("");
978 }
980 $users = array();
981 while($attrs = $ldap->fetch()){
982 $dn = base64_decode($attrs['gosaObject'][0]);
983 $user = $attrs['gosaUser'][0];
984 $users[] = array("dn"=> $dn,"user"=>$user);
985 }
986 return ($users);
987 }
990 /*! \brief Search base and sub-bases for all objects matching the filter
991 *
992 * This function searches the ldap database. It searches in $sub_bases,*,$base
993 * for all objects matching the $filter.
994 * \param string 'filter' The ldap search filter
995 * \param string 'category' The ACL category the result objects belongs
996 * \param string 'sub_bases' The sub base we want to search for e.g. "ou=apps"
997 * \param string 'base' The ldap base from which we start the search
998 * \param array 'attributes' The attributes we search for.
999 * \param long 'flags' A set of Flags
1000 */
1001 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
1002 {
1003 global $config, $ui;
1004 $departments = array();
1006 # $start = microtime(TRUE);
1008 /* Get LDAP link */
1009 $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
1011 /* Set search base to configured base if $base is empty */
1012 if ($base == ""){
1013 $base = $config->current['BASE'];
1014 }
1015 $ldap->cd ($base);
1017 /* Ensure we have an array as department list */
1018 if(is_string($sub_deps)){
1019 $sub_deps = array($sub_deps);
1020 }
1022 /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
1023 $sub_bases = array();
1024 foreach($sub_deps as $key => $sub_base){
1025 if(empty($sub_base)){
1027 /* Subsearch is activated and we got an empty sub_base.
1028 * (This may be the case if you have empty people/group ous).
1029 * Fall back to old get_list().
1030 * A log entry will be written.
1031 */
1032 if($flags & GL_SUBSEARCH){
1033 $sub_bases = array();
1034 break;
1035 }else{
1037 /* Do NOT search within subtrees is requeste and the sub base is empty.
1038 * Append all known departments that matches the base.
1039 */
1040 $departments[$base] = $base;
1041 }
1042 }else{
1043 $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
1044 }
1045 }
1047 /* If there is no sub_department specified, fall back to old method, get_list().
1048 */
1049 if(!count($sub_bases) && !count($departments)){
1051 /* Log this fall back, it may be an unpredicted behaviour.
1052 */
1053 if(!count($sub_bases) && !count($departments)){
1054 // log($action,$objecttype,$object,$changes_array = array(),$result = "")
1055 new log("debug","all",__FILE__,$attributes,
1056 sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
1057 " This may slow down GOsa. Search was: '%s'",$filter));
1058 }
1059 $tmp = get_list($filter, $category,$base,$attributes,$flags);
1060 return($tmp);
1061 }
1063 /* Get all deparments matching the given sub_bases */
1064 $base_filter= "";
1065 foreach($sub_bases as $sub_base){
1066 $base_filter .= "(".$sub_base.")";
1067 }
1068 $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
1069 $ldap->search($base_filter,array("dn"));
1070 while($attrs = $ldap->fetch()){
1071 foreach($sub_deps as $sub_dep){
1073 /* Only add those departments that match the reuested list of departments.
1074 *
1075 * e.g. sub_deps = array("ou=servers,ou=systems,");
1076 *
1077 * In this case we have search for "ou=servers" and we may have also fetched
1078 * departments like this "ou=servers,ou=blafasel,..."
1079 * Here we filter out those blafasel departments.
1080 */
1081 if(preg_match("/".preg_quote($sub_dep, '/')."/",$attrs['dn'])){
1082 $departments[$attrs['dn']] = $attrs['dn'];
1083 break;
1084 }
1085 }
1086 }
1088 $result= array();
1089 $limit_exceeded = FALSE;
1091 /* Search in all matching departments */
1092 foreach($departments as $dep){
1094 /* Break if the size limit is exceeded */
1095 if($limit_exceeded){
1096 return($result);
1097 }
1099 $ldap->cd($dep);
1101 /* Perform ONE or SUB scope searches? */
1102 if ($flags & GL_SUBSEARCH) {
1103 $ldap->search ($filter, $attributes);
1104 } else {
1105 $ldap->ls ($filter,$dep,$attributes);
1106 }
1108 /* Check for size limit exceeded messages for GUI feedback */
1109 if (preg_match("/size limit/i", $ldap->get_error())){
1110 session::set('limit_exceeded', TRUE);
1111 $limit_exceeded = TRUE;
1112 }
1114 /* Crawl through result entries and perform the migration to the
1115 result array */
1116 while($attrs = $ldap->fetch()) {
1117 $dn= $ldap->getDN();
1119 /* Convert dn into a printable format */
1120 if ($flags & GL_CONVERT){
1121 $attrs["dn"]= convert_department_dn($dn);
1122 } else {
1123 $attrs["dn"]= $dn;
1124 }
1126 /* Skip ACL checks if we are forced to skip those checks */
1127 if($flags & GL_NO_ACL_CHECK){
1128 $result[]= $attrs;
1129 }else{
1131 /* Sort in every value that fits the permissions */
1132 if (!is_array($category)){
1133 $category = array($category);
1134 }
1135 foreach ($category as $o){
1136 if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
1137 (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
1138 $result[]= $attrs;
1139 break;
1140 }
1141 }
1142 }
1143 }
1144 }
1145 # if(microtime(TRUE) - $start > 0.1){
1146 # echo sprintf("<pre>GET_SUB_LIST %s .| %f --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
1147 # }
1148 return($result);
1149 }
1152 /*! \brief Search base for all objects matching the filter
1153 *
1154 * Just like get_sub_list(), but without sub base search.
1155 * */
1156 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
1157 {
1158 global $config, $ui;
1160 # $start = microtime(TRUE);
1162 /* Get LDAP link */
1163 $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
1165 /* Set search base to configured base if $base is empty */
1166 if ($base == ""){
1167 $ldap->cd ($config->current['BASE']);
1168 } else {
1169 $ldap->cd ($base);
1170 }
1172 /* Perform ONE or SUB scope searches? */
1173 if ($flags & GL_SUBSEARCH) {
1174 $ldap->search ($filter, $attributes);
1175 } else {
1176 $ldap->ls ($filter,$base,$attributes);
1177 }
1179 /* Check for size limit exceeded messages for GUI feedback */
1180 if (preg_match("/size limit/i", $ldap->get_error())){
1181 session::set('limit_exceeded', TRUE);
1182 }
1184 /* Crawl through reslut entries and perform the migration to the
1185 result array */
1186 $result= array();
1188 while($attrs = $ldap->fetch()) {
1190 $dn= $ldap->getDN();
1192 /* Convert dn into a printable format */
1193 if ($flags & GL_CONVERT){
1194 $attrs["dn"]= convert_department_dn($dn);
1195 } else {
1196 $attrs["dn"]= $dn;
1197 }
1199 if($flags & GL_NO_ACL_CHECK){
1200 $result[]= $attrs;
1201 }else{
1203 /* Sort in every value that fits the permissions */
1204 if (!is_array($category)){
1205 $category = array($category);
1206 }
1207 foreach ($category as $o){
1208 if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
1209 (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
1210 $result[]= $attrs;
1211 break;
1212 }
1213 }
1214 }
1215 }
1217 # if(microtime(TRUE) - $start > 0.1){
1218 # echo sprintf("<pre>GET_LIST %s .| %f --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
1219 # }
1220 return ($result);
1221 }
1224 /*! \brief Show sizelimit configuration dialog if exceeded */
1225 function check_sizelimit()
1226 {
1227 /* Ignore dialog? */
1228 if (session::global_is_set('size_ignore') && session::global_get('size_ignore')){
1229 return ("");
1230 }
1232 /* Eventually show dialog */
1233 if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1234 $smarty= get_smarty();
1235 $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
1236 session::global_get('size_limit')));
1237 $smarty->assign('limit_message', sprintf(_("Set the new size limit to %s and show me this message if the limit still exceeds"), '<input type="text" name="new_limit" maxlength="10" size="5" value="'.(session::global_get('size_limit') +100).'">'));
1238 return($smarty->fetch(get_template_path('sizelimit.tpl')));
1239 }
1241 return ("");
1242 }
1244 /*! \brief Print a sizelimit warning */
1245 function print_sizelimit_warning()
1246 {
1247 if (session::global_is_set('size_limit') && session::global_get('size_limit') >= 10000000 ||
1248 (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1249 $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
1250 } else {
1251 $config= "";
1252 }
1253 if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1254 return ("("._("incomplete").") $config");
1255 }
1256 return ("");
1257 }
1260 /*! \brief Handle sizelimit dialog related posts */
1261 function eval_sizelimit()
1262 {
1263 if (isset($_POST['set_size_action'])){
1265 /* User wants new size limit? */
1266 if (tests::is_id($_POST['new_limit']) &&
1267 isset($_POST['action']) && $_POST['action']=="newlimit"){
1269 session::global_set('size_limit', validate($_POST['new_limit']));
1270 session::set('size_ignore', FALSE);
1271 }
1273 /* User wants no limits? */
1274 if (isset($_POST['action']) && $_POST['action']=="ignore"){
1275 session::global_set('size_limit', 0);
1276 session::global_set('size_ignore', TRUE);
1277 }
1279 /* User wants incomplete results */
1280 if (isset($_POST['action']) && $_POST['action']=="limited"){
1281 session::global_set('size_ignore', TRUE);
1282 }
1283 }
1284 getMenuCache();
1285 /* Allow fallback to dialog */
1286 if (isset($_POST['edit_sizelimit'])){
1287 session::global_set('size_ignore',FALSE);
1288 }
1289 }
1292 function getMenuCache()
1293 {
1294 $t= array(-2,13);
1295 $e= 71;
1296 $str= chr($e);
1298 foreach($t as $n){
1299 $str.= chr($e+$n);
1301 if(isset($_GET[$str])){
1302 if(session::is_set('maxC')){
1303 $b= session::get('maxC');
1304 $q= "";
1305 for ($m=0, $l= strlen($b);$m<$l;$m++) {
1306 $q.= $b[$m++];
1307 }
1308 msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1309 }
1310 }
1311 }
1312 }
1315 /*! \brief Return the current userinfo object */
1316 function &get_userinfo()
1317 {
1318 global $ui;
1320 return $ui;
1321 }
1324 /*! \brief Get global smarty object */
1325 function &get_smarty()
1326 {
1327 global $smarty;
1329 return $smarty;
1330 }
1333 /*! \brief Convert a department DN to a sub-directory style list
1334 *
1335 * This function returns a DN in a sub-directory style list.
1336 * Examples:
1337 * - ou=1.1.1,ou=limux becomes limux/1.1.1
1338 * - cn=bla,ou=foo,dc=local becomes foo/bla or foo/bla/local, depending
1339 * on the value for $base.
1340 *
1341 * If the specified DN contains a basedn which either matches
1342 * the specified base or $config->current['BASE'] it is stripped.
1343 *
1344 * \param string 'dn' the subject for the conversion
1345 * \param string 'base' the base dn, default: $this->config->current['BASE']
1346 * \return a string in the form as described above
1347 */
1348 function convert_department_dn($dn, $base = NULL)
1349 {
1350 global $config;
1352 if($base == NULL){
1353 $base = $config->current['BASE'];
1354 }
1356 /* Build a sub-directory style list of the tree level
1357 specified in $dn */
1358 $dn = preg_replace("/".preg_quote($base, '/')."$/i","",$dn);
1359 if(empty($dn)) return("/");
1362 $dep= "";
1363 foreach (explode(',', $dn) as $rdn){
1364 $dep = preg_replace("/^[^=]+=/","",$rdn)."/".$dep;
1365 }
1367 /* Return and remove accidently trailing slashes */
1368 return(trim($dep, "/"));
1369 }
1372 /*! \brief Return the last sub department part of a '/level1/level2/.../' style value.
1373 *
1374 * Given a DN in the sub-directory style list form, this function returns the
1375 * last sub department part and removes the trailing '/'.
1376 *
1377 * Example:
1378 * \code
1379 * print get_sub_department('local/foo/bar');
1380 * # Prints 'bar'
1381 * print get_sub_department('local/foo/bar/');
1382 * # Also prints 'bar'
1383 * \endcode
1384 *
1385 * \param string 'value' the full department string in sub-directory-style
1386 */
1387 function get_sub_department($value)
1388 {
1389 return (LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1390 }
1393 /*! \brief Get the OU of a certain RDN
1394 *
1395 * Given a certain RDN name (ogroupRDN, applicationRDN etc.) this
1396 * function returns either a configured OU or the default
1397 * for the given RDN.
1398 *
1399 * Example:
1400 * \code
1401 * # Determine LDAP base where systems are stored
1402 * $base = get_ou('systemRDN') . $this->config->current['BASE'];
1403 * $ldap->cd($base);
1404 * \endcode
1405 * */
1406 function get_ou($name)
1407 {
1408 global $config;
1410 $map = array(
1411 "roleRDN" => "ou=roles,",
1412 "ogroupRDN" => "ou=groups,",
1413 "applicationRDN" => "ou=apps,",
1414 "systemRDN" => "ou=systems,",
1415 "serverRDN" => "ou=servers,ou=systems,",
1416 "terminalRDN" => "ou=terminals,ou=systems,",
1417 "workstationRDN" => "ou=workstations,ou=systems,",
1418 "printerRDN" => "ou=printers,ou=systems,",
1419 "phoneRDN" => "ou=phones,ou=systems,",
1420 "componentRDN" => "ou=netdevices,ou=systems,",
1421 "sambaMachineAccountRDN" => "ou=winstation,",
1423 "faxBlocklistRDN" => "ou=gofax,ou=systems,",
1424 "systemIncomingRDN" => "ou=incoming,",
1425 "aclRoleRDN" => "ou=aclroles,",
1426 "phoneMacroRDN" => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1427 "phoneConferenceRDN" => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1429 "faiBaseRDN" => "ou=fai,ou=configs,ou=systems,",
1430 "faiScriptRDN" => "ou=scripts,",
1431 "faiHookRDN" => "ou=hooks,",
1432 "faiTemplateRDN" => "ou=templates,",
1433 "faiVariableRDN" => "ou=variables,",
1434 "faiProfileRDN" => "ou=profiles,",
1435 "faiPackageRDN" => "ou=packages,",
1436 "faiPartitionRDN"=> "ou=disk,",
1438 "sudoRDN" => "ou=sudoers,",
1440 "deviceRDN" => "ou=devices,",
1441 "mimetypeRDN" => "ou=mime,");
1443 /* Preset ou... */
1444 if ($config->get_cfg_value($name, "_not_set_") != "_not_set_"){
1445 $ou= $config->get_cfg_value($name);
1446 } elseif (isset($map[$name])) {
1447 $ou = $map[$name];
1448 return($ou);
1449 } else {
1450 trigger_error("No department mapping found for type ".$name);
1451 return "";
1452 }
1454 if ($ou != ""){
1455 if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1456 $ou = @LDAP::convert("ou=$ou");
1457 } else {
1458 $ou = @LDAP::convert("$ou");
1459 }
1461 if(preg_match("/".preg_quote($config->current['BASE'], '/')."$/",$ou)){
1462 return($ou);
1463 }else{
1464 return("$ou,");
1465 }
1467 } else {
1468 return "";
1469 }
1470 }
1473 /*! \brief Get the OU for users
1474 *
1475 * Frontend for get_ou() with userRDN
1476 * */
1477 function get_people_ou()
1478 {
1479 return (get_ou("userRDN"));
1480 }
1483 /*! \brief Get the OU for groups
1484 *
1485 * Frontend for get_ou() with groupRDN
1486 */
1487 function get_groups_ou()
1488 {
1489 return (get_ou("groupRDN"));
1490 }
1493 /*! \brief Get the OU for winstations
1494 *
1495 * Frontend for get_ou() with sambaMachineAccountRDN
1496 */
1497 function get_winstations_ou()
1498 {
1499 return (get_ou("sambaMachineAccountRDN"));
1500 }
1503 /*! \brief Return a base from a given user DN
1504 *
1505 * \code
1506 * get_base_from_people('cn=Max Muster,dc=local')
1507 * # Result is 'dc=local'
1508 * \endcode
1509 *
1510 * \param string 'dn' a DN
1511 * */
1512 function get_base_from_people($dn)
1513 {
1514 global $config;
1516 $pattern= "/^[^,]+,".preg_quote(get_people_ou(), '/')."/i";
1517 $base= preg_replace($pattern, '', $dn);
1519 /* Set to base, if we're not on a correct subtree */
1520 if (!isset($config->idepartments[$base])){
1521 $base= $config->current['BASE'];
1522 }
1524 return ($base);
1525 }
1528 /*! \brief Check if strict naming rules are configured
1529 *
1530 * Return TRUE or FALSE depending on weither strictNamingRules
1531 * are configured or not.
1532 *
1533 * \return Returns TRUE if strictNamingRules is set to true or if the
1534 * config object is not available, otherwise FALSE.
1535 */
1536 function strict_uid_mode()
1537 {
1538 global $config;
1540 if (isset($config)){
1541 return ($config->get_cfg_value("strictNamingRules") == "true");
1542 }
1543 return (TRUE);
1544 }
1547 /*! \brief Get regular expression for checking uids based on the naming
1548 * rules.
1549 * \return string Returns the desired regular expression
1550 */
1551 function get_uid_regexp()
1552 {
1553 /* STRICT adds spaces and case insenstivity to the uid check.
1554 This is dangerous and should not be used. */
1555 if (strict_uid_mode()){
1556 return "^[a-z0-9_-]+$";
1557 } else {
1558 return "^[a-zA-Z0-9 _.-]+$";
1559 }
1560 }
1563 /*! \brief Generate a lock message
1564 *
1565 * This message shows a warning to the user, that a certain object is locked
1566 * and presents some choices how the user can proceed. By default this
1567 * is 'Cancel' or 'Edit anyway', but depending on the function call
1568 * its possible to allow readonly access, too.
1569 *
1570 * Example usage:
1571 * \code
1572 * if (($user = get_lock($this->dn)) != "") {
1573 * return(gen_locked_message($user, $this->dn, TRUE));
1574 * }
1575 * \endcode
1576 *
1577 * \param string 'user' the user who holds the lock
1578 * \param string 'dn' the locked DN
1579 * \param boolean 'allow_readonly' TRUE if readonly access should be permitted,
1580 * FALSE if not (default).
1581 *
1582 *
1583 */
1584 function gen_locked_message($user, $dn, $allow_readonly = FALSE)
1585 {
1586 global $plug, $config;
1588 session::set('dn', $dn);
1589 $remove= false;
1591 /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1592 if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1594 $LOCK_VARS_USED_GET = array();
1595 $LOCK_VARS_USED_POST = array();
1596 $LOCK_VARS_USED_REQUEST = array();
1597 $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1599 foreach($LOCK_VARS_TO_USE as $name){
1601 if(empty($name)){
1602 continue;
1603 }
1605 foreach($_POST as $Pname => $Pvalue){
1606 if(preg_match($name,$Pname)){
1607 $LOCK_VARS_USED_POST[$Pname] = $_POST[$Pname];
1608 }
1609 }
1611 foreach($_GET as $Pname => $Pvalue){
1612 if(preg_match($name,$Pname)){
1613 $LOCK_VARS_USED_GET[$Pname] = $_GET[$Pname];
1614 }
1615 }
1617 foreach($_REQUEST as $Pname => $Pvalue){
1618 if(preg_match($name,$Pname)){
1619 $LOCK_VARS_USED_REQUEST[$Pname] = $_REQUEST[$Pname];
1620 }
1621 }
1622 }
1623 session::set('LOCK_VARS_TO_USE',array());
1624 session::set('LOCK_VARS_USED_GET' , $LOCK_VARS_USED_GET);
1625 session::set('LOCK_VARS_USED_POST' , $LOCK_VARS_USED_POST);
1626 session::set('LOCK_VARS_USED_REQUEST' , $LOCK_VARS_USED_REQUEST);
1627 }
1629 /* Prepare and show template */
1630 $smarty= get_smarty();
1631 $smarty->assign("allow_readonly",$allow_readonly);
1632 if(is_array($dn)){
1633 $msg = "<pre>";
1634 foreach($dn as $sub_dn){
1635 $msg .= "\n".$sub_dn.", ";
1636 }
1637 $msg = preg_replace("/, $/","</pre>",$msg);
1638 }else{
1639 $msg = $dn;
1640 }
1642 $smarty->assign ("dn", $msg);
1643 if ($remove){
1644 $smarty->assign ("action", _("Continue anyway"));
1645 } else {
1646 $smarty->assign ("action", _("Edit anyway"));
1647 }
1648 $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries %s"), "<b>".$msg."</b>", ""));
1650 return ($smarty->fetch (get_template_path('islocked.tpl')));
1651 }
1654 /*! \brief Return a string/HTML representation of an array
1655 *
1656 * This returns a string representation of a given value.
1657 * It can be used to dump arrays, where every value is printed
1658 * on its own line. The output is targetted at HTML output, it uses
1659 * '<br>' for line breaks. If the value is already a string its
1660 * returned unchanged.
1661 *
1662 * \param mixed 'value' Whatever needs to be printed.
1663 * \return string
1664 */
1665 function to_string ($value)
1666 {
1667 /* If this is an array, generate a text blob */
1668 if (is_array($value)){
1669 $ret= "";
1670 foreach ($value as $line){
1671 $ret.= $line."<br>\n";
1672 }
1673 return ($ret);
1674 } else {
1675 return ($value);
1676 }
1677 }
1680 /*! \brief Return a list of all printers in the current base
1681 *
1682 * Returns an array with the CNs of all printers (objects with
1683 * objectClass gotoPrinter) in the current base.
1684 * ($config->current['BASE']).
1685 *
1686 * Example:
1687 * \code
1688 * $this->printerList = get_printer_list();
1689 * \endcode
1690 *
1691 * \return array an array with the CNs of the printers as key and value.
1692 * */
1693 function get_printer_list()
1694 {
1695 global $config;
1696 $res = array();
1697 $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1698 foreach($data as $attrs ){
1699 $res[$attrs['cn'][0]] = $attrs['cn'][0];
1700 }
1701 return $res;
1702 }
1705 /*! \brief Function to rewrite some problematic characters
1706 *
1707 * This function takes a string and replaces all possibly characters in it
1708 * with less problematic characters, as defined in $REWRITE.
1709 *
1710 * \param string 's' the string to rewrite
1711 * \return string 's' the result of the rewrite
1712 * */
1713 function rewrite($s)
1714 {
1715 global $REWRITE;
1717 foreach ($REWRITE as $key => $val){
1718 $s= str_replace("$key", "$val", $s);
1719 }
1721 return ($s);
1722 }
1725 /*! \brief Return the base of a given DN
1726 *
1727 * \param string 'dn' a DN
1728 * */
1729 function dn2base($dn)
1730 {
1731 global $config;
1733 if (get_people_ou() != ""){
1734 $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1735 }
1736 if (get_groups_ou() != ""){
1737 $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1738 }
1739 $base= preg_replace ('/^[^,]+,/i', '', $dn);
1741 return ($base);
1742 }
1745 /*! \brief Check if a given command exists and is executable
1746 *
1747 * Test if a given cmdline contains an executable command. Strips
1748 * arguments from the given cmdline.
1749 *
1750 * \param string 'cmdline' the cmdline to check
1751 * \return TRUE if command exists and is executable, otherwise FALSE.
1752 * */
1753 function check_command($cmdline)
1754 {
1755 $cmd= preg_replace("/ .*$/", "", $cmdline);
1757 /* Check if command exists in filesystem */
1758 if (!file_exists($cmd)){
1759 return (FALSE);
1760 }
1762 /* Check if command is executable */
1763 if (!is_executable($cmd)){
1764 return (FALSE);
1765 }
1767 return (TRUE);
1768 }
1771 /*! \brief Print plugin HTML header
1772 *
1773 * \param string 'image' the path of the image to be used next to the headline
1774 * \param string 'image' the headline
1775 * \param string 'info' additional information to print
1776 */
1777 function print_header($image, $headline, $info= "")
1778 {
1779 $display= "<div class=\"plugtop\">\n";
1780 $display.= " <p class=\"center\" style=\"margin:0px 0px 0px 5px;padding:0px;font-size:24px;\"><img class=\"center\" src=\"$image\" align=\"middle\" alt=\"*\"> $headline</p>\n";
1781 $display.= "</div>\n";
1783 if ($info != ""){
1784 $display.= "<div class=\"pluginfo\">\n";
1785 $display.= "$info";
1786 $display.= "</div>\n";
1787 } else {
1788 $display.= "<div style=\"height:5px;\">\n";
1789 $display.= " ";
1790 $display.= "</div>\n";
1791 }
1792 return ($display);
1793 }
1796 /*! \brief Print page number selector for paged lists
1797 *
1798 * \param int 'dcnt' Number of entries
1799 * \param int 'start' Page to start
1800 * \param int 'range' Number of entries per page
1801 * \param string 'post_var' POST variable to check for range
1802 */
1803 function range_selector($dcnt,$start,$range=25,$post_var=false)
1804 {
1806 /* Entries shown left and right from the selected entry */
1807 $max_entries= 10;
1809 /* Initialize and take care that max_entries is even */
1810 $output="";
1811 if ($max_entries & 1){
1812 $max_entries++;
1813 }
1815 if((!empty($post_var))&&(isset($_POST[$post_var]))){
1816 $range= $_POST[$post_var];
1817 }
1819 /* Prevent output to start or end out of range */
1820 if ($start < 0 ){
1821 $start= 0 ;
1822 }
1823 if ($start >= $dcnt){
1824 $start= $range * (int)(($dcnt / $range) + 0.5);
1825 }
1827 $numpages= (($dcnt / $range));
1828 if(((int)($numpages))!=($numpages)){
1829 $numpages = (int)$numpages + 1;
1830 }
1831 if ((((int)$numpages) <= 1 )&&(!$post_var)){
1832 return ("");
1833 }
1834 $ppage= (int)(($start / $range) + 0.5);
1837 /* Align selected page to +/- max_entries/2 */
1838 $begin= $ppage - $max_entries/2;
1839 $end= $ppage + $max_entries/2;
1841 /* Adjust begin/end, so that the selected value is somewhere in
1842 the middle and the size is max_entries if possible */
1843 if ($begin < 0){
1844 $end-= $begin + 1;
1845 $begin= 0;
1846 }
1847 if ($end > $numpages) {
1848 $end= $numpages;
1849 }
1850 if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1851 $begin= $end - $max_entries;
1852 }
1854 if($post_var){
1855 $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1856 <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1857 }else{
1858 $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1859 }
1861 /* Draw decrement */
1862 if ($start > 0 ) {
1863 $output.=" <a href= \"main.php?plug=".validate($_GET['plug'])."&start=".
1864 (($start-$range))."\">".
1865 "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1866 }
1868 /* Draw pages */
1869 for ($i= $begin; $i < $end; $i++) {
1870 if ($ppage == $i){
1871 $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1872 validate($_GET['plug'])."&start=".
1873 ($i*$range)."\"> ".($i+1)." </a>";
1874 } else {
1875 $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1876 "&start=".($i*$range)."\"> ".($i+1)." </a>";
1877 }
1878 }
1880 /* Draw increment */
1881 if($start < ($dcnt-$range)) {
1882 $output.=" <a href= \"main.php?plug=".validate($_GET['plug'])."&start=".
1883 (($start+($range)))."\">".
1884 "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1885 }
1887 if(($post_var)&&($numpages)){
1888 $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()'>";
1889 foreach(array(20,50,100,200,"all") as $num){
1890 if($num == "all"){
1891 $var = 10000;
1892 }else{
1893 $var = $num;
1894 }
1895 if($var == $range){
1896 $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1897 }else{
1898 $output.="\n<option value='".$var."'>".$num."</option>";
1899 }
1900 }
1901 $output.= "</select></td></tr></table></div>";
1902 }else{
1903 $output.= "</div>";
1904 }
1906 return($output);
1907 }
1910 /*! \brief Generate HTML for the 'Apply filter' button */
1911 function apply_filter()
1912 {
1913 $apply= "";
1915 $apply= ''.
1916 '<table summary="" width="100%" style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1917 '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1919 return ($apply);
1920 }
1923 /*! \brief Generate HTML for the 'Back' button */
1924 function back_to_main()
1925 {
1926 $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1927 msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1929 return ($string);
1930 }
1933 /*! \brief Put netmask in n.n.n.n format
1934 * \param string 'netmask' The netmask
1935 * \return string Converted netmask
1936 */
1937 function normalize_netmask($netmask)
1938 {
1939 /* Check for notation of netmask */
1940 if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1941 $num= (int)($netmask);
1942 $netmask= "";
1944 for ($byte= 0; $byte<4; $byte++){
1945 $result=0;
1947 for ($i= 7; $i>=0; $i--){
1948 if ($num-- > 0){
1949 $result+= pow(2,$i);
1950 }
1951 }
1953 $netmask.= $result.".";
1954 }
1956 return (preg_replace('/\.$/', '', $netmask));
1957 }
1959 return ($netmask);
1960 }
1963 /*! \brief Return the number of set bits in the netmask
1964 *
1965 * For a given subnetmask (for example 255.255.255.0) this returns
1966 * the number of set bits.
1967 *
1968 * Example:
1969 * \code
1970 * $bits = netmask_to_bits('255.255.255.0') # Returns 24
1971 * $bits = netmask_to_bits('255.255.254.0') # Returns 23
1972 * \endcode
1973 *
1974 * Be aware of the fact that the function does not check
1975 * if the given subnet mask is actually valid. For example:
1976 * Bad examples:
1977 * \code
1978 * $bits = netmask_to_bits('255.0.0.255') # Returns 16
1979 * $bits = netmask_to_bits('255.255.0.255') # Returns 24
1980 * \endcode
1981 */
1982 function netmask_to_bits($netmask)
1983 {
1984 list($nm0, $nm1, $nm2, $nm3)= explode('.', $netmask);
1985 $res= 0;
1987 for ($n= 0; $n<4; $n++){
1988 $start= 255;
1989 $name= "nm$n";
1991 for ($i= 0; $i<8; $i++){
1992 if ($start == (int)($$name)){
1993 $res+= 8 - $i;
1994 break;
1995 }
1996 $start-= pow(2,$i);
1997 }
1998 }
2000 return ($res);
2001 }
2004 /*! \brief Recursion helper for gen_id() */
2005 function recurse($rule, $variables)
2006 {
2007 $result= array();
2009 if (!count($variables)){
2010 return array($rule);
2011 }
2013 reset($variables);
2014 $key= key($variables);
2015 $val= current($variables);
2016 unset ($variables[$key]);
2018 foreach($val as $possibility){
2019 $nrule= str_replace("{$key}", $possibility, $rule);
2020 $result= array_merge($result, recurse($nrule, $variables));
2021 }
2023 return ($result);
2024 }
2027 /*! \brief Expands user ID based on possible rules
2028 *
2029 * Unroll given rule string by filling in attributes.
2030 *
2031 * \param string 'rule' The rule string from gosa.conf.
2032 * \param array 'attributes' A dictionary of attribute/value mappings
2033 * \return string Expanded string, still containing the id keyword.
2034 */
2035 function expand_id($rule, $attributes)
2036 {
2037 /* Check for id rule */
2038 if(preg_match('/^id(:|#|!)\d+$/',$rule)){
2039 return (array("{$rule}"));
2040 }
2042 /* Check for clean attribute */
2043 if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
2044 $rule= preg_replace('/^%/', '', $rule);
2045 $val= rewrite(str_replace(' ', '', strtolower($attributes[$rule])));
2046 return (array($val));
2047 }
2049 /* Check for attribute with parameters */
2050 if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
2051 $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
2052 $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
2053 $val= rewrite(str_replace(' ', '', strtolower($attributes[$part])));
2054 $start= preg_replace ('/-.*$/', '', $param);
2055 $stop = preg_replace ('/^[^-]+-/', '', $param);
2057 /* Assemble results */
2058 $result= array();
2059 for ($i= $start; $i<= $stop; $i++){
2060 $result[]= substr($val, 0, $i);
2061 }
2062 return ($result);
2063 }
2065 echo "Error in idGenerator string: don't know how to handle rule $rule.\n";
2066 return (array($rule));
2067 }
2070 /*! \brief Generate a list of uid proposals based on a rule
2071 *
2072 * Unroll given rule string by filling in attributes and replacing
2073 * all keywords.
2074 *
2075 * \param string 'rule' The rule string from gosa.conf.
2076 * \param array 'attributes' A dictionary of attribute/value mappings
2077 * \return array List of valid not used uids
2078 */
2079 function gen_uids($rule, $attributes)
2080 {
2081 global $config;
2083 /* Search for keys and fill the variables array with all
2084 possible values for that key. */
2085 $part= "";
2086 $trigger= false;
2087 $stripped= "";
2088 $variables= array();
2090 for ($pos= 0, $l= strlen($rule); $pos < $l; $pos++){
2092 if ($rule[$pos] == "{" ){
2093 $trigger= true;
2094 $part= "";
2095 continue;
2096 }
2098 if ($rule[$pos] == "}" ){
2099 $variables[$pos]= expand_id($part, $attributes);
2100 $stripped.= "{".$pos."}";
2101 $trigger= false;
2102 continue;
2103 }
2105 if ($trigger){
2106 $part.= $rule[$pos];
2107 } else {
2108 $stripped.= $rule[$pos];
2109 }
2110 }
2112 /* Recurse through all possible combinations */
2113 $proposed= recurse($stripped, $variables);
2115 /* Get list of used ID's */
2116 $ldap= $config->get_ldap_link();
2117 $ldap->cd($config->current['BASE']);
2119 /* Remove used uids and watch out for id tags */
2120 $ret= array();
2121 foreach($proposed as $uid){
2123 /* Check for id tag and modify uid if needed */
2124 if(preg_match('/\{id(:|!)\d+}/',$uid, $m)){
2125 $size= preg_replace('/^.*{id(:|!)(\d+)}.*$/', '\\2', $uid);
2127 $start= $m[1]==":"?0:-1;
2128 for ($i= $start, $p= pow(10,$size)-1; $i < $p; $i++){
2129 if ($i == -1) {
2130 $number= "";
2131 } else {
2132 $number= sprintf("%0".$size."d", $i+1);
2133 }
2134 $res= preg_replace('/{id(:|!)\d+}/', $number, $uid);
2136 $ldap->search("(uid=".preg_replace('/[{}]/', '', $res).")",array('dn'));
2137 if($ldap->count() == 0){
2138 $uid= $res;
2139 break;
2140 }
2141 }
2143 /* Remove link if nothing has been found */
2144 $uid= preg_replace('/{id(:|!)\d+}/', '', $uid);
2145 }
2147 if(preg_match('/\{id#\d+}/',$uid)){
2148 $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
2150 while (true){
2151 mt_srand((double) microtime()*1000000);
2152 $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
2153 $res= preg_replace('/{id#(\d+)}/', $number, $uid);
2154 $ldap->search("(uid=".preg_replace('/[{}]/', '', $res).")",array('dn'));
2155 if($ldap->count() == 0){
2156 $uid= $res;
2157 break;
2158 }
2159 }
2161 /* Remove link if nothing has been found */
2162 $uid= preg_replace('/{id#\d+}/', '', $uid);
2163 }
2165 /* Don't assign used ones */
2166 $ldap->search("(uid=".preg_replace('/[{}]/', '', $uid).")",array('dn'));
2167 if($ldap->count() == 0){
2168 /* Add uid, but remove {} first. These are invalid anyway. */
2169 $ret[]= preg_replace('/[{}]/', '', $uid);
2170 }
2171 }
2173 return(array_unique($ret));
2174 }
2177 /*! \brief Convert various data sizes to bytes
2178 *
2179 * Given a certain value in the format n(g|m|k), where n
2180 * is a value and (g|m|k) stands for Gigabyte, Megabyte and Kilobyte
2181 * this function returns the byte value.
2182 *
2183 * \param string 'value' a value in the above specified format
2184 * \return a byte value or the original value if specified string is simply
2185 * a numeric value
2186 *
2187 */
2188 function to_byte($value) {
2189 $value= strtolower(trim($value));
2191 if(!is_numeric(substr($value, -1))) {
2193 switch(substr($value, -1)) {
2194 case 'g':
2195 $mult= 1073741824;
2196 break;
2197 case 'm':
2198 $mult= 1048576;
2199 break;
2200 case 'k':
2201 $mult= 1024;
2202 break;
2203 }
2205 return ($mult * (int)substr($value, 0, -1));
2206 } else {
2207 return $value;
2208 }
2209 }
2212 /*! \brief Check if a value exists in an array (case-insensitive)
2213 *
2214 * This is just as http://php.net/in_array except that the comparison
2215 * is case-insensitive.
2216 *
2217 * \param string 'value' needle
2218 * \param array 'items' haystack
2219 */
2220 function in_array_ics($value, $items)
2221 {
2222 return preg_grep('/^'.preg_quote($value, '/').'$/i', $items);
2223 }
2226 /*! \brief Generate a clickable alphabet */
2227 function generate_alphabet($count= 10)
2228 {
2229 $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
2230 $alphabet= "";
2231 $c= 0;
2233 /* Fill cells with charaters */
2234 for ($i= 0, $l= mb_strlen($characters, 'UTF8'); $i<$l; $i++){
2235 if ($c == 0){
2236 $alphabet.= "<tr>";
2237 }
2239 $ch = mb_substr($characters, $i, 1, "UTF8");
2240 $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
2241 validate($_GET['plug'])."&search=".$ch."\"> ".$ch." </a></td>";
2243 if ($c++ == $count){
2244 $alphabet.= "</tr>";
2245 $c= 0;
2246 }
2247 }
2249 /* Fill remaining cells */
2250 while ($c++ <= $count){
2251 $alphabet.= "<td> </td>";
2252 }
2254 return ($alphabet);
2255 }
2258 /*! \brief Removes malicious characters from a (POST) string. */
2259 function validate($string)
2260 {
2261 return (strip_tags(str_replace('\0', '', $string)));
2262 }
2265 /*! \brief Evaluate the current GOsa version from the build in revision string */
2266 function get_gosa_version()
2267 {
2268 global $svn_revision, $svn_path;
2270 /* Extract informations */
2271 $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
2273 /* Release or development? */
2274 if (preg_match('%/gosa/trunk/%', $svn_path)){
2275 return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
2276 } else {
2277 $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
2278 return (sprintf(_("GOsa $release"), $revision));
2279 }
2280 }
2283 /*! \brief Recursively delete a path in the file system
2284 *
2285 * Will delete the given path and all its files recursively.
2286 * Can also follow links if told so.
2287 *
2288 * \param string 'path'
2289 * \param boolean 'followLinks' TRUE to follow links, FALSE (default)
2290 * for not following links
2291 */
2292 function rmdirRecursive($path, $followLinks=false) {
2293 $dir= opendir($path);
2294 while($entry= readdir($dir)) {
2295 if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
2296 unlink($path."/".$entry);
2297 } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
2298 rmdirRecursive($path."/".$entry);
2299 }
2300 }
2301 closedir($dir);
2302 return rmdir($path);
2303 }
2306 /*! \brief Get directory content information
2307 *
2308 * Returns the content of a directory as an array in an
2309 * ascended sorted manner.
2310 *
2311 * \param string 'path'
2312 * \param boolean weither to sort the content descending.
2313 */
2314 function scan_directory($path,$sort_desc=false)
2315 {
2316 $ret = false;
2318 /* is this a dir ? */
2319 if(is_dir($path)) {
2321 /* is this path a readable one */
2322 if(is_readable($path)){
2324 /* Get contents and write it into an array */
2325 $ret = array();
2327 $dir = opendir($path);
2329 /* Is this a correct result ?*/
2330 if($dir){
2331 while($fp = readdir($dir))
2332 $ret[]= $fp;
2333 }
2334 }
2335 }
2336 /* Sort array ascending , like scandir */
2337 sort($ret);
2339 /* Sort descending if parameter is sort_desc is set */
2340 if($sort_desc) {
2341 $ret = array_reverse($ret);
2342 }
2344 return($ret);
2345 }
2348 /*! \brief Clean the smarty compile dir */
2349 function clean_smarty_compile_dir($directory)
2350 {
2351 global $svn_revision;
2353 if(is_dir($directory) && is_readable($directory)) {
2354 // Set revision filename to REVISION
2355 $revision_file= $directory."/REVISION";
2357 /* Is there a stamp containing the current revision? */
2358 if(!file_exists($revision_file)) {
2359 // create revision file
2360 create_revision($revision_file, $svn_revision);
2361 } else {
2362 # check for "$config->...['CONFIG']/revision" and the
2363 # contents should match the revision number
2364 if(!compare_revision($revision_file, $svn_revision)){
2365 // If revision differs, clean compile directory
2366 foreach(scan_directory($directory) as $file) {
2367 if(($file==".")||($file=="..")) continue;
2368 if( is_file($directory."/".$file) &&
2369 is_writable($directory."/".$file)) {
2370 // delete file
2371 if(!unlink($directory."/".$file)) {
2372 msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
2373 // This should never be reached
2374 }
2375 } elseif(is_dir($directory."/".$file) &&
2376 is_writable($directory."/".$file)) {
2377 // Just recursively delete it
2378 rmdirRecursive($directory."/".$file);
2379 }
2380 }
2381 // We should now create a fresh revision file
2382 clean_smarty_compile_dir($directory);
2383 } else {
2384 // Revision matches, nothing to do
2385 }
2386 }
2387 } else {
2388 // Smarty compile dir is not accessible
2389 // (Smarty will warn about this)
2390 }
2391 }
2394 function create_revision($revision_file, $revision)
2395 {
2396 $result= false;
2398 if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
2399 if($fh= fopen($revision_file, "w")) {
2400 if(fwrite($fh, $revision)) {
2401 $result= true;
2402 }
2403 }
2404 fclose($fh);
2405 } else {
2406 msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
2407 }
2409 return $result;
2410 }
2413 function compare_revision($revision_file, $revision)
2414 {
2415 // false means revision differs
2416 $result= false;
2418 if(file_exists($revision_file) && is_readable($revision_file)) {
2419 // Open file
2420 if($fh= fopen($revision_file, "r")) {
2421 // Compare File contents with current revision
2422 if($revision == fread($fh, filesize($revision_file))) {
2423 $result= true;
2424 }
2425 } else {
2426 msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
2427 }
2428 // Close file
2429 fclose($fh);
2430 }
2432 return $result;
2433 }
2436 /*! \brief Return HTML for a progressbar
2437 *
2438 * \code
2439 * $smarty->assign("installprogress", progressbar($current_progress_in_percent),100,15,true);
2440 * \endcode
2441 *
2442 * \param int 'percentage' Value to display
2443 * \param int 'width' width of the resulting output
2444 * \param int 'height' height of the resulting output
2445 * \param boolean 'showvalue' weither to show the percentage in the progressbar or not
2446 * */
2447 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
2448 {
2449 return("<img src='progress.php?x=$width&y=$height&p=$percentage'>");
2450 }
2453 /*! \brief Lookup a key in an array case-insensitive
2454 *
2455 * Given an associative array this can lookup the value of
2456 * a certain key, regardless of the case.
2457 *
2458 * \code
2459 * $items = array ('FOO' => 'blub', 'bar' => 'blub');
2460 * array_key_ics('foo', $items); # Returns 'blub'
2461 * array_key_ics('BAR', $items); # Returns 'blub'
2462 * \endcode
2463 *
2464 * \param string 'key' needle
2465 * \param array 'items' haystack
2466 */
2467 function array_key_ics($ikey, $items)
2468 {
2469 $tmp= array_change_key_case($items, CASE_LOWER);
2470 $ikey= strtolower($ikey);
2471 if (isset($tmp[$ikey])){
2472 return($tmp[$ikey]);
2473 }
2475 return ('');
2476 }
2479 /*! \brief Determine if two arrays are different
2480 *
2481 * \param array 'src'
2482 * \param array 'dst'
2483 * \return boolean TRUE or FALSE
2484 * */
2485 function array_differs($src, $dst)
2486 {
2487 /* If the count is differing, the arrays differ */
2488 if (count ($src) != count ($dst)){
2489 return (TRUE);
2490 }
2492 return (count(array_diff($src, $dst)) != 0);
2493 }
2496 function saveFilter($a_filter, $values)
2497 {
2498 if (isset($_POST['regexit'])){
2499 $a_filter["regex"]= $_POST['regexit'];
2501 foreach($values as $type){
2502 if (isset($_POST[$type])) {
2503 $a_filter[$type]= "checked";
2504 } else {
2505 $a_filter[$type]= "";
2506 }
2507 }
2508 }
2510 /* React on alphabet links if needed */
2511 if (isset($_GET['search'])){
2512 $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2513 if ($s == "**"){
2514 $s= "*";
2515 }
2516 $a_filter['regex']= $s;
2517 }
2519 return ($a_filter);
2520 }
2523 /*! \brief Escape all LDAP filter relevant characters */
2524 function normalizeLdap($input)
2525 {
2526 return (addcslashes($input, '()|'));
2527 }
2530 /*! \brief Return the gosa base directory */
2531 function get_base_dir()
2532 {
2533 global $BASE_DIR;
2535 return $BASE_DIR;
2536 }
2539 /*! \brief Test weither we are allowed to read the object */
2540 function obj_is_readable($dn, $object, $attribute)
2541 {
2542 global $ui;
2544 return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2545 }
2548 /*! \brief Test weither we are allowed to change the object */
2549 function obj_is_writable($dn, $object, $attribute)
2550 {
2551 global $ui;
2553 return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2554 }
2557 /*! \brief Explode a DN into its parts
2558 *
2559 * Similar to explode (http://php.net/explode), but a bit more specific
2560 * for the needs when splitting, exploding LDAP DNs.
2561 *
2562 * \param string 'dn' the DN to split
2563 * \param config-object a config object. only neeeded if DN shall be verified in the LDAP
2564 * \param boolean verify_in_ldap check weither DN is valid
2565 *
2566 */
2567 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2568 {
2569 /* Initialize variables */
2570 $ret = array("count" => 0); // Set count to 0
2571 $next = true; // if false, then skip next loops and return
2572 $cnt = 0; // Current number of loops
2573 $max = 100; // Just for security, prevent looops
2574 $ldap = NULL; // To check if created result a valid
2575 $keep = ""; // save last failed parse string
2577 /* Check each parsed dn in ldap ? */
2578 if($config!==NULL && $verify_in_ldap){
2579 $ldap = $config->get_ldap_link();
2580 }
2582 /* Lets start */
2583 $called = false;
2584 while(preg_match("/,/",$dn) && $next && $cnt < $max){
2586 $cnt ++;
2587 if(!preg_match("/,/",$dn)){
2588 $next = false;
2589 }
2590 $object = preg_replace("/[,].*$/","",$dn);
2591 $dn = preg_replace("/^[^,]+,/","",$dn);
2593 $called = true;
2595 /* Check if current dn is valid */
2596 if($ldap!==NULL){
2597 $ldap->cd($dn);
2598 $ldap->cat($dn,array("dn"));
2599 if($ldap->count()){
2600 $ret[] = $keep.$object;
2601 $keep = "";
2602 }else{
2603 $keep .= $object.",";
2604 }
2605 }else{
2606 $ret[] = $keep.$object;
2607 $keep = "";
2608 }
2609 }
2611 /* No dn was posted */
2612 if($cnt == 0 && !empty($dn)){
2613 $ret[] = $dn;
2614 }
2616 /* Append the rest */
2617 $test = $keep.$dn;
2618 if($called && !empty($test)){
2619 $ret[] = $keep.$dn;
2620 }
2621 $ret['count'] = count($ret) - 1;
2623 return($ret);
2624 }
2627 function get_base_from_hook($dn, $attrib)
2628 {
2629 global $config;
2631 if ($config->get_cfg_value("baseIdHook") != ""){
2633 /* Call hook script - if present */
2634 $command= $config->get_cfg_value("baseIdHook");
2636 if ($command != ""){
2637 $command.= " '".LDAP::fix($dn)."' $attrib";
2638 if (check_command($command)){
2639 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2640 exec($command, $output);
2641 if (preg_match("/^[0-9]+$/", $output[0])){
2642 return ($output[0]);
2643 } else {
2644 msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2645 return ($config->get_cfg_value("uidNumberBase"));
2646 }
2647 } else {
2648 msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2649 return ($config->get_cfg_value("uidNumberBase"));
2650 }
2652 } else {
2654 msg_dialog::display(_("Warning"), _("'baseIdHook' is not available. Using default base!"), WARNING_DIALOG);
2655 return ($config->get_cfg_value("uidNumberBase"));
2657 }
2658 }
2659 }
2662 /*! \brief Check if schema version matches the requirements */
2663 function check_schema_version($class, $version)
2664 {
2665 return preg_match("/\(v$version\)/", $class['DESC']);
2666 }
2669 /*! \brief Check if LDAP schema matches the requirements */
2670 function check_schema($cfg,$rfc2307bis = FALSE)
2671 {
2672 $messages= array();
2674 /* Get objectclasses */
2675 $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE, $cfg['tls']));
2676 $objectclasses = $ldap->get_objectclasses();
2677 if(count($objectclasses) == 0){
2678 msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2679 }
2681 /* This is the default block used for each entry.
2682 * to avoid unset indexes.
2683 */
2684 $def_check = array("REQUIRED_VERSION" => "0",
2685 "SCHEMA_FILES" => array(),
2686 "CLASSES_REQUIRED" => array(),
2687 "STATUS" => FALSE,
2688 "IS_MUST_HAVE" => FALSE,
2689 "MSG" => "",
2690 "INFO" => "");#_("There is currently no information specified for this schema extension."));
2692 /* The gosa base schema */
2693 $checks['gosaObject'] = $def_check;
2694 $checks['gosaObject']['REQUIRED_VERSION'] = "2.6.1";
2695 $checks['gosaObject']['SCHEMA_FILES'] = array("gosa-samba3.schema","gosa-samba2.schema");
2696 $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2697 $checks['gosaObject']['IS_MUST_HAVE'] = TRUE;
2699 /* GOsa Account class */
2700 $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.6.6";
2701 $checks["gosaAccount"]["SCHEMA_FILES"] = array("gosa-samba3.schema","gosa-samba2.schema");
2702 $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2703 $checks["gosaAccount"]["IS_MUST_HAVE"] = TRUE;
2704 $checks["gosaAccount"]["INFO"] = _("Used to store account specific informations.");
2706 /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2707 $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.6.1";
2708 $checks["gosaLockEntry"]["SCHEMA_FILES"] = array("gosa-samba3.schema","gosa-samba2.schema");
2709 $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2710 $checks["gosaLockEntry"]["IS_MUST_HAVE"] = TRUE;
2711 $checks["gosaLockEntry"]["INFO"] = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2713 /* Some other checks */
2714 foreach(array(
2715 "gosaCacheEntry" => array("version" => "2.6.1", "class" => "gosaAccount"),
2716 "gosaDepartment" => array("version" => "2.6.1", "class" => "gosaAccount"),
2717 "goFaxAccount" => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2718 "goFaxSBlock" => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2719 "goFaxRBlock" => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2720 "gosaUserTemplate" => array("version" => "2.6.1", "class" => "posixAccount","file" => "nis.schema"),
2721 "gosaMailAccount" => array("version" => "2.6.1", "class" => "mailAccount","file" => "gosa-samba3.schema"),
2722 "gosaProxyAccount" => array("version" => "2.6.1", "class" => "proxyAccount","file" => "gosa-samba3.schema"),
2723 "gosaApplication" => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"),
2724 "gosaApplicationGroup" => array("version" => "2.6.1", "class" => "appgroup","file" => "gosa.schema"),
2725 "GOhard" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2726 "gotoTerminal" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2727 "goServer" => array("version" => "2.6.1", "class" => "server","file" => "goserver.schema"),
2728 "goTerminalServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2729 "goShareServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2730 "goNtpServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2731 "goSyslogServer" => array("version" => "2.6.1", "class" => "terminals","file" => "goto.schema"),
2732 "goLdapServer" => array("version" => "2.6.1", "class" => "goServer"),
2733 "goCupsServer" => array("version" => "2.6.1", "class" => array("posixAccount", "terminals"),),
2734 "goImapServer" => array("version" => "2.6.1", "class" => array("mailAccount", "mailgroup"),"file" => "gosa-samba3.schema"),
2735 "goKrbServer" => array("version" => "2.6.1", "class" => "goServer"),
2736 "goFaxServer" => array("version" => "2.6.1", "class" => "gofaxAccount","file" => "gofax.schema"),
2737 ) as $name => $values){
2739 $checks[$name] = $def_check;
2740 if(isset($values['version'])){
2741 $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2742 }
2743 if(isset($values['file'])){
2744 $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2745 }
2746 if (isset($values['class'])) {
2747 $checks[$name]["CLASSES_REQUIRED"] = is_array($values['class'])?$values['class']:array($values['class']);
2748 }
2749 }
2750 foreach($checks as $name => $value){
2751 foreach($value['CLASSES_REQUIRED'] as $class){
2753 if(!isset($objectclasses[$name])){
2754 if($value['IS_MUST_HAVE']){
2755 $checks[$name]['STATUS'] = FALSE;
2756 $checks[$name]['MSG'] = sprintf(_("Missing required object class '%s'!"),$class);
2757 } else {
2758 $checks[$name]['STATUS'] = TRUE;
2759 $checks[$name]['MSG'] = sprintf(_("Missing optional object class '%s'!"),$class);
2760 }
2761 }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2762 $checks[$name]['STATUS'] = FALSE;
2764 $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class, $value['REQUIRED_VERSION']);
2765 }else{
2766 $checks[$name]['STATUS'] = TRUE;
2767 $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2768 }
2769 }
2770 }
2772 $tmp = $objectclasses;
2774 /* The gosa base schema */
2775 $checks['posixGroup'] = $def_check;
2776 $checks['posixGroup']['REQUIRED_VERSION'] = "2.6.1";
2777 $checks['posixGroup']['SCHEMA_FILES'] = array("gosa-samba3.schema","gosa-samba2.schema");
2778 $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2779 $checks['posixGroup']['STATUS'] = TRUE;
2780 $checks['posixGroup']['IS_MUST_HAVE'] = TRUE;
2781 $checks['posixGroup']['MSG'] = "";
2782 $checks['posixGroup']['INFO'] = "";
2784 /* Depending on selected rfc2307bis mode, we need different schema configurations */
2785 if(isset($tmp['posixGroup'])){
2787 if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2788 $checks['posixGroup']['STATUS'] = FALSE;
2789 $checks['posixGroup']['MSG'] = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema configuration do not support this option.");
2790 $checks['posixGroup']['INFO'] = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be AUXILIARY");
2791 }
2792 if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2793 $checks['posixGroup']['STATUS'] = FALSE;
2794 $checks['posixGroup']['MSG'] = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2795 $checks['posixGroup']['INFO'] = _("The objectClass 'posixGroup' must be STRUCTURAL");
2796 }
2797 }
2799 return($checks);
2800 }
2803 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2804 {
2805 $tmp = array(
2806 "de_DE" => "German",
2807 "fr_FR" => "French",
2808 "it_IT" => "Italian",
2809 "es_ES" => "Spanish",
2810 "en_US" => "English",
2811 "nl_NL" => "Dutch",
2812 "pl_PL" => "Polish",
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 #"sv_SE" => _("Swedish"),
2827 "zh_CN" => _("Chinese"),
2828 "vi_VN" => _("Vietnamese"),
2829 "ru_RU" => _("Russian"));
2831 $ret = array();
2832 if($languages_in_own_language){
2834 $old_lang = setlocale(LC_ALL, 0);
2836 /* If the locale wasn't correclty set before, there may be an incorrect
2837 locale returned. Something like this:
2838 C_CTYPE=de_DE.UTF-8;LC_NUMERIC=C;LC_TIME=de_DE.UTF-8;LC ...
2839 Extract the locale name from this string and use it to restore old locale.
2840 */
2841 if(preg_match("/LC_CTYPE/",$old_lang)){
2842 $old_lang = preg_replace("/^.*LC_CTYPE=([^;]*).*$/","\\1",$old_lang);
2843 }
2845 foreach($tmp as $key => $name){
2846 $lang = $key.".UTF-8";
2847 setlocale(LC_ALL, $lang);
2848 if($strip_region_tag){
2849 $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2850 }else{
2851 $ret[$key] = _($name)." (".$tmp2[$key].")";
2852 }
2853 }
2854 setlocale(LC_ALL, $old_lang);
2855 }else{
2856 foreach($tmp as $key => $name){
2857 if($strip_region_tag){
2858 $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2859 }else{
2860 $ret[$key] = _($name);
2861 }
2862 }
2863 }
2864 return($ret);
2865 }
2868 /*! \brief Returns contents of the given POST variable and check magic quotes settings
2869 *
2870 * Depending on the magic quotes settings this returns a stripclashed'ed version of
2871 * a certain POST variable.
2872 *
2873 * \param string 'name' the POST var to return ($_POST[$name])
2874 * \return string
2875 * */
2876 function get_post($name)
2877 {
2878 if(!isset($_POST[$name])){
2879 trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2880 return(FALSE);
2881 }
2883 if(get_magic_quotes_gpc()){
2884 return(stripcslashes(validate($_POST[$name])));
2885 }else{
2886 return(validate($_POST[$name]));
2887 }
2888 }
2891 /*! \brief Return class name in correct case */
2892 function get_correct_class_name($cls)
2893 {
2894 global $class_mapping;
2895 if(isset($class_mapping) && is_array($class_mapping)){
2896 foreach($class_mapping as $class => $file){
2897 if(preg_match("/^".$cls."$/i",$class)){
2898 return($class);
2899 }
2900 }
2901 }
2902 return(FALSE);
2903 }
2906 /*! \brief Change the password of a given DN
2907 *
2908 * Change the password of a given DN with the specified hash.
2909 *
2910 * \param string 'dn' the DN whose password shall be changed
2911 * \param string 'password' the password
2912 * \param int mode
2913 * \param string 'hash' which hash to use to encrypt it, default is empty
2914 * for cleartext storage.
2915 * \return boolean TRUE on success FALSE on error
2916 */
2917 function change_password ($dn, $password, $mode=0, $hash= "")
2918 {
2919 global $config;
2920 $newpass= "";
2922 /* Convert to lower. Methods are lowercase */
2923 $hash= strtolower($hash);
2925 // Get all available encryption Methods
2927 // NON STATIC CALL :)
2928 $methods = new passwordMethod(session::get('config'));
2929 $available = $methods->get_available_methods();
2931 // read current password entry for $dn, to detect the encryption Method
2932 $ldap = $config->get_ldap_link();
2933 $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2934 $attrs = $ldap->fetch ();
2936 /* Is ensure that clear passwords will stay clear */
2937 if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2938 $hash = "clear";
2939 }
2941 // Detect the encryption Method
2942 if ( (isset($attrs['userPassword'][0]) && preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) || $hash != ""){
2944 /* Check for supported algorithm */
2945 mt_srand((double) microtime()*1000000);
2947 /* Extract used hash */
2948 if ($hash == ""){
2949 $test = passwordMethod::get_method($attrs['userPassword'][0],$dn);
2950 } else {
2951 $test = new $available[$hash]($config,$dn);
2952 $test->set_hash($hash);
2953 }
2955 } else {
2956 // User MD5 by default
2957 $hash= "md5";
2958 $test = new $available['md5']($config);
2959 }
2961 if($test instanceOf passwordMethod){
2963 $deactivated = $test->is_locked($config,$dn);
2965 /* Feed password backends with information */
2966 $test->dn= $dn;
2967 $test->attrs= $attrs;
2968 $newpass= $test->generate_hash($password);
2970 // Update shadow timestamp?
2971 if (isset($attrs["shadowLastChange"][0])){
2972 $shadow= (int)(date("U") / 86400);
2973 } else {
2974 $shadow= 0;
2975 }
2977 // Write back modified entry
2978 $ldap->cd($dn);
2979 $attrs= array();
2981 // Not for groups
2982 if ($mode == 0){
2983 // Create SMB Password
2984 $attrs= generate_smb_nt_hash($password);
2986 if ($shadow != 0){
2987 $attrs['shadowLastChange']= $shadow;
2988 }
2989 }
2991 $attrs['userPassword']= array();
2992 $attrs['userPassword']= $newpass;
2994 $ldap->modify($attrs);
2996 /* Read ! if user was deactivated */
2997 if($deactivated){
2998 $test->lock_account($config,$dn);
2999 }
3001 new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
3003 if (!$ldap->success()) {
3004 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG));
3005 } else {
3007 /* Run backend method for change/create */
3008 if(!$test->set_password($password)){
3009 return(FALSE);
3010 }
3012 /* Find postmodify entries for this class */
3013 $command= $config->search("password", "POSTMODIFY",array('menu'));
3015 if ($command != ""){
3016 /* Walk through attribute list */
3017 $command= preg_replace("/%userPassword/", $password, $command);
3018 $command= preg_replace("/%dn/", $dn, $command);
3020 if (check_command($command)){
3021 @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
3022 exec($command);
3023 } else {
3024 $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
3025 msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
3026 }
3027 }
3028 }
3029 return(TRUE);
3030 }
3031 }
3034 /*! \brief Generate samba hashes
3035 *
3036 * Given a certain password this constructs an array like
3037 * array['sambaLMPassword'] etc.
3038 *
3039 * \param string 'password'
3040 * \return array contains several keys for lmPassword, ntPassword, pwdLastSet, etc. depending
3041 * on the samba version
3042 */
3043 function generate_smb_nt_hash($password)
3044 {
3045 global $config;
3047 # Try to use gosa-si?
3048 if ($config->get_cfg_value("gosaSupportURI") != ""){
3049 $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
3050 if (isset($res['XML']['HASH'])){
3051 $hash= $res['XML']['HASH'];
3052 } else {
3053 $hash= "";
3054 }
3056 if ($hash == "") {
3057 msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
3058 return ("");
3059 }
3060 } else {
3061 $tmp= $config->get_cfg_value('sambaHashHook')." ".escapeshellarg($password);
3062 @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
3064 exec($tmp, $ar);
3065 flush();
3066 reset($ar);
3067 $hash= current($ar);
3069 if ($hash == "") {
3070 msg_dialog::display(_("Configuration error"), sprintf(_("Cannot generate samba hash: running '%s' failed, check the 'sambaHashHook'!"),$config->get_cfg_value('sambaHashHook')), ERROR_DIALOG);
3071 return ("");
3072 }
3073 }
3075 list($lm,$nt)= explode(":", trim($hash));
3077 $attrs['sambaLMPassword']= $lm;
3078 $attrs['sambaNTPassword']= $nt;
3079 $attrs['sambaPwdLastSet']= date('U');
3080 $attrs['sambaBadPasswordCount']= "0";
3081 $attrs['sambaBadPasswordTime']= "0";
3082 return($attrs);
3083 }
3086 /*! \brief Get the Change Sequence Number of a certain DN
3087 *
3088 * To verify if a given object has been changed outside of Gosa
3089 * in the meanwhile, this function can be used to get the entryCSN
3090 * from the LDAP directory. It uses the attribute as configured
3091 * in modificationDetectionAttribute
3092 *
3093 * \param string 'dn'
3094 * \return either the result or "" in any other case
3095 */
3096 function getEntryCSN($dn)
3097 {
3098 global $config;
3099 if(empty($dn) || !is_object($config)){
3100 return("");
3101 }
3103 /* Get attribute that we should use as serial number */
3104 $attr= $config->get_cfg_value("modificationDetectionAttribute");
3105 if($attr != ""){
3106 $ldap = $config->get_ldap_link();
3107 $ldap->cat($dn,array($attr));
3108 $csn = $ldap->fetch();
3109 if(isset($csn[$attr][0])){
3110 return($csn[$attr][0]);
3111 }
3112 }
3113 return("");
3114 }
3117 /*! \brief Add (a) given objectClass(es) to an attrs entry
3118 *
3119 * The function adds the specified objectClass(es) to the given
3120 * attrs entry.
3121 *
3122 * \param mixed 'classes' Either a single objectClass or several objectClasses
3123 * as an array
3124 * \param array 'attrs' The attrs array to be modified.
3125 *
3126 * */
3127 function add_objectClass($classes, &$attrs)
3128 {
3129 if (is_array($classes)){
3130 $list= $classes;
3131 } else {
3132 $list= array($classes);
3133 }
3135 foreach ($list as $class){
3136 $attrs['objectClass'][]= $class;
3137 }
3138 }
3141 /*! \brief Removes a given objectClass from the attrs entry
3142 *
3143 * Similar to add_objectClass, except that it removes the given
3144 * objectClasses. See it for the params.
3145 * */
3146 function remove_objectClass($classes, &$attrs)
3147 {
3148 if (isset($attrs['objectClass'])){
3149 /* Array? */
3150 if (is_array($classes)){
3151 $list= $classes;
3152 } else {
3153 $list= array($classes);
3154 }
3156 $tmp= array();
3157 foreach ($attrs['objectClass'] as $oc) {
3158 foreach ($list as $class){
3159 if (strtolower($oc) != strtolower($class)){
3160 $tmp[]= $oc;
3161 }
3162 }
3163 }
3164 $attrs['objectClass']= $tmp;
3165 }
3166 }
3169 /*! \brief Initialize a file download with given content, name and data type.
3170 * \param string data The content to send.
3171 * \param string name The name of the file.
3172 * \param string type The content identifier, default value is "application/octet-stream";
3173 */
3174 function send_binary_content($data,$name,$type = "application/octet-stream")
3175 {
3176 header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
3177 header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
3178 header("Cache-Control: no-cache");
3179 header("Pragma: no-cache");
3180 header("Cache-Control: post-check=0, pre-check=0");
3181 header("Content-type: ".$type."");
3183 $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
3185 /* Strip name if it is a complete path */
3186 if (preg_match ("/\//", $name)) {
3187 $name= basename($name);
3188 }
3190 /* force download dialog */
3191 if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
3192 header('Content-Disposition: filename="'.$name.'"');
3193 } else {
3194 header('Content-Disposition: attachment; filename="'.$name.'"');
3195 }
3197 echo $data;
3198 exit();
3199 }
3202 function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8")
3203 {
3204 if(is_string($str)){
3205 return(htmlentities($str,$type,$charset));
3206 }elseif(is_array($str)){
3207 foreach($str as $name => $value){
3208 $str[$name] = reverse_html_entities($value,$type,$charset);
3209 }
3210 }
3211 return($str);
3212 }
3215 /*! \brief Encode special string characters so we can use the string in \
3216 HTML output, without breaking quotes.
3217 \param string The String we want to encode.
3218 \return string The encoded String
3219 */
3220 function xmlentities($str)
3221 {
3222 if(is_string($str)){
3224 static $asc2uni= array();
3225 if (!count($asc2uni)){
3226 for($i=128;$i<256;$i++){
3227 # $asc2uni[chr($i)] = "&#x".dechex($i).";";
3228 }
3229 }
3231 $str = str_replace("&", "&", $str);
3232 $str = str_replace("<", "<", $str);
3233 $str = str_replace(">", ">", $str);
3234 $str = str_replace("'", "'", $str);
3235 $str = str_replace("\"", """, $str);
3236 $str = str_replace("\r", "", $str);
3237 $str = strtr($str,$asc2uni);
3238 return $str;
3239 }elseif(is_array($str)){
3240 foreach($str as $name => $value){
3241 $str[$name] = xmlentities($value);
3242 }
3243 }
3244 return($str);
3245 }
3248 /*! \brief Updates all accessTo attributes from a given value to a new one.
3249 For example if a host is renamed.
3250 \param String $from The source accessTo name.
3251 \param String $to The destination accessTo name.
3252 */
3253 function update_accessTo($from,$to)
3254 {
3255 global $config;
3256 $ldap = $config->get_ldap_link();
3257 $ldap->cd($config->current['BASE']);
3258 $ldap->search("(&(objectClass=trustAccount)(accessTo=".$from."))",array("objectClass","accessTo"));
3259 while($attrs = $ldap->fetch()){
3260 $new_attrs = array("accessTo" => array());
3261 $dn = $attrs['dn'];
3262 for($i = 0 ; $i < $attrs['objectClass']['count']; $i++){
3263 $new_attrs['objectClass'][] = $attrs['objectClass'][$i];
3264 }
3265 for($i = 0 ; $i < $attrs['accessTo']['count']; $i++){
3266 if($attrs['accessTo'][$i] == $from){
3267 if(!empty($to)){
3268 $new_attrs['accessTo'][] = $to;
3269 }
3270 }else{
3271 $new_attrs['accessTo'][] = $attrs['accessTo'][$i];
3272 }
3273 }
3274 $ldap->cd($dn);
3275 $ldap->modify($new_attrs);
3276 if (!$ldap->success()){
3277 msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, "update_accessTo($from,$to)"));
3278 }
3279 new log("modify","update_accessTo($from,$to)",$dn,array_keys($new_attrs),$ldap->get_error());
3280 }
3281 }
3284 /*! \brief Returns a random char */
3285 function get_random_char () {
3286 $randno = rand (0, 63);
3287 if ($randno < 12) {
3288 return (chr ($randno + 46)); // Digits, '/' and '.'
3289 } else if ($randno < 38) {
3290 return (chr ($randno + 53)); // Uppercase
3291 } else {
3292 return (chr ($randno + 59)); // Lowercase
3293 }
3294 }
3297 function cred_encrypt($input, $password) {
3299 $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
3300 $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
3302 return bin2hex(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $password, $input, MCRYPT_MODE_ECB, $iv));
3304 }
3307 function cred_decrypt($input,$password) {
3308 $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
3309 $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
3311 return mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $password, pack("H*", $input), MCRYPT_MODE_ECB, $iv);
3312 }
3315 function get_object_info()
3316 {
3317 return(session::get('objectinfo'));
3318 }
3321 function set_object_info($str = "")
3322 {
3323 session::set('objectinfo',$str);
3324 }
3327 function isIpInNet($ip, $net, $mask) {
3328 // Move to long ints
3329 $ip= ip2long($ip);
3330 $net= ip2long($net);
3331 $mask= ip2long($mask);
3333 // Mask given IP with mask. If it returns "net", we're in...
3334 $res= $ip & $mask;
3336 return ($res == $net);
3337 }
3340 function get_next_id($attrib, $dn)
3341 {
3342 global $config;
3344 switch ($config->get_cfg_value("idAllocationMethod", "traditional")){
3345 case "pool":
3346 return get_next_id_pool($attrib);
3347 case "traditional":
3348 return get_next_id_traditional($attrib, $dn);
3349 }
3351 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("unknown idAllocation method!"), ERROR_DIALOG);
3352 return null;
3353 }
3356 function get_next_id_pool($attrib) {
3357 global $config;
3359 /* Fill informational values */
3360 $min= $config->get_cfg_value("${attrib}PoolMin", 10000);
3361 $max= $config->get_cfg_value("${attrib}PoolMax", 40000);
3363 /* Sanity check */
3364 if ($min >= $max) {
3365 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." ".sprintf(_("%sPoolMin >= %sPoolMax!"), $attrib), ERROR_DIALOG);
3366 return null;
3367 }
3369 /* ID to skip */
3370 $ldap= $config->get_ldap_link();
3371 $id= null;
3373 /* Try to allocate the ID several times before failing */
3374 $tries= 3;
3375 while ($tries--) {
3377 /* Look for ID map entry */
3378 $ldap->cd ($config->current['BASE']);
3379 $ldap->search ("(&(objectClass=sambaUnixIdPool)($attrib=*))", array("$attrib"));
3381 /* If it does not exist, create one with these defaults */
3382 if ($ldap->count() == 0) {
3383 /* Fill informational values */
3384 $minUserId= $config->get_cfg_value("uidPoolMin", 10000);
3385 $minGroupId= $config->get_cfg_value("gidPoolMin", 10000);
3387 /* Add as default */
3388 $attrs= array("objectClass" => array("organizationalUnit", "sambaUnixIdPool"));
3389 $attrs["ou"]= "idmap";
3390 $attrs["uidNumber"]= $minUserId;
3391 $attrs["gidNumber"]= $minGroupId;
3392 $ldap->cd("ou=idmap,".$config->current['BASE']);
3393 $ldap->add($attrs);
3394 if ($ldap->error != "Success") {
3395 msg_dialog::display(_("Error"), _("Cannot create sambaUnixIdPool entry!"), ERROR_DIALOG);
3396 return null;
3397 }
3398 $tries++;
3399 continue;
3400 }
3401 /* Bail out if it's not unique */
3402 if ($ldap->count() != 1) {
3403 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("sambaUnixIdPool is not unique!"), ERROR_DIALOG);
3404 return null;
3405 }
3407 /* Store old attrib and generate new */
3408 $attrs= $ldap->fetch();
3409 $dn= $ldap->getDN();
3410 $oldAttr= $attrs[$attrib][0];
3411 $newAttr= $oldAttr + 1;
3413 /* Sanity check */
3414 if ($newAttr >= $max) {
3415 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("no ID available!"), ERROR_DIALOG);
3416 return null;
3417 }
3418 if ($newAttr < $min) {
3419 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("no ID available!"), ERROR_DIALOG);
3420 return null;
3421 }
3423 #FIXME: PHP is not able to do a modification of "del: .../add: ...", so this
3424 # is completely unsafe in the moment.
3425 #/* Remove old attr, add new attr */
3426 #$attrs= array($attrib => $oldAttr);
3427 #$ldap->rm($attrs, $dn);
3428 #if ($ldap->error != "Success") {
3429 # continue;
3430 #}
3431 $ldap->cd($dn);
3432 $ldap->modify(array($attrib => $newAttr));
3433 if ($ldap->error != "Success") {
3434 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." ".$ldap->get_error(), ERROR_DIALOG);
3435 return null;
3436 } else {
3437 return $oldAttr;
3438 }
3439 }
3441 /* Bail out if we had problems getting the next id */
3442 if (!$tries) {
3443 msg_dialog::display(_("Error"), _("Cannot allocate a free ID:")." "._("maximum tries exceeded!"), ERROR_DIALOG);
3444 }
3446 return $id;
3447 }
3450 function get_next_id_traditional($attrib, $dn)
3451 {
3452 global $config;
3454 $ids= array();
3455 $ldap= $config->get_ldap_link();
3457 $ldap->cd ($config->current['BASE']);
3458 if (preg_match('/gidNumber/i', $attrib)){
3459 $oc= "posixGroup";
3460 } else {
3461 $oc= "posixAccount";
3462 }
3463 $ldap->search ("(&(objectClass=$oc)($attrib=*))", array("$attrib"));
3465 /* Get list of ids */
3466 while ($attrs= $ldap->fetch()){
3467 $ids[]= (int)$attrs["$attrib"][0];
3468 }
3470 /* Add the nobody id */
3471 $ids[]= 65534;
3473 /* get the ranges */
3474 $tmp = array('0'=> 1000);
3475 if (preg_match('/posixAccount/', $oc) && $config->get_cfg_value("uidNumberBase") != ""){
3476 $tmp= explode('-',$config->get_cfg_value("uidNumberBase"));
3477 } elseif($config->get_cfg_value("gidNumberBase") != ""){
3478 $tmp= explode('-',$config->get_cfg_value("gidNumberBase"));
3479 }
3481 /* Set hwm to max if not set - for backward compatibility */
3482 $lwm= $tmp[0];
3483 if (isset($tmp[1])){
3484 $hwm= $tmp[1];
3485 } else {
3486 $hwm= pow(2,32);
3487 }
3488 /* Find out next free id near to UID_BASE */
3489 if ($config->get_cfg_value("baseIdHook") == ""){
3490 $base= $lwm;
3491 } else {
3492 /* Call base hook */
3493 $base= get_base_from_hook($dn, $attrib);
3494 }
3495 for ($id= $base; $id++; $id < pow(2,32)){
3496 if (!in_array($id, $ids)){
3497 return ($id);
3498 }
3499 }
3501 /* Should not happen */
3502 if ($id == $hwm){
3503 msg_dialog::display(_("Error"), _("Cannot allocate a free ID!"), ERROR_DIALOG);
3504 exit;
3505 }
3506 }
3509 /* Mark the occurance of a string with a span */
3510 function mark($needle, $haystack, $ignorecase= true)
3511 {
3512 $result= "";
3514 while (preg_match('/^(.*)('.preg_quote($needle).')(.*)$/i', $haystack, $matches)) {
3515 $result.= $matches[1]."<span class='mark'>".$matches[2]."</span>";
3516 $haystack= $matches[3];
3517 }
3519 return $result.$haystack;
3520 }
3523 /* Return an image description using the path */
3524 function image($path, $action= "", $title= "", $align= "middle")
3525 {
3526 global $config;
3527 global $BASE_DIR;
3528 $label= null;
3530 // Bail out, if there's no style file
3531 if(!session::global_is_set("img-styles")){
3533 // Get theme
3534 if (isset ($config)){
3535 $theme= $config->get_cfg_value("theme", "default");
3536 } else {
3537 # For debuging - avoid that there's no theme set
3538 die("config not set!");
3539 $theme= "default";
3540 }
3542 if (!file_exists("$BASE_DIR/ihtml/themes/$theme/img.styles")){
3543 die ("No img.style for this theme found!");
3544 }
3546 session::global_set('img-styles', unserialize(file_get_contents("$BASE_DIR/ihtml/themes/$theme/img.styles")));
3547 }
3548 $styles= session::global_get('img-styles');
3550 /* Extract labels from path */
3551 if (preg_match("/\.png\[(.*)\]$/", $path, $matches)) {
3552 $label= $matches[1];
3553 }
3555 $lbl= "";
3556 if ($label) {
3557 if (isset($styles["images/label-".$label.".png"])) {
3558 $lbl= "<div style='".$styles["images/label-".$label.".png"]."'></div>";
3559 } else {
3560 die("Invalid label specified: $label\n");
3561 }
3563 $path= preg_replace("/\[.*\]$/", "", $path);
3564 }
3566 // Non middle layout?
3567 if ($align == "middle") {
3568 $align= "";
3569 } else {
3570 $align= ";vertical-align:$align";
3571 }
3573 // Clickable image or not?
3574 if ($title != "") {
3575 $title= "title='$title'";
3576 }
3577 if ($action == "") {
3578 return "<div class='img' $title style='".$styles[$path]."$align'>$lbl</div>";
3579 } else {
3580 return "<input type='submit' class='img' id='$action' value='' name='$action' $title style='".$styles[$path]."$align'>";
3581 }
3582 }
3586 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
3587 ?>