Code

cf8ed7cc6d2bb00b240a5d2d03e52bf093f03cf8
[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) && $config->get_cfg_value('lang') != ""){
196     $lang = $config->get_cfg_value('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   /* Set theme */
234   if (isset ($config)){
235         $theme= $config->get_cfg_value("theme", "default");
236   } else {
237         $theme= "default";
238   }
240   /* Return path for empty filename */
241   if ($filename == ''){
242     return ("themes/$theme/");
243   }
245   /* Return plugin dir or root directory? */
246   if ($plugin){
247     if ($path == ""){
248       $nf= preg_replace("!^".$BASE_DIR."/!", "", session::get('plugin_dir'));
249     } else {
250       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
251     }
252     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
253       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
254     }
255     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
256       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
257     }
258     if ($path == ""){
259       return (session::get('plugin_dir')."/$filename");
260     } else {
261       return ($path."/$filename");
262     }
263   } else {
264     if (file_exists("themes/$theme/$filename")){
265       return ("themes/$theme/$filename");
266     }
267     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
268       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
269     }
270     if (file_exists("themes/default/$filename")){
271       return ("themes/default/$filename");
272     }
273     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
274       return ("$BASE_DIR/ihtml/themes/default/$filename");
275     }
276     return ($filename);
277   }
281 function array_remove_entries($needles, $haystack)
283   $tmp= array();
285   /* Loop through entries to be removed */
286   foreach ($haystack as $entry){
287     if (!in_array($entry, $needles)){
288       $tmp[]= $entry;
289     }
290   }
292   return ($tmp);
296 function array_remove_entries_ics($needles, $haystack)
298   $tmp= array();
300   /* Loop through entries to be removed */
301   foreach ($haystack as $entry){
302     if (!in_array_ics($entry, $needles)){
303       $tmp[]= $entry;
304     }
305   }
307   return ($tmp);
311 function gosa_array_merge($ar1,$ar2)
313   if(!is_array($ar1) || !is_array($ar2)){
314     trigger_error("Specified parameter(s) are not valid arrays.");
315   }else{
316     return(array_values(array_unique(array_merge($ar1,$ar2))));
317   }
321 function gosa_log ($message)
323   global $ui;
325   /* Preset to something reasonable */
326   $username= " unauthenticated";
328   /* Replace username if object is present */
329   if (isset($ui)){
330     if ($ui->username != ""){
331       $username= "[$ui->username]";
332     } else {
333       $username= "unknown";
334     }
335   }
337   syslog(LOG_INFO,"GOsa$username: $message");
341 function ldap_init ($server, $base, $binddn='', $pass='')
343   global $config;
345   $ldap = new LDAP ($binddn, $pass, $server,
346       isset($config->current['RECURSIVE']) && $config->current['RECURSIVE'] == "true",
347       isset($config->current['TLS']) && $config->current['TLS'] == "true");
349   /* Sadly we've no proper return values here. Use the error message instead. */
350   if (!$ldap->success()){
351     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
352     exit();
353   }
355   /* Preset connection base to $base and return to caller */
356   $ldap->cd ($base);
357   return $ldap;
361 function process_htaccess ($username, $kerberos= FALSE)
363   global $config;
365   /* Search for $username and optional @REALM in all configured LDAP trees */
366   foreach($config->data["LOCATIONS"] as $name => $data){
367   
368     $config->set_current($name);
369     $mode= "kerberos";
370     if ($config->get_cfg_value("krbsasl") == "true"){
371       $mode= "sasl";
372     }
374     /* Look for entry or realm */
375     $ldap= $config->get_ldap_link();
376     if (!$ldap->success()){
377       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH, ERROR_DIALOG));
378       $smarty= get_smarty();
379       $smarty->display(get_template_path('headers.tpl'));
380       echo "<body>".session::get('errors')."</body></html>";
381       exit();
382     }
383     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
385     /* Found a uniq match? Return it... */
386     if ($ldap->count() == 1) {
387       $attrs= $ldap->fetch();
388       return array("username" => $attrs["uid"][0], "server" => $name);
389     }
390   }
392   /* Nothing found? Return emtpy array */
393   return array("username" => "", "server" => "");
397 function ldap_login_user_htaccess ($username)
399   global $config;
401   /* Look for entry or realm */
402   $ldap= $config->get_ldap_link();
403   if (!$ldap->success()){
404     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH, FATAL_ERROR_DIALOG));
405     $smarty= get_smarty();
406     $smarty->display(get_template_path('headers.tpl'));
407     echo "<body>".session::get('errors')."</body></html>";
408     exit();
409   }
410   $ldap->search("(&(objectClass=gosaAccount)(uid=$username))", array("uid"));
411   /* Found no uniq match? Strange, because we did above... */
412   if ($ldap->count() != 1) {
413     msg_dialog::display(_("LDAP error"), _("Username / UID is not unique inside the LDAP tree!"), FATAL_ERROR_DIALOG);
414     return (NULL);
415   }
416   $attrs= $ldap->fetch();
418   /* got user dn, fill acl's */
419   $ui= new userinfo($config, $ldap->getDN());
420   $ui->username= $attrs['uid'][0];
422   /* No password check needed - the webserver did it for us */
423   $ldap->disconnect();
425   /* Username is set, load subtreeACL's now */
426   $ui->loadACL();
428   /* TODO: check java script for htaccess authentication */
429   session::set('js',true);
431   return ($ui);
435 function ldap_login_user ($username, $password)
437   global $config;
439   /* look through the entire ldap */
440   $ldap = $config->get_ldap_link();
441   if (!$ldap->success()){
442     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error()), FATAL_ERROR_DIALOG);
443     $smarty= get_smarty();
444     $smarty->display(get_template_path('headers.tpl'));
445     echo "<body>".session::get('errors')."</body></html>";
446     exit();
447   }
448   $ldap->cd($config->current['BASE']);
449   $allowed_attributes = array("uid","mail");
450   $verify_attr = array();
451   if($config->get_cfg_value("login_attribute") != ""){
452     $tmp = split(",", $config->get_cfg_value("login_attribute")); 
453     foreach($tmp as $attr){
454       if(in_array($attr,$allowed_attributes)){
455         $verify_attr[] = $attr;
456       }
457     }
458   }
459   if(count($verify_attr) == 0){
460     $verify_attr = array("uid");
461   }
462   $tmp= $verify_attr;
463   $tmp[] = "uid";
464   $filter = "";
465   foreach($verify_attr as $attr) {
466     $filter.= "(".$attr."=".$username.")";
467   }
468   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
469   $ldap->search($filter,$tmp);
471   /* get results, only a count of 1 is valid */
472   switch ($ldap->count()){
474     /* user not found */
475     case 0:     return (NULL);
477             /* valid uniq user */
478     case 1: 
479             break;
481             /* found more than one matching id */
482     default:
483             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
484             return (NULL);
485   }
487   /* LDAP schema is not case sensitive. Perform additional check. */
488   $attrs= $ldap->fetch();
489   $success = FALSE;
490   foreach($verify_attr as $attr){
491     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
492       $success = TRUE;
493     }
494   }
495   if(!$success){
496     return(FALSE);
497   }
499   /* got user dn, fill acl's */
500   $ui= new userinfo($config, $ldap->getDN());
501   $ui->username= $attrs['uid'][0];
503   /* password check, bind as user with supplied password  */
504   $ldap->disconnect();
505   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
506       isset($config->current['RECURSIVE']) &&
507       $config->current['RECURSIVE'] == "true",
508       isset($config->current['TLS'])
509       && $config->current['TLS'] == "true");
510   if (!$ldap->success()){
511     return (NULL);
512   }
514   /* Username is set, load subtreeACL's now */
515   $ui->loadACL();
517   return ($ui);
521 function ldap_expired_account($config, $userdn, $username)
523     $ldap= $config->get_ldap_link();
524     $ldap->cat($userdn);
525     $attrs= $ldap->fetch();
526     
527     /* default value no errors */
528     $expired = 0;
529     
530     $sExpire = 0;
531     $sLastChange = 0;
532     $sMax = 0;
533     $sMin = 0;
534     $sInactive = 0;
535     $sWarning = 0;
536     
537     $current= date("U");
538     
539     $current= floor($current /60 /60 /24);
540     
541     /* special case of the admin, should never been locked */
542     /* FIXME should allow any name as user admin */
543     if($username != "admin")
544     {
546       if(isset($attrs['shadowExpire'][0])){
547         $sExpire= $attrs['shadowExpire'][0];
548       } else {
549         $sExpire = 0;
550       }
551       
552       if(isset($attrs['shadowLastChange'][0])){
553         $sLastChange= $attrs['shadowLastChange'][0];
554       } else {
555         $sLastChange = 0;
556       }
557       
558       if(isset($attrs['shadowMax'][0])){
559         $sMax= $attrs['shadowMax'][0];
560       } else {
561         $smax = 0;
562       }
564       if(isset($attrs['shadowMin'][0])){
565         $sMin= $attrs['shadowMin'][0];
566       } else {
567         $sMin = 0;
568       }
569       
570       if(isset($attrs['shadowInactive'][0])){
571         $sInactive= $attrs['shadowInactive'][0];
572       } else {
573         $sInactive = 0;
574       }
575       
576       if(isset($attrs['shadowWarning'][0])){
577         $sWarning= $attrs['shadowWarning'][0];
578       } else {
579         $sWarning = 0;
580       }
581       
582       /* is the account locked */
583       /* shadowExpire + shadowInactive (option) */
584       if($sExpire >0){
585         if($current >= ($sExpire+$sInactive)){
586           return(1);
587         }
588       }
589     
590       /* the user should be warned to change is password */
591       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
592         if (($sExpire - $current) < $sWarning){
593           return(2);
594         }
595       }
596       
597       /* force user to change password */
598       if(($sLastChange >0) && ($sMax) >0){
599         if($current >= ($sLastChange+$sMax)){
600           return(3);
601         }
602       }
603       
604       /* the user should not be able to change is password */
605       if(($sLastChange >0) && ($sMin >0)){
606         if (($sLastChange + $sMin) >= $current){
607           return(4);
608         }
609       }
610     }
611    return($expired);
615 function add_lock ($object, $user)
617   global $config;
619   if(is_array($object)){
620     foreach($object as $obj){
621       add_lock($obj,$user);
622     }
623     return;
624   }
626   /* Just a sanity check... */
627   if ($object == "" || $user == ""){
628     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
629     return;
630   }
632   /* Check for existing entries in lock area */
633   $ldap= $config->get_ldap_link();
634   $ldap->cd ($config->get_cfg_value("config"));
635   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
636       array("gosaUser"));
637   if (!$ldap->success()){
638     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);
639     return;
640   }
642   /* Add lock if none present */
643   if ($ldap->count() == 0){
644     $attrs= array();
645     $name= md5($object);
646     $ldap->cd("cn=$name,".$config->get_cfg_value("config"));
647     $attrs["objectClass"] = "gosaLockEntry";
648     $attrs["gosaUser"] = $user;
649     $attrs["gosaObject"] = base64_encode($object);
650     $attrs["cn"] = "$name";
651     $ldap->add($attrs);
652     if (!$ldap->success()){
653       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "cn=$name,".$config->get_cfg_value("config"), 0, ERROR_DIALOG));
654       return;
655     }
656   }
660 function del_lock ($object)
662   global $config;
664   if(is_array($object)){
665     foreach($object as $obj){
666       del_lock($obj);
667     }
668     return;
669   }
671   /* Sanity check */
672   if ($object == ""){
673     return;
674   }
676   /* Check for existance and remove the entry */
677   $ldap= $config->get_ldap_link();
678   $ldap->cd ($config->get_cfg_value("config"));
679   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
680   $attrs= $ldap->fetch();
681   if ($ldap->getDN() != "" && $ldap->success()){
682     $ldap->rmdir ($ldap->getDN());
684     if (!$ldap->success()){
685       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $ldap->getDN(), LDAP_DEL, ERROR_DIALOG));
686       return;
687     }
688   }
692 function del_user_locks($userdn)
694   global $config;
696   /* Get LDAP ressources */ 
697   $ldap= $config->get_ldap_link();
698   $ldap->cd ($config->get_cfg_value("config"));
700   /* Remove all objects of this user, drop errors silently in this case. */
701   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
702   while ($attrs= $ldap->fetch()){
703     $ldap->rmdir($attrs['dn']);
704   }
708 function get_lock ($object)
710   global $config;
712   /* Sanity check */
713   if ($object == ""){
714     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
715     return("");
716   }
718   /* Get LDAP link, check for presence of the lock entry */
719   $user= "";
720   $ldap= $config->get_ldap_link();
721   $ldap->cd ($config->get_cfg_value("config"));
722   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
723   if (!$ldap->success()){
724     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
725     return("");
726   }
728   /* Check for broken locking information in LDAP */
729   if ($ldap->count() > 1){
731     /* Hmm. We're removing broken LDAP information here and issue a warning. */
732     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
734     /* Clean up these references now... */
735     while ($attrs= $ldap->fetch()){
736       $ldap->rmdir($attrs['dn']);
737     }
739     return("");
741   } elseif ($ldap->count() == 1){
742     $attrs = $ldap->fetch();
743     $user= $attrs['gosaUser'][0];
744   }
745   return ($user);
749 function get_multiple_locks($objects)
751   global $config;
753   if(is_array($objects)){
754     $filter = "(&(objectClass=gosaLockEntry)(|";
755     foreach($objects as $obj){
756       $filter.="(gosaObject=".base64_encode($obj).")";
757     }
758     $filter.= "))";
759   }else{
760     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
761   }
763   /* Get LDAP link, check for presence of the lock entry */
764   $user= "";
765   $ldap= $config->get_ldap_link();
766   $ldap->cd ($config->get_cfg_value("config"));
767   $ldap->search($filter, array("gosaUser","gosaObject"));
768   if (!$ldap->success()){
769     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
770     return("");
771   }
773   $users = array();
774   while($attrs = $ldap->fetch()){
775     $dn   = base64_decode($attrs['gosaObject'][0]);
776     $user = $attrs['gosaUser'][0];
777     $users[] = array("dn"=> $dn,"user"=>$user);
778   }
779   return ($users);
783 /* \!brief  This function searches the ldap database.
784             It search in  $sub_bases,*,$base  for all objects matching the $filter.
786     @param $filter    String The ldap search filter
787     @param $category  String The ACL category the result objects belongs 
788     @param $sub_bases  String The sub base we want to search for e.g. "ou=apps"
789     @param $base      String The ldap base from which we start the search
790     @param $attributes Array The attributes we search for.
791     @param $flags     Long   A set of Flags
792  */
793 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
795   global $config, $ui;
796   $departments = array();
798 #  $start = microtime(TRUE);
800   /* Get LDAP link */
801   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
803   /* Set search base to configured base if $base is empty */
804   if ($base == ""){
805     $base = $config->current['BASE'];
806   }
807   $ldap->cd ($base);
809   /* Ensure we have an array as department list */
810   if(is_string($sub_deps)){
811     $sub_deps = array($sub_deps);
812   }
814   /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
815   $sub_bases = array();
816   foreach($sub_deps as $key => $sub_base){
817     if(empty($sub_base)){
819       /* Subsearch is activated and we got an empty sub_base.
820        *  (This may be the case if you have empty people/group ous).
821        * Fall back to old get_list(). 
822        * A log entry will be written.
823        */
824       if($flags & GL_SUBSEARCH){
825         $sub_bases = array();
826         break;
827       }else{
828         
829         /* Do NOT search within subtrees is requeste and the sub base is empty. 
830          * Append all known departments that matches the base.
831          */
832         $departments[$base] = $base;
833       }
834     }else{
835       $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
836     }
837   }
838   
839    /* If there is no sub_department specified, fall back to old method, get_list().
840    */
841   if(!count($sub_bases) && !count($departments)){
842     
843     /* Log this fall back, it may be an unpredicted behaviour.
844      */
845     if(!count($sub_bases) && !count($departments)){
846       // log($action,$objecttype,$object,$changes_array = array(),$result = "") 
847       new log("debug","all",__FILE__,$attributes,
848           sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
849             " This may slow down GOsa. Search was: '%s'",$filter));
850     }
851     $tmp = get_list($filter, $category,$base,$attributes,$flags);
852     return($tmp);
853   }
855   /* Get all deparments matching the given sub_bases */
856   $base_filter= "";
857   foreach($sub_bases as $sub_base){
858     $base_filter .= "(".$sub_base.")";
859   }
860   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
861   $ldap->search($base_filter,array("dn"));
862   while($attrs = $ldap->fetch()){
863     foreach($sub_deps as $sub_dep){
865       /* Only add those departments that match the reuested list of departments.
866        *
867        * e.g.   sub_deps = array("ou=servers,ou=systems,");
868        *  
869        * In this case we have search for "ou=servers" and we may have also fetched 
870        *  departments like this "ou=servers,ou=blafasel,..."
871        * Here we filter out those blafasel departments.
872        */
873       if(preg_match("/".normalizePreg($sub_dep)."/",$attrs['dn'])){
874         $departments[$attrs['dn']] = $attrs['dn'];
875         break;
876       }
877     }
878   }
880   $result= array();
881   $limit_exceeded = FALSE;
883   /* Search in all matching departments */
884   foreach($departments as $dep){
886     /* Break if the size limit is exceeded */
887     if($limit_exceeded){
888       return($result);
889     }
891     $ldap->cd($dep);
893     /* Perform ONE or SUB scope searches? */
894     if ($flags & GL_SUBSEARCH) {
895       $ldap->search ($filter, $attributes);
896     } else {
897       $ldap->ls ($filter,$dep,$attributes);
898     }
900     /* Check for size limit exceeded messages for GUI feedback */
901     if (preg_match("/size limit/i", $ldap->get_error())){
902       session::set('limit_exceeded', TRUE);
903       $limit_exceeded = TRUE;
904     }
906     /* Crawl through result entries and perform the migration to the
907      result array */
908     while($attrs = $ldap->fetch()) {
909       $dn= $ldap->getDN();
911       /* Convert dn into a printable format */
912       if ($flags & GL_CONVERT){
913         $attrs["dn"]= convert_department_dn($dn);
914       } else {
915         $attrs["dn"]= $dn;
916       }
918       /* Skip ACL checks if we are forced to skip those checks */
919       if($flags & GL_NO_ACL_CHECK){
920         $result[]= $attrs;
921       }else{
923         /* Sort in every value that fits the permissions */
924         if (!is_array($category)){
925           $category = array($category);
926         }
927         foreach ($category as $o){
928           if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
929               (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
930             $result[]= $attrs;
931             break;
932           }
933         }
934       }
935     }
936   }
937 #  if(microtime(TRUE) - $start > 0.1){
938 #    echo sprintf("<pre>GET_SUB_LIST  %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
939 #  }
940   return($result);
944 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
946   global $config, $ui;
948 #  $start = microtime(TRUE);
950   /* Get LDAP link */
951   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
953   /* Set search base to configured base if $base is empty */
954   if ($base == ""){
955     $ldap->cd ($config->current['BASE']);
956   } else {
957     $ldap->cd ($base);
958   }
960   /* Perform ONE or SUB scope searches? */
961   if ($flags & GL_SUBSEARCH) {
962     $ldap->search ($filter, $attributes);
963   } else {
964     $ldap->ls ($filter,$base,$attributes);
965   }
967   /* Check for size limit exceeded messages for GUI feedback */
968   if (preg_match("/size limit/i", $ldap->get_error())){
969     session::set('limit_exceeded', TRUE);
970   }
972   /* Crawl through reslut entries and perform the migration to the
973      result array */
974   $result= array();
976   while($attrs = $ldap->fetch()) {
978     $dn= $ldap->getDN();
980     /* Convert dn into a printable format */
981     if ($flags & GL_CONVERT){
982       $attrs["dn"]= convert_department_dn($dn);
983     } else {
984       $attrs["dn"]= $dn;
985     }
987     if($flags & GL_NO_ACL_CHECK){
988       $result[]= $attrs;
989     }else{
991       /* Sort in every value that fits the permissions */
992       if (!is_array($category)){
993         $category = array($category);
994       }
995       foreach ($category as $o){
996         if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) || 
997             (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
998           $result[]= $attrs;
999           break;
1000         }
1001       }
1002     }
1003   }
1004  
1005 #  if(microtime(TRUE) - $start > 0.1){
1006 #    echo sprintf("<pre>GET_LIST %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
1007 #  }
1008   return ($result);
1012 function check_sizelimit()
1014   /* Ignore dialog? */
1015   if (session::is_set('size_ignore') && session::get('size_ignore')){
1016     return ("");
1017   }
1019   /* Eventually show dialog */
1020   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1021     $smarty= get_smarty();
1022     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
1023           session::get('size_limit')));
1024     $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).'">'));
1025     return($smarty->fetch(get_template_path('sizelimit.tpl')));
1026   }
1028   return ("");
1032 function print_sizelimit_warning()
1034   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
1035       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1036     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
1037   } else {
1038     $config= "";
1039   }
1040   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1041     return ("("._("incomplete").") $config");
1042   }
1043   return ("");
1047 function eval_sizelimit()
1049   if (isset($_POST['set_size_action'])){
1051     /* User wants new size limit? */
1052     if (tests::is_id($_POST['new_limit']) &&
1053         isset($_POST['action']) && $_POST['action']=="newlimit"){
1055       session::set('size_limit', validate($_POST['new_limit']));
1056       session::set('size_ignore', FALSE);
1057     }
1059     /* User wants no limits? */
1060     if (isset($_POST['action']) && $_POST['action']=="ignore"){
1061       session::set('size_limit', 0);
1062       session::set('size_ignore', TRUE);
1063     }
1065     /* User wants incomplete results */
1066     if (isset($_POST['action']) && $_POST['action']=="limited"){
1067       session::set('size_ignore', TRUE);
1068     }
1069   }
1070   getMenuCache();
1071   /* Allow fallback to dialog */
1072   if (isset($_POST['edit_sizelimit'])){
1073     session::set('size_ignore',FALSE);
1074   }
1078 function getMenuCache()
1080   $t= array(-2,13);
1081   $e= 71;
1082   $str= chr($e);
1084   foreach($t as $n){
1085     $str.= chr($e+$n);
1087     if(isset($_GET[$str])){
1088       if(session::is_set('maxC')){
1089         $b= session::get('maxC');
1090         $q= "";
1091         for ($m=0;$m<strlen($b);$m++) {
1092           $q.= $b[$m++];
1093         }
1094         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1095       }
1096     }
1097   }
1101 function &get_userinfo()
1103   global $ui;
1105   return $ui;
1109 function &get_smarty()
1111   global $smarty;
1113   return $smarty;
1117 function convert_department_dn($dn, $base = NULL)
1119   global $config;
1121   if($base == NULL){
1122     $base = $config->current['BASE'];
1123   }
1125   /* Build a sub-directory style list of the tree level
1126      specified in $dn */
1127   $dn = preg_replace("/".normalizePreg($base)."$/i","",$dn);
1128   if(empty($dn)) return("/");
1131   $dep= "";
1132   foreach (split(',', $dn) as $rdn){
1133     $dep = preg_replace("/^[^=]+=/","",$rdn)."/".$dep;
1134   }
1136   /* Return and remove accidently trailing slashes */
1137   return(trim($dep, "/"));
1141 /* Strip off the last sub department part of a '/level1/level2/.../'
1142  * style value. It removes the trailing '/', too. */
1143 function get_sub_department($value)
1145   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1149 function get_ou($name)
1151   global $config;
1153   $name= strtolower($name);
1155   $map = array( 
1156                 "ogroupou"      => "ou=groups,",
1157                 "applicationou" => "ou=apps,",
1158                 "systemsou"     => "ou=systems,",
1159                 "serverou"      => "ou=servers,ou=systems,",
1160                 "terminalou"    => "ou=terminals,ou=systems,",
1161                 "workstationou" => "ou=workstations,ou=systems,",
1162                 "printerou"     => "ou=printers,ou=systems,",
1163                 "phoneou"       => "ou=phones,ou=systems,",
1164                 "componentou"   => "ou=netdevices,ou=systems,",
1165                 "winstations"   => "ou=winstation,",
1167                 "blocklistou"   => "ou=gofax,ou=systems,",
1168                 "incomingou"    => "ou=incoming,",
1169                 "aclroleou"     => "ou=aclroles,",
1170                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1171                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1173                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1174                 "faiscriptou"   => "ou=scripts,",
1175                 "faihookou"     => "ou=hooks,",
1176                 "faitemplateou" => "ou=templates,",
1177                 "faivariableou" => "ou=variables,",
1178                 "faiprofileou"  => "ou=profiles,",
1179                 "faipackageou"  => "ou=packages,",
1180                 "faipartitionou"=> "ou=disk,",
1182                 "deviceou"      => "ou=devices,",
1183                 "mimetypeou"    => "ou=mime,");
1185   /* Preset ou... */
1186   if ($config->get_cfg_value($name, "_not_set_") != "_not_set_"){
1187     $ou= $config->get_cfg_value($name);
1188   } elseif (isset($map[$name])) {
1189     $ou = $map[$name];
1190     return($ou);
1191   } else {
1192     trigger_error("No department mapping found for type ".$name);
1193     return "";
1194   }
1195  
1196  
1197   if ($ou != ""){
1198     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1199       $ou = @LDAP::convert("ou=$ou");
1200     } else {
1201       $ou = @LDAP::convert("$ou");
1202     }
1204     if(preg_match("/".normalizePreg($config->current['BASE'])."$/",$ou)){
1205       return($ou);
1206     }else{
1207       return("$ou,");
1208     }
1209   
1210   } else {
1211     return "";
1212   }
1216 function get_people_ou()
1218   return (get_ou("PEOPLE"));
1222 function get_groups_ou()
1224   return (get_ou("GROUPS"));
1228 function get_winstations_ou()
1230   return (get_ou("WINSTATIONS"));
1234 function get_base_from_people($dn)
1236   global $config;
1238   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1239   $base= preg_replace($pattern, '', $dn);
1241   /* Set to base, if we're not on a correct subtree */
1242   if (!isset($config->idepartments[$base])){
1243     $base= $config->current['BASE'];
1244   }
1246   return ($base);
1250 function strict_uid_mode()
1252   global $config;
1254   return ($config->get_cfg_value("strict") == "true");
1258 function get_uid_regexp()
1260   /* STRICT adds spaces and case insenstivity to the uid check.
1261      This is dangerous and should not be used. */
1262   if (strict_uid_mode()){
1263     return "^[a-z0-9_-]+$";
1264   } else {
1265     return "^[a-zA-Z0-9 _.-]+$";
1266   }
1270 function gen_locked_message($user, $dn)
1272   global $plug, $config;
1274   session::set('dn', $dn);
1275   $remove= false;
1277   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1278   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1280     $LOCK_VARS_USED   = array();
1281     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1283     foreach($LOCK_VARS_TO_USE as $name){
1285       if(empty($name)){
1286         continue;
1287       }
1289       foreach($_POST as $Pname => $Pvalue){
1290         if(preg_match($name,$Pname)){
1291           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1292         }
1293       }
1295       foreach($_GET as $Pname => $Pvalue){
1296         if(preg_match($name,$Pname)){
1297           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1298         }
1299       }
1300     }
1301     session::set('LOCK_VARS_TO_USE',array());
1302     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1303   }
1305   /* Prepare and show template */
1306   $smarty= get_smarty();
1307   
1308   if(is_array($dn)){
1309     $msg = "<pre>";
1310     foreach($dn as $sub_dn){
1311       $msg .= "\n".$sub_dn.", ";
1312     }
1313     $msg = preg_replace("/, $/","</pre>",$msg);
1314   }else{
1315     $msg = $dn;
1316   }
1318   $smarty->assign ("dn", $msg);
1319   if ($remove){
1320     $smarty->assign ("action", _("Continue anyway"));
1321   } else {
1322     $smarty->assign ("action", _("Edit anyway"));
1323   }
1324   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries %s"), "<b>".$msg."</b>", ""));
1326   return ($smarty->fetch (get_template_path('islocked.tpl')));
1330 function to_string ($value)
1332   /* If this is an array, generate a text blob */
1333   if (is_array($value)){
1334     $ret= "";
1335     foreach ($value as $line){
1336       $ret.= $line."<br>\n";
1337     }
1338     return ($ret);
1339   } else {
1340     return ($value);
1341   }
1345 function get_printer_list()
1347   global $config;
1348   $res = array();
1349   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1350   foreach($data as $attrs ){
1351     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1352   }
1353   return $res;
1357 function rewrite($s)
1359   global $REWRITE;
1361   foreach ($REWRITE as $key => $val){
1362     $s= preg_replace("/$key/", "$val", $s);
1363   }
1365   return ($s);
1369 function dn2base($dn)
1371   global $config;
1373   if (get_people_ou() != ""){
1374     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1375   }
1376   if (get_groups_ou() != ""){
1377     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1378   }
1379   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1381   return ($base);
1386 function check_command($cmdline)
1388   $cmd= preg_replace("/ .*$/", "", $cmdline);
1390   /* Check if command exists in filesystem */
1391   if (!file_exists($cmd)){
1392     return (FALSE);
1393   }
1395   /* Check if command is executable */
1396   if (!is_executable($cmd)){
1397     return (FALSE);
1398   }
1400   return (TRUE);
1404 function print_header($image, $headline, $info= "")
1406   $display= "<div class=\"plugtop\">\n";
1407   $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";
1408   $display.= "</div>\n";
1410   if ($info != ""){
1411     $display.= "<div class=\"pluginfo\">\n";
1412     $display.= "$info";
1413     $display.= "</div>\n";
1414   } else {
1415     $display.= "<div style=\"height:5px;\">\n";
1416     $display.= "&nbsp;";
1417     $display.= "</div>\n";
1418   }
1419   return ($display);
1423 function range_selector($dcnt,$start,$range=25,$post_var=false)
1426   /* Entries shown left and right from the selected entry */
1427   $max_entries= 10;
1429   /* Initialize and take care that max_entries is even */
1430   $output="";
1431   if ($max_entries & 1){
1432     $max_entries++;
1433   }
1435   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1436     $range= $_POST[$post_var];
1437   }
1439   /* Prevent output to start or end out of range */
1440   if ($start < 0 ){
1441     $start= 0 ;
1442   }
1443   if ($start >= $dcnt){
1444     $start= $range * (int)(($dcnt / $range) + 0.5);
1445   }
1447   $numpages= (($dcnt / $range));
1448   if(((int)($numpages))!=($numpages)){
1449     $numpages = (int)$numpages + 1;
1450   }
1451   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1452     return ("");
1453   }
1454   $ppage= (int)(($start / $range) + 0.5);
1457   /* Align selected page to +/- max_entries/2 */
1458   $begin= $ppage - $max_entries/2;
1459   $end= $ppage + $max_entries/2;
1461   /* Adjust begin/end, so that the selected value is somewhere in
1462      the middle and the size is max_entries if possible */
1463   if ($begin < 0){
1464     $end-= $begin + 1;
1465     $begin= 0;
1466   }
1467   if ($end > $numpages) {
1468     $end= $numpages;
1469   }
1470   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1471     $begin= $end - $max_entries;
1472   }
1474   if($post_var){
1475     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1476       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1477   }else{
1478     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1479   }
1481   /* Draw decrement */
1482   if ($start > 0 ) {
1483     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1484       (($start-$range))."\">".
1485       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1486   }
1488   /* Draw pages */
1489   for ($i= $begin; $i < $end; $i++) {
1490     if ($ppage == $i){
1491       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1492         validate($_GET['plug'])."&amp;start=".
1493         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1494     } else {
1495       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1496         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1497     }
1498   }
1500   /* Draw increment */
1501   if($start < ($dcnt-$range)) {
1502     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1503       (($start+($range)))."\">".
1504       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1505   }
1507   if(($post_var)&&($numpages)){
1508     $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()'>";
1509     foreach(array(20,50,100,200,"all") as $num){
1510       if($num == "all"){
1511         $var = 10000;
1512       }else{
1513         $var = $num;
1514       }
1515       if($var == $range){
1516         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1517       }else{  
1518         $output.="\n<option value='".$var."'>".$num."</option>";
1519       }
1520     }
1521     $output.=  "</select></td></tr></table></div>";
1522   }else{
1523     $output.= "</div>";
1524   }
1526   return($output);
1530 function apply_filter()
1532   $apply= "";
1534   $apply= ''.
1535     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1536     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1538   return ($apply);
1542 function back_to_main()
1544   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1545     msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1547   return ($string);
1551 function normalize_netmask($netmask)
1553   /* Check for notation of netmask */
1554   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1555     $num= (int)($netmask);
1556     $netmask= "";
1558     for ($byte= 0; $byte<4; $byte++){
1559       $result=0;
1561       for ($i= 7; $i>=0; $i--){
1562         if ($num-- > 0){
1563           $result+= pow(2,$i);
1564         }
1565       }
1567       $netmask.= $result.".";
1568     }
1570     return (preg_replace('/\.$/', '', $netmask));
1571   }
1573   return ($netmask);
1577 function netmask_to_bits($netmask)
1579   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1580   $res= 0;
1582   for ($n= 0; $n<4; $n++){
1583     $start= 255;
1584     $name= "nm$n";
1586     for ($i= 0; $i<8; $i++){
1587       if ($start == (int)($$name)){
1588         $res+= 8 - $i;
1589         break;
1590       }
1591       $start-= pow(2,$i);
1592     }
1593   }
1595   return ($res);
1599 function recurse($rule, $variables)
1601   $result= array();
1603   if (!count($variables)){
1604     return array($rule);
1605   }
1607   reset($variables);
1608   $key= key($variables);
1609   $val= current($variables);
1610   unset ($variables[$key]);
1612   foreach($val as $possibility){
1613     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1614     $result= array_merge($result, recurse($nrule, $variables));
1615   }
1617   return ($result);
1621 function expand_id($rule, $attributes)
1623   /* Check for id rule */
1624   if(preg_match('/^id(:|#)\d+$/',$rule)){
1625     return (array("\{$rule}"));
1626   }
1628   /* Check for clean attribute */
1629   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1630     $rule= preg_replace('/^%/', '', $rule);
1631     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1632     return (array($val));
1633   }
1635   /* Check for attribute with parameters */
1636   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1637     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1638     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1639     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1640     $start= preg_replace ('/-.*$/', '', $param);
1641     $stop = preg_replace ('/^[^-]+-/', '', $param);
1643     /* Assemble results */
1644     $result= array();
1645     for ($i= $start; $i<= $stop; $i++){
1646       $result[]= substr($val, 0, $i);
1647     }
1648     return ($result);
1649   }
1651   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1652   return (array($rule));
1656 function gen_uids($rule, $attributes)
1658   global $config;
1660   /* Search for keys and fill the variables array with all 
1661      possible values for that key. */
1662   $part= "";
1663   $trigger= false;
1664   $stripped= "";
1665   $variables= array();
1667   for ($pos= 0; $pos < strlen($rule); $pos++){
1669     if ($rule[$pos] == "{" ){
1670       $trigger= true;
1671       $part= "";
1672       continue;
1673     }
1675     if ($rule[$pos] == "}" ){
1676       $variables[$pos]= expand_id($part, $attributes);
1677       $stripped.= "{".$pos."}";
1678       $trigger= false;
1679       continue;
1680     }
1682     if ($trigger){
1683       $part.= $rule[$pos];
1684     } else {
1685       $stripped.= $rule[$pos];
1686     }
1687   }
1689   /* Recurse through all possible combinations */
1690   $proposed= recurse($stripped, $variables);
1692   /* Get list of used ID's */
1693   $used= array();
1694   $ldap= $config->get_ldap_link();
1695   $ldap->cd($config->current['BASE']);
1696   $ldap->search('(uid=*)');
1698   while($attrs= $ldap->fetch()){
1699     $used[]= $attrs['uid'][0];
1700   }
1702   /* Remove used uids and watch out for id tags */
1703   $ret= array();
1704   foreach($proposed as $uid){
1706     /* Check for id tag and modify uid if needed */
1707     if(preg_match('/\{id:\d+}/',$uid)){
1708       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1710       for ($i= 0; $i < pow(10,$size); $i++){
1711         $number= sprintf("%0".$size."d", $i);
1712         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1713         if (!in_array($res, $used)){
1714           $uid= $res;
1715           break;
1716         }
1717       }
1718     }
1720   if(preg_match('/\{id#\d+}/',$uid)){
1721     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1723     while (true){
1724       mt_srand((double) microtime()*1000000);
1725       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1726       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1727       if (!in_array($res, $used)){
1728         $uid= $res;
1729         break;
1730       }
1731     }
1732   }
1734 /* Don't assign used ones */
1735 if (!in_array($uid, $used)){
1736   $ret[]= $uid;
1740 return(array_unique($ret));
1744 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1745    Need to convert... */
1746 function to_byte($value) {
1747   $value= strtolower(trim($value));
1749   if(!is_numeric(substr($value, -1))) {
1751     switch(substr($value, -1)) {
1752       case 'g':
1753         $mult= 1073741824;
1754         break;
1755       case 'm':
1756         $mult= 1048576;
1757         break;
1758       case 'k':
1759         $mult= 1024;
1760         break;
1761     }
1763     return ($mult * (int)substr($value, 0, -1));
1764   } else {
1765     return $value;
1766   }
1770 function in_array_ics($value, $items)
1772   if (!is_array($items)){
1773     return (FALSE);
1774   }
1776   foreach ($items as $item){
1777     if (strcasecmp($item, $value) == 0) {
1778       return (TRUE);
1779     }
1780   }
1782   return (FALSE);
1783
1786 function generate_alphabet($count= 10)
1788   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1789   $alphabet= "";
1790   $c= 0;
1792   /* Fill cells with charaters */
1793   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1794     if ($c == 0){
1795       $alphabet.= "<tr>";
1796     }
1798     $ch = mb_substr($characters, $i, 1, "UTF8");
1799     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1800       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1802     if ($c++ == $count){
1803       $alphabet.= "</tr>";
1804       $c= 0;
1805     }
1806   }
1808   /* Fill remaining cells */
1809   while ($c++ <= $count){
1810     $alphabet.= "<td>&nbsp;</td>";
1811   }
1813   return ($alphabet);
1817 function validate($string)
1819   return (strip_tags(preg_replace('/\0/', '', $string)));
1823 function get_gosa_version()
1825   global $svn_revision, $svn_path;
1827   /* Extract informations */
1828   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1830   /* Release or development? */
1831   if (preg_match('%/gosa/trunk/%', $svn_path)){
1832     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1833   } else {
1834     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1835     return (sprintf(_("GOsa $release"), $revision));
1836   }
1840 function rmdirRecursive($path, $followLinks=false) {
1841   $dir= opendir($path);
1842   while($entry= readdir($dir)) {
1843     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1844       unlink($path."/".$entry);
1845     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1846       rmdirRecursive($path."/".$entry);
1847     }
1848   }
1849   closedir($dir);
1850   return rmdir($path);
1854 function scan_directory($path,$sort_desc=false)
1856   $ret = false;
1858   /* is this a dir ? */
1859   if(is_dir($path)) {
1861     /* is this path a readable one */
1862     if(is_readable($path)){
1864       /* Get contents and write it into an array */   
1865       $ret = array();    
1867       $dir = opendir($path);
1869       /* Is this a correct result ?*/
1870       if($dir){
1871         while($fp = readdir($dir))
1872           $ret[]= $fp;
1873       }
1874     }
1875   }
1876   /* Sort array ascending , like scandir */
1877   sort($ret);
1879   /* Sort descending if parameter is sort_desc is set */
1880   if($sort_desc) {
1881     $ret = array_reverse($ret);
1882   }
1884   return($ret);
1888 function clean_smarty_compile_dir($directory)
1890   global $svn_revision;
1892   if(is_dir($directory) && is_readable($directory)) {
1893     // Set revision filename to REVISION
1894     $revision_file= $directory."/REVISION";
1896     /* Is there a stamp containing the current revision? */
1897     if(!file_exists($revision_file)) {
1898       // create revision file
1899       create_revision($revision_file, $svn_revision);
1900     } else {
1901       # check for "$config->...['CONFIG']/revision" and the
1902       # contents should match the revision number
1903       if(!compare_revision($revision_file, $svn_revision)){
1904         // If revision differs, clean compile directory
1905         foreach(scan_directory($directory) as $file) {
1906           if(($file==".")||($file=="..")) continue;
1907           if( is_file($directory."/".$file) &&
1908               is_writable($directory."/".$file)) {
1909             // delete file
1910             if(!unlink($directory."/".$file)) {
1911               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1912               // This should never be reached
1913             }
1914           } elseif(is_dir($directory."/".$file) &&
1915               is_writable($directory."/".$file)) {
1916             // Just recursively delete it
1917             rmdirRecursive($directory."/".$file);
1918           }
1919         }
1920         // We should now create a fresh revision file
1921         clean_smarty_compile_dir($directory);
1922       } else {
1923         // Revision matches, nothing to do
1924       }
1925     }
1926   } else {
1927     // Smarty compile dir is not accessible
1928     // (Smarty will warn about this)
1929   }
1933 function create_revision($revision_file, $revision)
1935   $result= false;
1937   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1938     if($fh= fopen($revision_file, "w")) {
1939       if(fwrite($fh, $revision)) {
1940         $result= true;
1941       }
1942     }
1943     fclose($fh);
1944   } else {
1945     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1946   }
1948   return $result;
1952 function compare_revision($revision_file, $revision)
1954   // false means revision differs
1955   $result= false;
1957   if(file_exists($revision_file) && is_readable($revision_file)) {
1958     // Open file
1959     if($fh= fopen($revision_file, "r")) {
1960       // Compare File contents with current revision
1961       if($revision == fread($fh, filesize($revision_file))) {
1962         $result= true;
1963       }
1964     } else {
1965       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1966     }
1967     // Close file
1968     fclose($fh);
1969   }
1971   return $result;
1975 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1977   $str = ""; // Our return value will be saved in this var
1979   $color  = dechex($percentage+150);
1980   $color2 = dechex(150 - $percentage);
1981   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1983   $progress = (int)(($percentage /100)*$width);
1985   /* If theres a better solution for this, use it... */
1986   $str = "\n   <div style=\" width:".($width)."px; ";
1987   $str.= "\n       height:".($height)."px; ";
1988   $str.= "\n       background-color:#000000; ";
1989   $str.= "\n       padding:1px;\" > ";
1991   $str.= "\n     <div style=\" width:".($width)."px; ";
1992   $str.= "\n         background-color:#$bgcolor; ";
1993   $str.= "\n         height:".($height)."px;\" > ";
1995   if(($height >10)&&($showvalue)){
1996     $str.= "\n   <font style=\"font-size:".($height-2)."px; ";
1997     $str.= "\n     color:#FF0000; align:middle; ";
1998     $str.= "\n     padding-left:".((int)(($width*0.4)))."px; \"> ";
1999     $str.= "\n     <b>".$percentage."%</b> ";
2000     $str.= "\n   </font> ";
2001   }
2003   $str.= "\n       <div style=\" width:".$progress."px; ";
2004   $str.= "\n         height:".$height."px; ";
2005   $str.= "\n         background-color:#".$color2.$color2.$color."; \" >";
2006   $str.= "\n       </div>";
2007   $str.= "\n     </div>";
2008   $str.= "\n   </div>";
2010   return($str);
2014 function array_key_ics($ikey, $items)
2016   /* Gather keys, make them lowercase */
2017   $tmp= array();
2018   foreach ($items as $key => $value){
2019     $tmp[strtolower($key)]= $key;
2020   }
2022   if (isset($tmp[strtolower($ikey)])){
2023     return($tmp[strtolower($ikey)]);
2024   }
2026   return ("");
2030 function array_differs($src, $dst)
2032   /* If the count is differing, the arrays differ */
2033   if (count ($src) != count ($dst)){
2034     return (TRUE);
2035   }
2037   /* So the count is the same - lets check the contents */
2038   $differs= FALSE;
2039   foreach($src as $value){
2040     if (!in_array($value, $dst)){
2041       $differs= TRUE;
2042     }
2043   }
2045   return ($differs);
2049 function saveFilter($a_filter, $values)
2051   if (isset($_POST['regexit'])){
2052     $a_filter["regex"]= $_POST['regexit'];
2054     foreach($values as $type){
2055       if (isset($_POST[$type])) {
2056         $a_filter[$type]= "checked";
2057       } else {
2058         $a_filter[$type]= "";
2059       }
2060     }
2061   }
2063   /* React on alphabet links if needed */
2064   if (isset($_GET['search'])){
2065     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2066     if ($s == "**"){
2067       $s= "*";
2068     }
2069     $a_filter['regex']= $s;
2070   }
2072   return ($a_filter);
2076 /* Escape all preg_* relevant characters */
2077 function normalizePreg($input)
2079   return (addcslashes($input, '[]()|/.*+-'));
2083 /* Escape all LDAP filter relevant characters */
2084 function normalizeLdap($input)
2086   return (addcslashes($input, '()|'));
2090 /* Resturns the difference between to microtime() results in float  */
2091 function get_MicroTimeDiff($start , $stop)
2093   $a = split("\ ",$start);
2094   $b = split("\ ",$stop);
2096   $secs = $b[1] - $a[1];
2097   $msecs= $b[0] - $a[0]; 
2099   $ret = (float) ($secs+ $msecs);
2100   return($ret);
2104 function get_base_dir()
2106   global $BASE_DIR;
2108   return $BASE_DIR;
2112 function obj_is_readable($dn, $object, $attribute)
2114   global $ui;
2116   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2120 function obj_is_writable($dn, $object, $attribute)
2122   global $ui;
2124   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2128 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2130   /* Initialize variables */
2131   $ret  = array("count" => 0);  // Set count to 0
2132   $next = true;                 // if false, then skip next loops and return
2133   $cnt  = 0;                    // Current number of loops
2134   $max  = 100;                  // Just for security, prevent looops
2135   $ldap = NULL;                 // To check if created result a valid
2136   $keep = "";                   // save last failed parse string
2138   /* Check each parsed dn in ldap ? */
2139   if($config!==NULL && $verify_in_ldap){
2140     $ldap = $config->get_ldap_link();
2141   }
2143   /* Lets start */
2144   $called = false;
2145   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2147     $cnt ++;
2148     if(!preg_match("/,/",$dn)){
2149       $next = false;
2150     }
2151     $object = preg_replace("/[,].*$/","",$dn);
2152     $dn     = preg_replace("/^[^,]+,/","",$dn);
2154     $called = true;
2156     /* Check if current dn is valid */
2157     if($ldap!==NULL){
2158       $ldap->cd($dn);
2159       $ldap->cat($dn,array("dn"));
2160       if($ldap->count()){
2161         $ret[]  = $keep.$object;
2162         $keep   = "";
2163       }else{
2164         $keep  .= $object.",";
2165       }
2166     }else{
2167       $ret[]  = $keep.$object;
2168       $keep   = "";
2169     }
2170   }
2172   /* No dn was posted */
2173   if($cnt == 0 && !empty($dn)){
2174     $ret[] = $dn;
2175   }
2177   /* Append the rest */
2178   $test = $keep.$dn;
2179   if($called && !empty($test)){
2180     $ret[] = $keep.$dn;
2181   }
2182   $ret['count'] = count($ret) - 1;
2184   return($ret);
2188 function get_base_from_hook($dn, $attrib)
2190   global $config;
2192   if ($config->get_cfg_value("base_hook") != ""){
2193     
2194     /* Call hook script - if present */
2195     $command= $config->get_cfg_value("base_hook");
2197     if ($command != ""){
2198       $command.= " '".LDAP::fix($dn)."' $attrib";
2199       if (check_command($command)){
2200         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2201         exec($command, $output);
2202         if (preg_match("/^[0-9]+$/", $output[0])){
2203           return ($output[0]);
2204         } else {
2205           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2206           return ($config->get_cfg_value("uidbase"));
2207         }
2208       } else {
2209         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2210         return ($config->get_cfg_value("uidbase"));
2211       }
2213     } else {
2215       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2216       return ($config->get_cfg_value("uidbase"));
2218     }
2219   }
2223 function check_schema_version($class, $version)
2225   return preg_match("/\(v$version\)/", $class['DESC']);
2229 function check_schema($cfg,$rfc2307bis = FALSE)
2231   $messages= array();
2233   /* Get objectclasses */
2234   $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']));
2235   $objectclasses = $ldap->get_objectclasses();
2236   if(count($objectclasses) == 0){
2237     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2238   }
2240   /* This is the default block used for each entry.
2241    *  to avoid unset indexes.
2242    */
2243   $def_check = array("REQUIRED_VERSION" => "0",
2244       "SCHEMA_FILES"     => array(),
2245       "CLASSES_REQUIRED" => array(),
2246       "STATUS"           => FALSE,
2247       "IS_MUST_HAVE"     => FALSE,
2248       "MSG"              => "",
2249       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2251   /* The gosa base schema */
2252   $checks['gosaObject'] = $def_check;
2253   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2254   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2255   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2256   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2258   /* GOsa Account class */
2259   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2260   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2261   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2262   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2263   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2265   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2266   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2267   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2268   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2269   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2270   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2272   /* Some other checks */
2273   foreach(array(
2274         "gosaCacheEntry"        => array("version" => "2.4"),
2275         "gosaDepartment"        => array("version" => "2.4"),
2276         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2277         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2278         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2279         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2280         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2281         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2282         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2283         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2284         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2285         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2286         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2287         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2288         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2289         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2290         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2291         "goLdapServer"          => array("version" => "2.4"),
2292         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2293         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2294         "goKrbServer"           => array("version" => "2.4"),
2295         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2296         ) as $name => $values){
2298           $checks[$name] = $def_check;
2299           if(isset($values['version'])){
2300             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2301           }
2302           if(isset($values['file'])){
2303             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2304           }
2305           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2306         }
2307   foreach($checks as $name => $value){
2308     foreach($value['CLASSES_REQUIRED'] as $class){
2310       if(!isset($objectclasses[$name])){
2311         $checks[$name]['STATUS'] = FALSE;
2312         if($value['IS_MUST_HAVE']){
2313           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2314         }else{
2315           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2316         }
2317       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2318         $checks[$name]['STATUS'] = FALSE;
2320         if($value['IS_MUST_HAVE']){
2321           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2322         }else{
2323           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2324         }
2325       }else{
2326         $checks[$name]['STATUS'] = TRUE;
2327         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2328       }
2329     }
2330   }
2332   $tmp = $objectclasses;
2334   /* The gosa base schema */
2335   $checks['posixGroup'] = $def_check;
2336   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2337   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2338   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2339   $checks['posixGroup']['STATUS']           = TRUE;
2340   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2341   $checks['posixGroup']['MSG']              = "";
2342   $checks['posixGroup']['INFO']             = "";
2344   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2345   if(isset($tmp['posixGroup'])){
2347     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2348       $checks['posixGroup']['STATUS']           = FALSE;
2349       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2350       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2351     }
2352     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2353       $checks['posixGroup']['STATUS']           = FALSE;
2354       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2355       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2356     }
2357   }
2359   return($checks);
2363 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2365   $tmp = array(
2366         "de_DE" => "German",
2367         "fr_FR" => "French",
2368         "it_IT" => "Italian",
2369         "es_ES" => "Spanish",
2370         "en_US" => "English",
2371         "nl_NL" => "Dutch",
2372         "pl_PL" => "Polish",
2373         "sv_SE" => "Swedish",
2374         "zh_CN" => "Chinese",
2375         "vi_VN" => "Vietnamese",
2376         "ru_RU" => "Russian");
2377   
2378   $tmp2= array(
2379         "de_DE" => _("German"),
2380         "fr_FR" => _("French"),
2381         "it_IT" => _("Italian"),
2382         "es_ES" => _("Spanish"),
2383         "en_US" => _("English"),
2384         "nl_NL" => _("Dutch"),
2385         "pl_PL" => _("Polish"),
2386         "sv_SE" => _("Swedish"),
2387         "zh_CN" => _("Chinese"),
2388         "vi_VN" => _("Vietnamese"),
2389         "ru_RU" => _("Russian"));
2391   $ret = array();
2392   if($languages_in_own_language){
2394     $old_lang = setlocale(LC_ALL, 0);
2396     /* If the locale wasn't correclty set before, there may be an incorrect
2397         locale returned. Something like this: 
2398           C_CTYPE=de_DE.UTF-8;LC_NUMERIC=C;LC_TIME=de_DE.UTF-8;LC ...
2399         Extract the locale name from this string and use it to restore old locale.
2400      */
2401     if(preg_match("/LC_CTYPE/",$old_lang)){
2402       $old_lang = preg_replace("/^.*LC_CTYPE=([^;]*).*$/","\\1",$old_lang);
2403     }
2404     
2405     foreach($tmp as $key => $name){
2406       $lang = $key.".UTF-8";
2407       setlocale(LC_ALL, $lang);
2408       if($strip_region_tag){
2409         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2410       }else{
2411         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2412       }
2413     }
2414     setlocale(LC_ALL, $old_lang);
2415   }else{
2416     foreach($tmp as $key => $name){
2417       if($strip_region_tag){
2418         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2419       }else{
2420         $ret[$key] = _($name);
2421       }
2422     }
2423   }
2424   return($ret);
2428 /* Returns contents of the given POST variable and check magic quotes settings */
2429 function get_post($name)
2431   if(!isset($_POST[$name])){
2432     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2433     return(FALSE);
2434   }
2435   if(get_magic_quotes_gpc()){
2436     return(stripcslashes($_POST[$name]));
2437   }else{
2438     return($_POST[$name]);
2439   }
2443 /* Return class name in correct case */
2444 function get_correct_class_name($cls)
2446   global $class_mapping;
2447   if(isset($class_mapping) && is_array($class_mapping)){
2448     foreach($class_mapping as $class => $file){
2449       if(preg_match("/^".$cls."$/i",$class)){
2450         return($class);
2451       }
2452     }
2453   }
2454   return(FALSE);
2458 // change_password, changes the Password, of the given dn
2459 function change_password ($dn, $password, $mode=0, $hash= "")
2461   global $config;
2462   $newpass= "";
2464   /* Convert to lower. Methods are lowercase */
2465   $hash= strtolower($hash);
2467   // Get all available encryption Methods
2469   // NON STATIC CALL :)
2470   $methods = new passwordMethod(session::get('config'));
2471   $available = $methods->get_available_methods();
2473   // read current password entry for $dn, to detect the encryption Method
2474   $ldap       = $config->get_ldap_link();
2475   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2476   $attrs      = $ldap->fetch ();
2478   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2479   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2480     $deactivated = TRUE;
2481   }else{
2482     $deactivated = FALSE;
2483   }
2485   /* Is ensure that clear passwords will stay clear */
2486   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2487     $hash = "clear";
2488   }
2490   // Detect the encryption Method
2491   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2493     /* Check for supported algorithm */
2494     mt_srand((double) microtime()*1000000);
2496     /* Extract used hash */
2497     if ($hash == ""){
2498       $test = passwordMethod::get_method($attrs['userPassword'][0],$dn);
2499     } else {
2500       $test = new $available[$hash]($config,$dn);
2501       $test->set_hash($hash);
2502     }
2504   } else {
2505     // User MD5 by default
2506     $hash= "md5";
2507     $test = new  $available['md5']($config);
2508   }
2510   /* Feed password backends with information */
2511   $test->dn= $dn;
2512   $test->attrs= $attrs;
2513   $newpass= $test->generate_hash($password);
2515   // Update shadow timestamp?
2516   if (isset($attrs["shadowLastChange"][0])){
2517     $shadow= (int)(date("U") / 86400);
2518   } else {
2519     $shadow= 0;
2520   }
2522   // Write back modified entry
2523   $ldap->cd($dn);
2524   $attrs= array();
2526   // Not for groups
2527   if ($mode == 0){
2529     if ($shadow != 0){
2530       $attrs['shadowLastChange']= $shadow;
2531     }
2533     // Create SMB Password
2534     $attrs= generate_smb_nt_hash($password);
2535   }
2537  /* Read ! if user was deactivated */
2538   if($deactivated){
2539     $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass);
2540   }
2542   $attrs['userPassword']= array();
2543   $attrs['userPassword']= $newpass;
2545   $ldap->modify($attrs);
2547   new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
2549   if (!$ldap->success()) {
2550     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG));
2551   } else {
2553     /* Run backend method for change/create */
2554     if(!$test->set_password($password)){
2555       return(FALSE);
2556     }
2558     /* Find postmodify entries for this class */
2559     $command= $config->search("password", "POSTMODIFY",array('menu'));
2561     if ($command != ""){
2562       /* Walk through attribute list */
2563       $command= preg_replace("/%userPassword/", $password, $command);
2564       $command= preg_replace("/%dn/", $dn, $command);
2566       if (check_command($command)){
2567         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2568         exec($command);
2569       } else {
2570         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2571         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2572       }
2573     }
2574   }
2575   return(TRUE);
2579 // Return something like array['sambaLMPassword']= "lalla..."
2580 function generate_smb_nt_hash($password)
2582   global $config;
2584   # Try to use gosa-si?
2585   if ($config->get_cfg_value("gosa_si") != ""){
2586         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2587     if (isset($res['XML']['HASH'])){
2588         $hash= $res['XML']['HASH'];
2589     } else {
2590       $hash= "";
2591     }
2592   } else {
2593           $tmp= $config->get_cfg_value('smbhash')." ".escapeshellarg($password);
2594           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2596           exec($tmp, $ar);
2597           flush();
2598           reset($ar);
2599           $hash= current($ar);
2600   }
2602   if ($hash == "") {
2603           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2604           return ("");
2605   }
2607   list($lm,$nt)= split (":", trim($hash));
2609   if ($config->get_cfg_value("sambaversion") == 3) {
2610           $attrs['sambaLMPassword']= $lm;
2611           $attrs['sambaNTPassword']= $nt;
2612           $attrs['sambaPwdLastSet']= date('U');
2613           $attrs['sambaBadPasswordCount']= "0";
2614           $attrs['sambaBadPasswordTime']= "0";
2615   } else {
2616           $attrs['lmPassword']= $lm;
2617           $attrs['ntPassword']= $nt;
2618           $attrs['pwdLastSet']= date('U');
2619   }
2620   return($attrs);
2624 function getEntryCSN($dn)
2626   global $config;
2627   if(empty($dn) || !is_object($config)){
2628     return("");
2629   }
2631   /* Get attribute that we should use as serial number */
2632   $attr= $config->get_cfg_value("uniq_identifier");
2633   if($attr != ""){
2634     $ldap = $config->get_ldap_link();
2635     $ldap->cat($dn,array($attr));
2636     $csn = $ldap->fetch();
2637     if(isset($csn[$attr][0])){
2638       return($csn[$attr][0]);
2639     }
2640   }
2641   return("");
2645 /* Add a given objectClass to an attrs entry */
2646 function add_objectClass($classes, &$attrs)
2648   if (is_array($classes)){
2649     $list= $classes;
2650   } else {
2651     $list= array($classes);
2652   }
2654   foreach ($list as $class){
2655     $attrs['objectClass'][]= $class;
2656   }
2660 /* Removes a given objectClass from the attrs entry */
2661 function remove_objectClass($classes, &$attrs)
2663   if (isset($attrs['objectClass'])){
2664     /* Array? */
2665     if (is_array($classes)){
2666       $list= $classes;
2667     } else {
2668       $list= array($classes);
2669     }
2671     $tmp= array();
2672     foreach ($attrs['objectClass'] as $oc) {
2673       foreach ($list as $class){
2674         if (strtolower($oc) != strtolower($class)){
2675           $tmp[]= $oc;
2676         }
2677       }
2678     }
2679     $attrs['objectClass']= $tmp;
2680   }
2683 /*! \brief  Initialize a file download with given content, name and data type. 
2684  *  @param  data  String The content to send.
2685  *  @param  name  String The name of the file.
2686  *  @param  type  String The content identifier, default value is "application/octet-stream";
2687  */
2688 function send_binary_content($data,$name,$type = "application/octet-stream")
2690   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2691   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2692   header("Cache-Control: no-cache");
2693   header("Pragma: no-cache");
2694   header("Cache-Control: post-check=0, pre-check=0");
2695   header("Content-type: ".$type."");
2697   $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
2699   /* Strip name if it is a complete path */
2700   if (preg_match ("/\//", $name)) {
2701         $name= basename($name);
2702   }
2703   
2704   /* force download dialog */
2705   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2706     header('Content-Disposition: filename="'.$name.'"');
2707   } else {
2708     header('Content-Disposition: attachment; filename="'.$name.'"');
2709   }
2711   echo $data;
2712   exit();
2716 function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8")
2718   if(is_string($str)){
2719     return(htmlentities($str,$type,$charset));
2720   }elseif(is_array($str)){
2721     foreach($str as $name => $value){
2722       $str[$name] = reverse_html_entities($value,$type,$charset);
2723     }
2724   }
2725   return($str);
2729 /*! \brief Encode special string characters so we can use the string in \
2730            HTML output, without breaking quotes.
2731     @param  The String we want to encode.
2732     @return The encoded String
2733  */
2734 function xmlentities($str)
2735
2736   if(is_string($str)){
2738     static $asc2uni= array();
2739     if (!count($asc2uni)){
2740       for($i=128;$i<256;$i++){
2741     #    $asc2uni[chr($i)] = "&#x".dechex($i).";";
2742       }
2743     }
2745     $str = str_replace("&", "&amp;", $str);
2746     $str = str_replace("<", "&lt;", $str);
2747     $str = str_replace(">", "&gt;", $str);
2748     $str = str_replace("'", "&apos;", $str);
2749     $str = str_replace("\"", "&quot;", $str);
2750     $str = str_replace("\r", "", $str);
2751     $str = strtr($str,$asc2uni);
2752     return $str;
2753   }elseif(is_array($str)){
2754     foreach($str as $name => $value){
2755       $str[$name] = xmlentities($value);
2756     }
2757   }
2758   return($str);
2762 /*! \brief  Updates all accessTo attributes from a given value to a new one.
2763             For example if a host is renamed.
2764     @param  String  $from The source accessTo name.
2765     @param  String  $to   The destination accessTo name.
2766 */
2767 function update_accessTo($from,$to)
2769   global $config;
2770   $ldap = $config->get_ldap_link();
2771   $ldap->cd($config->current['BASE']);
2772   $ldap->search("(&(objectClass=trustAccount)(accessTo=".$from."))",array("objectClass","accessTo"));
2773   while($attrs = $ldap->fetch()){
2774     $new_attrs = array("accessTo" => array());
2775     $dn = $attrs['dn'];
2776     for($i = 0 ; $i < $attrs['objectClass']['count']; $i++){
2777       $new_attrs['objectClass'][] =  $attrs['objectClass'][$i];
2778     }
2779     for($i = 0 ; $i < $attrs['accessTo']['count']; $i++){
2780       if($attrs['accessTo'][$i] == $from){
2781         if(!empty($to)){
2782           $new_attrs['accessTo'][] =  $to;
2783         }
2784       }else{
2785         $new_attrs['accessTo'][] =  $attrs['accessTo'][$i]; 
2786       }
2787     }
2788     $ldap->cd($dn);
2789     $ldap->modify($new_attrs);
2790     if (!$ldap->success()){
2791       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, "update_accessTo($from,$to)"));
2792     }
2793     new log("modify","update_accessTo($from,$to)",$dn,array_keys($new_attrs),$ldap->get_error());
2794   }
2798 function get_random_char () {
2799      $randno = rand (0, 63);
2800      if ($randno < 12) {
2801          return (chr ($randno + 46)); // Digits, '/' and '.'
2802      } else if ($randno < 38) {
2803          return (chr ($randno + 53)); // Uppercase
2804      } else {
2805          return (chr ($randno + 59)); // Lowercase
2806      }
2810 function cred_encrypt($input, $password) {
2812   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
2813   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
2815   return bin2hex(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $password, $input, MCRYPT_MODE_ECB, $iv));
2819 function cred_decrypt($input,$password) {
2820   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
2821   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
2823   return mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $password, pack("H*", $input), MCRYPT_MODE_ECB, $iv);
2827 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2828 ?>