Code

Updated )
[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     msg_dialog::display(_("Fatal error"),
352         sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error()),
353         FATAL_ERROR_DIALOG);
354     exit();
355   }
357   /* Preset connection base to $base and return to caller */
358   $ldap->cd ($base);
359   return $ldap;
363 function process_htaccess ($username, $kerberos= FALSE)
365   global $config;
367   /* Search for $username and optional @REALM in all configured LDAP trees */
368   foreach($config->data["LOCATIONS"] as $name => $data){
369   
370     $config->set_current($name);
371     $mode= "kerberos";
372     if ($config->get_cfg_value("krbsasl") == "true"){
373       $mode= "sasl";
374     }
376     /* Look for entry or realm */
377     $ldap= $config->get_ldap_link();
378     if (!$ldap->success()){
379       msg_dialog::display(_("LDAP error"), 
380           msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH)."<br><br>".session::get('errors'), 
381           FATAL_ERROR_DIALOG);
382       exit();
383     }
384     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
386     /* Found a uniq match? Return it... */
387     if ($ldap->count() == 1) {
388       $attrs= $ldap->fetch();
389       return array("username" => $attrs["uid"][0], "server" => $name);
390     }
391   }
393   /* Nothing found? Return emtpy array */
394   return array("username" => "", "server" => "");
398 function ldap_login_user_htaccess ($username)
400   global $config;
402   /* Look for entry or realm */
403   $ldap= $config->get_ldap_link();
404   if (!$ldap->success()){
405     msg_dialog::display(_("LDAP error"), 
406         msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH)."<br><br>".session::get('errors'), 
407         FATAL_ERROR_DIALOG));
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"), 
443         msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH)."<br><br>".session::get('errors'), 
444         FATAL_ERROR_DIALOG));
445     exit();
446   }
447   $ldap->cd($config->current['BASE']);
448   $allowed_attributes = array("uid","mail");
449   $verify_attr = array();
450   if($config->get_cfg_value("login_attribute") != ""){
451     $tmp = split(",", $config->get_cfg_value("login_attribute")); 
452     foreach($tmp as $attr){
453       if(in_array($attr,$allowed_attributes)){
454         $verify_attr[] = $attr;
455       }
456     }
457   }
458   if(count($verify_attr) == 0){
459     $verify_attr = array("uid");
460   }
461   $tmp= $verify_attr;
462   $tmp[] = "uid";
463   $filter = "";
464   foreach($verify_attr as $attr) {
465     $filter.= "(".$attr."=".$username.")";
466   }
467   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
468   $ldap->search($filter,$tmp);
470   /* get results, only a count of 1 is valid */
471   switch ($ldap->count()){
473     /* user not found */
474     case 0:     return (NULL);
476             /* valid uniq user */
477     case 1: 
478             break;
480             /* found more than one matching id */
481     default:
482             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
483             return (NULL);
484   }
486   /* LDAP schema is not case sensitive. Perform additional check. */
487   $attrs= $ldap->fetch();
488   $success = FALSE;
489   foreach($verify_attr as $attr){
490     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
491       $success = TRUE;
492     }
493   }
494   if(!$success){
495     return(FALSE);
496   }
498   /* got user dn, fill acl's */
499   $ui= new userinfo($config, $ldap->getDN());
500   $ui->username= $attrs['uid'][0];
502   /* password check, bind as user with supplied password  */
503   $ldap->disconnect();
504   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
505       isset($config->current['RECURSIVE']) &&
506       $config->current['RECURSIVE'] == "true",
507       isset($config->current['TLS'])
508       && $config->current['TLS'] == "true");
509   if (!$ldap->success()){
510     return (NULL);
511   }
513   /* Username is set, load subtreeACL's now */
514   $ui->loadACL();
516   return ($ui);
520 function ldap_expired_account($config, $userdn, $username)
522     $ldap= $config->get_ldap_link();
523     $ldap->cat($userdn);
524     $attrs= $ldap->fetch();
525     
526     /* default value no errors */
527     $expired = 0;
528     
529     $sExpire = 0;
530     $sLastChange = 0;
531     $sMax = 0;
532     $sMin = 0;
533     $sInactive = 0;
534     $sWarning = 0;
535     
536     $current= date("U");
537     
538     $current= floor($current /60 /60 /24);
539     
540     /* special case of the admin, should never been locked */
541     /* FIXME should allow any name as user admin */
542     if($username != "admin")
543     {
545       if(isset($attrs['shadowExpire'][0])){
546         $sExpire= $attrs['shadowExpire'][0];
547       } else {
548         $sExpire = 0;
549       }
550       
551       if(isset($attrs['shadowLastChange'][0])){
552         $sLastChange= $attrs['shadowLastChange'][0];
553       } else {
554         $sLastChange = 0;
555       }
556       
557       if(isset($attrs['shadowMax'][0])){
558         $sMax= $attrs['shadowMax'][0];
559       } else {
560         $smax = 0;
561       }
563       if(isset($attrs['shadowMin'][0])){
564         $sMin= $attrs['shadowMin'][0];
565       } else {
566         $sMin = 0;
567       }
568       
569       if(isset($attrs['shadowInactive'][0])){
570         $sInactive= $attrs['shadowInactive'][0];
571       } else {
572         $sInactive = 0;
573       }
574       
575       if(isset($attrs['shadowWarning'][0])){
576         $sWarning= $attrs['shadowWarning'][0];
577       } else {
578         $sWarning = 0;
579       }
580       
581       /* is the account locked */
582       /* shadowExpire + shadowInactive (option) */
583       if($sExpire >0){
584         if($current >= ($sExpire+$sInactive)){
585           return(1);
586         }
587       }
588     
589       /* the user should be warned to change is password */
590       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
591         if (($sExpire - $current) < $sWarning){
592           return(2);
593         }
594       }
595       
596       /* force user to change password */
597       if(($sLastChange >0) && ($sMax) >0){
598         if($current >= ($sLastChange+$sMax)){
599           return(3);
600         }
601       }
602       
603       /* the user should not be able to change is password */
604       if(($sLastChange >0) && ($sMin >0)){
605         if (($sLastChange + $sMin) >= $current){
606           return(4);
607         }
608       }
609     }
610    return($expired);
614 function add_lock ($object, $user)
616   global $config;
618   if(is_array($object)){
619     foreach($object as $obj){
620       add_lock($obj,$user);
621     }
622     return;
623   }
625   /* Just a sanity check... */
626   if ($object == "" || $user == ""){
627     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
628     return;
629   }
631   /* Check for existing entries in lock area */
632   $ldap= $config->get_ldap_link();
633   $ldap->cd ($config->get_cfg_value("config"));
634   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
635       array("gosaUser"));
636   if (!$ldap->success()){
637     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);
638     return;
639   }
641   /* Add lock if none present */
642   if ($ldap->count() == 0){
643     $attrs= array();
644     $name= md5($object);
645     $ldap->cd("cn=$name,".$config->get_cfg_value("config"));
646     $attrs["objectClass"] = "gosaLockEntry";
647     $attrs["gosaUser"] = $user;
648     $attrs["gosaObject"] = base64_encode($object);
649     $attrs["cn"] = "$name";
650     $ldap->add($attrs);
651     if (!$ldap->success()){
652       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "cn=$name,".$config->get_cfg_value("config"), 0, ERROR_DIALOG));
653       return;
654     }
655   }
659 function del_lock ($object)
661   global $config;
663   if(is_array($object)){
664     foreach($object as $obj){
665       del_lock($obj);
666     }
667     return;
668   }
670   /* Sanity check */
671   if ($object == ""){
672     return;
673   }
675   /* Check for existance and remove the entry */
676   $ldap= $config->get_ldap_link();
677   $ldap->cd ($config->get_cfg_value("config"));
678   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
679   $attrs= $ldap->fetch();
680   if ($ldap->getDN() != "" && $ldap->success()){
681     $ldap->rmdir ($ldap->getDN());
683     if (!$ldap->success()){
684       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $ldap->getDN(), LDAP_DEL, ERROR_DIALOG));
685       return;
686     }
687   }
691 function del_user_locks($userdn)
693   global $config;
695   /* Get LDAP ressources */ 
696   $ldap= $config->get_ldap_link();
697   $ldap->cd ($config->get_cfg_value("config"));
699   /* Remove all objects of this user, drop errors silently in this case. */
700   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
701   while ($attrs= $ldap->fetch()){
702     $ldap->rmdir($attrs['dn']);
703   }
707 function get_lock ($object)
709   global $config;
711   /* Sanity check */
712   if ($object == ""){
713     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
714     return("");
715   }
717   /* Get LDAP link, check for presence of the lock entry */
718   $user= "";
719   $ldap= $config->get_ldap_link();
720   $ldap->cd ($config->get_cfg_value("config"));
721   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
722   if (!$ldap->success()){
723     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
724     return("");
725   }
727   /* Check for broken locking information in LDAP */
728   if ($ldap->count() > 1){
730     /* Hmm. We're removing broken LDAP information here and issue a warning. */
731     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
733     /* Clean up these references now... */
734     while ($attrs= $ldap->fetch()){
735       $ldap->rmdir($attrs['dn']);
736     }
738     return("");
740   } elseif ($ldap->count() == 1){
741     $attrs = $ldap->fetch();
742     $user= $attrs['gosaUser'][0];
743   }
744   return ($user);
748 function get_multiple_locks($objects)
750   global $config;
752   if(is_array($objects)){
753     $filter = "(&(objectClass=gosaLockEntry)(|";
754     foreach($objects as $obj){
755       $filter.="(gosaObject=".base64_encode($obj).")";
756     }
757     $filter.= "))";
758   }else{
759     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
760   }
762   /* Get LDAP link, check for presence of the lock entry */
763   $user= "";
764   $ldap= $config->get_ldap_link();
765   $ldap->cd ($config->get_cfg_value("config"));
766   $ldap->search($filter, array("gosaUser","gosaObject"));
767   if (!$ldap->success()){
768     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
769     return("");
770   }
772   $users = array();
773   while($attrs = $ldap->fetch()){
774     $dn   = base64_decode($attrs['gosaObject'][0]);
775     $user = $attrs['gosaUser'][0];
776     $users[] = array("dn"=> $dn,"user"=>$user);
777   }
778   return ($users);
782 /* \!brief  This function searches the ldap database.
783             It search in  $sub_bases,*,$base  for all objects matching the $filter.
785     @param $filter    String The ldap search filter
786     @param $category  String The ACL category the result objects belongs 
787     @param $sub_bases  String The sub base we want to search for e.g. "ou=apps"
788     @param $base      String The ldap base from which we start the search
789     @param $attributes Array The attributes we search for.
790     @param $flags     Long   A set of Flags
791  */
792 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
794   global $config, $ui;
795   $departments = array();
797 #  $start = microtime(TRUE);
799   /* Get LDAP link */
800   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
802   /* Set search base to configured base if $base is empty */
803   if ($base == ""){
804     $base = $config->current['BASE'];
805   }
806   $ldap->cd ($base);
808   /* Ensure we have an array as department list */
809   if(is_string($sub_deps)){
810     $sub_deps = array($sub_deps);
811   }
813   /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
814   $sub_bases = array();
815   foreach($sub_deps as $key => $sub_base){
816     if(empty($sub_base)){
818       /* Subsearch is activated and we got an empty sub_base.
819        *  (This may be the case if you have empty people/group ous).
820        * Fall back to old get_list(). 
821        * A log entry will be written.
822        */
823       if($flags & GL_SUBSEARCH){
824         $sub_bases = array();
825         break;
826       }else{
827         
828         /* Do NOT search within subtrees is requeste and the sub base is empty. 
829          * Append all known departments that matches the base.
830          */
831         $departments[$base] = $base;
832       }
833     }else{
834       $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
835     }
836   }
837   
838    /* If there is no sub_department specified, fall back to old method, get_list().
839    */
840   if(!count($sub_bases) && !count($departments)){
841     
842     /* Log this fall back, it may be an unpredicted behaviour.
843      */
844     if(!count($sub_bases) && !count($departments)){
845       // log($action,$objecttype,$object,$changes_array = array(),$result = "") 
846       new log("debug","all",__FILE__,$attributes,
847           sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
848             " This may slow down GOsa. Search was: '%s'",$filter));
849     }
850     $tmp = get_list($filter, $category,$base,$attributes,$flags);
851     return($tmp);
852   }
854   /* Get all deparments matching the given sub_bases */
855   $base_filter= "";
856   foreach($sub_bases as $sub_base){
857     $base_filter .= "(".$sub_base.")";
858   }
859   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
860   $ldap->search($base_filter,array("dn"));
861   while($attrs = $ldap->fetch()){
862     foreach($sub_deps as $sub_dep){
864       /* Only add those departments that match the reuested list of departments.
865        *
866        * e.g.   sub_deps = array("ou=servers,ou=systems,");
867        *  
868        * In this case we have search for "ou=servers" and we may have also fetched 
869        *  departments like this "ou=servers,ou=blafasel,..."
870        * Here we filter out those blafasel departments.
871        */
872       if(preg_match("/".normalizePreg($sub_dep)."/",$attrs['dn'])){
873         $departments[$attrs['dn']] = $attrs['dn'];
874         break;
875       }
876     }
877   }
879   $result= array();
880   $limit_exceeded = FALSE;
882   /* Search in all matching departments */
883   foreach($departments as $dep){
885     /* Break if the size limit is exceeded */
886     if($limit_exceeded){
887       return($result);
888     }
890     $ldap->cd($dep);
892     /* Perform ONE or SUB scope searches? */
893     if ($flags & GL_SUBSEARCH) {
894       $ldap->search ($filter, $attributes);
895     } else {
896       $ldap->ls ($filter,$dep,$attributes);
897     }
899     /* Check for size limit exceeded messages for GUI feedback */
900     if (preg_match("/size limit/i", $ldap->get_error())){
901       session::set('limit_exceeded', TRUE);
902       $limit_exceeded = TRUE;
903     }
905     /* Crawl through result entries and perform the migration to the
906      result array */
907     while($attrs = $ldap->fetch()) {
908       $dn= $ldap->getDN();
910       /* Convert dn into a printable format */
911       if ($flags & GL_CONVERT){
912         $attrs["dn"]= convert_department_dn($dn);
913       } else {
914         $attrs["dn"]= $dn;
915       }
917       /* Skip ACL checks if we are forced to skip those checks */
918       if($flags & GL_NO_ACL_CHECK){
919         $result[]= $attrs;
920       }else{
922         /* Sort in every value that fits the permissions */
923         if (!is_array($category)){
924           $category = array($category);
925         }
926         foreach ($category as $o){
927           if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) ||
928               (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
929             $result[]= $attrs;
930             break;
931           }
932         }
933       }
934     }
935   }
936 #  if(microtime(TRUE) - $start > 0.1){
937 #    echo sprintf("<pre>GET_SUB_LIST  %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
938 #  }
939   return($result);
943 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
945   global $config, $ui;
947 #  $start = microtime(TRUE);
949   /* Get LDAP link */
950   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
952   /* Set search base to configured base if $base is empty */
953   if ($base == ""){
954     $ldap->cd ($config->current['BASE']);
955   } else {
956     $ldap->cd ($base);
957   }
959   /* Perform ONE or SUB scope searches? */
960   if ($flags & GL_SUBSEARCH) {
961     $ldap->search ($filter, $attributes);
962   } else {
963     $ldap->ls ($filter,$base,$attributes);
964   }
966   /* Check for size limit exceeded messages for GUI feedback */
967   if (preg_match("/size limit/i", $ldap->get_error())){
968     session::set('limit_exceeded', TRUE);
969   }
971   /* Crawl through reslut entries and perform the migration to the
972      result array */
973   $result= array();
975   while($attrs = $ldap->fetch()) {
977     $dn= $ldap->getDN();
979     /* Convert dn into a printable format */
980     if ($flags & GL_CONVERT){
981       $attrs["dn"]= convert_department_dn($dn);
982     } else {
983       $attrs["dn"]= $dn;
984     }
986     if($flags & GL_NO_ACL_CHECK){
987       $result[]= $attrs;
988     }else{
990       /* Sort in every value that fits the permissions */
991       if (!is_array($category)){
992         $category = array($category);
993       }
994       foreach ($category as $o){
995         if((preg_match("/\//",$o) && preg_match("/r/",$ui->get_permissions($dn,$o))) || 
996             (!preg_match("/\//",$o) && preg_match("/r/",$ui->get_category_permissions($dn, $o)))){
997           $result[]= $attrs;
998           break;
999         }
1000       }
1001     }
1002   }
1003  
1004 #  if(microtime(TRUE) - $start > 0.1){
1005 #    echo sprintf("<pre>GET_LIST %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
1006 #  }
1007   return ($result);
1011 function check_sizelimit()
1013   /* Ignore dialog? */
1014   if (session::is_set('size_ignore') && session::get('size_ignore')){
1015     return ("");
1016   }
1018   /* Eventually show dialog */
1019   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1020     $smarty= get_smarty();
1021     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
1022           session::get('size_limit')));
1023     $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).'">'));
1024     return($smarty->fetch(get_template_path('sizelimit.tpl')));
1025   }
1027   return ("");
1031 function print_sizelimit_warning()
1033   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
1034       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1035     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
1036   } else {
1037     $config= "";
1038   }
1039   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1040     return ("("._("incomplete").") $config");
1041   }
1042   return ("");
1046 function eval_sizelimit()
1048   if (isset($_POST['set_size_action'])){
1050     /* User wants new size limit? */
1051     if (tests::is_id($_POST['new_limit']) &&
1052         isset($_POST['action']) && $_POST['action']=="newlimit"){
1054       session::set('size_limit', validate($_POST['new_limit']));
1055       session::set('size_ignore', FALSE);
1056     }
1058     /* User wants no limits? */
1059     if (isset($_POST['action']) && $_POST['action']=="ignore"){
1060       session::set('size_limit', 0);
1061       session::set('size_ignore', TRUE);
1062     }
1064     /* User wants incomplete results */
1065     if (isset($_POST['action']) && $_POST['action']=="limited"){
1066       session::set('size_ignore', TRUE);
1067     }
1068   }
1069   getMenuCache();
1070   /* Allow fallback to dialog */
1071   if (isset($_POST['edit_sizelimit'])){
1072     session::set('size_ignore',FALSE);
1073   }
1077 function getMenuCache()
1079   $t= array(-2,13);
1080   $e= 71;
1081   $str= chr($e);
1083   foreach($t as $n){
1084     $str.= chr($e+$n);
1086     if(isset($_GET[$str])){
1087       if(session::is_set('maxC')){
1088         $b= session::get('maxC');
1089         $q= "";
1090         for ($m=0;$m<strlen($b);$m++) {
1091           $q.= $b[$m++];
1092         }
1093         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1094       }
1095     }
1096   }
1100 function &get_userinfo()
1102   global $ui;
1104   return $ui;
1108 function &get_smarty()
1110   global $smarty;
1112   return $smarty;
1116 function convert_department_dn($dn, $base = NULL)
1118   global $config;
1120   if($base == NULL){
1121     $base = $config->current['BASE'];
1122   }
1124   /* Build a sub-directory style list of the tree level
1125      specified in $dn */
1126   $dn = preg_replace("/".normalizePreg($base)."$/i","",$dn);
1127   if(empty($dn)) return("/");
1130   $dep= "";
1131   foreach (split(',', $dn) as $rdn){
1132     $dep = preg_replace("/^[^=]+=/","",$rdn)."/".$dep;
1133   }
1135   /* Return and remove accidently trailing slashes */
1136   return(trim($dep, "/"));
1140 /* Strip off the last sub department part of a '/level1/level2/.../'
1141  * style value. It removes the trailing '/', too. */
1142 function get_sub_department($value)
1144   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1148 function get_ou($name)
1150   global $config;
1152   $name= strtolower($name);
1154   $map = array( 
1155                 "ogroupou"      => "ou=groups,",
1156                 "applicationou" => "ou=apps,",
1157                 "systemsou"     => "ou=systems,",
1158                 "serverou"      => "ou=servers,ou=systems,",
1159                 "terminalou"    => "ou=terminals,ou=systems,",
1160                 "workstationou" => "ou=workstations,ou=systems,",
1161                 "printerou"     => "ou=printers,ou=systems,",
1162                 "phoneou"       => "ou=phones,ou=systems,",
1163                 "componentou"   => "ou=netdevices,ou=systems,",
1164                 "winstations"   => "ou=winstation,",
1166                 "blocklistou"   => "ou=gofax,ou=systems,",
1167                 "incomingou"    => "ou=incoming,",
1168                 "aclroleou"     => "ou=aclroles,",
1169                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1170                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1172                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1173                 "faiscriptou"   => "ou=scripts,",
1174                 "faihookou"     => "ou=hooks,",
1175                 "faitemplateou" => "ou=templates,",
1176                 "faivariableou" => "ou=variables,",
1177                 "faiprofileou"  => "ou=profiles,",
1178                 "faipackageou"  => "ou=packages,",
1179                 "faipartitionou"=> "ou=disk,",
1181                 "deviceou"      => "ou=devices,",
1182                 "mimetypeou"    => "ou=mime,");
1184   /* Preset ou... */
1185   if ($config->get_cfg_value($name, "_not_set_") != "_not_set_"){
1186     $ou= $config->get_cfg_value($name);
1187   } elseif (isset($map[$name])) {
1188     $ou = $map[$name];
1189     return($ou);
1190   } else {
1191     trigger_error("No department mapping found for type ".$name);
1192     return "";
1193   }
1194  
1195  
1196   if ($ou != ""){
1197     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1198       $ou = @LDAP::convert("ou=$ou");
1199     } else {
1200       $ou = @LDAP::convert("$ou");
1201     }
1203     if(preg_match("/".normalizePreg($config->current['BASE'])."$/",$ou)){
1204       return($ou);
1205     }else{
1206       return("$ou,");
1207     }
1208   
1209   } else {
1210     return "";
1211   }
1215 function get_people_ou()
1217   return (get_ou("PEOPLE"));
1221 function get_groups_ou()
1223   return (get_ou("GROUPS"));
1227 function get_winstations_ou()
1229   return (get_ou("WINSTATIONS"));
1233 function get_base_from_people($dn)
1235   global $config;
1237   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1238   $base= preg_replace($pattern, '', $dn);
1240   /* Set to base, if we're not on a correct subtree */
1241   if (!isset($config->idepartments[$base])){
1242     $base= $config->current['BASE'];
1243   }
1245   return ($base);
1249 function strict_uid_mode()
1251   global $config;
1253   return ($config->get_cfg_value("strict") == "true");
1257 function get_uid_regexp()
1259   /* STRICT adds spaces and case insenstivity to the uid check.
1260      This is dangerous and should not be used. */
1261   if (strict_uid_mode()){
1262     return "^[a-z0-9_-]+$";
1263   } else {
1264     return "^[a-zA-Z0-9 _.-]+$";
1265   }
1269 function gen_locked_message($user, $dn)
1271   global $plug, $config;
1273   session::set('dn', $dn);
1274   $remove= false;
1276   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1277   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1279     $LOCK_VARS_USED   = array();
1280     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1282     foreach($LOCK_VARS_TO_USE as $name){
1284       if(empty($name)){
1285         continue;
1286       }
1288       foreach($_POST as $Pname => $Pvalue){
1289         if(preg_match($name,$Pname)){
1290           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1291         }
1292       }
1294       foreach($_GET as $Pname => $Pvalue){
1295         if(preg_match($name,$Pname)){
1296           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1297         }
1298       }
1299     }
1300     session::set('LOCK_VARS_TO_USE',array());
1301     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1302   }
1304   /* Prepare and show template */
1305   $smarty= get_smarty();
1306   
1307   if(is_array($dn)){
1308     $msg = "<pre>";
1309     foreach($dn as $sub_dn){
1310       $msg .= "\n".$sub_dn.", ";
1311     }
1312     $msg = preg_replace("/, $/","</pre>",$msg);
1313   }else{
1314     $msg = $dn;
1315   }
1317   $smarty->assign ("dn", $msg);
1318   if ($remove){
1319     $smarty->assign ("action", _("Continue anyway"));
1320   } else {
1321     $smarty->assign ("action", _("Edit anyway"));
1322   }
1323   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries %s"), "<b>".$msg."</b>", ""));
1325   return ($smarty->fetch (get_template_path('islocked.tpl')));
1329 function to_string ($value)
1331   /* If this is an array, generate a text blob */
1332   if (is_array($value)){
1333     $ret= "";
1334     foreach ($value as $line){
1335       $ret.= $line."<br>\n";
1336     }
1337     return ($ret);
1338   } else {
1339     return ($value);
1340   }
1344 function get_printer_list()
1346   global $config;
1347   $res = array();
1348   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1349   foreach($data as $attrs ){
1350     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1351   }
1352   return $res;
1356 function rewrite($s)
1358   global $REWRITE;
1360   foreach ($REWRITE as $key => $val){
1361     $s= preg_replace("/$key/", "$val", $s);
1362   }
1364   return ($s);
1368 function dn2base($dn)
1370   global $config;
1372   if (get_people_ou() != ""){
1373     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1374   }
1375   if (get_groups_ou() != ""){
1376     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1377   }
1378   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1380   return ($base);
1385 function check_command($cmdline)
1387   $cmd= preg_replace("/ .*$/", "", $cmdline);
1389   /* Check if command exists in filesystem */
1390   if (!file_exists($cmd)){
1391     return (FALSE);
1392   }
1394   /* Check if command is executable */
1395   if (!is_executable($cmd)){
1396     return (FALSE);
1397   }
1399   return (TRUE);
1403 function print_header($image, $headline, $info= "")
1405   $display= "<div class=\"plugtop\">\n";
1406   $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";
1407   $display.= "</div>\n";
1409   if ($info != ""){
1410     $display.= "<div class=\"pluginfo\">\n";
1411     $display.= "$info";
1412     $display.= "</div>\n";
1413   } else {
1414     $display.= "<div style=\"height:5px;\">\n";
1415     $display.= "&nbsp;";
1416     $display.= "</div>\n";
1417   }
1418   return ($display);
1422 function range_selector($dcnt,$start,$range=25,$post_var=false)
1425   /* Entries shown left and right from the selected entry */
1426   $max_entries= 10;
1428   /* Initialize and take care that max_entries is even */
1429   $output="";
1430   if ($max_entries & 1){
1431     $max_entries++;
1432   }
1434   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1435     $range= $_POST[$post_var];
1436   }
1438   /* Prevent output to start or end out of range */
1439   if ($start < 0 ){
1440     $start= 0 ;
1441   }
1442   if ($start >= $dcnt){
1443     $start= $range * (int)(($dcnt / $range) + 0.5);
1444   }
1446   $numpages= (($dcnt / $range));
1447   if(((int)($numpages))!=($numpages)){
1448     $numpages = (int)$numpages + 1;
1449   }
1450   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1451     return ("");
1452   }
1453   $ppage= (int)(($start / $range) + 0.5);
1456   /* Align selected page to +/- max_entries/2 */
1457   $begin= $ppage - $max_entries/2;
1458   $end= $ppage + $max_entries/2;
1460   /* Adjust begin/end, so that the selected value is somewhere in
1461      the middle and the size is max_entries if possible */
1462   if ($begin < 0){
1463     $end-= $begin + 1;
1464     $begin= 0;
1465   }
1466   if ($end > $numpages) {
1467     $end= $numpages;
1468   }
1469   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1470     $begin= $end - $max_entries;
1471   }
1473   if($post_var){
1474     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1475       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1476   }else{
1477     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1478   }
1480   /* Draw decrement */
1481   if ($start > 0 ) {
1482     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1483       (($start-$range))."\">".
1484       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1485   }
1487   /* Draw pages */
1488   for ($i= $begin; $i < $end; $i++) {
1489     if ($ppage == $i){
1490       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1491         validate($_GET['plug'])."&amp;start=".
1492         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1493     } else {
1494       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1495         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1496     }
1497   }
1499   /* Draw increment */
1500   if($start < ($dcnt-$range)) {
1501     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1502       (($start+($range)))."\">".
1503       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1504   }
1506   if(($post_var)&&($numpages)){
1507     $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()'>";
1508     foreach(array(20,50,100,200,"all") as $num){
1509       if($num == "all"){
1510         $var = 10000;
1511       }else{
1512         $var = $num;
1513       }
1514       if($var == $range){
1515         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1516       }else{  
1517         $output.="\n<option value='".$var."'>".$num."</option>";
1518       }
1519     }
1520     $output.=  "</select></td></tr></table></div>";
1521   }else{
1522     $output.= "</div>";
1523   }
1525   return($output);
1529 function apply_filter()
1531   $apply= "";
1533   $apply= ''.
1534     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1535     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1537   return ($apply);
1541 function back_to_main()
1543   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1544     msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1546   return ($string);
1550 function normalize_netmask($netmask)
1552   /* Check for notation of netmask */
1553   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1554     $num= (int)($netmask);
1555     $netmask= "";
1557     for ($byte= 0; $byte<4; $byte++){
1558       $result=0;
1560       for ($i= 7; $i>=0; $i--){
1561         if ($num-- > 0){
1562           $result+= pow(2,$i);
1563         }
1564       }
1566       $netmask.= $result.".";
1567     }
1569     return (preg_replace('/\.$/', '', $netmask));
1570   }
1572   return ($netmask);
1576 function netmask_to_bits($netmask)
1578   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1579   $res= 0;
1581   for ($n= 0; $n<4; $n++){
1582     $start= 255;
1583     $name= "nm$n";
1585     for ($i= 0; $i<8; $i++){
1586       if ($start == (int)($$name)){
1587         $res+= 8 - $i;
1588         break;
1589       }
1590       $start-= pow(2,$i);
1591     }
1592   }
1594   return ($res);
1598 function recurse($rule, $variables)
1600   $result= array();
1602   if (!count($variables)){
1603     return array($rule);
1604   }
1606   reset($variables);
1607   $key= key($variables);
1608   $val= current($variables);
1609   unset ($variables[$key]);
1611   foreach($val as $possibility){
1612     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1613     $result= array_merge($result, recurse($nrule, $variables));
1614   }
1616   return ($result);
1620 function expand_id($rule, $attributes)
1622   /* Check for id rule */
1623   if(preg_match('/^id(:|#)\d+$/',$rule)){
1624     return (array("\{$rule}"));
1625   }
1627   /* Check for clean attribute */
1628   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1629     $rule= preg_replace('/^%/', '', $rule);
1630     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1631     return (array($val));
1632   }
1634   /* Check for attribute with parameters */
1635   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1636     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1637     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1638     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1639     $start= preg_replace ('/-.*$/', '', $param);
1640     $stop = preg_replace ('/^[^-]+-/', '', $param);
1642     /* Assemble results */
1643     $result= array();
1644     for ($i= $start; $i<= $stop; $i++){
1645       $result[]= substr($val, 0, $i);
1646     }
1647     return ($result);
1648   }
1650   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1651   return (array($rule));
1655 function gen_uids($rule, $attributes)
1657   global $config;
1659   /* Search for keys and fill the variables array with all 
1660      possible values for that key. */
1661   $part= "";
1662   $trigger= false;
1663   $stripped= "";
1664   $variables= array();
1666   for ($pos= 0; $pos < strlen($rule); $pos++){
1668     if ($rule[$pos] == "{" ){
1669       $trigger= true;
1670       $part= "";
1671       continue;
1672     }
1674     if ($rule[$pos] == "}" ){
1675       $variables[$pos]= expand_id($part, $attributes);
1676       $stripped.= "{".$pos."}";
1677       $trigger= false;
1678       continue;
1679     }
1681     if ($trigger){
1682       $part.= $rule[$pos];
1683     } else {
1684       $stripped.= $rule[$pos];
1685     }
1686   }
1688   /* Recurse through all possible combinations */
1689   $proposed= recurse($stripped, $variables);
1691   /* Get list of used ID's */
1692   $used= array();
1693   $ldap= $config->get_ldap_link();
1694   $ldap->cd($config->current['BASE']);
1695   $ldap->search('(uid=*)');
1697   while($attrs= $ldap->fetch()){
1698     $used[]= $attrs['uid'][0];
1699   }
1701   /* Remove used uids and watch out for id tags */
1702   $ret= array();
1703   foreach($proposed as $uid){
1705     /* Check for id tag and modify uid if needed */
1706     if(preg_match('/\{id:\d+}/',$uid)){
1707       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1709       for ($i= 0; $i < pow(10,$size); $i++){
1710         $number= sprintf("%0".$size."d", $i);
1711         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1712         if (!in_array($res, $used)){
1713           $uid= $res;
1714           break;
1715         }
1716       }
1717     }
1719   if(preg_match('/\{id#\d+}/',$uid)){
1720     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1722     while (true){
1723       mt_srand((double) microtime()*1000000);
1724       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1725       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1726       if (!in_array($res, $used)){
1727         $uid= $res;
1728         break;
1729       }
1730     }
1731   }
1733 /* Don't assign used ones */
1734 if (!in_array($uid, $used)){
1735   $ret[]= $uid;
1739 return(array_unique($ret));
1743 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1744    Need to convert... */
1745 function to_byte($value) {
1746   $value= strtolower(trim($value));
1748   if(!is_numeric(substr($value, -1))) {
1750     switch(substr($value, -1)) {
1751       case 'g':
1752         $mult= 1073741824;
1753         break;
1754       case 'm':
1755         $mult= 1048576;
1756         break;
1757       case 'k':
1758         $mult= 1024;
1759         break;
1760     }
1762     return ($mult * (int)substr($value, 0, -1));
1763   } else {
1764     return $value;
1765   }
1769 function in_array_ics($value, $items)
1771   if (!is_array($items)){
1772     return (FALSE);
1773   }
1775   foreach ($items as $item){
1776     if (strcasecmp($item, $value) == 0) {
1777       return (TRUE);
1778     }
1779   }
1781   return (FALSE);
1782
1785 function generate_alphabet($count= 10)
1787   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1788   $alphabet= "";
1789   $c= 0;
1791   /* Fill cells with charaters */
1792   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1793     if ($c == 0){
1794       $alphabet.= "<tr>";
1795     }
1797     $ch = mb_substr($characters, $i, 1, "UTF8");
1798     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1799       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1801     if ($c++ == $count){
1802       $alphabet.= "</tr>";
1803       $c= 0;
1804     }
1805   }
1807   /* Fill remaining cells */
1808   while ($c++ <= $count){
1809     $alphabet.= "<td>&nbsp;</td>";
1810   }
1812   return ($alphabet);
1816 function validate($string)
1818   return (strip_tags(preg_replace('/\0/', '', $string)));
1822 function get_gosa_version()
1824   global $svn_revision, $svn_path;
1826   /* Extract informations */
1827   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1829   /* Release or development? */
1830   if (preg_match('%/gosa/trunk/%', $svn_path)){
1831     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1832   } else {
1833     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1834     return (sprintf(_("GOsa $release"), $revision));
1835   }
1839 function rmdirRecursive($path, $followLinks=false) {
1840   $dir= opendir($path);
1841   while($entry= readdir($dir)) {
1842     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1843       unlink($path."/".$entry);
1844     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1845       rmdirRecursive($path."/".$entry);
1846     }
1847   }
1848   closedir($dir);
1849   return rmdir($path);
1853 function scan_directory($path,$sort_desc=false)
1855   $ret = false;
1857   /* is this a dir ? */
1858   if(is_dir($path)) {
1860     /* is this path a readable one */
1861     if(is_readable($path)){
1863       /* Get contents and write it into an array */   
1864       $ret = array();    
1866       $dir = opendir($path);
1868       /* Is this a correct result ?*/
1869       if($dir){
1870         while($fp = readdir($dir))
1871           $ret[]= $fp;
1872       }
1873     }
1874   }
1875   /* Sort array ascending , like scandir */
1876   sort($ret);
1878   /* Sort descending if parameter is sort_desc is set */
1879   if($sort_desc) {
1880     $ret = array_reverse($ret);
1881   }
1883   return($ret);
1887 function clean_smarty_compile_dir($directory)
1889   global $svn_revision;
1891   if(is_dir($directory) && is_readable($directory)) {
1892     // Set revision filename to REVISION
1893     $revision_file= $directory."/REVISION";
1895     /* Is there a stamp containing the current revision? */
1896     if(!file_exists($revision_file)) {
1897       // create revision file
1898       create_revision($revision_file, $svn_revision);
1899     } else {
1900       # check for "$config->...['CONFIG']/revision" and the
1901       # contents should match the revision number
1902       if(!compare_revision($revision_file, $svn_revision)){
1903         // If revision differs, clean compile directory
1904         foreach(scan_directory($directory) as $file) {
1905           if(($file==".")||($file=="..")) continue;
1906           if( is_file($directory."/".$file) &&
1907               is_writable($directory."/".$file)) {
1908             // delete file
1909             if(!unlink($directory."/".$file)) {
1910               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1911               // This should never be reached
1912             }
1913           } elseif(is_dir($directory."/".$file) &&
1914               is_writable($directory."/".$file)) {
1915             // Just recursively delete it
1916             rmdirRecursive($directory."/".$file);
1917           }
1918         }
1919         // We should now create a fresh revision file
1920         clean_smarty_compile_dir($directory);
1921       } else {
1922         // Revision matches, nothing to do
1923       }
1924     }
1925   } else {
1926     // Smarty compile dir is not accessible
1927     // (Smarty will warn about this)
1928   }
1932 function create_revision($revision_file, $revision)
1934   $result= false;
1936   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1937     if($fh= fopen($revision_file, "w")) {
1938       if(fwrite($fh, $revision)) {
1939         $result= true;
1940       }
1941     }
1942     fclose($fh);
1943   } else {
1944     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1945   }
1947   return $result;
1951 function compare_revision($revision_file, $revision)
1953   // false means revision differs
1954   $result= false;
1956   if(file_exists($revision_file) && is_readable($revision_file)) {
1957     // Open file
1958     if($fh= fopen($revision_file, "r")) {
1959       // Compare File contents with current revision
1960       if($revision == fread($fh, filesize($revision_file))) {
1961         $result= true;
1962       }
1963     } else {
1964       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1965     }
1966     // Close file
1967     fclose($fh);
1968   }
1970   return $result;
1974 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1976   $str = ""; // Our return value will be saved in this var
1978   $color  = dechex($percentage+150);
1979   $color2 = dechex(150 - $percentage);
1980   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1982   $progress = (int)(($percentage /100)*$width);
1984   /* If theres a better solution for this, use it... */
1985   $str = "\n   <div style=\" width:".($width)."px; ";
1986   $str.= "\n       height:".($height)."px; ";
1987   $str.= "\n       background-color:#000000; ";
1988   $str.= "\n       padding:1px;\" > ";
1990   $str.= "\n     <div style=\" width:".($width)."px; ";
1991   $str.= "\n         background-color:#$bgcolor; ";
1992   $str.= "\n         height:".($height)."px;\" > ";
1994   if(($height >10)&&($showvalue)){
1995     $str.= "\n   <font style=\"font-size:".($height-2)."px; ";
1996     $str.= "\n     color:#FF0000; align:middle; ";
1997     $str.= "\n     padding-left:".((int)(($width*0.4)))."px; \"> ";
1998     $str.= "\n     <b>".$percentage."%</b> ";
1999     $str.= "\n   </font> ";
2000   }
2002   $str.= "\n       <div style=\" width:".$progress."px; ";
2003   $str.= "\n         height:".$height."px; ";
2004   $str.= "\n         background-color:#".$color2.$color2.$color."; \" >";
2005   $str.= "\n       </div>";
2006   $str.= "\n     </div>";
2007   $str.= "\n   </div>";
2009   return($str);
2013 function array_key_ics($ikey, $items)
2015   /* Gather keys, make them lowercase */
2016   $tmp= array();
2017   foreach ($items as $key => $value){
2018     $tmp[strtolower($key)]= $key;
2019   }
2021   if (isset($tmp[strtolower($ikey)])){
2022     return($tmp[strtolower($ikey)]);
2023   }
2025   return ("");
2029 function array_differs($src, $dst)
2031   /* If the count is differing, the arrays differ */
2032   if (count ($src) != count ($dst)){
2033     return (TRUE);
2034   }
2036   /* So the count is the same - lets check the contents */
2037   $differs= FALSE;
2038   foreach($src as $value){
2039     if (!in_array($value, $dst)){
2040       $differs= TRUE;
2041     }
2042   }
2044   return ($differs);
2048 function saveFilter($a_filter, $values)
2050   if (isset($_POST['regexit'])){
2051     $a_filter["regex"]= $_POST['regexit'];
2053     foreach($values as $type){
2054       if (isset($_POST[$type])) {
2055         $a_filter[$type]= "checked";
2056       } else {
2057         $a_filter[$type]= "";
2058       }
2059     }
2060   }
2062   /* React on alphabet links if needed */
2063   if (isset($_GET['search'])){
2064     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2065     if ($s == "**"){
2066       $s= "*";
2067     }
2068     $a_filter['regex']= $s;
2069   }
2071   return ($a_filter);
2075 /* Escape all preg_* relevant characters */
2076 function normalizePreg($input)
2078   return (addcslashes($input, '[]()|/.*+-'));
2082 /* Escape all LDAP filter relevant characters */
2083 function normalizeLdap($input)
2085   return (addcslashes($input, '()|'));
2089 /* Resturns the difference between to microtime() results in float  */
2090 function get_MicroTimeDiff($start , $stop)
2092   $a = split("\ ",$start);
2093   $b = split("\ ",$stop);
2095   $secs = $b[1] - $a[1];
2096   $msecs= $b[0] - $a[0]; 
2098   $ret = (float) ($secs+ $msecs);
2099   return($ret);
2103 function get_base_dir()
2105   global $BASE_DIR;
2107   return $BASE_DIR;
2111 function obj_is_readable($dn, $object, $attribute)
2113   global $ui;
2115   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2119 function obj_is_writable($dn, $object, $attribute)
2121   global $ui;
2123   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2127 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2129   /* Initialize variables */
2130   $ret  = array("count" => 0);  // Set count to 0
2131   $next = true;                 // if false, then skip next loops and return
2132   $cnt  = 0;                    // Current number of loops
2133   $max  = 100;                  // Just for security, prevent looops
2134   $ldap = NULL;                 // To check if created result a valid
2135   $keep = "";                   // save last failed parse string
2137   /* Check each parsed dn in ldap ? */
2138   if($config!==NULL && $verify_in_ldap){
2139     $ldap = $config->get_ldap_link();
2140   }
2142   /* Lets start */
2143   $called = false;
2144   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2146     $cnt ++;
2147     if(!preg_match("/,/",$dn)){
2148       $next = false;
2149     }
2150     $object = preg_replace("/[,].*$/","",$dn);
2151     $dn     = preg_replace("/^[^,]+,/","",$dn);
2153     $called = true;
2155     /* Check if current dn is valid */
2156     if($ldap!==NULL){
2157       $ldap->cd($dn);
2158       $ldap->cat($dn,array("dn"));
2159       if($ldap->count()){
2160         $ret[]  = $keep.$object;
2161         $keep   = "";
2162       }else{
2163         $keep  .= $object.",";
2164       }
2165     }else{
2166       $ret[]  = $keep.$object;
2167       $keep   = "";
2168     }
2169   }
2171   /* No dn was posted */
2172   if($cnt == 0 && !empty($dn)){
2173     $ret[] = $dn;
2174   }
2176   /* Append the rest */
2177   $test = $keep.$dn;
2178   if($called && !empty($test)){
2179     $ret[] = $keep.$dn;
2180   }
2181   $ret['count'] = count($ret) - 1;
2183   return($ret);
2187 function get_base_from_hook($dn, $attrib)
2189   global $config;
2191   if ($config->get_cfg_value("base_hook") != ""){
2192     
2193     /* Call hook script - if present */
2194     $command= $config->get_cfg_value("base_hook");
2196     if ($command != ""){
2197       $command.= " '".LDAP::fix($dn)."' $attrib";
2198       if (check_command($command)){
2199         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2200         exec($command, $output);
2201         if (preg_match("/^[0-9]+$/", $output[0])){
2202           return ($output[0]);
2203         } else {
2204           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2205           return ($config->get_cfg_value("uidbase"));
2206         }
2207       } else {
2208         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2209         return ($config->get_cfg_value("uidbase"));
2210       }
2212     } else {
2214       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base!"), WARNING_DIALOG);
2215       return ($config->get_cfg_value("uidbase"));
2217     }
2218   }
2222 function check_schema_version($class, $version)
2224   return preg_match("/\(v$version\)/", $class['DESC']);
2228 function check_schema($cfg,$rfc2307bis = FALSE)
2230   $messages= array();
2232   /* Get objectclasses */
2233   $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']));
2234   $objectclasses = $ldap->get_objectclasses();
2235   if(count($objectclasses) == 0){
2236     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2237   }
2239   /* This is the default block used for each entry.
2240    *  to avoid unset indexes.
2241    */
2242   $def_check = array("REQUIRED_VERSION" => "0",
2243       "SCHEMA_FILES"     => array(),
2244       "CLASSES_REQUIRED" => array(),
2245       "STATUS"           => FALSE,
2246       "IS_MUST_HAVE"     => FALSE,
2247       "MSG"              => "",
2248       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2250   /* The gosa base schema */
2251   $checks['gosaObject'] = $def_check;
2252   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2253   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2254   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2255   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2257   /* GOsa Account class */
2258   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2259   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2260   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2261   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2262   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2264   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2265   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2266   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2267   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2268   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2269   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2271   /* Some other checks */
2272   foreach(array(
2273         "gosaCacheEntry"        => array("version" => "2.4"),
2274         "gosaDepartment"        => array("version" => "2.4"),
2275         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2276         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2277         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2278         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2279         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2280         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2281         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2282         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2283         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2284         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2285         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2286         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2287         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2288         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2289         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2290         "goLdapServer"          => array("version" => "2.4"),
2291         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2292         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2293         "goKrbServer"           => array("version" => "2.4"),
2294         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2295         ) as $name => $values){
2297           $checks[$name] = $def_check;
2298           if(isset($values['version'])){
2299             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2300           }
2301           if(isset($values['file'])){
2302             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2303           }
2304           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2305         }
2306   foreach($checks as $name => $value){
2307     foreach($value['CLASSES_REQUIRED'] as $class){
2309       if(!isset($objectclasses[$name])){
2310         $checks[$name]['STATUS'] = FALSE;
2311         if($value['IS_MUST_HAVE']){
2312           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2313         }else{
2314           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2315         }
2316       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2317         $checks[$name]['STATUS'] = FALSE;
2319         if($value['IS_MUST_HAVE']){
2320           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2321         }else{
2322           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2323         }
2324       }else{
2325         $checks[$name]['STATUS'] = TRUE;
2326         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2327       }
2328     }
2329   }
2331   $tmp = $objectclasses;
2333   /* The gosa base schema */
2334   $checks['posixGroup'] = $def_check;
2335   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2336   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2337   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2338   $checks['posixGroup']['STATUS']           = TRUE;
2339   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2340   $checks['posixGroup']['MSG']              = "";
2341   $checks['posixGroup']['INFO']             = "";
2343   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2344   if(isset($tmp['posixGroup'])){
2346     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2347       $checks['posixGroup']['STATUS']           = FALSE;
2348       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2349       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2350     }
2351     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2352       $checks['posixGroup']['STATUS']           = FALSE;
2353       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2354       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2355     }
2356   }
2358   return($checks);
2362 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2364   $tmp = array(
2365         "de_DE" => "German",
2366         "fr_FR" => "French",
2367         "it_IT" => "Italian",
2368         "es_ES" => "Spanish",
2369         "en_US" => "English",
2370         "nl_NL" => "Dutch",
2371         "pl_PL" => "Polish",
2372         "sv_SE" => "Swedish",
2373         "zh_CN" => "Chinese",
2374         "vi_VN" => "Vietnamese",
2375         "ru_RU" => "Russian");
2376   
2377   $tmp2= array(
2378         "de_DE" => _("German"),
2379         "fr_FR" => _("French"),
2380         "it_IT" => _("Italian"),
2381         "es_ES" => _("Spanish"),
2382         "en_US" => _("English"),
2383         "nl_NL" => _("Dutch"),
2384         "pl_PL" => _("Polish"),
2385         "sv_SE" => _("Swedish"),
2386         "zh_CN" => _("Chinese"),
2387         "vi_VN" => _("Vietnamese"),
2388         "ru_RU" => _("Russian"));
2390   $ret = array();
2391   if($languages_in_own_language){
2393     $old_lang = setlocale(LC_ALL, 0);
2395     /* If the locale wasn't correclty set before, there may be an incorrect
2396         locale returned. Something like this: 
2397           C_CTYPE=de_DE.UTF-8;LC_NUMERIC=C;LC_TIME=de_DE.UTF-8;LC ...
2398         Extract the locale name from this string and use it to restore old locale.
2399      */
2400     if(preg_match("/LC_CTYPE/",$old_lang)){
2401       $old_lang = preg_replace("/^.*LC_CTYPE=([^;]*).*$/","\\1",$old_lang);
2402     }
2403     
2404     foreach($tmp as $key => $name){
2405       $lang = $key.".UTF-8";
2406       setlocale(LC_ALL, $lang);
2407       if($strip_region_tag){
2408         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2409       }else{
2410         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2411       }
2412     }
2413     setlocale(LC_ALL, $old_lang);
2414   }else{
2415     foreach($tmp as $key => $name){
2416       if($strip_region_tag){
2417         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2418       }else{
2419         $ret[$key] = _($name);
2420       }
2421     }
2422   }
2423   return($ret);
2427 /* Returns contents of the given POST variable and check magic quotes settings */
2428 function get_post($name)
2430   if(!isset($_POST[$name])){
2431     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2432     return(FALSE);
2433   }
2434   if(get_magic_quotes_gpc()){
2435     return(stripcslashes($_POST[$name]));
2436   }else{
2437     return($_POST[$name]);
2438   }
2442 /* Return class name in correct case */
2443 function get_correct_class_name($cls)
2445   global $class_mapping;
2446   if(isset($class_mapping) && is_array($class_mapping)){
2447     foreach($class_mapping as $class => $file){
2448       if(preg_match("/^".$cls."$/i",$class)){
2449         return($class);
2450       }
2451     }
2452   }
2453   return(FALSE);
2457 // change_password, changes the Password, of the given dn
2458 function change_password ($dn, $password, $mode=0, $hash= "")
2460   global $config;
2461   $newpass= "";
2463   /* Convert to lower. Methods are lowercase */
2464   $hash= strtolower($hash);
2466   // Get all available encryption Methods
2468   // NON STATIC CALL :)
2469   $methods = new passwordMethod(session::get('config'));
2470   $available = $methods->get_available_methods();
2472   // read current password entry for $dn, to detect the encryption Method
2473   $ldap       = $config->get_ldap_link();
2474   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2475   $attrs      = $ldap->fetch ();
2477   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2478   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2479     $deactivated = TRUE;
2480   }else{
2481     $deactivated = FALSE;
2482   }
2484   /* Is ensure that clear passwords will stay clear */
2485   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2486     $hash = "clear";
2487   }
2489   // Detect the encryption Method
2490   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2492     /* Check for supported algorithm */
2493     mt_srand((double) microtime()*1000000);
2495     /* Extract used hash */
2496     if ($hash == ""){
2497       $test = passwordMethod::get_method($attrs['userPassword'][0],$dn);
2498     } else {
2499       $test = new $available[$hash]($config,$dn);
2500       $test->set_hash($hash);
2501     }
2503   } else {
2504     // User MD5 by default
2505     $hash= "md5";
2506     $test = new  $available['md5']($config);
2507   }
2509   /* Feed password backends with information */
2510   $test->dn= $dn;
2511   $test->attrs= $attrs;
2512   $newpass= $test->generate_hash($password);
2514   // Update shadow timestamp?
2515   if (isset($attrs["shadowLastChange"][0])){
2516     $shadow= (int)(date("U") / 86400);
2517   } else {
2518     $shadow= 0;
2519   }
2521   // Write back modified entry
2522   $ldap->cd($dn);
2523   $attrs= array();
2525   // Not for groups
2526   if ($mode == 0){
2528     if ($shadow != 0){
2529       $attrs['shadowLastChange']= $shadow;
2530     }
2532     // Create SMB Password
2533     $attrs= generate_smb_nt_hash($password);
2534   }
2536  /* Read ! if user was deactivated */
2537   if($deactivated){
2538     $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass);
2539   }
2541   $attrs['userPassword']= array();
2542   $attrs['userPassword']= $newpass;
2544   $ldap->modify($attrs);
2546   new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
2548   if (!$ldap->success()) {
2549     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG));
2550   } else {
2552     /* Run backend method for change/create */
2553     if(!$test->set_password($password)){
2554       return(FALSE);
2555     }
2557     /* Find postmodify entries for this class */
2558     $command= $config->search("password", "POSTMODIFY",array('menu'));
2560     if ($command != ""){
2561       /* Walk through attribute list */
2562       $command= preg_replace("/%userPassword/", $password, $command);
2563       $command= preg_replace("/%dn/", $dn, $command);
2565       if (check_command($command)){
2566         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2567         exec($command);
2568       } else {
2569         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2570         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2571       }
2572     }
2573   }
2574   return(TRUE);
2578 // Return something like array['sambaLMPassword']= "lalla..."
2579 function generate_smb_nt_hash($password)
2581   global $config;
2583   # Try to use gosa-si?
2584   if ($config->get_cfg_value("gosa_si") != ""){
2585         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2586     if (isset($res['XML']['HASH'])){
2587         $hash= $res['XML']['HASH'];
2588     } else {
2589       $hash= "";
2590     }
2591   } else {
2592           $tmp= $config->get_cfg_value('smbhash')." ".escapeshellarg($password);
2593           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2595           exec($tmp, $ar);
2596           flush();
2597           reset($ar);
2598           $hash= current($ar);
2599   }
2601   if ($hash == "") {
2602           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2603           return ("");
2604   }
2606   list($lm,$nt)= split (":", trim($hash));
2608   if ($config->get_cfg_value("sambaversion") == 3) {
2609           $attrs['sambaLMPassword']= $lm;
2610           $attrs['sambaNTPassword']= $nt;
2611           $attrs['sambaPwdLastSet']= date('U');
2612           $attrs['sambaBadPasswordCount']= "0";
2613           $attrs['sambaBadPasswordTime']= "0";
2614   } else {
2615           $attrs['lmPassword']= $lm;
2616           $attrs['ntPassword']= $nt;
2617           $attrs['pwdLastSet']= date('U');
2618   }
2619   return($attrs);
2623 function getEntryCSN($dn)
2625   global $config;
2626   if(empty($dn) || !is_object($config)){
2627     return("");
2628   }
2630   /* Get attribute that we should use as serial number */
2631   $attr= $config->get_cfg_value("uniq_identifier");
2632   if($attr != ""){
2633     $ldap = $config->get_ldap_link();
2634     $ldap->cat($dn,array($attr));
2635     $csn = $ldap->fetch();
2636     if(isset($csn[$attr][0])){
2637       return($csn[$attr][0]);
2638     }
2639   }
2640   return("");
2644 /* Add a given objectClass to an attrs entry */
2645 function add_objectClass($classes, &$attrs)
2647   if (is_array($classes)){
2648     $list= $classes;
2649   } else {
2650     $list= array($classes);
2651   }
2653   foreach ($list as $class){
2654     $attrs['objectClass'][]= $class;
2655   }
2659 /* Removes a given objectClass from the attrs entry */
2660 function remove_objectClass($classes, &$attrs)
2662   if (isset($attrs['objectClass'])){
2663     /* Array? */
2664     if (is_array($classes)){
2665       $list= $classes;
2666     } else {
2667       $list= array($classes);
2668     }
2670     $tmp= array();
2671     foreach ($attrs['objectClass'] as $oc) {
2672       foreach ($list as $class){
2673         if (strtolower($oc) != strtolower($class)){
2674           $tmp[]= $oc;
2675         }
2676       }
2677     }
2678     $attrs['objectClass']= $tmp;
2679   }
2682 /*! \brief  Initialize a file download with given content, name and data type. 
2683  *  @param  data  String The content to send.
2684  *  @param  name  String The name of the file.
2685  *  @param  type  String The content identifier, default value is "application/octet-stream";
2686  */
2687 function send_binary_content($data,$name,$type = "application/octet-stream")
2689   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2690   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2691   header("Cache-Control: no-cache");
2692   header("Pragma: no-cache");
2693   header("Cache-Control: post-check=0, pre-check=0");
2694   header("Content-type: ".$type."");
2696   $HTTP_USER_AGENT = $_SERVER['HTTP_USER_AGENT'];
2698   /* Strip name if it is a complete path */
2699   if (preg_match ("/\//", $name)) {
2700         $name= basename($name);
2701   }
2702   
2703   /* force download dialog */
2704   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2705     header('Content-Disposition: filename="'.$name.'"');
2706   } else {
2707     header('Content-Disposition: attachment; filename="'.$name.'"');
2708   }
2710   echo $data;
2711   exit();
2715 function reverse_html_entities($str,$type = ENT_QUOTES , $charset = "UTF-8")
2717   if(is_string($str)){
2718     return(htmlentities($str,$type,$charset));
2719   }elseif(is_array($str)){
2720     foreach($str as $name => $value){
2721       $str[$name] = reverse_html_entities($value,$type,$charset);
2722     }
2723   }
2724   return($str);
2728 /*! \brief Encode special string characters so we can use the string in \
2729            HTML output, without breaking quotes.
2730     @param  The String we want to encode.
2731     @return The encoded String
2732  */
2733 function xmlentities($str)
2734
2735   if(is_string($str)){
2737     static $asc2uni= array();
2738     if (!count($asc2uni)){
2739       for($i=128;$i<256;$i++){
2740     #    $asc2uni[chr($i)] = "&#x".dechex($i).";";
2741       }
2742     }
2744     $str = str_replace("&", "&amp;", $str);
2745     $str = str_replace("<", "&lt;", $str);
2746     $str = str_replace(">", "&gt;", $str);
2747     $str = str_replace("'", "&apos;", $str);
2748     $str = str_replace("\"", "&quot;", $str);
2749     $str = str_replace("\r", "", $str);
2750     $str = strtr($str,$asc2uni);
2751     return $str;
2752   }elseif(is_array($str)){
2753     foreach($str as $name => $value){
2754       $str[$name] = xmlentities($value);
2755     }
2756   }
2757   return($str);
2761 /*! \brief  Updates all accessTo attributes from a given value to a new one.
2762             For example if a host is renamed.
2763     @param  String  $from The source accessTo name.
2764     @param  String  $to   The destination accessTo name.
2765 */
2766 function update_accessTo($from,$to)
2768   global $config;
2769   $ldap = $config->get_ldap_link();
2770   $ldap->cd($config->current['BASE']);
2771   $ldap->search("(&(objectClass=trustAccount)(accessTo=".$from."))",array("objectClass","accessTo"));
2772   while($attrs = $ldap->fetch()){
2773     $new_attrs = array("accessTo" => array());
2774     $dn = $attrs['dn'];
2775     for($i = 0 ; $i < $attrs['objectClass']['count']; $i++){
2776       $new_attrs['objectClass'][] =  $attrs['objectClass'][$i];
2777     }
2778     for($i = 0 ; $i < $attrs['accessTo']['count']; $i++){
2779       if($attrs['accessTo'][$i] == $from){
2780         if(!empty($to)){
2781           $new_attrs['accessTo'][] =  $to;
2782         }
2783       }else{
2784         $new_attrs['accessTo'][] =  $attrs['accessTo'][$i]; 
2785       }
2786     }
2787     $ldap->cd($dn);
2788     $ldap->modify($new_attrs);
2789     if (!$ldap->success()){
2790       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, "update_accessTo($from,$to)"));
2791     }
2792     new log("modify","update_accessTo($from,$to)",$dn,array_keys($new_attrs),$ldap->get_error());
2793   }
2797 function get_random_char () {
2798      $randno = rand (0, 63);
2799      if ($randno < 12) {
2800          return (chr ($randno + 46)); // Digits, '/' and '.'
2801      } else if ($randno < 38) {
2802          return (chr ($randno + 53)); // Uppercase
2803      } else {
2804          return (chr ($randno + 59)); // Lowercase
2805      }
2809 function cred_encrypt($input, $password) {
2811   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
2812   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
2814   return bin2hex(mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $password, $input, MCRYPT_MODE_ECB, $iv));
2818 function cred_decrypt($input,$password) {
2819   $size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
2820   $iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
2822   return mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $password, pack("H*", $input), MCRYPT_MODE_ECB, $iv);
2826 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2827 ?>