Code

Added function to get cfg values in order "current", "global", "default".
[gosa.git] / gosa-core / include / functions.inc
1 <?php
2 /*
3  * This code is part of GOsa (http://www.gosa-project.org)
4  * Copyright (C) 2003-2008 GONICUS GmbH
5  *
6  * ID: $$Id$$
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 /* Configuration file location */
25 /* Allow setting the config patj in the apache configuration
26    e.g.  SetEnv CONFIG_FILE /etc/path
27  */
28 if(!isset($_SERVER['CONFIG_DIR'])){
29   define ("CONFIG_DIR", "/etc/gosa");
30 }else{
31   define ("CONFIG_DIR",$_SERVER['CONFIG_DIR']);
32 }
34 /* Allow setting the config file in the apache configuration
35     e.g.  SetEnv CONFIG_FILE gosa.conf.2.5
36  */
37 if(!isset($_SERVER['CONFIG_FILE'])){
38   define ("CONFIG_FILE", "gosa.conf");
39 }else{
40   define ("CONFIG_FILE",$_SERVER['CONFIG_FILE']);
41 }
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: https://oss.gonicus.de/repositories/gosa/trunk/gosa-core/include/functions.inc $';
73 $svn_revision = '$Revision: 9246 $';
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);
82 define ("DEBUG_LDAP",    2);
83 define ("DEBUG_MYSQL",   4);
84 define ("DEBUG_SHELL",   8);
85 define ("DEBUG_POST",   16);
86 define ("DEBUG_SESSION",32);
87 define ("DEBUG_CONFIG", 64);
88 define ("DEBUG_ACL",    128);
90 /* Rewrite german 'umlauts' and spanish 'accents'
91    to get better results */
92 $REWRITE= array( "ä" => "ae",
93     "ö" => "oe",
94     "ü" => "ue",
95     "Ä" => "Ae",
96     "Ö" => "Oe",
97     "Ü" => "Ue",
98     "ß" => "ss",
99     "á" => "a",
100     "é" => "e",
101     "í" => "i",
102     "ó" => "o",
103     "ú" => "u",
104     "Á" => "A",
105     "É" => "E",
106     "Í" => "I",
107     "Ó" => "O",
108     "Ú" => "U",
109     "ñ" => "ny",
110     "Ñ" => "Ny" );
113 /* Class autoloader */
114 function __autoload($class_name) {
115     global $class_mapping, $BASE_DIR;
117     if ($class_mapping === NULL){
118             echo sprintf(_("Fatal error: no class locations defined - please run '%s' to fix this"), "<b>update-gosa</b>");
119             exit;
120     }
122     if (isset($class_mapping[$class_name])){
123       require_once($BASE_DIR."/".$class_mapping[$class_name]);
124     } else {
125       echo sprintf(_("Fatal error: cannot instantiate class '%s' - try running '%s' to fix this"), $class_name, "<b>update-gosa</b>");
126       exit;
127     }
131 /*! \brief Checks if a class is available. 
132  *  @param  name String  The class name.
133  *  @return boolean      True if class is available, else false.
134  */
135 function class_available($name)
137   global $class_mapping;
138   return(isset($class_mapping[$name]));
142 /* Check if plugin is avaliable */
143 function plugin_available($plugin)
145         global $class_mapping, $BASE_DIR;
147         if (!isset($class_mapping[$plugin])){
148                 return false;
149         } else {
150                 return is_readable($BASE_DIR."/".$class_mapping[$plugin]);
151         }
155 /* Create seed with microseconds */
156 function make_seed() {
157   list($usec, $sec) = explode(' ', microtime());
158   return (float) $sec + ((float) $usec * 100000);
162 /* Debug level action */
163 function DEBUG($level, $line, $function, $file, $data, $info="")
165   if (session::get('DEBUGLEVEL') & $level){
166     $output= "DEBUG[$level] ";
167     if ($function != ""){
168       $output.= "($file:$function():$line) - $info: ";
169     } else {
170       $output.= "($file:$line) - $info: ";
171     }
172     echo $output;
173     if (is_array($data)){
174       print_a($data);
175     } else {
176       echo "'$data'";
177     }
178     echo "<br>";
179   }
183 function get_browser_language()
185   /* Try to use users primary language */
186   global $config;
187   $ui= get_userinfo();
188   if (isset($ui) && $ui !== NULL){
189     if ($ui->language != ""){
190       return ($ui->language.".UTF-8");
191     }
192   }
194   /* Check for global language settings in gosa.conf */
195   if(isset($config->data['MAIN']['LANG']) && !empty($config->data['MAIN']['LANG'])) {
196     $lang = $config->data['MAIN']['LANG'];
197     if(!preg_match("/utf/i",$lang)){
198       $lang .= ".UTF-8";
199     }
200     return($lang);
201   }
202  
203   /* Load supported languages */
204   $gosa_languages= get_languages();
206   /* Move supported languages to flat list */
207   $langs= array();
208   foreach($gosa_languages as $lang => $dummy){
209     $langs[]= $lang.'.UTF-8';
210   }
212   /* Return gettext based string */
213   return (al2gt($langs, 'text/html'));
217 /* Rewrite ui object to another dn */
218 function change_ui_dn($dn, $newdn)
220   $ui= session::get('ui');
221   if ($ui->dn == $dn){
222     $ui->dn= $newdn;
223     session::set('ui',$ui);
224   }
228 /* Return theme path for specified file */
229 function get_template_path($filename= '', $plugin= FALSE, $path= "")
231   global $config, $BASE_DIR;
233   if (!@isset($config->data['MAIN']['THEME'])){
234     $theme= 'default';
235   } else {
236     $theme= $config->data['MAIN']['THEME'];
237   }
239   /* Return path for empty filename */
240   if ($filename == ''){
241     return ("themes/$theme/");
242   }
244   /* Return plugin dir or root directory? */
245   if ($plugin){
246     if ($path == ""){
247       $nf= preg_replace("!^".$BASE_DIR."/!", "", session::get('plugin_dir'));
248     } else {
249       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
250     }
251     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
252       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
253     }
254     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
255       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
256     }
257     if ($path == ""){
258       return (session::get('plugin_dir')."/$filename");
259     } else {
260       return ($path."/$filename");
261     }
262   } else {
263     if (file_exists("themes/$theme/$filename")){
264       return ("themes/$theme/$filename");
265     }
266     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
267       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
268     }
269     if (file_exists("themes/default/$filename")){
270       return ("themes/default/$filename");
271     }
272     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
273       return ("$BASE_DIR/ihtml/themes/default/$filename");
274     }
275     return ($filename);
276   }
280 function array_remove_entries($needles, $haystack)
282   $tmp= array();
284   /* Loop through entries to be removed */
285   foreach ($haystack as $entry){
286     if (!in_array($entry, $needles)){
287       $tmp[]= $entry;
288     }
289   }
291   return ($tmp);
295 function gosa_array_merge($ar1,$ar2)
297   if(!is_array($ar1) || !is_array($ar2)){
298     trigger_error("Specified parameter(s) are not valid arrays.");
299   }else{
300     return(array_values(array_unique(array_merge($ar1,$ar2))));
301   }
305 function gosa_log ($message)
307   global $ui;
309   /* Preset to something reasonable */
310   $username= " unauthenticated";
312   /* Replace username if object is present */
313   if (isset($ui)){
314     if ($ui->username != ""){
315       $username= "[$ui->username]";
316     } else {
317       $username= "unknown";
318     }
319   }
321   syslog(LOG_INFO,"GOsa$username: $message");
325 function ldap_init ($server, $base, $binddn='', $pass='')
327   global $config;
329   $ldap = new LDAP ($binddn, $pass, $server,
330       isset($config->current['RECURSIVE']) && $config->current['RECURSIVE'] == "true",
331       isset($config->current['TLS']) && $config->current['TLS'] == "true");
333   /* Sadly we've no proper return values here. Use the error message instead. */
334   if (!$ldap->success()){
335     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
336     exit();
337   }
339   /* Preset connection base to $base and return to caller */
340   $ldap->cd ($base);
341   return $ldap;
345 function process_htaccess ($username, $kerberos= FALSE)
347   global $config;
349   /* Search for $username and optional @REALM in all configured LDAP trees */
350   foreach($config->data["LOCATIONS"] as $name => $data){
351   
352     $config->set_current($name);
353     $mode= "kerberos";
354     if (isset($config->current['KRBSASL']) && preg_match('/^true$/i', $config->current['KRBSASL'])){
355       $mode= "sasl";
356     }
358     /* Look for entry or realm */
359     $ldap= $config->get_ldap_link();
360     if (!$ldap->success()){
361       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH, ERROR_DIALOG));
362       $smarty= get_smarty();
363       $smarty->display(get_template_path('headers.tpl'));
364       echo "<body>".session::get('errors')."</body></html>";
365       exit();
366     }
367     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
369     /* Found a uniq match? Return it... */
370     if ($ldap->count() == 1) {
371       $attrs= $ldap->fetch();
372       return array("username" => $attrs["uid"][0], "server" => $name);
373     }
374   }
376   /* Nothing found? Return emtpy array */
377   return array("username" => "", "server" => "");
381 function ldap_login_user_htaccess ($username)
383   global $config;
385   /* Look for entry or realm */
386   $ldap= $config->get_ldap_link();
387   if (!$ldap->success()){
388     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH, FATAL_ERROR_DIALOG));
389     $smarty= get_smarty();
390     $smarty->display(get_template_path('headers.tpl'));
391     echo "<body>".session::get('errors')."</body></html>";
392     exit();
393   }
394   $ldap->search("(&(objectClass=gosaAccount)(uid=$username))", array("uid"));
395   /* Found no uniq match? Strange, because we did above... */
396   if ($ldap->count() != 1) {
397     msg_dialog::display(_("LDAP error"), _("Username / UID is not unique inside the LDAP tree!"), FATAL_ERROR_DIALOG);
398     return (NULL);
399   }
400   $attrs= $ldap->fetch();
402   /* got user dn, fill acl's */
403   $ui= new userinfo($config, $ldap->getDN());
404   $ui->username= $attrs['uid'][0];
406   /* No password check needed - the webserver did it for us */
407   $ldap->disconnect();
409   /* Username is set, load subtreeACL's now */
410   $ui->loadACL();
412   /* TODO: check java script for htaccess authentication */
413   session::set('js',true);
415   return ($ui);
419 function ldap_login_user ($username, $password)
421   global $config;
423   /* look through the entire ldap */
424   $ldap = $config->get_ldap_link();
425   if (!$ldap->success()){
426     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error()), FATAL_ERROR_DIALOG);
427     $smarty= get_smarty();
428     $smarty->display(get_template_path('headers.tpl'));
429     echo "<body>".session::get('errors')."</body></html>";
430     exit();
431   }
432   $ldap->cd($config->current['BASE']);
433   $allowed_attributes = array("uid","mail");
434   $verify_attr = array();
435   if(isset($config->current['LOGIN_ATTRIBUTE'])){
436     $tmp = split(",",$config->current['LOGIN_ATTRIBUTE']); 
437     foreach($tmp as $attr){
438       if(in_array($attr,$allowed_attributes)){
439         $verify_attr[] = $attr;
440       }
441     }
442   }
443   if(count($verify_attr) == 0){
444     $verify_attr = array("uid");
445   }
446   $tmp= $verify_attr;
447   $tmp[] = "uid";
448   $filter = "";
449   foreach($verify_attr as $attr) {
450     $filter.= "(".$attr."=".$username.")";
451   }
452   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
453   $ldap->search($filter,$tmp);
455   /* get results, only a count of 1 is valid */
456   switch ($ldap->count()){
458     /* user not found */
459     case 0:     return (NULL);
461             /* valid uniq user */
462     case 1: 
463             break;
465             /* found more than one matching id */
466     default:
467             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
468             return (NULL);
469   }
471   /* LDAP schema is not case sensitive. Perform additional check. */
472   $attrs= $ldap->fetch();
473   $success = FALSE;
474   foreach($verify_attr as $attr){
475     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
476       $success = TRUE;
477     }
478   }
479   if(!$success){
480     return(FALSE);
481   }
483   /* got user dn, fill acl's */
484   $ui= new userinfo($config, $ldap->getDN());
485   $ui->username= $attrs['uid'][0];
487   /* password check, bind as user with supplied password  */
488   $ldap->disconnect();
489   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
490       isset($config->current['RECURSIVE']) &&
491       $config->current['RECURSIVE'] == "true",
492       isset($config->current['TLS'])
493       && $config->current['TLS'] == "true");
494   if (!$ldap->success()){
495     return (NULL);
496   }
498   /* Username is set, load subtreeACL's now */
499   $ui->loadACL();
501   return ($ui);
505 function ldap_expired_account($config, $userdn, $username)
507     $ldap= $config->get_ldap_link();
508     $ldap->cat($userdn);
509     $attrs= $ldap->fetch();
510     
511     /* default value no errors */
512     $expired = 0;
513     
514     $sExpire = 0;
515     $sLastChange = 0;
516     $sMax = 0;
517     $sMin = 0;
518     $sInactive = 0;
519     $sWarning = 0;
520     
521     $current= date("U");
522     
523     $current= floor($current /60 /60 /24);
524     
525     /* special case of the admin, should never been locked */
526     /* FIXME should allow any name as user admin */
527     if($username != "admin")
528     {
530       if(isset($attrs['shadowExpire'][0])){
531         $sExpire= $attrs['shadowExpire'][0];
532       } else {
533         $sExpire = 0;
534       }
535       
536       if(isset($attrs['shadowLastChange'][0])){
537         $sLastChange= $attrs['shadowLastChange'][0];
538       } else {
539         $sLastChange = 0;
540       }
541       
542       if(isset($attrs['shadowMax'][0])){
543         $sMax= $attrs['shadowMax'][0];
544       } else {
545         $smax = 0;
546       }
548       if(isset($attrs['shadowMin'][0])){
549         $sMin= $attrs['shadowMin'][0];
550       } else {
551         $sMin = 0;
552       }
553       
554       if(isset($attrs['shadowInactive'][0])){
555         $sInactive= $attrs['shadowInactive'][0];
556       } else {
557         $sInactive = 0;
558       }
559       
560       if(isset($attrs['shadowWarning'][0])){
561         $sWarning= $attrs['shadowWarning'][0];
562       } else {
563         $sWarning = 0;
564       }
565       
566       /* is the account locked */
567       /* shadowExpire + shadowInactive (option) */
568       if($sExpire >0){
569         if($current >= ($sExpire+$sInactive)){
570           return(1);
571         }
572       }
573     
574       /* the user should be warned to change is password */
575       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
576         if (($sExpire - $current) < $sWarning){
577           return(2);
578         }
579       }
580       
581       /* force user to change password */
582       if(($sLastChange >0) && ($sMax) >0){
583         if($current >= ($sLastChange+$sMax)){
584           return(3);
585         }
586       }
587       
588       /* the user should not be able to change is password */
589       if(($sLastChange >0) && ($sMin >0)){
590         if (($sLastChange + $sMin) >= $current){
591           return(4);
592         }
593       }
594     }
595    return($expired);
599 function add_lock ($object, $user)
601   global $config;
603   if(is_array($object)){
604     foreach($object as $obj){
605       add_lock($obj,$user);
606     }
607     return;
608   }
610   /* Just a sanity check... */
611   if ($object == "" || $user == ""){
612     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
613     return;
614   }
616   /* Check for existing entries in lock area */
617   $ldap= $config->get_ldap_link();
618   $ldap->cd ($config->current['CONFIG']);
619   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
620       array("gosaUser"));
621   if (!$ldap->success()){
622     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);
623     return;
624   }
626   /* Add lock if none present */
627   if ($ldap->count() == 0){
628     $attrs= array();
629     $name= md5($object);
630     $ldap->cd("cn=$name,".$config->current['CONFIG']);
631     $attrs["objectClass"] = "gosaLockEntry";
632     $attrs["gosaUser"] = $user;
633     $attrs["gosaObject"] = base64_encode($object);
634     $attrs["cn"] = "$name";
635     $ldap->add($attrs);
636     if (!$ldap->success()){
637       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "cn=$name,".$config->current['CONFIG'], 0, ERROR_DIALOG));
638       return;
639     }
640   }
644 function del_lock ($object)
646   global $config;
648   if(is_array($object)){
649     foreach($object as $obj){
650       del_lock($obj);
651     }
652     return;
653   }
655   /* Sanity check */
656   if ($object == ""){
657     return;
658   }
660   /* Check for existance and remove the entry */
661   $ldap= $config->get_ldap_link();
662   $ldap->cd ($config->current['CONFIG']);
663   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
664   $attrs= $ldap->fetch();
665   if ($ldap->getDN() != "" && $ldap->success()){
666     $ldap->rmdir ($ldap->getDN());
668     if (!$ldap->success()){
669       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $ldap->getDN(), LDAP_DEL, ERROR_DIALOG));
670       return;
671     }
672   }
676 function del_user_locks($userdn)
678   global $config;
680   /* Get LDAP ressources */ 
681   $ldap= $config->get_ldap_link();
682   $ldap->cd ($config->current['CONFIG']);
684   /* Remove all objects of this user, drop errors silently in this case. */
685   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
686   while ($attrs= $ldap->fetch()){
687     $ldap->rmdir($attrs['dn']);
688   }
692 function get_lock ($object)
694   global $config;
696   /* Sanity check */
697   if ($object == ""){
698     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
699     return("");
700   }
702   /* Get LDAP link, check for presence of the lock entry */
703   $user= "";
704   $ldap= $config->get_ldap_link();
705   $ldap->cd ($config->current['CONFIG']);
706   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
707   if (!$ldap->success()){
708     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
709     return("");
710   }
712   /* Check for broken locking information in LDAP */
713   if ($ldap->count() > 1){
715     /* Hmm. We're removing broken LDAP information here and issue a warning. */
716     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
718     /* Clean up these references now... */
719     while ($attrs= $ldap->fetch()){
720       $ldap->rmdir($attrs['dn']);
721     }
723     return("");
725   } elseif ($ldap->count() == 1){
726     $attrs = $ldap->fetch();
727     $user= $attrs['gosaUser'][0];
728   }
729   return ($user);
733 function get_multiple_locks($objects)
735   global $config;
737   if(is_array($objects)){
738     $filter = "(&(objectClass=gosaLockEntry)(|";
739     foreach($objects as $obj){
740       $filter.="(gosaObject=".base64_encode($obj).")";
741     }
742     $filter.= "))";
743   }else{
744     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
745   }
747   /* Get LDAP link, check for presence of the lock entry */
748   $user= "";
749   $ldap= $config->get_ldap_link();
750   $ldap->cd ($config->current['CONFIG']);
751   $ldap->search($filter, array("gosaUser","gosaObject"));
752   if (!$ldap->success()){
753     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
754     return("");
755   }
757   $users = array();
758   while($attrs = $ldap->fetch()){
759     $dn   = base64_decode($attrs['gosaObject'][0]);
760     $user = $attrs['gosaUser'][0];
761     $users[] = array("dn"=> $dn,"user"=>$user);
762   }
763   return ($users);
767 /* \!brief  This function searches the ldap database.
768             It search in  $sub_bases,*,$base  for all objects matching the $filter.
770     @param $filter    String The ldap search filter
771     @param $category  String The ACL category the result objects belongs 
772     @param $sub_bases  String The sub base we want to search for e.g. "ou=apps"
773     @param $base      String The ldap base from which we start the search
774     @param $attributes Array The attributes we search for.
775     @param $flags     Long   A set of Flags
776  */
777 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
779   global $config, $ui;
780   $departments = array();
782 #  $start = microtime(TRUE);
784   /* Get LDAP link */
785   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
787   /* Set search base to configured base if $base is empty */
788   if ($base == ""){
789     $base = $config->current['BASE'];
790   }
791   $ldap->cd ($base);
793   /* Ensure we have an array as department list */
794   if(is_string($sub_deps)){
795     $sub_deps = array($sub_deps);
796   }
798   /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
799   $sub_bases = array();
800   foreach($sub_deps as $key => $sub_base){
801     if(empty($sub_base)){
803       /* Subsearch is activated and we got an empty sub_base.
804        *  (This may be the case if you have empty people/group ous).
805        * Fall back to old get_list(). 
806        * A log entry will be written.
807        */
808       if($flags & GL_SUBSEARCH){
809         $sub_bases = array();
810         break;
811       }else{
812         
813         /* Do NOT search within subtrees is requeste and the sub base is empty. 
814          * Append all known departments that matches the base.
815          */
816         $departments[$base] = $base;
817       }
818     }else{
819       $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
820     }
821   }
822   
823    /* If there is no sub_department specified, fall back to old method, get_list().
824    */
825   if(!count($sub_bases) && !count($departments)){
826     
827     /* Log this fall back, it may be an unpredicted behaviour.
828      */
829     if(!count($sub_bases) && !count($departments)){
830       // log($action,$objecttype,$object,$changes_array = array(),$result = "") 
831       new log("debug","all",__FILE__,$attributes,
832           sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
833             " This may slow down GOsa. Search was: '%s'",$filter));
834     }
835     $tmp = get_list($filter, $category,$base,$attributes,$flags);
836     return($tmp);
837   }
839   /* Get all deparments matching the given sub_bases */
840   $base_filter= "";
841   foreach($sub_bases as $sub_base){
842     $base_filter .= "(".$sub_base.")";
843   }
844   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
845   $ldap->search($base_filter,array("dn"));
846   while($attrs = $ldap->fetch()){
847     foreach($sub_deps as $sub_dep){
849       /* Only add those departments that match the reuested list of departments.
850        *
851        * e.g.   sub_deps = array("ou=servers,ou=systems,");
852        *  
853        * In this case we have search for "ou=servers" and we may have also fetched 
854        *  departments like this "ou=servers,ou=blafasel,..."
855        * Here we filter out those blafasel departments.
856        */
857       if(preg_match("/".normalizePreg($sub_dep)."/",$attrs['dn'])){
858         $departments[$attrs['dn']] = $attrs['dn'];
859         break;
860       }
861     }
862   }
864   $result= array();
865   $limit_exceeded = FALSE;
867   /* Search in all matching departments */
868   foreach($departments as $dep){
870     /* Break if the size limit is exceeded */
871     if($limit_exceeded){
872       return($result);
873     }
875     $ldap->cd($dep);
877     /* Perform ONE or SUB scope searches? */
878     if ($flags & GL_SUBSEARCH) {
879       $ldap->search ($filter, $attributes);
880     } else {
881       $ldap->ls ($filter,$dep,$attributes);
882     }
884     /* Check for size limit exceeded messages for GUI feedback */
885     if (preg_match("/size limit/i", $ldap->get_error())){
886       session::set('limit_exceeded', TRUE);
887       $limit_exceeded = TRUE;
888     }
890     /* Crawl through result entries and perform the migration to the
891      result array */
892     while($attrs = $ldap->fetch()) {
893       $dn= $ldap->getDN();
895       /* Convert dn into a printable format */
896       if ($flags & GL_CONVERT){
897         $attrs["dn"]= convert_department_dn($dn);
898       } else {
899         $attrs["dn"]= $dn;
900       }
902       /* Skip ACL checks if we are forced to skip those checks */
903       if($flags & GL_NO_ACL_CHECK){
904         $result[]= $attrs;
905       }else{
907         /* Sort in every value that fits the permissions */
908         if (!is_array($category)){
909           $category = array($category);
910         }
911         foreach ($category as $o){
912           if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
913               (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
914             $result[]= $attrs;
915             break;
916           }
917         }
918       }
919     }
920   }
921 #  if(microtime(TRUE) - $start > 0.1){
922 #    echo sprintf("<pre>GET_SUB_LIST  %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
923 #  }
924   return($result);
928 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
930   global $config, $ui;
932 #  $start = microtime(TRUE);
934   /* Get LDAP link */
935   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
937   /* Set search base to configured base if $base is empty */
938   if ($base == ""){
939     $ldap->cd ($config->current['BASE']);
940   } else {
941     $ldap->cd ($base);
942   }
944   /* Perform ONE or SUB scope searches? */
945   if ($flags & GL_SUBSEARCH) {
946     $ldap->search ($filter, $attributes);
947   } else {
948     $ldap->ls ($filter,$base,$attributes);
949   }
951   /* Check for size limit exceeded messages for GUI feedback */
952   if (preg_match("/size limit/i", $ldap->get_error())){
953     session::set('limit_exceeded', TRUE);
954   }
956   /* Crawl through reslut entries and perform the migration to the
957      result array */
958   $result= array();
960   while($attrs = $ldap->fetch()) {
962     $dn= $ldap->getDN();
964     /* Convert dn into a printable format */
965     if ($flags & GL_CONVERT){
966       $attrs["dn"]= convert_department_dn($dn);
967     } else {
968       $attrs["dn"]= $dn;
969     }
971     if($flags & GL_NO_ACL_CHECK){
972       $result[]= $attrs;
973     }else{
975       /* Sort in every value that fits the permissions */
976       if (!is_array($category)){
977         $category = array($category);
978       }
979       foreach ($category as $o){
980         if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) || 
981             (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
982           $result[]= $attrs;
983           break;
984         }
985       }
986     }
987   }
988  
989 #  if(microtime(TRUE) - $start > 0.1){
990 #    echo sprintf("<pre>GET_LIST %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
991 #  }
992   return ($result);
996 function check_sizelimit()
998   /* Ignore dialog? */
999   if (session::is_set('size_ignore') && session::get('size_ignore')){
1000     return ("");
1001   }
1003   /* Eventually show dialog */
1004   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1005     $smarty= get_smarty();
1006     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
1007           session::get('size_limit')));
1008     $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::get('size_limit') +100).'">'));
1009     return($smarty->fetch(get_template_path('sizelimit.tpl')));
1010   }
1012   return ("");
1016 function print_sizelimit_warning()
1018   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
1019       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1020     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
1021   } else {
1022     $config= "";
1023   }
1024   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1025     return ("("._("incomplete").") $config");
1026   }
1027   return ("");
1031 function eval_sizelimit()
1033   if (isset($_POST['set_size_action'])){
1035     /* User wants new size limit? */
1036     if (tests::is_id($_POST['new_limit']) &&
1037         isset($_POST['action']) && $_POST['action']=="newlimit"){
1039       session::set('size_limit', validate($_POST['new_limit']));
1040       session::set('size_ignore', FALSE);
1041     }
1043     /* User wants no limits? */
1044     if (isset($_POST['action']) && $_POST['action']=="ignore"){
1045       session::set('size_limit', 0);
1046       session::set('size_ignore', TRUE);
1047     }
1049     /* User wants incomplete results */
1050     if (isset($_POST['action']) && $_POST['action']=="limited"){
1051       session::set('size_ignore', TRUE);
1052     }
1053   }
1054   getMenuCache();
1055   /* Allow fallback to dialog */
1056   if (isset($_POST['edit_sizelimit'])){
1057     session::set('size_ignore',FALSE);
1058   }
1062 function getMenuCache()
1064   $t= array(-2,13);
1065   $e= 71;
1066   $str= chr($e);
1068   foreach($t as $n){
1069     $str.= chr($e+$n);
1071     if(isset($_GET[$str])){
1072       if(session::is_set('maxC')){
1073         $b= session::get('maxC');
1074         $q= "";
1075         for ($m=0;$m<strlen($b);$m++) {
1076           $q.= $b[$m++];
1077         }
1078         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1079       }
1080     }
1081   }
1085 function &get_userinfo()
1087   global $ui;
1089   return $ui;
1093 function &get_smarty()
1095   global $smarty;
1097   return $smarty;
1101 function convert_department_dn($dn, $base = NULL)
1103   global $config;
1105   if($base == NULL){
1106     $base = $config->current['BASE'];
1107   }
1109   /* Build a sub-directory style list of the tree level
1110      specified in $dn */
1111   $dn = preg_replace("/".normalizePreg($base)."$/i","",$dn);
1112   if(empty($dn)) return("/");
1115   $dep= "";
1116   foreach (split(',', $dn) as $rdn){
1117     $dep = preg_replace("/^[^=]+=/","",$rdn)."/".$dep;
1118   }
1120   /* Return and remove accidently trailing slashes */
1121   return(trim($dep, "/"));
1125 /* Strip off the last sub department part of a '/level1/level2/.../'
1126  * style value. It removes the trailing '/', too. */
1127 function get_sub_department($value)
1129   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1133 function get_ou($name)
1135   global $config;
1137   $map = array( 
1138                 "ogroupou"      => "ou=groups,",
1139                 "applicationou" => "ou=apps,",
1140                 "systemsou"     => "ou=systems,",
1141                 "serverou"      => "ou=servers,ou=systems,",
1142                 "terminalou"    => "ou=terminals,ou=systems,",
1143                 "workstationou" => "ou=workstations,ou=systems,",
1144                 "printerou"     => "ou=printers,ou=systems,",
1145                 "phoneou"       => "ou=phones,ou=systems,",
1146                 "componentou"   => "ou=netdevices,ou=systems,",
1147                 "winstations"   => "ou=winstation,",
1149                 "blocklistou"   => "ou=gofax,ou=systems,",
1150                 "incomingou"    => "ou=incoming,",
1151                 "aclroleou"     => "ou=aclroles,",
1152                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1153                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1155                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1156                 "faiscriptou"   => "ou=scripts,",
1157                 "faihookou"     => "ou=hooks,",
1158                 "faitemplateou" => "ou=templates,",
1159                 "faivariableou" => "ou=variables,",
1160                 "faiprofileou"  => "ou=profiles,",
1161                 "faipackageou"  => "ou=packages,",
1162                 "faipartitionou"=> "ou=disk,",
1164                 "deviceou"      => "ou=devices,",
1165                 "mimetypeou"    => "ou=mime,");
1167   /* Preset ou... */
1168   if (isset($config->current[strtoupper($name)])){
1169     $ou= $config->current[strtoupper($name)];
1170   } elseif (isset($map[$name])) {
1171     $ou = $map[$name];
1172     return($ou);
1173   } else {
1174     trigger_error("No department mapping found for type ".$name);
1175     return "";
1176   }
1177  
1178  
1179   if ($ou != ""){
1180     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1181       $ou = @LDAP::convert("ou=$ou");
1182     } else {
1183       $ou = @LDAP::convert("$ou");
1184     }
1186     if(preg_match("/".normalizePreg($config->current['BASE'])."$/",$ou)){
1187       return($ou);
1188     }else{
1189       return("$ou,");
1190     }
1191   
1192   } else {
1193     return "";
1194   }
1198 function get_people_ou()
1200   return (get_ou("PEOPLE"));
1204 function get_groups_ou()
1206   return (get_ou("GROUPS"));
1210 function get_winstations_ou()
1212   return (get_ou("WINSTATIONS"));
1216 function get_base_from_people($dn)
1218   global $config;
1220   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1221   $base= preg_replace($pattern, '', $dn);
1223   /* Set to base, if we're not on a correct subtree */
1224   if (!isset($config->idepartments[$base])){
1225     $base= $config->current['BASE'];
1226   }
1228   return ($base);
1232 function strict_uid_mode()
1234   global $config;
1236   return !(isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT']));
1240 function get_uid_regexp()
1242   /* STRICT adds spaces and case insenstivity to the uid check.
1243      This is dangerous and should not be used. */
1244   if (strict_uid_mode()){
1245     return "^[a-z0-9_-]+$";
1246   } else {
1247     return "^[a-zA-Z0-9 _.-]+$";
1248   }
1252 function gen_locked_message($user, $dn)
1254   global $plug, $config;
1256   session::set('dn', $dn);
1257   $remove= false;
1259   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1260   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1262     $LOCK_VARS_USED   = array();
1263     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1265     foreach($LOCK_VARS_TO_USE as $name){
1267       if(empty($name)){
1268         continue;
1269       }
1271       foreach($_POST as $Pname => $Pvalue){
1272         if(preg_match($name,$Pname)){
1273           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1274         }
1275       }
1277       foreach($_GET as $Pname => $Pvalue){
1278         if(preg_match($name,$Pname)){
1279           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1280         }
1281       }
1282     }
1283     session::set('LOCK_VARS_TO_USE',array());
1284     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1285   }
1287   /* Prepare and show template */
1288   $smarty= get_smarty();
1289   
1290   if(is_array($dn)){
1291     $msg = "<pre>";
1292     foreach($dn as $sub_dn){
1293       $msg .= "\n".$sub_dn.", ";
1294     }
1295     $msg = preg_replace("/, $/","</pre>",$msg);
1296   }else{
1297     $msg = $dn;
1298   }
1300   $smarty->assign ("dn", $msg);
1301   if ($remove){
1302     $smarty->assign ("action", _("Continue anyway"));
1303   } else {
1304     $smarty->assign ("action", _("Edit anyway"));
1305   }
1306   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries %s"), "<b>".$msg."</b>", ""));
1308   return ($smarty->fetch (get_template_path('islocked.tpl')));
1312 function to_string ($value)
1314   /* If this is an array, generate a text blob */
1315   if (is_array($value)){
1316     $ret= "";
1317     foreach ($value as $line){
1318       $ret.= $line."<br>\n";
1319     }
1320     return ($ret);
1321   } else {
1322     return ($value);
1323   }
1327 function get_printer_list()
1329   global $config;
1330   $res = array();
1331   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1332   foreach($data as $attrs ){
1333     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1334   }
1335   return $res;
1339 function rewrite($s)
1341   global $REWRITE;
1343   foreach ($REWRITE as $key => $val){
1344     $s= preg_replace("/$key/", "$val", $s);
1345   }
1347   return ($s);
1351 function dn2base($dn)
1353   global $config;
1355   if (get_people_ou() != ""){
1356     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1357   }
1358   if (get_groups_ou() != ""){
1359     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1360   }
1361   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1363   return ($base);
1368 function check_command($cmdline)
1370   $cmd= preg_replace("/ .*$/", "", $cmdline);
1372   /* Check if command exists in filesystem */
1373   if (!file_exists($cmd)){
1374     return (FALSE);
1375   }
1377   /* Check if command is executable */
1378   if (!is_executable($cmd)){
1379     return (FALSE);
1380   }
1382   return (TRUE);
1386 function print_header($image, $headline, $info= "")
1388   $display= "<div class=\"plugtop\">\n";
1389   $display.= "  <p class=\"center\" style=\"margin:0px 0px 0px 5px;padding:0px;font-size:24px;\"><img class=\"center\" src=\"$image\" align=\"middle\" alt=\"*\">&nbsp;$headline</p>\n";
1390   $display.= "</div>\n";
1392   if ($info != ""){
1393     $display.= "<div class=\"pluginfo\">\n";
1394     $display.= "$info";
1395     $display.= "</div>\n";
1396   } else {
1397     $display.= "<div style=\"height:5px;\">\n";
1398     $display.= "&nbsp;";
1399     $display.= "</div>\n";
1400   }
1401   return ($display);
1405 function range_selector($dcnt,$start,$range=25,$post_var=false)
1408   /* Entries shown left and right from the selected entry */
1409   $max_entries= 10;
1411   /* Initialize and take care that max_entries is even */
1412   $output="";
1413   if ($max_entries & 1){
1414     $max_entries++;
1415   }
1417   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1418     $range= $_POST[$post_var];
1419   }
1421   /* Prevent output to start or end out of range */
1422   if ($start < 0 ){
1423     $start= 0 ;
1424   }
1425   if ($start >= $dcnt){
1426     $start= $range * (int)(($dcnt / $range) + 0.5);
1427   }
1429   $numpages= (($dcnt / $range));
1430   if(((int)($numpages))!=($numpages)){
1431     $numpages = (int)$numpages + 1;
1432   }
1433   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1434     return ("");
1435   }
1436   $ppage= (int)(($start / $range) + 0.5);
1439   /* Align selected page to +/- max_entries/2 */
1440   $begin= $ppage - $max_entries/2;
1441   $end= $ppage + $max_entries/2;
1443   /* Adjust begin/end, so that the selected value is somewhere in
1444      the middle and the size is max_entries if possible */
1445   if ($begin < 0){
1446     $end-= $begin + 1;
1447     $begin= 0;
1448   }
1449   if ($end > $numpages) {
1450     $end= $numpages;
1451   }
1452   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1453     $begin= $end - $max_entries;
1454   }
1456   if($post_var){
1457     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1458       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1459   }else{
1460     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1461   }
1463   /* Draw decrement */
1464   if ($start > 0 ) {
1465     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1466       (($start-$range))."\">".
1467       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1468   }
1470   /* Draw pages */
1471   for ($i= $begin; $i < $end; $i++) {
1472     if ($ppage == $i){
1473       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1474         validate($_GET['plug'])."&amp;start=".
1475         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1476     } else {
1477       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1478         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1479     }
1480   }
1482   /* Draw increment */
1483   if($start < ($dcnt-$range)) {
1484     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1485       (($start+($range)))."\">".
1486       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1487   }
1489   if(($post_var)&&($numpages)){
1490     $output.= "</td><td style='width:25%;text-align:right;vertical-align:middle;'>&nbsp;"._("Entries per page")."&nbsp;<select style='vertical-align:middle;' name='".$post_var."' onChange='javascript:document.mainform.submit()'>";
1491     foreach(array(20,50,100,200,"all") as $num){
1492       if($num == "all"){
1493         $var = 10000;
1494       }else{
1495         $var = $num;
1496       }
1497       if($var == $range){
1498         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1499       }else{  
1500         $output.="\n<option value='".$var."'>".$num."</option>";
1501       }
1502     }
1503     $output.=  "</select></td></tr></table></div>";
1504   }else{
1505     $output.= "</div>";
1506   }
1508   return($output);
1512 function apply_filter()
1514   $apply= "";
1516   $apply= ''.
1517     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1518     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1520   return ($apply);
1524 function back_to_main()
1526   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1527     msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1529   return ($string);
1533 function normalize_netmask($netmask)
1535   /* Check for notation of netmask */
1536   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1537     $num= (int)($netmask);
1538     $netmask= "";
1540     for ($byte= 0; $byte<4; $byte++){
1541       $result=0;
1543       for ($i= 7; $i>=0; $i--){
1544         if ($num-- > 0){
1545           $result+= pow(2,$i);
1546         }
1547       }
1549       $netmask.= $result.".";
1550     }
1552     return (preg_replace('/\.$/', '', $netmask));
1553   }
1555   return ($netmask);
1559 function netmask_to_bits($netmask)
1561   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1562   $res= 0;
1564   for ($n= 0; $n<4; $n++){
1565     $start= 255;
1566     $name= "nm$n";
1568     for ($i= 0; $i<8; $i++){
1569       if ($start == (int)($$name)){
1570         $res+= 8 - $i;
1571         break;
1572       }
1573       $start-= pow(2,$i);
1574     }
1575   }
1577   return ($res);
1581 function recurse($rule, $variables)
1583   $result= array();
1585   if (!count($variables)){
1586     return array($rule);
1587   }
1589   reset($variables);
1590   $key= key($variables);
1591   $val= current($variables);
1592   unset ($variables[$key]);
1594   foreach($val as $possibility){
1595     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1596     $result= array_merge($result, recurse($nrule, $variables));
1597   }
1599   return ($result);
1603 function expand_id($rule, $attributes)
1605   /* Check for id rule */
1606   if(preg_match('/^id(:|#)\d+$/',$rule)){
1607     return (array("\{$rule}"));
1608   }
1610   /* Check for clean attribute */
1611   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1612     $rule= preg_replace('/^%/', '', $rule);
1613     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1614     return (array($val));
1615   }
1617   /* Check for attribute with parameters */
1618   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1619     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1620     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1621     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1622     $start= preg_replace ('/-.*$/', '', $param);
1623     $stop = preg_replace ('/^[^-]+-/', '', $param);
1625     /* Assemble results */
1626     $result= array();
1627     for ($i= $start; $i<= $stop; $i++){
1628       $result[]= substr($val, 0, $i);
1629     }
1630     return ($result);
1631   }
1633   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1634   return (array($rule));
1638 function gen_uids($rule, $attributes)
1640   global $config;
1642   /* Search for keys and fill the variables array with all 
1643      possible values for that key. */
1644   $part= "";
1645   $trigger= false;
1646   $stripped= "";
1647   $variables= array();
1649   for ($pos= 0; $pos < strlen($rule); $pos++){
1651     if ($rule[$pos] == "{" ){
1652       $trigger= true;
1653       $part= "";
1654       continue;
1655     }
1657     if ($rule[$pos] == "}" ){
1658       $variables[$pos]= expand_id($part, $attributes);
1659       $stripped.= "{".$pos."}";
1660       $trigger= false;
1661       continue;
1662     }
1664     if ($trigger){
1665       $part.= $rule[$pos];
1666     } else {
1667       $stripped.= $rule[$pos];
1668     }
1669   }
1671   /* Recurse through all possible combinations */
1672   $proposed= recurse($stripped, $variables);
1674   /* Get list of used ID's */
1675   $used= array();
1676   $ldap= $config->get_ldap_link();
1677   $ldap->cd($config->current['BASE']);
1678   $ldap->search('(uid=*)');
1680   while($attrs= $ldap->fetch()){
1681     $used[]= $attrs['uid'][0];
1682   }
1684   /* Remove used uids and watch out for id tags */
1685   $ret= array();
1686   foreach($proposed as $uid){
1688     /* Check for id tag and modify uid if needed */
1689     if(preg_match('/\{id:\d+}/',$uid)){
1690       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1692       for ($i= 0; $i < pow(10,$size); $i++){
1693         $number= sprintf("%0".$size."d", $i);
1694         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1695         if (!in_array($res, $used)){
1696           $uid= $res;
1697           break;
1698         }
1699       }
1700     }
1702   if(preg_match('/\{id#\d+}/',$uid)){
1703     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1705     while (true){
1706       mt_srand((double) microtime()*1000000);
1707       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1708       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1709       if (!in_array($res, $used)){
1710         $uid= $res;
1711         break;
1712       }
1713     }
1714   }
1716 /* Don't assign used ones */
1717 if (!in_array($uid, $used)){
1718   $ret[]= $uid;
1722 return(array_unique($ret));
1726 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1727    Need to convert... */
1728 function to_byte($value) {
1729   $value= strtolower(trim($value));
1731   if(!is_numeric(substr($value, -1))) {
1733     switch(substr($value, -1)) {
1734       case 'g':
1735         $mult= 1073741824;
1736         break;
1737       case 'm':
1738         $mult= 1048576;
1739         break;
1740       case 'k':
1741         $mult= 1024;
1742         break;
1743     }
1745     return ($mult * (int)substr($value, 0, -1));
1746   } else {
1747     return $value;
1748   }
1752 function in_array_ics($value, $items)
1754   if (!is_array($items)){
1755     return (FALSE);
1756   }
1758   foreach ($items as $item){
1759     if (strcasecmp($item, $value) == 0) {
1760       return (TRUE);
1761     }
1762   }
1764   return (FALSE);
1765
1768 function generate_alphabet($count= 10)
1770   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1771   $alphabet= "";
1772   $c= 0;
1774   /* Fill cells with charaters */
1775   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1776     if ($c == 0){
1777       $alphabet.= "<tr>";
1778     }
1780     $ch = mb_substr($characters, $i, 1, "UTF8");
1781     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1782       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1784     if ($c++ == $count){
1785       $alphabet.= "</tr>";
1786       $c= 0;
1787     }
1788   }
1790   /* Fill remaining cells */
1791   while ($c++ <= $count){
1792     $alphabet.= "<td>&nbsp;</td>";
1793   }
1795   return ($alphabet);
1799 function validate($string)
1801   return (strip_tags(preg_replace('/\0/', '', $string)));
1805 function get_gosa_version()
1807   global $svn_revision, $svn_path;
1809   /* Extract informations */
1810   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1812   /* Release or development? */
1813   if (preg_match('%/gosa/trunk/%', $svn_path)){
1814     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1815   } else {
1816     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1817     return (sprintf(_("GOsa $release"), $revision));
1818   }
1822 function rmdirRecursive($path, $followLinks=false) {
1823   $dir= opendir($path);
1824   while($entry= readdir($dir)) {
1825     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1826       unlink($path."/".$entry);
1827     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1828       rmdirRecursive($path."/".$entry);
1829     }
1830   }
1831   closedir($dir);
1832   return rmdir($path);
1836 function scan_directory($path,$sort_desc=false)
1838   $ret = false;
1840   /* is this a dir ? */
1841   if(is_dir($path)) {
1843     /* is this path a readable one */
1844     if(is_readable($path)){
1846       /* Get contents and write it into an array */   
1847       $ret = array();    
1849       $dir = opendir($path);
1851       /* Is this a correct result ?*/
1852       if($dir){
1853         while($fp = readdir($dir))
1854           $ret[]= $fp;
1855       }
1856     }
1857   }
1858   /* Sort array ascending , like scandir */
1859   sort($ret);
1861   /* Sort descending if parameter is sort_desc is set */
1862   if($sort_desc) {
1863     $ret = array_reverse($ret);
1864   }
1866   return($ret);
1870 function clean_smarty_compile_dir($directory)
1872   global $svn_revision;
1874   if(is_dir($directory) && is_readable($directory)) {
1875     // Set revision filename to REVISION
1876     $revision_file= $directory."/REVISION";
1878     /* Is there a stamp containing the current revision? */
1879     if(!file_exists($revision_file)) {
1880       // create revision file
1881       create_revision($revision_file, $svn_revision);
1882     } else {
1883       # check for "$config->...['CONFIG']/revision" and the
1884       # contents should match the revision number
1885       if(!compare_revision($revision_file, $svn_revision)){
1886         // If revision differs, clean compile directory
1887         foreach(scan_directory($directory) as $file) {
1888           if(($file==".")||($file=="..")) continue;
1889           if( is_file($directory."/".$file) &&
1890               is_writable($directory."/".$file)) {
1891             // delete file
1892             if(!unlink($directory."/".$file)) {
1893               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1894               // This should never be reached
1895             }
1896           } elseif(is_dir($directory."/".$file) &&
1897               is_writable($directory."/".$file)) {
1898             // Just recursively delete it
1899             rmdirRecursive($directory."/".$file);
1900           }
1901         }
1902         // We should now create a fresh revision file
1903         clean_smarty_compile_dir($directory);
1904       } else {
1905         // Revision matches, nothing to do
1906       }
1907     }
1908   } else {
1909     // Smarty compile dir is not accessible
1910     // (Smarty will warn about this)
1911   }
1915 function create_revision($revision_file, $revision)
1917   $result= false;
1919   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1920     if($fh= fopen($revision_file, "w")) {
1921       if(fwrite($fh, $revision)) {
1922         $result= true;
1923       }
1924     }
1925     fclose($fh);
1926   } else {
1927     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1928   }
1930   return $result;
1934 function compare_revision($revision_file, $revision)
1936   // false means revision differs
1937   $result= false;
1939   if(file_exists($revision_file) && is_readable($revision_file)) {
1940     // Open file
1941     if($fh= fopen($revision_file, "r")) {
1942       // Compare File contents with current revision
1943       if($revision == fread($fh, filesize($revision_file))) {
1944         $result= true;
1945       }
1946     } else {
1947       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1948     }
1949     // Close file
1950     fclose($fh);
1951   }
1953   return $result;
1957 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1959   $str = ""; // Our return value will be saved in this var
1961   $color  = dechex($percentage+150);
1962   $color2 = dechex(150 - $percentage);
1963   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1965   $progress = (int)(($percentage /100)*$width);
1967   /* Abort printing out percentage, if divs are to small */
1970   /* If theres a better solution for this, use it... */
1971   $str = "
1972     <div style=\" width:".($width)."px; 
1973     height:".($height)."px;
1974   background-color:#000000;
1975 padding:1px;\">
1977           <div style=\" width:".($width)."px;
1978         background-color:#$bgcolor;
1979 height:".($height)."px;\">
1981          <div style=\" width:".$progress."px;
1982 height:".$height."px;
1983        background-color:#".$color2.$color2.$color."; \">";
1986        if(($height >10)&&($showvalue)){
1987          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
1988            <b>".$percentage."%</b>
1989            </font>";
1990        }
1992        $str.= "</div></div></div>";
1994        return($str);
1998 function array_key_ics($ikey, $items)
2000   /* Gather keys, make them lowercase */
2001   $tmp= array();
2002   foreach ($items as $key => $value){
2003     $tmp[strtolower($key)]= $key;
2004   }
2006   if (isset($tmp[strtolower($ikey)])){
2007     return($tmp[strtolower($ikey)]);
2008   }
2010   return ("");
2014 function array_differs($src, $dst)
2016   /* If the count is differing, the arrays differ */
2017   if (count ($src) != count ($dst)){
2018     return (TRUE);
2019   }
2021   /* So the count is the same - lets check the contents */
2022   $differs= FALSE;
2023   foreach($src as $value){
2024     if (!in_array($value, $dst)){
2025       $differs= TRUE;
2026     }
2027   }
2029   return ($differs);
2033 function saveFilter($a_filter, $values)
2035   if (isset($_POST['regexit'])){
2036     $a_filter["regex"]= $_POST['regexit'];
2038     foreach($values as $type){
2039       if (isset($_POST[$type])) {
2040         $a_filter[$type]= "checked";
2041       } else {
2042         $a_filter[$type]= "";
2043       }
2044     }
2045   }
2047   /* React on alphabet links if needed */
2048   if (isset($_GET['search'])){
2049     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2050     if ($s == "**"){
2051       $s= "*";
2052     }
2053     $a_filter['regex']= $s;
2054   }
2056   return ($a_filter);
2060 /* Escape all preg_* relevant characters */
2061 function normalizePreg($input)
2063   return (addcslashes($input, '[]()|/.*+-'));
2067 /* Escape all LDAP filter relevant characters */
2068 function normalizeLdap($input)
2070   return (addcslashes($input, '()|'));
2074 /* Resturns the difference between to microtime() results in float  */
2075 function get_MicroTimeDiff($start , $stop)
2077   $a = split("\ ",$start);
2078   $b = split("\ ",$stop);
2080   $secs = $b[1] - $a[1];
2081   $msecs= $b[0] - $a[0]; 
2083   $ret = (float) ($secs+ $msecs);
2084   return($ret);
2088 function get_base_dir()
2090   global $BASE_DIR;
2092   return $BASE_DIR;
2096 function obj_is_readable($dn, $object, $attribute)
2098   global $ui;
2100   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2104 function obj_is_writable($dn, $object, $attribute)
2106   global $ui;
2108   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2112 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2114   /* Initialize variables */
2115   $ret  = array("count" => 0);  // Set count to 0
2116   $next = true;                 // if false, then skip next loops and return
2117   $cnt  = 0;                    // Current number of loops
2118   $max  = 100;                  // Just for security, prevent looops
2119   $ldap = NULL;                 // To check if created result a valid
2120   $keep = "";                   // save last failed parse string
2122   /* Check each parsed dn in ldap ? */
2123   if($config!==NULL && $verify_in_ldap){
2124     $ldap = $config->get_ldap_link();
2125   }
2127   /* Lets start */
2128   $called = false;
2129   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2131     $cnt ++;
2132     if(!preg_match("/,/",$dn)){
2133       $next = false;
2134     }
2135     $object = preg_replace("/[,].*$/","",$dn);
2136     $dn     = preg_replace("/^[^,]+,/","",$dn);
2138     $called = true;
2140     /* Check if current dn is valid */
2141     if($ldap!==NULL){
2142       $ldap->cd($dn);
2143       $ldap->cat($dn,array("dn"));
2144       if($ldap->count()){
2145         $ret[]  = $keep.$object;
2146         $keep   = "";
2147       }else{
2148         $keep  .= $object.",";
2149       }
2150     }else{
2151       $ret[]  = $keep.$object;
2152       $keep   = "";
2153     }
2154   }
2156   /* No dn was posted */
2157   if($cnt == 0 && !empty($dn)){
2158     $ret[] = $dn;
2159   }
2161   /* Append the rest */
2162   $test = $keep.$dn;
2163   if($called && !empty($test)){
2164     $ret[] = $keep.$dn;
2165   }
2166   $ret['count'] = count($ret) - 1;
2168   return($ret);
2172 function get_base_from_hook($dn, $attrib)
2174   global $config;
2176   if (isset($config->current['BASE_HOOK'])){
2177     
2178     /* Call hook script - if present */
2179     $command= $config->current['BASE_HOOK'];
2181     if ($command != ""){
2182       $command.= " '".LDAP::fix($dn)."' $attrib";
2183       if (check_command($command)){
2184         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2185         exec($command, $output);
2186         if (preg_match("/^[0-9]+$/", $output[0])){
2187           return ($output[0]);
2188         } else {
2189           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2190           return ($config->current['UIDBASE']);
2191         }
2192       } else {
2193         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2194         return ($config->current['UIDBASE']);
2195       }
2197     } else {
2199       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2200       return ($config->current['UIDBASE']);
2202     }
2203   }
2207 function check_schema_version($class, $version)
2209   return preg_match("/\(v$version\)/", $class['DESC']);
2213 function check_schema($cfg,$rfc2307bis = FALSE)
2215   $messages= array();
2217   /* Get objectclasses */
2218   $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']));
2219   $objectclasses = $ldap->get_objectclasses();
2220   if(count($objectclasses) == 0){
2221     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2222   }
2224   /* This is the default block used for each entry.
2225    *  to avoid unset indexes.
2226    */
2227   $def_check = array("REQUIRED_VERSION" => "0",
2228       "SCHEMA_FILES"     => array(),
2229       "CLASSES_REQUIRED" => array(),
2230       "STATUS"           => FALSE,
2231       "IS_MUST_HAVE"     => FALSE,
2232       "MSG"              => "",
2233       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2235   /* The gosa base schema */
2236   $checks['gosaObject'] = $def_check;
2237   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2238   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2239   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2240   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2242   /* GOsa Account class */
2243   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2244   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2245   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2246   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2247   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2249   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2250   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2251   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2252   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2253   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2254   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2256   /* Some other checks */
2257   foreach(array(
2258         "gosaCacheEntry"        => array("version" => "2.4"),
2259         "gosaDepartment"        => array("version" => "2.4"),
2260         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2261         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2262         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2263         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2264         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2265         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2266         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2267         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2268         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2269         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2270         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2271         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2272         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2273         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2274         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2275         "goLdapServer"          => array("version" => "2.4"),
2276         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2277         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2278         "goKrbServer"           => array("version" => "2.4"),
2279         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2280         ) as $name => $values){
2282           $checks[$name] = $def_check;
2283           if(isset($values['version'])){
2284             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2285           }
2286           if(isset($values['file'])){
2287             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2288           }
2289           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2290         }
2291   foreach($checks as $name => $value){
2292     foreach($value['CLASSES_REQUIRED'] as $class){
2294       if(!isset($objectclasses[$name])){
2295         $checks[$name]['STATUS'] = FALSE;
2296         if($value['IS_MUST_HAVE']){
2297           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2298         }else{
2299           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2300         }
2301       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2302         $checks[$name]['STATUS'] = FALSE;
2304         if($value['IS_MUST_HAVE']){
2305           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2306         }else{
2307           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2308         }
2309       }else{
2310         $checks[$name]['STATUS'] = TRUE;
2311         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2312       }
2313     }
2314   }
2316   $tmp = $objectclasses;
2318   /* The gosa base schema */
2319   $checks['posixGroup'] = $def_check;
2320   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2321   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2322   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2323   $checks['posixGroup']['STATUS']           = TRUE;
2324   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2325   $checks['posixGroup']['MSG']              = "";
2326   $checks['posixGroup']['INFO']             = "";
2328   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2329   if(isset($tmp['posixGroup'])){
2331     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2332       $checks['posixGroup']['STATUS']           = FALSE;
2333       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2334       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2335     }
2336     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2337       $checks['posixGroup']['STATUS']           = FALSE;
2338       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2339       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2340     }
2341   }
2343   return($checks);
2347 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2349   $tmp = array(
2350         "de_DE" => "German",
2351         "fr_FR" => "French",
2352         "it_IT" => "Italian",
2353         "es_ES" => "Spanish",
2354         "en_US" => "English",
2355         "nl_NL" => "Dutch",
2356         "pl_PL" => "Polish",
2357         "sv_SE" => "Swedish",
2358         "zh_CN" => "Chinese",
2359         "vi_VN" => "Vietnamese",
2360         "ru_RU" => "Russian");
2361   
2362   $tmp2= array(
2363         "de_DE" => _("German"),
2364         "fr_FR" => _("French"),
2365         "it_IT" => _("Italian"),
2366         "es_ES" => _("Spanish"),
2367         "en_US" => _("English"),
2368         "nl_NL" => _("Dutch"),
2369         "pl_PL" => _("Polish"),
2370         "sv_SE" => _("Swedish"),
2371         "zh_CN" => _("Chinese"),
2372         "vi_VN" => _("Vietnamese"),
2373         "ru_RU" => _("Russian"));
2375   $ret = array();
2376   if($languages_in_own_language){
2378     $old_lang = setlocale(LC_ALL, 0);
2380     /* If the locale wasn't correclty set before, there may be an incorrect
2381         locale returned. Something like this: 
2382           C_CTYPE=de_DE.UTF-8;LC_NUMERIC=C;LC_TIME=de_DE.UTF-8;LC ...
2383         Extract the locale name from this string and use it to restore old locale.
2384      */
2385     if(preg_match("/LC_CTYPE/",$old_lang)){
2386       $old_lang = preg_replace("/^.*LC_CTYPE=([^;]*).*$/","\\1",$old_lang);
2387     }
2388     
2389     foreach($tmp as $key => $name){
2390       $lang = $key.".UTF-8";
2391       setlocale(LC_ALL, $lang);
2392       if($strip_region_tag){
2393         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2394       }else{
2395         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2396       }
2397     }
2398     setlocale(LC_ALL, $old_lang);
2399   }else{
2400     foreach($tmp as $key => $name){
2401       if($strip_region_tag){
2402         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2403       }else{
2404         $ret[$key] = _($name);
2405       }
2406     }
2407   }
2408   return($ret);
2412 /* Returns contents of the given POST variable and check magic quotes settings */
2413 function get_post($name)
2415   if(!isset($_POST[$name])){
2416     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2417     return(FALSE);
2418   }
2419   if(get_magic_quotes_gpc()){
2420     return(stripcslashes($_POST[$name]));
2421   }else{
2422     return($_POST[$name]);
2423   }
2427 /* Return class name in correct case */
2428 function get_correct_class_name($cls)
2430   global $class_mapping;
2431   if(isset($class_mapping) && is_array($class_mapping)){
2432     foreach($class_mapping as $class => $file){
2433       if(preg_match("/^".$cls."$/i",$class)){
2434         return($class);
2435       }
2436     }
2437   }
2438   return(FALSE);
2442 // change_password, changes the Password, of the given dn
2443 function change_password ($dn, $password, $mode=0, $hash= "")
2445   global $config;
2446   $newpass= "";
2448   /* Convert to lower. Methods are lowercase */
2449   $hash= strtolower($hash);
2451   // Get all available encryption Methods
2453   // NON STATIC CALL :)
2454   $methods = new passwordMethod(session::get('config'));
2455   $available = $methods->get_available_methods();
2457   // read current password entry for $dn, to detect the encryption Method
2458   $ldap       = $config->get_ldap_link();
2459   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2460   $attrs      = $ldap->fetch ();
2462   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2463   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2464     $deactivated = TRUE;
2465   }else{
2466     $deactivated = FALSE;
2467   }
2469   /* Is ensure that clear passwords will stay clear */
2470   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2471     $hash = "clear";
2472   }
2474   // Detect the encryption Method
2475   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2477     /* Check for supported algorithm */
2478     mt_srand((double) microtime()*1000000);
2480     /* Extract used hash */
2481     if ($hash == ""){
2482       $test = passwordMethod::get_method($attrs['userPassword'][0],$dn);
2483     } else {
2484       $test = new $available[$hash]($config,$dn);
2485       $test->set_hash($hash);
2486     }
2488   } else {
2489     // User MD5 by default
2490     $hash= "md5";
2491     $test = new  $available['md5']($config);
2492   }
2494   /* Feed password backends with information */
2495   $test->dn= $dn;
2496   $test->attrs= $attrs;
2497   $newpass= $test->generate_hash($password);
2499   // Update shadow timestamp?
2500   if (isset($attrs["shadowLastChange"][0])){
2501     $shadow= (int)(date("U") / 86400);
2502   } else {
2503     $shadow= 0;
2504   }
2506   // Write back modified entry
2507   $ldap->cd($dn);
2508   $attrs= array();
2510   // Not for groups
2511   if ($mode == 0){
2513     if ($shadow != 0){
2514       $attrs['shadowLastChange']= $shadow;
2515     }
2517     // Create SMB Password
2518     $attrs= generate_smb_nt_hash($password);
2519   }
2521  /* Read ! if user was deactivated */
2522   if($deactivated){
2523     $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass);
2524   }
2526   $attrs['userPassword']= array();
2527   $attrs['userPassword']= $newpass;
2529   $ldap->modify($attrs);
2531   new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
2533   if (!$ldap->success()) {
2534     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG));
2535   } else {
2537     /* Run backend method for change/create */
2538     if(!$test->set_password($password)){
2539       return(FALSE);
2540     }
2542     /* Find postmodify entries for this class */
2543     $command= $config->search("password", "POSTMODIFY",array('menu'));
2545     if ($command != ""){
2546       /* Walk through attribute list */
2547       $command= preg_replace("/%userPassword/", $password, $command);
2548       $command= preg_replace("/%dn/", $dn, $command);
2550       if (check_command($command)){
2551         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2552         exec($command);
2553       } else {
2554         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2555         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2556       }
2557     }
2558   }
2559   return(TRUE);
2563 // Return something like array['sambaLMPassword']= "lalla..."
2564 function generate_smb_nt_hash($password)
2566   global $config;
2568   # Try to use gosa-si?
2569   if (isset($config->current['GOSA_SI'])){
2570         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2571     if (isset($res['XML']['HASH'])){
2572         $hash= $res['XML']['HASH'];
2573     } else {
2574       $hash= "";
2575     }
2576   } else {
2577           $tmp= $config->data['MAIN']['SMBHASH']." ".escapeshellarg($password);
2578           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2580           exec($tmp, $ar);
2581           flush();
2582           reset($ar);
2583           $hash= current($ar);
2584   }
2586   if ($hash == "") {
2587           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2588           return ("");
2589   }
2591   list($lm,$nt)= split (":", trim($hash));
2593   if ($config->current['SAMBAVERSION'] == 3) {
2594           $attrs['sambaLMPassword']= $lm;
2595           $attrs['sambaNTPassword']= $nt;
2596           $attrs['sambaPwdLastSet']= date('U');
2597           $attrs['sambaBadPasswordCount']= "0";
2598           $attrs['sambaBadPasswordTime']= "0";
2599   } else {
2600           $attrs['lmPassword']= $lm;
2601           $attrs['ntPassword']= $nt;
2602           $attrs['pwdLastSet']= date('U');
2603   }
2604   return($attrs);
2608 function getEntryCSN($dn)
2610   global $config;
2611   if(empty($dn) || !is_object($config)){
2612     return("");
2613   }
2615   /* Get attribute that we should use as serial number */
2616   if(isset($config->current['UNIQ_IDENTIFIER'])){
2617     $attr = $config->current['UNIQ_IDENTIFIER'];
2618   }elseif(isset($config->data['MAIN']['UNIQ_IDENTIFIER'])){
2619     $attr = $config->data['MAIN']['UNIQ_IDENTIFIER'];
2620   }
2621   if(!empty($attr)){
2622     $ldap = $config->get_ldap_link();
2623     $ldap->cat($dn,array($attr));
2624     $csn = $ldap->fetch();
2625     if(isset($csn[$attr][0])){
2626       return($csn[$attr][0]);
2627     }
2628   }
2629   return("");
2633 /* Add a given objectClass to an attrs entry */
2634 function add_objectClass($classes, &$attrs)
2636   if (is_array($classes)){
2637     $list= $classes;
2638   } else {
2639     $list= array($classes);
2640   }
2642   foreach ($list as $class){
2643     $attrs['objectClass'][]= $class;
2644   }
2648 /* Removes a given objectClass from the attrs entry */
2649 function remove_objectClass($classes, &$attrs)
2651   if (isset($attrs['objectClass'])){
2652     /* Array? */
2653     if (is_array($classes)){
2654       $list= $classes;
2655     } else {
2656       $list= array($classes);
2657     }
2659     $tmp= array();
2660     foreach ($attrs['objectClass'] as $oc) {
2661       foreach ($list as $class){
2662         if ($oc != $class){
2663           $tmp[]= $oc;
2664         }
2665       }
2666     }
2667     $attrs['objectClass']= $tmp;
2668   }
2671 /*! \brief  Initialize a file download with given content, name and data type. 
2672  *  @param  data  String The content to send.
2673  *  @param  name  String The name of the file.
2674  *  @param  type  String The content identifier, default value is "application/octet-stream";
2675  */
2676 function send_binary_content($data,$name,$type = "application/octet-stream")
2678   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2679   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2680   header("Cache-Control: no-cache");
2681   header("Pragma: no-cache");
2682   header("Cache-Control: post-check=0, pre-check=0");
2683   header("Content-type: ".$type."");
2685   $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
2687   /* Strip name if it is a complete path */
2688   if (preg_match ("/\//", $name)) {
2689         $name= basename($name);
2690   }
2691   
2692   /* force download dialog */
2693   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2694     header('Content-Disposition: filename="'.$name.'"');
2695   } else {
2696     header('Content-Disposition: attachment; filename="'.$name.'"');
2697   }
2699   echo $data;
2700   exit();
2704 function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8")
2706   if(is_string($str)){
2707     return(htmlentities($str,$type,$charset));
2708   }elseif(is_array($str)){
2709     foreach($str as $name => $value){
2710       $str[$name] = reverse_html_entities($value,$type,$charset);
2711     }
2712   }
2713   return($str);
2717 /*! \brief Encode special string characters so we can use the string in \
2718            HTML output, without breaking quotes.
2719     @param  The String we want to encode.
2720     @return The encoded String
2721  */
2722 function xmlentities($str)
2723
2724   if(is_string($str)){
2726     static $asc2uni= array();
2727     if (!count($asc2uni)){
2728       for($i=128;$i<256;$i++){
2729     #    $asc2uni[chr($i)] = "&#x".dechex($i).";";
2730       }
2731     }
2733     $str = str_replace("&", "&amp;", $str);
2734     $str = str_replace("<", "&lt;", $str);
2735     $str = str_replace(">", "&gt;", $str);
2736     $str = str_replace("'", "&apos;", $str);
2737     $str = str_replace("\"", "&quot;", $str);
2738     $str = str_replace("\r", "", $str);
2739     $str = strtr($str,$asc2uni);
2740     return $str;
2741   }elseif(is_array($str)){
2742     foreach($str as $name => $value){
2743       $str[$name] = xmlentities($value);
2744     }
2745   }
2746   return($str);
2750 /*! \brief  Updates all accessTo attributes from a given value to a new one.
2751             For example if a host is renamed.
2752     @param  String  $from The source accessTo name.
2753     @param  String  $to   The destination accessTo name.
2754 */
2755 function update_accessTo($from,$to)
2757   global $config;
2758   $ldap = $config->get_ldap_link();
2759   $ldap->cd($config->current['BASE']);
2760   $ldap->search("(&(objectClass=trustAccount)(accessTo=".$from."))",array("objectClass","accessTo"));
2761   while($attrs = $ldap->fetch()){
2762     $new_attrs = array("accessTo" => array());
2763     $dn = $attrs['dn'];
2764     for($i = 0 ; $i < $attrs['objectClass']['count']; $i++){
2765       $new_attrs['objectClass'][] =  $attrs['objectClass'][$i];
2766     }
2767     for($i = 0 ; $i < $attrs['accessTo']['count']; $i++){
2768       if($attrs['accessTo'][$i] == $from){
2769         if(!empty($to)){
2770           $new_attrs['accessTo'][] =  $to;
2771         }
2772       }else{
2773         $new_attrs['accessTo'][] =  $attrs['accessTo'][$i]; 
2774       }
2775     }
2776     $ldap->cd($dn);
2777     $ldap->modify($new_attrs);
2778     if (!$ldap->success()){
2779       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, "update_accessTo($from,$to)"));
2780     }
2781     new log("modify","update_accessTo($from,$to)",$dn,array_keys($new_attrs),$ldap->get_error());
2782   }
2786 function get_random_char () {
2787      $randno = rand (0, 63);
2788      if ($randno < 12) {
2789          return (chr ($randno + 46)); // Digits, '/' and '.'
2790      } else if ($randno < 38) {
2791          return (chr ($randno + 53)); // Uppercase
2792      } else {
2793          return (chr ($randno + 59)); // Lowercase
2794      }
2798 function cred_encrypt($input, $password) {
2800   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
2801   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
2803   return bin2hex(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $password, $input, MCRYPT_MODE_ECB, $iv));
2807 function cred_decrypt($input,$password) {
2808   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
2809   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
2811   return mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $password, pack("H*", $input), MCRYPT_MODE_ECB, $iv);
2815 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2816 ?>