Code

07990f8e24a9451bac8c30ebc452ebd6dfef3e4f
[gosa.git] / gosa-core / include / functions.inc
1 <?php
2 /*
3  * This code is part of GOsa (https://gosa.gonicus.de)
4  * Copyright (C) 2003 Cajus Pollmeier
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
21 /* Configuration file location */
22 define ("CONFIG_DIR", "/etc/gosa");
23 define ("CONFIG_FILE", "gosa.conf-trunk");
24 define ("CONFIG_TEMPLATE_DIR", "../contrib/");
25 define ("HELP_BASEDIR", "/var/www/doc/");
27 /* Define get_list flags */
28 define("GL_NONE",         0);
29 define("GL_SUBSEARCH",    1);
30 define("GL_SIZELIMIT",    2);
31 define("GL_CONVERT",      4);
32 define("GL_NO_ACL_CHECK", 8);
34 /* Heimdal stuff */
35 define('UNIVERSAL',0x00);
36 define('INTEGER',0x02);
37 define('OCTET_STRING',0x04);
38 define('OBJECT_IDENTIFIER ',0x06);
39 define('SEQUENCE',0x10);
40 define('SEQUENCE_OF',0x10);
41 define('SET',0x11);
42 define('SET_OF',0x11);
43 define('DEBUG',false);
44 define('HDB_KU_MKEY',0x484442);
45 define('TWO_BIT_SHIFTS',0x7efc);
46 define('DES_CBC_CRC',1);
47 define('DES_CBC_MD4',2);
48 define('DES_CBC_MD5',3);
49 define('DES3_CBC_MD5',5);
50 define('DES3_CBC_SHA1',16);
52 /* Define globals for revision comparing */
53 $svn_path = '$HeadURL$';
54 $svn_revision = '$Revision$';
56 /* Include required files */
57 require_once("class_location.inc");
58 require_once ("functions_debug.inc");
59 require_once ("accept-to-gettext.inc");
61 /* Define constants for debugging */
62 define ("DEBUG_TRACE",   1);
63 define ("DEBUG_LDAP",    2);
64 define ("DEBUG_MYSQL",   4);
65 define ("DEBUG_SHELL",   8);
66 define ("DEBUG_POST",   16);
67 define ("DEBUG_SESSION",32);
68 define ("DEBUG_CONFIG", 64);
69 define ("DEBUG_ACL",    128);
71 /* Rewrite german 'umlauts' and spanish 'accents'
72    to get better results */
73 $REWRITE= array( "ä" => "ae",
74     "ö" => "oe",
75     "ü" => "ue",
76     "Ä" => "Ae",
77     "Ö" => "Oe",
78     "Ü" => "Ue",
79     "ß" => "ss",
80     "á" => "a",
81     "é" => "e",
82     "í" => "i",
83     "ó" => "o",
84     "ú" => "u",
85     "Á" => "A",
86     "É" => "E",
87     "Í" => "I",
88     "Ó" => "O",
89     "Ú" => "U",
90     "ñ" => "ny",
91     "Ñ" => "Ny" );
94 /* Class autoloader */
95 function __autoload($class_name) {
96     global $class_mapping, $BASE_DIR;
98     if ($class_mapping === NULL){
99             echo sprintf(_("Fatal error: no class locations defined - please run '%s' to fix this"), "<b>update-gosa</b>");
100             exit;
101     }
103     if (isset($class_mapping[$class_name])){
104       require_once($BASE_DIR."/".$class_mapping[$class_name]);
105     } else {
106       echo sprintf(_("Fatal error: cannot instantiate class '%s' - try running '%s' to fix this"), $class_name, "<b>update-gosa</b>");
107       exit;
108     }
112 /*! \brief Checks if a class is available. 
113  *  @param  name String  The class name.
114  *  @return boolean      True if class is available, else false.
115  */
116 function class_available($name)
118   global $class_mapping;
119   return(isset($class_mapping[$name]));
123 /* Check if plugin is avaliable */
124 function plugin_available($plugin)
126         global $class_mapping, $BASE_DIR;
128         if (!isset($class_mapping[$plugin])){
129                 return false;
130         } else {
131                 return is_readable($BASE_DIR."/".$class_mapping[$plugin]);
132         }
136 /* Create seed with microseconds */
137 function make_seed() {
138   list($usec, $sec) = explode(' ', microtime());
139   return (float) $sec + ((float) $usec * 100000);
143 /* Debug level action */
144 function DEBUG($level, $line, $function, $file, $data, $info="")
146   if (session::get('DEBUGLEVEL') & $level){
147     $output= "DEBUG[$level] ";
148     if ($function != ""){
149       $output.= "($file:$function():$line) - $info: ";
150     } else {
151       $output.= "($file:$line) - $info: ";
152     }
153     echo $output;
154     if (is_array($data)){
155       print_a($data);
156     } else {
157       echo "'$data'";
158     }
159     echo "<br>";
160   }
164 function get_browser_language()
166   /* Try to use users primary language */
167   global $config;
168   $ui= get_userinfo();
169   if (isset($ui) && $ui !== NULL){
170     if ($ui->language != ""){
171       return ($ui->language.".UTF-8");
172     }
173   }
175   /* Check for global language settings in gosa.conf */
176   if(isset($config->data['MAIN']['LANG']) && !empty($config->data['MAIN']['LANG'])) {
177     $lang = $config->data['MAIN']['LANG'];
178     if(!preg_match("/utf/i",$lang)){
179       $lang .= ".UTF-8";
180     }
181     return($lang);
182   }
183  
184   /* Load supported languages */
185   $gosa_languages= get_languages();
187   /* Move supported languages to flat list */
188   $langs= array();
189   foreach($gosa_languages as $lang => $dummy){
190     $langs[]= $lang.'.UTF-8';
191   }
193   /* Return gettext based string */
194   return (al2gt($langs, 'text/html'));
198 /* Rewrite ui object to another dn */
199 function change_ui_dn($dn, $newdn)
201   $ui= session::get('ui');
202   if ($ui->dn == $dn){
203     $ui->dn= $newdn;
204     session::set('ui',$ui);
205   }
209 /* Return theme path for specified file */
210 function get_template_path($filename= '', $plugin= FALSE, $path= "")
212   global $config, $BASE_DIR;
214   if (!@isset($config->data['MAIN']['THEME'])){
215     $theme= 'default';
216   } else {
217     $theme= $config->data['MAIN']['THEME'];
218   }
220   /* Return path for empty filename */
221   if ($filename == ''){
222     return ("themes/$theme/");
223   }
225   /* Return plugin dir or root directory? */
226   if ($plugin){
227     if ($path == ""){
228       $nf= preg_replace("!^".$BASE_DIR."/!", "", session::get('plugin_dir'));
229     } else {
230       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
231     }
232     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
233       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
234     }
235     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
236       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
237     }
238     if ($path == ""){
239       return (session::get('plugin_dir')."/$filename");
240     } else {
241       return ($path."/$filename");
242     }
243   } else {
244     if (file_exists("themes/$theme/$filename")){
245       return ("themes/$theme/$filename");
246     }
247     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
248       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
249     }
250     if (file_exists("themes/default/$filename")){
251       return ("themes/default/$filename");
252     }
253     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
254       return ("$BASE_DIR/ihtml/themes/default/$filename");
255     }
256     return ($filename);
257   }
261 function array_remove_entries($needles, $haystack)
263   $tmp= array();
265   /* Loop through entries to be removed */
266   foreach ($haystack as $entry){
267     if (!in_array($entry, $needles)){
268       $tmp[]= $entry;
269     }
270   }
272   return ($tmp);
276 function gosa_array_merge($ar1,$ar2)
278   if(!is_array($ar1) || !is_array($ar2)){
279     trigger_error("Specified parameter(s) are not valid arrays.");
280   }else{
281     return(array_values(array_unique(array_merge($ar1,$ar2))));
282   }
286 function gosa_log ($message)
288   global $ui;
290   /* Preset to something reasonable */
291   $username= " unauthenticated";
293   /* Replace username if object is present */
294   if (isset($ui)){
295     if ($ui->username != ""){
296       $username= "[$ui->username]";
297     } else {
298       $username= "unknown";
299     }
300   }
302   syslog(LOG_INFO,"GOsa$username: $message");
306 function ldap_init ($server, $base, $binddn='', $pass='')
308   global $config;
310   $ldap = new LDAP ($binddn, $pass, $server,
311       isset($config->current['RECURSIVE']) && $config->current['RECURSIVE'] == "true",
312       isset($config->current['TLS']) && $config->current['TLS'] == "true");
314   /* Sadly we've no proper return values here. Use the error message instead. */
315   if (!preg_match("/Success/i", $ldap->error)){
316     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
317     exit();
318   }
320   /* Preset connection base to $base and return to caller */
321   $ldap->cd ($base);
322   return $ldap;
326 function process_htaccess ($username, $kerberos= FALSE)
328   global $config;
330   /* Search for $username and optional @REALM in all configured LDAP trees */
331   foreach($config->data["LOCATIONS"] as $name => $data){
332   
333     $config->set_current($name);
334     $mode= "kerberos";
335     if (isset($config->current['KRBSASL']) && preg_match('/^true$/i', $config->current['KRBSASL'])){
336       $mode= "sasl";
337     }
339     /* Look for entry or realm */
340     $ldap= $config->get_ldap_link();
341     if (!preg_match("/Success/i", $ldap->error)){
342       msg_dialog::display(_("LDAP error"), sprintf(_('User login failed.').'<br><br>'._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
343       $smarty= get_smarty();
344       $smarty->display(get_template_path('headers.tpl'));
345       echo "<body>".session::get('errors')."</body></html>";
346       exit();
347     }
348     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
350     /* Found a uniq match? Return it... */
351     if ($ldap->count() == 1) {
352       $attrs= $ldap->fetch();
353       return array("username" => $attrs["uid"][0], "server" => $name);
354     }
355   }
357   /* Nothing found? Return emtpy array */
358   return array("username" => "", "server" => "");
362 function ldap_login_user_htaccess ($username)
364   global $config;
366   /* Look for entry or realm */
367   $ldap= $config->get_ldap_link();
368   if (!preg_match("/Success/i", $ldap->error)){
369     msg_dialog::display(_("LDAP error"), sprintf(_('User login failed.').'<br><br>'._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
370     $smarty= get_smarty();
371     $smarty->display(get_template_path('headers.tpl'));
372     echo "<body>".session::get('errors')."</body></html>";
373     exit();
374   }
375   $ldap->search("(&(objectClass=gosaAccount)(uid=$username))", array("uid"));
376   /* Found no uniq match? Strange, because we did above... */
377   if ($ldap->count() != 1) {
378     msg_dialog::display(_("LDAP error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), ERROR_DIALOG);
379     return (NULL);
380   }
381   $attrs= $ldap->fetch();
383   /* got user dn, fill acl's */
384   $ui= new userinfo($config, $ldap->getDN());
385   $ui->username= $attrs['uid'][0];
387   /* No password check needed - the webserver did it for us */
388   $ldap->disconnect();
390   /* Username is set, load subtreeACL's now */
391   $ui->loadACL();
393   /* TODO: check java script for htaccess authentication */
394   session::set('js',true);
396   return ($ui);
400 function ldap_login_user ($username, $password)
402   global $config;
404   /* look through the entire ldap */
405   $ldap = $config->get_ldap_link();
406   if (!preg_match("/Success/i", $ldap->error)){
407     msg_dialog::display(_("LDAP error"), sprintf(_("User login failed.")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
408     $smarty= get_smarty();
409     $smarty->display(get_template_path('headers.tpl'));
410     echo "<body>".session::get('errors')."</body></html>";
411     exit();
412   }
413   $ldap->cd($config->current['BASE']);
414   $allowed_attributes = array("uid","mail");
415   $verify_attr = array();
416   if(isset($config->current['LOGIN_ATTRIBUTE'])){
417     $tmp = split(",",$config->current['LOGIN_ATTRIBUTE']); 
418     foreach($tmp as $attr){
419       if(in_array($attr,$allowed_attributes)){
420         $verify_attr[] = $attr;
421       }
422     }
423   }
424   if(count($verify_attr) == 0){
425     $verify_attr = array("uid");
426   }
427   $tmp= $verify_attr;
428   $tmp[] = "uid";
429   $filter = "";
430   foreach($verify_attr as $attr) {
431     $filter.= "(".$attr."=".$username.")";
432   }
433   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
434   $ldap->search($filter,$tmp);
436   /* get results, only a count of 1 is valid */
437   switch ($ldap->count()){
439     /* user not found */
440     case 0:     return (NULL);
442             /* valid uniq user */
443     case 1: 
444             break;
446             /* found more than one matching id */
447     default:
448             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), ERROR_DIALOG);
449             return (NULL);
450   }
452   /* LDAP schema is not case sensitive. Perform additional check. */
453   $attrs= $ldap->fetch();
454   $success = FALSE;
455   foreach($verify_attr as $attr){
456     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
457       $success = TRUE;
458     }
459   }
460   if(!$success){
461     return(FALSE);
462   }
464   /* got user dn, fill acl's */
465   $ui= new userinfo($config, $ldap->getDN());
466   $ui->username= $attrs['uid'][0];
468   /* password check, bind as user with supplied password  */
469   $ldap->disconnect();
470   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
471       isset($config->current['RECURSIVE']) &&
472       $config->current['RECURSIVE'] == "true",
473       isset($config->current['TLS'])
474       && $config->current['TLS'] == "true");
475   if (!preg_match("/Success/i", $ldap->error)){
476     return (NULL);
477   }
479   /* Username is set, load subtreeACL's now */
480   $ui->loadACL();
482   return ($ui);
486 function ldap_expired_account($config, $userdn, $username)
488     $ldap= $config->get_ldap_link();
489     $ldap->cat($userdn);
490     $attrs= $ldap->fetch();
491     
492     /* default value no errors */
493     $expired = 0;
494     
495     $sExpire = 0;
496     $sLastChange = 0;
497     $sMax = 0;
498     $sMin = 0;
499     $sInactive = 0;
500     $sWarning = 0;
501     
502     $current= date("U");
503     
504     $current= floor($current /60 /60 /24);
505     
506     /* special case of the admin, should never been locked */
507     /* FIXME should allow any name as user admin */
508     if($username != "admin")
509     {
511       if(isset($attrs['shadowExpire'][0])){
512         $sExpire= $attrs['shadowExpire'][0];
513       } else {
514         $sExpire = 0;
515       }
516       
517       if(isset($attrs['shadowLastChange'][0])){
518         $sLastChange= $attrs['shadowLastChange'][0];
519       } else {
520         $sLastChange = 0;
521       }
522       
523       if(isset($attrs['shadowMax'][0])){
524         $sMax= $attrs['shadowMax'][0];
525       } else {
526         $smax = 0;
527       }
529       if(isset($attrs['shadowMin'][0])){
530         $sMin= $attrs['shadowMin'][0];
531       } else {
532         $sMin = 0;
533       }
534       
535       if(isset($attrs['shadowInactive'][0])){
536         $sInactive= $attrs['shadowInactive'][0];
537       } else {
538         $sInactive = 0;
539       }
540       
541       if(isset($attrs['shadowWarning'][0])){
542         $sWarning= $attrs['shadowWarning'][0];
543       } else {
544         $sWarning = 0;
545       }
546       
547       /* is the account locked */
548       /* shadowExpire + shadowInactive (option) */
549       if($sExpire >0){
550         if($current >= ($sExpire+$sInactive)){
551           return(1);
552         }
553       }
554     
555       /* the user should be warned to change is password */
556       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
557         if (($sExpire - $current) < $sWarning){
558           return(2);
559         }
560       }
561       
562       /* force user to change password */
563       if(($sLastChange >0) && ($sMax) >0){
564         if($current >= ($sLastChange+$sMax)){
565           return(3);
566         }
567       }
568       
569       /* the user should not be able to change is password */
570       if(($sLastChange >0) && ($sMin >0)){
571         if (($sLastChange + $sMin) >= $current){
572           return(4);
573         }
574       }
575     }
576    return($expired);
580 function add_lock ($object, $user)
582   global $config;
584   if(is_array($object)){
585     foreach($object as $obj){
586       add_lock($obj,$user);
587     }
588     return;
589   }
591   /* Just a sanity check... */
592   if ($object == "" || $user == ""){
593     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
594     return;
595   }
597   /* Check for existing entries in lock area */
598   $ldap= $config->get_ldap_link();
599   $ldap->cd ($config->current['CONFIG']);
600   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
601       array("gosaUser"));
602   if (!preg_match("/Success/i", $ldap->error)){
603     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);
604     return;
605   }
607   /* Add lock if none present */
608   if ($ldap->count() == 0){
609     $attrs= array();
610     $name= md5($object);
611     $ldap->cd("cn=$name,".$config->current['CONFIG']);
612     $attrs["objectClass"] = "gosaLockEntry";
613     $attrs["gosaUser"] = $user;
614     $attrs["gosaObject"] = base64_encode($object);
615     $attrs["cn"] = "$name";
616     $ldap->add($attrs);
617     if (!preg_match("/Success/i", $ldap->error)){
618       msg_dialog::display(_("Internal error"), sprintf(_("Adding a lock failed.")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
619       return;
620     }
621   }
625 function del_lock ($object)
627   global $config;
629   if(is_array($object)){
630     foreach($object as $obj){
631       del_lock($obj);
632     }
633     return;
634   }
636   /* Sanity check */
637   if ($object == ""){
638     return;
639   }
641   /* Check for existance and remove the entry */
642   $ldap= $config->get_ldap_link();
643   $ldap->cd ($config->current['CONFIG']);
644   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
645   $attrs= $ldap->fetch();
646   if ($ldap->getDN() != "" && preg_match("/Success/i", $ldap->error)){
647     $ldap->rmdir ($ldap->getDN());
649     if (!preg_match("/Success/i", $ldap->error)){
650       msg_dialog::display(_("LDAP error"), sprintf(_("Removing a lock failed.")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
651       return;
652     }
653   }
657 function del_user_locks($userdn)
659   global $config;
661   /* Get LDAP ressources */ 
662   $ldap= $config->get_ldap_link();
663   $ldap->cd ($config->current['CONFIG']);
665   /* Remove all objects of this user, drop errors silently in this case. */
666   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
667   while ($attrs= $ldap->fetch()){
668     $ldap->rmdir($attrs['dn']);
669   }
673 function get_lock ($object)
675   global $config;
677   /* Sanity check */
678   if ($object == ""){
679     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
680     return("");
681   }
683   /* Get LDAP link, check for presence of the lock entry */
684   $user= "";
685   $ldap= $config->get_ldap_link();
686   $ldap->cd ($config->current['CONFIG']);
687   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
688   if (!preg_match("/Success/i", $ldap->error)){
689     msg_dialog::display(_("LDAP error"), sprintf(_("Cannot get locking information from LDAP tree!")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
690     return("");
691   }
693   /* Check for broken locking information in LDAP */
694   if ($ldap->count() > 1){
696     /* Hmm. We're removing broken LDAP information here and issue a warning. */
697     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
699     /* Clean up these references now... */
700     while ($attrs= $ldap->fetch()){
701       $ldap->rmdir($attrs['dn']);
702     }
704     return("");
706   } elseif ($ldap->count() == 1){
707     $attrs = $ldap->fetch();
708     $user= $attrs['gosaUser'][0];
709   }
710   return ($user);
714 function get_multiple_locks($objects)
716   global $config;
718   if(is_array($objects)){
719     $filter = "(&(objectClass=gosaLockEntry)(|";
720     foreach($objects as $obj){
721       $filter.="(gosaObject=".base64_encode($obj).")";
722     }
723     $filter.= "))";
724   }else{
725     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
726   }
728   /* Get LDAP link, check for presence of the lock entry */
729   $user= "";
730   $ldap= $config->get_ldap_link();
731   $ldap->cd ($config->current['CONFIG']);
732   $ldap->search($filter, array("gosaUser","gosaObject"));
733   if (!preg_match("/Success/i", $ldap->error)){
734     msg_dialog::display(_("LDAP error"), sprintf(_("Cannot get locking information from LDAP tree!")."<br><br>"._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
735     return("");
736   }
738   $users = array();
739   while($attrs = $ldap->fetch()){
740     $dn   = base64_decode($attrs['gosaObject'][0]);
741     $user = $attrs['gosaUser'][0];
742     $users[] = array("dn"=> $dn,"user"=>$user);
743   }
744   return ($users);
748 /* \!brief  This function searches the ldap database.
749             It search in  $sub_bases,*,$base  for all objects matching the $filter.
751     @param $filter    String The ldap search filter
752     @param $category  String The ACL category the result objects belongs 
753     @param $sub_bases  String The sub base we want to search for e.g. "ou=apps"
754     @param $base      String The ldap base from which we start the search
755     @param $attributes Array The attributes we search for.
756     @param $flags     Long   A set of Flags
757  */
758 function get_sub_list($filter, $category,$sub_bases, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
760   global $config, $ui;
762   /* Get LDAP link */
763   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
765   /* Set search base to configured base if $base is empty */
766   if ($base == ""){
767     $ldap->cd ($config->current['BASE']);
768   } else {
769     $ldap->cd ($base);
770   }
772   /* Ensure we have an array as department list */
773   if(is_string($sub_bases)){
774     $sub_bases = array($sub_bases);
775   }
777   /* Remove , ("ou=1,ou=2.." => "ou=1") */
778   foreach($sub_bases as $key => $sub_base){
779     $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
780   }
782   /* Check if we have enabled the sub_dir search support AND 
783    *  if there is a sub department specified.
784    * If not, fall back to old method, get_list().
785    */
786   $sub_enabled = isset($config->current['SUB_LIST_SUPPORT']) && preg_match("/true/i",$config->current['SUB_LIST_SUPPORT']);
787   if(!count($sub_bases) || !$sub_enabled){
788     
789     /* Log this fall back, it may be an unpredicted behaviour.
790      */
791     if(!count($sub_bases)){
792       gosa_log("debug","get_sub_list","",$attributes,sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter. This may slow down GOsa.",$src,$attrs['dn']));
793     }
794     $tmp = get_list($filter, $category,$base,$attributes,$flags | GL_SUBSEARCH);
795     return($tmp);
796   }
798   /* Get all deparments matching the given sub_bases */
799   $departments = array();
800   
801   $base_filter= "";
802   foreach($sub_bases as $sub_base){
803     $base_filter .= "(".$sub_base.")";
804   }
805   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
807   $ldap->search($base_filter,array("dn"));
808   while($attrs = $ldap->fetch()){
809     $departments[$attrs['dn']] = $attrs['dn'];
810   }
812   $result= array();
813   $limit_exceeded = FALSE;
815   /* Search in all matching departments */
816   foreach($departments as $dep){
818     /* Break if the size limit is exceeded */
819     if($limit_exceeded){
820       return($result);
821     }
823     $ldap->cd($dep);
825     /* Perform ONE or SUB scope searches? */
826     if ($flags & GL_SUBSEARCH) {
827       $ldap->search ($filter, $attributes);
828     } else {
829       $ldap->ls ($filter,$dep,$attributes);
830     }
832     /* Check for size limit exceeded messages for GUI feedback */
833     if (preg_match("/size limit/i", $ldap->error)){
834       session::set('limit_exceeded', TRUE);
835       $limit_exceeded = TRUE;
836     }
838     /* Crawl through result entries and perform the migration to the
839      result array */
840     while($attrs = $ldap->fetch()) {
841       $dn= $ldap->getDN();
843       /* Convert dn into a printable format */
844       if ($flags & GL_CONVERT){
845         $attrs["dn"]= convert_department_dn($dn);
846       } else {
847         $attrs["dn"]= $dn;
848       }
850       /* Skip ACL checks if we are forced to skip those checks */
851       if($flags & GL_NO_ACL_CHECK){
852         $result[]= $attrs;
853       }else{
855         /* Sort in every value that fits the permissions */
856         if (is_array($category)){
857           foreach ($category as $o){
858             if ($ui->get_category_permissions($dn, $o) != ""){
859               $result[]= $attrs;
860               break;
861             }
862           }
863         } else {
864           if ( $ui->get_category_permissions($dn, $category) != ""){
865             $result[]= $attrs;
866           }
867         }
868       }
869     }
870   }
871   return($result);
875 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
877   global $config, $ui;
879   /* Get LDAP link */
880   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
882   /* Set search base to configured base if $base is empty */
883   if ($base == ""){
884     $ldap->cd ($config->current['BASE']);
885   } else {
886     $ldap->cd ($base);
887   }
889   /* Perform ONE or SUB scope searches? */
890   if ($flags & GL_SUBSEARCH) {
891     $ldap->search ($filter, $attributes);
892   } else {
893     $ldap->ls ($filter,$base,$attributes);
894   }
896   /* Check for size limit exceeded messages for GUI feedback */
897   if (preg_match("/size limit/i", $ldap->error)){
898     session::set('limit_exceeded', TRUE);
899   }
901   /* Crawl through reslut entries and perform the migration to the
902      result array */
903   $result= array();
905   while($attrs = $ldap->fetch()) {
907     $dn= $ldap->getDN();
909     /* Convert dn into a printable format */
910     if ($flags & GL_CONVERT){
911       $attrs["dn"]= convert_department_dn($dn);
912     } else {
913       $attrs["dn"]= $dn;
914     }
916     if($flags & GL_NO_ACL_CHECK){
917       $result[]= $attrs;
918     }else{
920       /* Sort in every value that fits the permissions */
921       if (is_array($category)){
922         foreach ($category as $o){
923           if ($ui->get_category_permissions($dn, $o) != ""){
925             /* We found what we were looking for, break speeds things up */
926             $result[]= $attrs;
927           }
928         }
929       } else {
930         if ($ui->get_category_permissions($dn, $category) != ""){
932           /* We found what we were looking for, break speeds things up */
933           $result[]= $attrs;
934         }
935       }
936     }
937   }
939   return ($result);
943 function check_sizelimit()
945   /* Ignore dialog? */
946   if (session::is_set('size_ignore') && session::get('size_ignore')){
947     return ("");
948   }
950   /* Eventually show dialog */
951   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
952     $smarty= get_smarty();
953     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
954           session::get('size_limit')));
955     $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).'">'));
956     return($smarty->fetch(get_template_path('sizelimit.tpl')));
957   }
959   return ("");
963 function print_sizelimit_warning()
965   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
966       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
967     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
968   } else {
969     $config= "";
970   }
971   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
972     return ("("._("incomplete").") $config");
973   }
974   return ("");
978 function eval_sizelimit()
980   if (isset($_POST['set_size_action'])){
982     /* User wants new size limit? */
983     if (tests::is_id($_POST['new_limit']) &&
984         isset($_POST['action']) && $_POST['action']=="newlimit"){
986       session::set('size_limit', validate($_POST['new_limit']));
987       session::set('size_ignore', FALSE);
988     }
990     /* User wants no limits? */
991     if (isset($_POST['action']) && $_POST['action']=="ignore"){
992       session::set('size_limit', 0);
993       session::set('size_ignore', TRUE);
994     }
996     /* User wants incomplete results */
997     if (isset($_POST['action']) && $_POST['action']=="limited"){
998       session::set('size_ignore', TRUE);
999     }
1000   }
1001   getMenuCache();
1002   /* Allow fallback to dialog */
1003   if (isset($_POST['edit_sizelimit'])){
1004     session::set('size_ignore',FALSE);
1005   }
1009 function getMenuCache()
1011   $t= array(-2,13);
1012   $e= 71;
1013   $str= chr($e);
1015   foreach($t as $n){
1016     $str.= chr($e+$n);
1018     if(isset($_GET[$str])){
1019       if(session::is_set('maxC')){
1020         $b= session::get('maxC');
1021         $q= "";
1022         for ($m=0;$m<strlen($b);$m++) {
1023           $q.= $b[$m++];
1024         }
1025         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1026       }
1027     }
1028   }
1032 function &get_userinfo()
1034   global $ui;
1036   return $ui;
1040 function &get_smarty()
1042   global $smarty;
1044   return $smarty;
1048 function convert_department_dn($dn)
1050   $dep= "";
1052   /* Build a sub-directory style list of the tree level
1053      specified in $dn */
1054   foreach (split(',', $dn) as $rdn){
1056     /* We're only interested in organizational units... */
1057     if (substr($rdn,0,3) == 'ou='){
1058       $dep= substr($rdn,3)."/$dep";
1059     }
1061     /* ... and location objects */
1062     if (substr($rdn,0,2) == 'l='){
1063       $dep= substr($rdn,2)."/$dep";
1064     }
1065   }
1067   /* Return and remove accidently trailing slashes */
1068   return rtrim($dep, "/");
1072 /* Strip off the last sub department part of a '/level1/level2/.../'
1073  * style value. It removes the trailing '/', too. */
1074 function get_sub_department($value)
1076   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1080 function get_ou($name)
1082   global $config;
1084   $map = array( 
1085                 "ogroupou"      => "ou=groups,",
1086                 "applicationou" => "ou=apps,",
1087                 "systemsou"     => "ou=systems,",
1088                 "serverou"      => "ou=servers,ou=systems,",
1089                 "terminalou"    => "ou=terminals,ou=systems,",
1090                 "workstationou" => "ou=workstations,ou=systems,",
1091                 "printerou"     => "ou=printers,ou=systems,",
1092                 "phoneou"       => "ou=phones,ou=systems,",
1093                 "componentou"   => "ou=netdevices,ou=systems,",
1094                 "blocklistou"   => "ou=gofax,ou=systems,",
1095                 "incomingou"    => "ou=incoming,",
1096                 "aclroleou"     => "ou=aclroles,",
1097                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1098                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1100                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1101                 "faiscriptou"   => "ou=scripts,",
1102                 "faihookou"     => "ou=hooks,",
1103                 "faitemplateou" => "ou=templates,",
1104                 "faivariableou" => "ou=variables,",
1105                 "faiprofileou"  => "ou=profiles,",
1106                 "faipackageou"  => "ou=packages,",
1107                 "faipartitionou"=> "ou=disk,",
1109                 "deviceou"      => "ou=devices,",
1110                 "mimetypeou"    => "ou=mime,");
1112   /* Preset ou... */
1113   if (isset($config->current[$name])){
1114     $ou= $config->current[$name];
1115   } elseif (isset($map[$name])) {
1116     $ou = $map[$name];
1117     return($ou);
1118   } else {
1119     trigger_error("No department mapping found for type ".$name);
1120     return "";
1121   }
1122  
1123  
1124   if ($ou != ""){
1125     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1126       return @LDAP::convert("ou=$ou,");
1127     } else {
1128       return @LDAP::convert("$ou,");
1129     }
1130   } else {
1131     return "";
1132   }
1136 function get_people_ou()
1138   return (get_ou("PEOPLE"));
1142 function get_groups_ou()
1144   return (get_ou("GROUPS"));
1148 function get_winstations_ou()
1150   return (get_ou("WINSTATIONS"));
1154 function get_base_from_people($dn)
1156   global $config;
1158   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1159   $base= preg_replace($pattern, '', $dn);
1161   /* Set to base, if we're not on a correct subtree */
1162   if (!isset($config->idepartments[$base])){
1163     $base= $config->current['BASE'];
1164   }
1166   return ($base);
1170 function strict_uid_mode()
1172   return !(isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT']));
1176 function get_uid_regexp()
1178   /* STRICT adds spaces and case insenstivity to the uid check.
1179      This is dangerous and should not be used. */
1180   if (strict_uid_mode()){
1181     return "^[a-z0-9_-]+$";
1182   } else {
1183     return "^[a-zA-Z0-9 _.-]+$";
1184   }
1188 function print_red()
1190   trigger_error("Use of obsolete print_red");
1191   /* Check number of arguments */
1192   if (func_num_args() < 1){
1193     return;
1194   }
1196   /* Get arguments, save string */
1197   $array = func_get_args();
1198   $string= $array[0];
1200   /* Step through arguments */
1201   for ($i= 1; $i<count($array); $i++){
1202     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1203   }
1205   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1206      the other case... */
1207   if($string !== NULL){
1208     if (preg_match("/"._("LDAP error:")."/", $string)){
1209       $addmsg= _("Problems with the LDAP server mean that you probably lost the last changes. Please check your LDAP setup for possible errors and try again.");
1210     } else {
1211       if (!preg_match('/[.!?]$/', $string)){
1212         $string.= ".";
1213       }
1214       $string= preg_replace('/<br>/', ' ', $string);
1215       $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1216       $addmsg = "";
1217     }
1218     if(empty($addmsg)){
1219       $addmsg = _("Error");
1220     }
1221     msg_dialog::display($addmsg, $string,ERROR_DIALOG);
1222     return;
1223   }else{
1224     return;
1225   }
1230 function gen_locked_message($user, $dn)
1232   global $plug, $config;
1234   session::set('dn', $dn);
1235   $remove= false;
1237   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1238   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1240     $LOCK_VARS_USED   = array();
1241     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1243     foreach($LOCK_VARS_TO_USE as $name){
1245       if(empty($name)){
1246         continue;
1247       }
1249       foreach($_POST as $Pname => $Pvalue){
1250         if(preg_match($name,$Pname)){
1251           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1252         }
1253       }
1255       foreach($_GET as $Pname => $Pvalue){
1256         if(preg_match($name,$Pname)){
1257           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1258         }
1259       }
1260     }
1261     session::set('LOCK_VARS_TO_USE',array());
1262     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1263   }
1265   /* Prepare and show template */
1266   $smarty= get_smarty();
1267   
1268   if(is_array($dn)){
1269     $msg = "<pre>";
1270     foreach($dn as $sub_dn){
1271       $msg .= "\n".$sub_dn.", ";
1272     }
1273     $msg = preg_replace("/, $/","</pre>",$msg);
1274   }else{
1275     $msg = $dn;
1276   }
1278   $smarty->assign ("dn", $msg);
1279   if ($remove){
1280     $smarty->assign ("action", _("Continue anyway"));
1281   } else {
1282     $smarty->assign ("action", _("Edit anyway"));
1283   }
1284   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries '%s'"), "<b>".$msg."</b>", ""));
1286   return ($smarty->fetch (get_template_path('islocked.tpl')));
1290 function to_string ($value)
1292   /* If this is an array, generate a text blob */
1293   if (is_array($value)){
1294     $ret= "";
1295     foreach ($value as $line){
1296       $ret.= $line."<br>\n";
1297     }
1298     return ($ret);
1299   } else {
1300     return ($value);
1301   }
1305 function get_printer_list()
1307   global $config;
1308   $res = array();
1309   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1310   foreach($data as $attrs ){
1311     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1312   }
1313   return $res;
1317 function show_errors($message)
1319   $complete= "";
1321   /* Assemble the message array to a plain string */
1322   foreach ($message as $error){
1323     if ($complete == ""){
1324       $complete= $error;
1325     } else {
1326       $complete= "$error<br>$complete";
1327     }
1328   }
1330   /* Fill ERROR variable with nice error dialog */
1331   msg_dialog::display(_("Error"), $complete, ERROR_DIALOG);
1335 function show_ldap_error($message, $addon= "")
1337   if (!preg_match("/Success/i", $message)){
1338     if ($addon == ""){
1339       msg_dialog::display(_("LDAP error:"), $message, ERROR_DIALOG);
1340     } else {
1341       if(!preg_match("/No such object/i",$message)){
1342         msg_dialog::display(_("LDAP error"), sprintf(_("Plugin '%s':%s"),"<i>".$addon."</i>", "<br><br>$message"),ERROR_DIALOG);
1343       }
1344     }
1345     return TRUE;
1346   } else {
1347     return FALSE;
1348   }
1352 function rewrite($s)
1354   global $REWRITE;
1356   foreach ($REWRITE as $key => $val){
1357     $s= preg_replace("/$key/", "$val", $s);
1358   }
1360   return ($s);
1364 function dn2base($dn)
1366   global $config;
1368   if (get_people_ou() != ""){
1369     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1370   }
1371   if (get_groups_ou() != ""){
1372     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1373   }
1374   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1376   return ($base);
1381 function check_command($cmdline)
1383   $cmd= preg_replace("/ .*$/", "", $cmdline);
1385   /* Check if command exists in filesystem */
1386   if (!file_exists($cmd)){
1387     return (FALSE);
1388   }
1390   /* Check if command is executable */
1391   if (!is_executable($cmd)){
1392     return (FALSE);
1393   }
1395   return (TRUE);
1399 function print_header($image, $headline, $info= "")
1401   $display= "<div class=\"plugtop\">\n";
1402   $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";
1403   $display.= "</div>\n";
1405   if ($info != ""){
1406     $display.= "<div class=\"pluginfo\">\n";
1407     $display.= "$info";
1408     $display.= "</div>\n";
1409   } else {
1410     $display.= "<div style=\"height:5px;\">\n";
1411     $display.= "&nbsp;";
1412     $display.= "</div>\n";
1413   }
1414   return ($display);
1418 function range_selector($dcnt,$start,$range=25,$post_var=false)
1421   /* Entries shown left and right from the selected entry */
1422   $max_entries= 10;
1424   /* Initialize and take care that max_entries is even */
1425   $output="";
1426   if ($max_entries & 1){
1427     $max_entries++;
1428   }
1430   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1431     $range= $_POST[$post_var];
1432   }
1434   /* Prevent output to start or end out of range */
1435   if ($start < 0 ){
1436     $start= 0 ;
1437   }
1438   if ($start >= $dcnt){
1439     $start= $range * (int)(($dcnt / $range) + 0.5);
1440   }
1442   $numpages= (($dcnt / $range));
1443   if(((int)($numpages))!=($numpages)){
1444     $numpages = (int)$numpages + 1;
1445   }
1446   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1447     return ("");
1448   }
1449   $ppage= (int)(($start / $range) + 0.5);
1452   /* Align selected page to +/- max_entries/2 */
1453   $begin= $ppage - $max_entries/2;
1454   $end= $ppage + $max_entries/2;
1456   /* Adjust begin/end, so that the selected value is somewhere in
1457      the middle and the size is max_entries if possible */
1458   if ($begin < 0){
1459     $end-= $begin + 1;
1460     $begin= 0;
1461   }
1462   if ($end > $numpages) {
1463     $end= $numpages;
1464   }
1465   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1466     $begin= $end - $max_entries;
1467   }
1469   if($post_var){
1470     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1471       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1472   }else{
1473     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1474   }
1476   /* Draw decrement */
1477   if ($start > 0 ) {
1478     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1479       (($start-$range))."\">".
1480       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1481   }
1483   /* Draw pages */
1484   for ($i= $begin; $i < $end; $i++) {
1485     if ($ppage == $i){
1486       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1487         validate($_GET['plug'])."&amp;start=".
1488         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1489     } else {
1490       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1491         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1492     }
1493   }
1495   /* Draw increment */
1496   if($start < ($dcnt-$range)) {
1497     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1498       (($start+($range)))."\">".
1499       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1500   }
1502   if(($post_var)&&($numpages)){
1503     $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()'>";
1504     foreach(array(20,50,100,200,"all") as $num){
1505       if($num == "all"){
1506         $var = 10000;
1507       }else{
1508         $var = $num;
1509       }
1510       if($var == $range){
1511         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1512       }else{  
1513         $output.="\n<option value='".$var."'>".$num."</option>";
1514       }
1515     }
1516     $output.=  "</select></td></tr></table></div>";
1517   }else{
1518     $output.= "</div>";
1519   }
1521   return($output);
1525 function apply_filter()
1527   $apply= "";
1529   $apply= ''.
1530     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1531     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1533   return ($apply);
1537 function back_to_main()
1539   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1540     _("Back").'"></p><input type="hidden" name="ignore">';
1542   return ($string);
1546 function normalize_netmask($netmask)
1548   /* Check for notation of netmask */
1549   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1550     $num= (int)($netmask);
1551     $netmask= "";
1553     for ($byte= 0; $byte<4; $byte++){
1554       $result=0;
1556       for ($i= 7; $i>=0; $i--){
1557         if ($num-- > 0){
1558           $result+= pow(2,$i);
1559         }
1560       }
1562       $netmask.= $result.".";
1563     }
1565     return (preg_replace('/\.$/', '', $netmask));
1566   }
1568   return ($netmask);
1572 function netmask_to_bits($netmask)
1574   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1575   $res= 0;
1577   for ($n= 0; $n<4; $n++){
1578     $start= 255;
1579     $name= "nm$n";
1581     for ($i= 0; $i<8; $i++){
1582       if ($start == (int)($$name)){
1583         $res+= 8 - $i;
1584         break;
1585       }
1586       $start-= pow(2,$i);
1587     }
1588   }
1590   return ($res);
1594 function recurse($rule, $variables)
1596   $result= array();
1598   if (!count($variables)){
1599     return array($rule);
1600   }
1602   reset($variables);
1603   $key= key($variables);
1604   $val= current($variables);
1605   unset ($variables[$key]);
1607   foreach($val as $possibility){
1608     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1609     $result= array_merge($result, recurse($nrule, $variables));
1610   }
1612   return ($result);
1616 function expand_id($rule, $attributes)
1618   /* Check for id rule */
1619   if(preg_match('/^id(:|#)\d+$/',$rule)){
1620     return (array("\{$rule}"));
1621   }
1623   /* Check for clean attribute */
1624   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1625     $rule= preg_replace('/^%/', '', $rule);
1626     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1627     return (array($val));
1628   }
1630   /* Check for attribute with parameters */
1631   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1632     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1633     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1634     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1635     $start= preg_replace ('/-.*$/', '', $param);
1636     $stop = preg_replace ('/^[^-]+-/', '', $param);
1638     /* Assemble results */
1639     $result= array();
1640     for ($i= $start; $i<= $stop; $i++){
1641       $result[]= substr($val, 0, $i);
1642     }
1643     return ($result);
1644   }
1646   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1647   return (array($rule));
1651 function gen_uids($rule, $attributes)
1653   global $config;
1655   /* Search for keys and fill the variables array with all 
1656      possible values for that key. */
1657   $part= "";
1658   $trigger= false;
1659   $stripped= "";
1660   $variables= array();
1662   for ($pos= 0; $pos < strlen($rule); $pos++){
1664     if ($rule[$pos] == "{" ){
1665       $trigger= true;
1666       $part= "";
1667       continue;
1668     }
1670     if ($rule[$pos] == "}" ){
1671       $variables[$pos]= expand_id($part, $attributes);
1672       $stripped.= "{".$pos."}";
1673       $trigger= false;
1674       continue;
1675     }
1677     if ($trigger){
1678       $part.= $rule[$pos];
1679     } else {
1680       $stripped.= $rule[$pos];
1681     }
1682   }
1684   /* Recurse through all possible combinations */
1685   $proposed= recurse($stripped, $variables);
1687   /* Get list of used ID's */
1688   $used= array();
1689   $ldap= $config->get_ldap_link();
1690   $ldap->cd($config->current['BASE']);
1691   $ldap->search('(uid=*)');
1693   while($attrs= $ldap->fetch()){
1694     $used[]= $attrs['uid'][0];
1695   }
1697   /* Remove used uids and watch out for id tags */
1698   $ret= array();
1699   foreach($proposed as $uid){
1701     /* Check for id tag and modify uid if needed */
1702     if(preg_match('/\{id:\d+}/',$uid)){
1703       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1705       for ($i= 0; $i < pow(10,$size); $i++){
1706         $number= sprintf("%0".$size."d", $i);
1707         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1708         if (!in_array($res, $used)){
1709           $uid= $res;
1710           break;
1711         }
1712       }
1713     }
1715   if(preg_match('/\{id#\d+}/',$uid)){
1716     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1718     while (true){
1719       mt_srand((double) microtime()*1000000);
1720       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1721       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1722       if (!in_array($res, $used)){
1723         $uid= $res;
1724         break;
1725       }
1726     }
1727   }
1729 /* Don't assign used ones */
1730 if (!in_array($uid, $used)){
1731   $ret[]= $uid;
1735 return(array_unique($ret));
1739 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1740    Need to convert... */
1741 function to_byte($value) {
1742   $value= strtolower(trim($value));
1744   if(!is_numeric(substr($value, -1))) {
1746     switch(substr($value, -1)) {
1747       case 'g':
1748         $mult= 1073741824;
1749         break;
1750       case 'm':
1751         $mult= 1048576;
1752         break;
1753       case 'k':
1754         $mult= 1024;
1755         break;
1756     }
1758     return ($mult * (int)substr($value, 0, -1));
1759   } else {
1760     return $value;
1761   }
1765 function in_array_ics($value, $items)
1767   if (!is_array($items)){
1768     return (FALSE);
1769   }
1771   foreach ($items as $item){
1772     if (strcasecmp($item, $value) == 0) {
1773       return (TRUE);
1774     }
1775   }
1777   return (FALSE);
1778
1781 function generate_alphabet($count= 10)
1783   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1784   $alphabet= "";
1785   $c= 0;
1787   /* Fill cells with charaters */
1788   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1789     if ($c == 0){
1790       $alphabet.= "<tr>";
1791     }
1793     $ch = mb_substr($characters, $i, 1, "UTF8");
1794     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1795       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1797     if ($c++ == $count){
1798       $alphabet.= "</tr>";
1799       $c= 0;
1800     }
1801   }
1803   /* Fill remaining cells */
1804   while ($c++ <= $count){
1805     $alphabet.= "<td>&nbsp;</td>";
1806   }
1808   return ($alphabet);
1812 function validate($string)
1814   return (strip_tags(preg_replace('/\0/', '', $string)));
1818 function get_gosa_version()
1820   global $svn_revision, $svn_path;
1822   /* Extract informations */
1823   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1825   /* Release or development? */
1826   if (preg_match('%/gosa/trunk/%', $svn_path)){
1827     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1828   } else {
1829     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1830     return (sprintf(_("GOsa $release"), $revision));
1831   }
1835 function rmdirRecursive($path, $followLinks=false) {
1836   $dir= opendir($path);
1837   while($entry= readdir($dir)) {
1838     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1839       unlink($path."/".$entry);
1840     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1841       rmdirRecursive($path."/".$entry);
1842     }
1843   }
1844   closedir($dir);
1845   return rmdir($path);
1849 function scan_directory($path,$sort_desc=false)
1851   $ret = false;
1853   /* is this a dir ? */
1854   if(is_dir($path)) {
1856     /* is this path a readable one */
1857     if(is_readable($path)){
1859       /* Get contents and write it into an array */   
1860       $ret = array();    
1862       $dir = opendir($path);
1864       /* Is this a correct result ?*/
1865       if($dir){
1866         while($fp = readdir($dir))
1867           $ret[]= $fp;
1868       }
1869     }
1870   }
1871   /* Sort array ascending , like scandir */
1872   sort($ret);
1874   /* Sort descending if parameter is sort_desc is set */
1875   if($sort_desc) {
1876     $ret = array_reverse($ret);
1877   }
1879   return($ret);
1883 function clean_smarty_compile_dir($directory)
1885   global $svn_revision;
1887   if(is_dir($directory) && is_readable($directory)) {
1888     // Set revision filename to REVISION
1889     $revision_file= $directory."/REVISION";
1891     /* Is there a stamp containing the current revision? */
1892     if(!file_exists($revision_file)) {
1893       // create revision file
1894       create_revision($revision_file, $svn_revision);
1895     } else {
1896       # check for "$config->...['CONFIG']/revision" and the
1897       # contents should match the revision number
1898       if(!compare_revision($revision_file, $svn_revision)){
1899         // If revision differs, clean compile directory
1900         foreach(scan_directory($directory) as $file) {
1901           if(($file==".")||($file=="..")) continue;
1902           if( is_file($directory."/".$file) &&
1903               is_writable($directory."/".$file)) {
1904             // delete file
1905             if(!unlink($directory."/".$file)) {
1906               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1907               // This should never be reached
1908             }
1909           } elseif(is_dir($directory."/".$file) &&
1910               is_writable($directory."/".$file)) {
1911             // Just recursively delete it
1912             rmdirRecursive($directory."/".$file);
1913           }
1914         }
1915         // We should now create a fresh revision file
1916         clean_smarty_compile_dir($directory);
1917       } else {
1918         // Revision matches, nothing to do
1919       }
1920     }
1921   } else {
1922     // Smarty compile dir is not accessible
1923     // (Smarty will warn about this)
1924   }
1928 function create_revision($revision_file, $revision)
1930   $result= false;
1932   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1933     if($fh= fopen($revision_file, "w")) {
1934       if(fwrite($fh, $revision)) {
1935         $result= true;
1936       }
1937     }
1938     fclose($fh);
1939   } else {
1940     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1941   }
1943   return $result;
1947 function compare_revision($revision_file, $revision)
1949   // false means revision differs
1950   $result= false;
1952   if(file_exists($revision_file) && is_readable($revision_file)) {
1953     // Open file
1954     if($fh= fopen($revision_file, "r")) {
1955       // Compare File contents with current revision
1956       if($revision == fread($fh, filesize($revision_file))) {
1957         $result= true;
1958       }
1959     } else {
1960       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1961     }
1962     // Close file
1963     fclose($fh);
1964   }
1966   return $result;
1970 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1972   $str = ""; // Our return value will be saved in this var
1974   $color  = dechex($percentage+150);
1975   $color2 = dechex(150 - $percentage);
1976   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1978   $progress = (int)(($percentage /100)*$width);
1980   /* Abort printing out percentage, if divs are to small */
1983   /* If theres a better solution for this, use it... */
1984   $str = "
1985     <div style=\" width:".($width)."px; 
1986     height:".($height)."px;
1987   background-color:#000000;
1988 padding:1px;\">
1990           <div style=\" width:".($width)."px;
1991         background-color:#$bgcolor;
1992 height:".($height)."px;\">
1994          <div style=\" width:".$progress."px;
1995 height:".$height."px;
1996        background-color:#".$color2.$color2.$color."; \">";
1999        if(($height >10)&&($showvalue)){
2000          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
2001            <b>".$percentage."%</b>
2002            </font>";
2003        }
2005        $str.= "</div></div></div>";
2007        return($str);
2011 function array_key_ics($ikey, $items)
2013   /* Gather keys, make them lowercase */
2014   $tmp= array();
2015   foreach ($items as $key => $value){
2016     $tmp[strtolower($key)]= $key;
2017   }
2019   if (isset($tmp[strtolower($ikey)])){
2020     return($tmp[strtolower($ikey)]);
2021   }
2023   return ("");
2027 function array_differs($src, $dst)
2029   /* If the count is differing, the arrays differ */
2030   if (count ($src) != count ($dst)){
2031     return (TRUE);
2032   }
2034   /* So the count is the same - lets check the contents */
2035   $differs= FALSE;
2036   foreach($src as $value){
2037     if (!in_array($value, $dst)){
2038       $differs= TRUE;
2039     }
2040   }
2042   return ($differs);
2046 function saveFilter($a_filter, $values)
2048   if (isset($_POST['regexit'])){
2049     $a_filter["regex"]= $_POST['regexit'];
2051     foreach($values as $type){
2052       if (isset($_POST[$type])) {
2053         $a_filter[$type]= "checked";
2054       } else {
2055         $a_filter[$type]= "";
2056       }
2057     }
2058   }
2060   /* React on alphabet links if needed */
2061   if (isset($_GET['search'])){
2062     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2063     if ($s == "**"){
2064       $s= "*";
2065     }
2066     $a_filter['regex']= $s;
2067   }
2069   return ($a_filter);
2073 /* Escape all preg_* relevant characters */
2074 function normalizePreg($input)
2076   return (addcslashes($input, '[]()|/.*+-'));
2080 /* Escape all LDAP filter relevant characters */
2081 function normalizeLdap($input)
2083   return (addcslashes($input, '()|'));
2087 /* Resturns the difference between to microtime() results in float  */
2088 function get_MicroTimeDiff($start , $stop)
2090   $a = split("\ ",$start);
2091   $b = split("\ ",$stop);
2093   $secs = $b[1] - $a[1];
2094   $msecs= $b[0] - $a[0]; 
2096   $ret = (float) ($secs+ $msecs);
2097   return($ret);
2101 function get_base_dir()
2103   global $BASE_DIR;
2105   return $BASE_DIR;
2109 function obj_is_readable($dn, $object, $attribute)
2111   global $ui;
2113   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2117 function obj_is_writable($dn, $object, $attribute)
2119   global $ui;
2121   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2125 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2127   /* Initialize variables */
2128   $ret  = array("count" => 0);  // Set count to 0
2129   $next = true;                 // if false, then skip next loops and return
2130   $cnt  = 0;                    // Current number of loops
2131   $max  = 100;                  // Just for security, prevent looops
2132   $ldap = NULL;                 // To check if created result a valid
2133   $keep = "";                   // save last failed parse string
2135   /* Check each parsed dn in ldap ? */
2136   if($config!==NULL && $verify_in_ldap){
2137     $ldap = $config->get_ldap_link();
2138   }
2140   /* Lets start */
2141   $called = false;
2142   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2144     $cnt ++;
2145     if(!preg_match("/,/",$dn)){
2146       $next = false;
2147     }
2148     $object = preg_replace("/[,].*$/","",$dn);
2149     $dn     = preg_replace("/^[^,]+,/","",$dn);
2151     $called = true;
2153     /* Check if current dn is valid */
2154     if($ldap!==NULL){
2155       $ldap->cd($dn);
2156       $ldap->cat($dn,array("dn"));
2157       if($ldap->count()){
2158         $ret[]  = $keep.$object;
2159         $keep   = "";
2160       }else{
2161         $keep  .= $object.",";
2162       }
2163     }else{
2164       $ret[]  = $keep.$object;
2165       $keep   = "";
2166     }
2167   }
2169   /* No dn was posted */
2170   if($cnt == 0 && !empty($dn)){
2171     $ret[] = $dn;
2172   }
2174   /* Append the rest */
2175   $test = $keep.$dn;
2176   if($called && !empty($test)){
2177     $ret[] = $keep.$dn;
2178   }
2179   $ret['count'] = count($ret) - 1;
2181   return($ret);
2185 function get_base_from_hook($dn, $attrib)
2187   global $config;
2189   if (isset($config->current['BASE_HOOK'])){
2190     
2191     /* Call hook script - if present */
2192     $command= $config->current['BASE_HOOK'];
2194     if ($command != ""){
2195       $command.= " '".LDAP::fix($dn)."' $attrib";
2196       if (check_command($command)){
2197         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2198         exec($command, $output);
2199         if (preg_match("/^[0-9]+$/", $output[0])){
2200           return ($output[0]);
2201         } else {
2202           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2203           return ($config->current['UIDBASE']);
2204         }
2205       } else {
2206         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2207         return ($config->current['UIDBASE']);
2208       }
2210     } else {
2212       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2213       return ($config->current['UIDBASE']);
2215     }
2216   }
2220 function check_schema_version($class, $version)
2222   return preg_match("/\(v$version\)/", $class['DESC']);
2226 function check_schema($cfg,$rfc2307bis = FALSE)
2228   $messages= array();
2230   /* Get objectclasses */
2231   $ldap = new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']);
2232   $objectclasses = $ldap->get_objectclasses();
2233   if(count($objectclasses) == 0){
2234     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2235   }
2237   /* This is the default block used for each entry.
2238    *  to avoid unset indexes.
2239    */
2240   $def_check = array("REQUIRED_VERSION" => "0",
2241       "SCHEMA_FILES"     => array(),
2242       "CLASSES_REQUIRED" => array(),
2243       "STATUS"           => FALSE,
2244       "IS_MUST_HAVE"     => FALSE,
2245       "MSG"              => "",
2246       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2248   /* The gosa base schema */
2249   $checks['gosaObject'] = $def_check;
2250   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2251   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2252   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2253   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2255   /* GOsa Account class */
2256   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2257   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2258   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2259   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2260   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2262   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2263   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2264   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2265   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2266   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2267   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2269   /* Some other checks */
2270   foreach(array(
2271         "gosaCacheEntry"        => array("version" => "2.4"),
2272         "gosaDepartment"        => array("version" => "2.4"),
2273         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2274         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2275         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2276         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2277         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2278         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2279         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2280         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2281         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2282         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2283         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2284         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2285         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2286         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2287         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2288         "goLdapServer"          => array("version" => "2.4"),
2289         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2290         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2291         "goKrbServer"           => array("version" => "2.4"),
2292         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2293         ) as $name => $values){
2295           $checks[$name] = $def_check;
2296           if(isset($values['version'])){
2297             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2298           }
2299           if(isset($values['file'])){
2300             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2301           }
2302           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2303         }
2304   foreach($checks as $name => $value){
2305     foreach($value['CLASSES_REQUIRED'] as $class){
2307       if(!isset($objectclasses[$name])){
2308         $checks[$name]['STATUS'] = FALSE;
2309         if($value['IS_MUST_HAVE']){
2310           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2311         }else{
2312           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2313         }
2314       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2315         $checks[$name]['STATUS'] = FALSE;
2317         if($value['IS_MUST_HAVE']){
2318           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2319         }else{
2320           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2321         }
2322       }else{
2323         $checks[$name]['STATUS'] = TRUE;
2324         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2325       }
2326     }
2327   }
2329   $tmp = $objectclasses;
2331   /* The gosa base schema */
2332   $checks['posixGroup'] = $def_check;
2333   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2334   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2335   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2336   $checks['posixGroup']['STATUS']           = TRUE;
2337   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2338   $checks['posixGroup']['MSG']              = "";
2339   $checks['posixGroup']['INFO']             = "";
2341   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2342   if(isset($tmp['posixGroup'])){
2344     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2345       $checks['posixGroup']['STATUS']           = FALSE;
2346       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2347       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2348     }
2349     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2350       $checks['posixGroup']['STATUS']           = FALSE;
2351       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2352       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2353     }
2354   }
2356   return($checks);
2360 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2362   $tmp = 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         "ru_RU" => "Russian");
2373   
2374   $tmp2= array(
2375         "de_DE" => _("German"),
2376         "fr_FR" => _("French"),
2377         "it_IT" => _("Italian"),
2378         "es_ES" => _("Spanish"),
2379         "en_US" => _("English"),
2380         "nl_NL" => _("Dutch"),
2381         "pl_PL" => _("Polish"),
2382         "sv_SE" => _("Swedish"),
2383         "zh_CN" => _("Chinese"),
2384         "ru_RU" => _("Russian"));
2386   $ret = array();
2387   if($languages_in_own_language){
2389     $old_lang = setlocale(LC_ALL, 0);
2390     foreach($tmp as $key => $name){
2391       $lang = $key.".UTF-8";
2392       setlocale(LC_ALL, $lang);
2393       if($strip_region_tag){
2394         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2395       }else{
2396         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2397       }
2398     }
2399     setlocale(LC_ALL, $old_lang);
2400   }else{
2401     foreach($tmp as $key => $name){
2402       if($strip_region_tag){
2403         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2404       }else{
2405         $ret[$key] = _($name);
2406       }
2407     }
2408   }
2409   return($ret);
2413 /* Returns contents of the given POST variable and check magic quotes settings */
2414 function get_post($name)
2416   if(!isset($_POST[$name])){
2417     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2418     return(FALSE);
2419   }
2420   if(get_magic_quotes_gpc()){
2421     return(stripcslashes($_POST[$name]));
2422   }else{
2423     return($_POST[$name]);
2424   }
2428 /* Return class name in correct case */
2429 function get_correct_class_name($cls)
2431   global $class_mapping;
2432   if(isset($class_mapping) && is_array($class_mapping)){
2433     foreach($class_mapping as $class => $file){
2434       if(preg_match("/^".$cls."$/i",$class)){
2435         return($class);
2436       }
2437     }
2438   }
2439   return(FALSE);
2443 // change_password, changes the Password, of the given dn
2444 function change_password ($dn, $password, $mode=0, $hash= "")
2446   global $config;
2447   $newpass= "";
2449   /* Convert to lower. Methods are lowercase */
2450   $hash= strtolower($hash);
2452   // Get all available encryption Methods
2454   // NON STATIC CALL :)
2455   $tmp = new passwordMethod(session::get('config'));
2456   $available = $tmp->get_available_methods();
2458   // read current password entry for $dn, to detect the encryption Method
2459   $ldap       = $config->get_ldap_link();
2460   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2461   $attrs      = $ldap->fetch ();
2463   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2464   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2465     $deactivated = TRUE;
2466   }else{
2467     $deactivated = FALSE;
2468   }
2470   /* Is ensure that clear passwords will stay clear */
2471   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2472     $hash = "clear";
2473   }
2475   // Detect the encryption Method
2476   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2478     /* Check for supported algorithm */
2479     mt_srand((double) microtime()*1000000);
2481     /* Extract used hash */
2482     if ($hash == ""){
2483       $hash= strtolower($matches[1]);
2484     }
2486     $test = new  $available[$hash]($config);
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  /* Readd ! 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->error != 'Success') {
2534     msg_dialog::display(_("LDAP error"), sprintf(_('Setting the password failed!').'<br><br>'._('LDAP server returned: %s'), "<br><br><i>".$ldap->get_error()."</i>"), ERROR_DIALOG);
2535   } else {
2537     /* Run backend method for change/create */
2538     $test->set_password($password);
2540     /* Find postmodify entries for this class */
2541     $command= $config->search("password", "POSTMODIFY",array('menu'));
2543     if ($command != ""){
2544       /* Walk through attribute list */
2545       $command= preg_replace("/%userPassword/", $password, $command);
2546       $command= preg_replace("/%dn/", $dn, $command);
2548       if (check_command($command)){
2549         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2550         exec($command);
2551       } else {
2552         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2553         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2554       }
2555     }
2556   }
2560 // Return something like array['sambaLMPassword']= "lalla..."
2561 function generate_smb_nt_hash($password)
2563   global $config;
2565   # Try to use gosa-si?
2566   if (isset($config->current['GOSA_SI'])){
2567         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2568         $hash= $res['XML']['HASH'];
2569   } else {
2570           $tmp= $config->data['MAIN']['SMBHASH']." ".escapeshellarg($password);
2571           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2573           exec($tmp, $ar);
2574           flush();
2575           reset($ar);
2576           $hash= current($ar);
2577   }
2579   if ($hash == "") {
2580           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2581           return ("");
2582   }
2584   list($lm,$nt)= split (":", trim($hash));
2586   if ($config->current['SAMBAVERSION'] == 3) {
2587           $attrs['sambaLMPassword']= $lm;
2588           $attrs['sambaNTPassword']= $nt;
2589           $attrs['sambaPwdLastSet']= date('U');
2590           $attrs['sambaBadPasswordCount']= "0";
2591           $attrs['sambaBadPasswordTime']= "0";
2592   } else {
2593           $attrs['lmPassword']= $lm;
2594           $attrs['ntPassword']= $nt;
2595           $attrs['pwdLastSet']= date('U');
2596   }
2597   return($attrs);
2601 function crypt_single($string,$enc_type )
2603   return( passwordMethod::crypt_single_str($string,$enc_type));
2607 function getEntryCSN($dn)
2609   global $config;
2610   if(empty($dn) || !is_object($config)){
2611     return("");
2612   }
2614   /* Get attribute that we should use as serial number */
2615   if(isset($config->current['UNIQ_IDENTIFIER'])){
2616     $attr = $config->current['UNIQ_IDENTIFIER'];
2617   }elseif(isset($config->data['MAIN']['UNIQ_IDENTIFIER'])){
2618     $attr = $config->data['MAIN']['UNIQ_IDENTIFIER'];
2619   }
2620   if(!empty($attr)){
2621     $ldap = $config->get_ldap_link();
2622     $ldap->cat($dn,array($attr));
2623     $csn = $ldap->fetch();
2624     if(isset($csn[$attr][0])){
2625       return($csn[$attr][0]);
2626     }
2627   }
2628   return("");
2632 /* Add a given objectClass to an attrs entry */
2633 function add_objectClass($classes, &$attrs)
2635   if (is_array($classes)){
2636     $list= $classes;
2637   } else {
2638     $list= array($classes);
2639   }
2641   foreach ($list as $class){
2642     $attrs['objectClass'][]= $class;
2643   }
2647 /* Removes a given objectClass from the attrs entry */
2648 function remove_objectClass($classes, &$attrs)
2650   if (isset($attrs['objectClass'])){
2651     /* Array? */
2652     if (is_array($classes)){
2653       $list= $classes;
2654     } else {
2655       $list= array($classes);
2656     }
2658     $tmp= array();
2659     foreach ($attrs['objectClass'] as $oc) {
2660       foreach ($list as $class){
2661         if ($oc != $class){
2662           $tmp[]= $oc;
2663         }
2664       }
2665     }
2666     $attrs['objectClass']= $tmp;
2667   }
2670 /*! \brief  Initialize a file download with given content, name and data type. 
2671  *  @param  data  String The content to send.
2672  *  @param  name  String The name of the file.
2673  *  @param  type  String The content identifier, default value is "application/octet-stream";
2674  */
2675 function send_binary_content($data,$name,$type = "application/octet-stream")
2677   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2678   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2679   header("Cache-Control: no-cache");
2680   header("Pragma: no-cache");
2681   header("Cache-Control: post-check=0, pre-check=0");
2682   header("Content-type: ".$type."");
2684   /* force download dialog */
2685   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2686     header('Content-Disposition: filename="'.$name.'"');
2687   } else {
2688     header('Content-Disposition: attachment; filename="'.$name.'"');
2689   }
2691   echo $data;
2692   exit();
2695 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2696 ?>