Code

Removed Back
[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 */
24 define ("CONFIG_DIR", "/etc/gosa");
25 define ("CONFIG_FILE", "gosa.conf-trunk");
26 define ("CONFIG_TEMPLATE_DIR", "../contrib/");
27 define ("HELP_BASEDIR", "/var/www/doc/");
29 /* Define get_list flags */
30 define("GL_NONE",         0);
31 define("GL_SUBSEARCH",    1);
32 define("GL_SIZELIMIT",    2);
33 define("GL_CONVERT",      4);
34 define("GL_NO_ACL_CHECK", 8);
36 /* Heimdal stuff */
37 define('UNIVERSAL',0x00);
38 define('INTEGER',0x02);
39 define('OCTET_STRING',0x04);
40 define('OBJECT_IDENTIFIER ',0x06);
41 define('SEQUENCE',0x10);
42 define('SEQUENCE_OF',0x10);
43 define('SET',0x11);
44 define('SET_OF',0x11);
45 define('DEBUG',false);
46 define('HDB_KU_MKEY',0x484442);
47 define('TWO_BIT_SHIFTS',0x7efc);
48 define('DES_CBC_CRC',1);
49 define('DES_CBC_MD4',2);
50 define('DES_CBC_MD5',3);
51 define('DES3_CBC_MD5',5);
52 define('DES3_CBC_SHA1',16);
54 /* Define globals for revision comparing */
55 $svn_path = '$HeadURL: https://oss.gonicus.de/repositories/gosa/trunk/gosa-core/include/functions.inc $';
56 $svn_revision = '$Revision: 9246 $';
58 /* Include required files */
59 require_once("class_location.inc");
60 require_once ("functions_debug.inc");
61 require_once ("accept-to-gettext.inc");
63 /* Define constants for debugging */
64 define ("DEBUG_TRACE",   1);
65 define ("DEBUG_LDAP",    2);
66 define ("DEBUG_MYSQL",   4);
67 define ("DEBUG_SHELL",   8);
68 define ("DEBUG_POST",   16);
69 define ("DEBUG_SESSION",32);
70 define ("DEBUG_CONFIG", 64);
71 define ("DEBUG_ACL",    128);
73 /* Rewrite german 'umlauts' and spanish 'accents'
74    to get better results */
75 $REWRITE= array( "ä" => "ae",
76     "ö" => "oe",
77     "ü" => "ue",
78     "Ä" => "Ae",
79     "Ö" => "Oe",
80     "Ü" => "Ue",
81     "ß" => "ss",
82     "á" => "a",
83     "é" => "e",
84     "í" => "i",
85     "ó" => "o",
86     "ú" => "u",
87     "Á" => "A",
88     "É" => "E",
89     "Í" => "I",
90     "Ó" => "O",
91     "Ú" => "U",
92     "ñ" => "ny",
93     "Ñ" => "Ny" );
96 /* Class autoloader */
97 function __autoload($class_name) {
98     global $class_mapping, $BASE_DIR;
100     if ($class_mapping === NULL){
101             echo sprintf(_("Fatal error: no class locations defined - please run '%s' to fix this"), "<b>update-gosa</b>");
102             exit;
103     }
105     if (isset($class_mapping[$class_name])){
106       require_once($BASE_DIR."/".$class_mapping[$class_name]);
107     } else {
108       echo sprintf(_("Fatal error: cannot instantiate class '%s' - try running '%s' to fix this"), $class_name, "<b>update-gosa</b>");
109       exit;
110     }
114 /*! \brief Checks if a class is available. 
115  *  @param  name String  The class name.
116  *  @return boolean      True if class is available, else false.
117  */
118 function class_available($name)
120   global $class_mapping;
121   return(isset($class_mapping[$name]));
125 /* Check if plugin is avaliable */
126 function plugin_available($plugin)
128         global $class_mapping, $BASE_DIR;
130         if (!isset($class_mapping[$plugin])){
131                 return false;
132         } else {
133                 return is_readable($BASE_DIR."/".$class_mapping[$plugin]);
134         }
138 /* Create seed with microseconds */
139 function make_seed() {
140   list($usec, $sec) = explode(' ', microtime());
141   return (float) $sec + ((float) $usec * 100000);
145 /* Debug level action */
146 function DEBUG($level, $line, $function, $file, $data, $info="")
148   if (session::get('DEBUGLEVEL') & $level){
149     $output= "DEBUG[$level] ";
150     if ($function != ""){
151       $output.= "($file:$function():$line) - $info: ";
152     } else {
153       $output.= "($file:$line) - $info: ";
154     }
155     echo $output;
156     if (is_array($data)){
157       print_a($data);
158     } else {
159       echo "'$data'";
160     }
161     echo "<br>";
162   }
166 function get_browser_language()
168   /* Try to use users primary language */
169   global $config;
170   $ui= get_userinfo();
171   if (isset($ui) && $ui !== NULL){
172     if ($ui->language != ""){
173       return ($ui->language.".UTF-8");
174     }
175   }
177   /* Check for global language settings in gosa.conf */
178   if(isset($config->data['MAIN']['LANG']) && !empty($config->data['MAIN']['LANG'])) {
179     $lang = $config->data['MAIN']['LANG'];
180     if(!preg_match("/utf/i",$lang)){
181       $lang .= ".UTF-8";
182     }
183     return($lang);
184   }
185  
186   /* Load supported languages */
187   $gosa_languages= get_languages();
189   /* Move supported languages to flat list */
190   $langs= array();
191   foreach($gosa_languages as $lang => $dummy){
192     $langs[]= $lang.'.UTF-8';
193   }
195   /* Return gettext based string */
196   return (al2gt($langs, 'text/html'));
200 /* Rewrite ui object to another dn */
201 function change_ui_dn($dn, $newdn)
203   $ui= session::get('ui');
204   if ($ui->dn == $dn){
205     $ui->dn= $newdn;
206     session::set('ui',$ui);
207   }
211 /* Return theme path for specified file */
212 function get_template_path($filename= '', $plugin= FALSE, $path= "")
214   global $config, $BASE_DIR;
216   if (!@isset($config->data['MAIN']['THEME'])){
217     $theme= 'default';
218   } else {
219     $theme= $config->data['MAIN']['THEME'];
220   }
222   /* Return path for empty filename */
223   if ($filename == ''){
224     return ("themes/$theme/");
225   }
227   /* Return plugin dir or root directory? */
228   if ($plugin){
229     if ($path == ""){
230       $nf= preg_replace("!^".$BASE_DIR."/!", "", session::get('plugin_dir'));
231     } else {
232       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
233     }
234     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
235       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
236     }
237     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
238       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
239     }
240     if ($path == ""){
241       return (session::get('plugin_dir')."/$filename");
242     } else {
243       return ($path."/$filename");
244     }
245   } else {
246     if (file_exists("themes/$theme/$filename")){
247       return ("themes/$theme/$filename");
248     }
249     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
250       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
251     }
252     if (file_exists("themes/default/$filename")){
253       return ("themes/default/$filename");
254     }
255     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
256       return ("$BASE_DIR/ihtml/themes/default/$filename");
257     }
258     return ($filename);
259   }
263 function array_remove_entries($needles, $haystack)
265   $tmp= array();
267   /* Loop through entries to be removed */
268   foreach ($haystack as $entry){
269     if (!in_array($entry, $needles)){
270       $tmp[]= $entry;
271     }
272   }
274   return ($tmp);
278 function gosa_array_merge($ar1,$ar2)
280   if(!is_array($ar1) || !is_array($ar2)){
281     trigger_error("Specified parameter(s) are not valid arrays.");
282   }else{
283     return(array_values(array_unique(array_merge($ar1,$ar2))));
284   }
288 function gosa_log ($message)
290   global $ui;
292   /* Preset to something reasonable */
293   $username= " unauthenticated";
295   /* Replace username if object is present */
296   if (isset($ui)){
297     if ($ui->username != ""){
298       $username= "[$ui->username]";
299     } else {
300       $username= "unknown";
301     }
302   }
304   syslog(LOG_INFO,"GOsa$username: $message");
308 function ldap_init ($server, $base, $binddn='', $pass='')
310   global $config;
312   $ldap = new LDAP ($binddn, $pass, $server,
313       isset($config->current['RECURSIVE']) && $config->current['RECURSIVE'] == "true",
314       isset($config->current['TLS']) && $config->current['TLS'] == "true");
316   /* Sadly we've no proper return values here. Use the error message instead. */
317   if (!$ldap->success()){
318     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
319     exit();
320   }
322   /* Preset connection base to $base and return to caller */
323   $ldap->cd ($base);
324   return $ldap;
328 function process_htaccess ($username, $kerberos= FALSE)
330   global $config;
332   /* Search for $username and optional @REALM in all configured LDAP trees */
333   foreach($config->data["LOCATIONS"] as $name => $data){
334   
335     $config->set_current($name);
336     $mode= "kerberos";
337     if (isset($config->current['KRBSASL']) && preg_match('/^true$/i', $config->current['KRBSASL'])){
338       $mode= "sasl";
339     }
341     /* Look for entry or realm */
342     $ldap= $config->get_ldap_link();
343     if (!$ldap->success()){
344       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH, ERROR_DIALOG));
345       $smarty= get_smarty();
346       $smarty->display(get_template_path('headers.tpl'));
347       echo "<body>".session::get('errors')."</body></html>";
348       exit();
349     }
350     $ldap->search("(&(objectClass=gosaAccount)(|(uid=$username)(userPassword={$mode}$username)))", array("uid"));
352     /* Found a uniq match? Return it... */
353     if ($ldap->count() == 1) {
354       $attrs= $ldap->fetch();
355       return array("username" => $attrs["uid"][0], "server" => $name);
356     }
357   }
359   /* Nothing found? Return emtpy array */
360   return array("username" => "", "server" => "");
364 function ldap_login_user_htaccess ($username)
366   global $config;
368   /* Look for entry or realm */
369   $ldap= $config->get_ldap_link();
370   if (!$ldap->success()){
371     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_AUTH, FATAL_ERROR_DIALOG));
372     $smarty= get_smarty();
373     $smarty->display(get_template_path('headers.tpl'));
374     echo "<body>".session::get('errors')."</body></html>";
375     exit();
376   }
377   $ldap->search("(&(objectClass=gosaAccount)(uid=$username))", array("uid"));
378   /* Found no uniq match? Strange, because we did above... */
379   if ($ldap->count() != 1) {
380     msg_dialog::display(_("LDAP error"), _("Username / UID is not unique inside the LDAP tree!"), FATAL_ERROR_DIALOG);
381     return (NULL);
382   }
383   $attrs= $ldap->fetch();
385   /* got user dn, fill acl's */
386   $ui= new userinfo($config, $ldap->getDN());
387   $ui->username= $attrs['uid'][0];
389   /* No password check needed - the webserver did it for us */
390   $ldap->disconnect();
392   /* Username is set, load subtreeACL's now */
393   $ui->loadACL();
395   /* TODO: check java script for htaccess authentication */
396   session::set('js',true);
398   return ($ui);
402 function ldap_login_user ($username, $password)
404   global $config;
406   /* look through the entire ldap */
407   $ldap = $config->get_ldap_link();
408   if (!$ldap->success()){
409     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error()), FATAL_ERROR_DIALOG);
410     $smarty= get_smarty();
411     $smarty->display(get_template_path('headers.tpl'));
412     echo "<body>".session::get('errors')."</body></html>";
413     exit();
414   }
415   $ldap->cd($config->current['BASE']);
416   $allowed_attributes = array("uid","mail");
417   $verify_attr = array();
418   if(isset($config->current['LOGIN_ATTRIBUTE'])){
419     $tmp = split(",",$config->current['LOGIN_ATTRIBUTE']); 
420     foreach($tmp as $attr){
421       if(in_array($attr,$allowed_attributes)){
422         $verify_attr[] = $attr;
423       }
424     }
425   }
426   if(count($verify_attr) == 0){
427     $verify_attr = array("uid");
428   }
429   $tmp= $verify_attr;
430   $tmp[] = "uid";
431   $filter = "";
432   foreach($verify_attr as $attr) {
433     $filter.= "(".$attr."=".$username.")";
434   }
435   $filter = "(&(|".$filter.")(objectClass=gosaAccount))";
436   $ldap->search($filter,$tmp);
438   /* get results, only a count of 1 is valid */
439   switch ($ldap->count()){
441     /* user not found */
442     case 0:     return (NULL);
444             /* valid uniq user */
445     case 1: 
446             break;
448             /* found more than one matching id */
449     default:
450             msg_dialog::display(_("Internal error"), _("Username / UID is not unique inside the LDAP tree. Please contact your Administrator."), FATAL_ERROR_DIALOG);
451             return (NULL);
452   }
454   /* LDAP schema is not case sensitive. Perform additional check. */
455   $attrs= $ldap->fetch();
456   $success = FALSE;
457   foreach($verify_attr as $attr){
458     if(isset($attrs[$attr][0]) && $attrs[$attr][0] == $username){
459       $success = TRUE;
460     }
461   }
462   if(!$success){
463     return(FALSE);
464   }
466   /* got user dn, fill acl's */
467   $ui= new userinfo($config, $ldap->getDN());
468   $ui->username= $attrs['uid'][0];
470   /* password check, bind as user with supplied password  */
471   $ldap->disconnect();
472   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
473       isset($config->current['RECURSIVE']) &&
474       $config->current['RECURSIVE'] == "true",
475       isset($config->current['TLS'])
476       && $config->current['TLS'] == "true");
477   if (!$ldap->success()){
478     return (NULL);
479   }
481   /* Username is set, load subtreeACL's now */
482   $ui->loadACL();
484   return ($ui);
488 function ldap_expired_account($config, $userdn, $username)
490     $ldap= $config->get_ldap_link();
491     $ldap->cat($userdn);
492     $attrs= $ldap->fetch();
493     
494     /* default value no errors */
495     $expired = 0;
496     
497     $sExpire = 0;
498     $sLastChange = 0;
499     $sMax = 0;
500     $sMin = 0;
501     $sInactive = 0;
502     $sWarning = 0;
503     
504     $current= date("U");
505     
506     $current= floor($current /60 /60 /24);
507     
508     /* special case of the admin, should never been locked */
509     /* FIXME should allow any name as user admin */
510     if($username != "admin")
511     {
513       if(isset($attrs['shadowExpire'][0])){
514         $sExpire= $attrs['shadowExpire'][0];
515       } else {
516         $sExpire = 0;
517       }
518       
519       if(isset($attrs['shadowLastChange'][0])){
520         $sLastChange= $attrs['shadowLastChange'][0];
521       } else {
522         $sLastChange = 0;
523       }
524       
525       if(isset($attrs['shadowMax'][0])){
526         $sMax= $attrs['shadowMax'][0];
527       } else {
528         $smax = 0;
529       }
531       if(isset($attrs['shadowMin'][0])){
532         $sMin= $attrs['shadowMin'][0];
533       } else {
534         $sMin = 0;
535       }
536       
537       if(isset($attrs['shadowInactive'][0])){
538         $sInactive= $attrs['shadowInactive'][0];
539       } else {
540         $sInactive = 0;
541       }
542       
543       if(isset($attrs['shadowWarning'][0])){
544         $sWarning= $attrs['shadowWarning'][0];
545       } else {
546         $sWarning = 0;
547       }
548       
549       /* is the account locked */
550       /* shadowExpire + shadowInactive (option) */
551       if($sExpire >0){
552         if($current >= ($sExpire+$sInactive)){
553           return(1);
554         }
555       }
556     
557       /* the user should be warned to change is password */
558       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
559         if (($sExpire - $current) < $sWarning){
560           return(2);
561         }
562       }
563       
564       /* force user to change password */
565       if(($sLastChange >0) && ($sMax) >0){
566         if($current >= ($sLastChange+$sMax)){
567           return(3);
568         }
569       }
570       
571       /* the user should not be able to change is password */
572       if(($sLastChange >0) && ($sMin >0)){
573         if (($sLastChange + $sMin) >= $current){
574           return(4);
575         }
576       }
577     }
578    return($expired);
582 function add_lock ($object, $user)
584   global $config;
586   if(is_array($object)){
587     foreach($object as $obj){
588       add_lock($obj,$user);
589     }
590     return;
591   }
593   /* Just a sanity check... */
594   if ($object == "" || $user == ""){
595     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
596     return;
597   }
599   /* Check for existing entries in lock area */
600   $ldap= $config->get_ldap_link();
601   $ldap->cd ($config->current['CONFIG']);
602   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
603       array("gosaUser"));
604   if (!$ldap->success()){
605     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);
606     return;
607   }
609   /* Add lock if none present */
610   if ($ldap->count() == 0){
611     $attrs= array();
612     $name= md5($object);
613     $ldap->cd("cn=$name,".$config->current['CONFIG']);
614     $attrs["objectClass"] = "gosaLockEntry";
615     $attrs["gosaUser"] = $user;
616     $attrs["gosaObject"] = base64_encode($object);
617     $attrs["cn"] = "$name";
618     $ldap->add($attrs);
619     if (!$ldap->success()){
620       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "cn=$name,".$config->current['CONFIG'], 0, ERROR_DIALOG));
621       return;
622     }
623   }
627 function del_lock ($object)
629   global $config;
631   if(is_array($object)){
632     foreach($object as $obj){
633       del_lock($obj);
634     }
635     return;
636   }
638   /* Sanity check */
639   if ($object == ""){
640     return;
641   }
643   /* Check for existance and remove the entry */
644   $ldap= $config->get_ldap_link();
645   $ldap->cd ($config->current['CONFIG']);
646   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
647   $attrs= $ldap->fetch();
648   if ($ldap->getDN() != "" && $ldap->success()){
649     $ldap->rmdir ($ldap->getDN());
651     if (!$ldap->success()){
652       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $ldap->getDN(), LDAP_DEL, ERROR_DIALOG));
653       return;
654     }
655   }
659 function del_user_locks($userdn)
661   global $config;
663   /* Get LDAP ressources */ 
664   $ldap= $config->get_ldap_link();
665   $ldap->cd ($config->current['CONFIG']);
667   /* Remove all objects of this user, drop errors silently in this case. */
668   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
669   while ($attrs= $ldap->fetch()){
670     $ldap->rmdir($attrs['dn']);
671   }
675 function get_lock ($object)
677   global $config;
679   /* Sanity check */
680   if ($object == ""){
681     msg_dialog::display(_("Internal error"), _("Error while adding a lock. Contact the developers!"), ERROR_DIALOG);
682     return("");
683   }
685   /* Get LDAP link, check for presence of the lock entry */
686   $user= "";
687   $ldap= $config->get_ldap_link();
688   $ldap->cd ($config->current['CONFIG']);
689   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
690   if (!$ldap->success()){
691     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
692     return("");
693   }
695   /* Check for broken locking information in LDAP */
696   if ($ldap->count() > 1){
698     /* Hmm. We're removing broken LDAP information here and issue a warning. */
699     msg_dialog::display(_("Warning"), _("Found multiple locks for object to be locked. This should not happen - cleaning up multiple references."), WARNING_DIALOG);
701     /* Clean up these references now... */
702     while ($attrs= $ldap->fetch()){
703       $ldap->rmdir($attrs['dn']);
704     }
706     return("");
708   } elseif ($ldap->count() == 1){
709     $attrs = $ldap->fetch();
710     $user= $attrs['gosaUser'][0];
711   }
712   return ($user);
716 function get_multiple_locks($objects)
718   global $config;
720   if(is_array($objects)){
721     $filter = "(&(objectClass=gosaLockEntry)(|";
722     foreach($objects as $obj){
723       $filter.="(gosaObject=".base64_encode($obj).")";
724     }
725     $filter.= "))";
726   }else{
727     $filter = "(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($objects)."))";
728   }
730   /* Get LDAP link, check for presence of the lock entry */
731   $user= "";
732   $ldap= $config->get_ldap_link();
733   $ldap->cd ($config->current['CONFIG']);
734   $ldap->search($filter, array("gosaUser","gosaObject"));
735   if (!$ldap->success()){
736     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), "", LDAP_SEARCH, ERROR_DIALOG));
737     return("");
738   }
740   $users = array();
741   while($attrs = $ldap->fetch()){
742     $dn   = base64_decode($attrs['gosaObject'][0]);
743     $user = $attrs['gosaUser'][0];
744     $users[] = array("dn"=> $dn,"user"=>$user);
745   }
746   return ($users);
750 /* \!brief  This function searches the ldap database.
751             It search in  $sub_bases,*,$base  for all objects matching the $filter.
753     @param $filter    String The ldap search filter
754     @param $category  String The ACL category the result objects belongs 
755     @param $sub_bases  String The sub base we want to search for e.g. "ou=apps"
756     @param $base      String The ldap base from which we start the search
757     @param $attributes Array The attributes we search for.
758     @param $flags     Long   A set of Flags
759  */
760 function get_sub_list($filter, $category,$sub_deps, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
762   global $config, $ui;
763   $departments = array();
765 #  $start = microtime(TRUE);
767   /* Get LDAP link */
768   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
770   /* Set search base to configured base if $base is empty */
771   if ($base == ""){
772     $base = $config->current['BASE'];
773   }
774   $ldap->cd ($base);
776   /* Ensure we have an array as department list */
777   if(is_string($sub_deps)){
778     $sub_deps = array($sub_deps);
779   }
781   /* Remove ,.*$ ("ou=1,ou=2.." => "ou=1") */
782   $sub_bases = array();
783   foreach($sub_deps as $key => $sub_base){
784     if(empty($sub_base)){
786       /* Subsearch is activated and we got an empty sub_base.
787        *  (This may be the case if you have empty people/group ous).
788        * Fall back to old get_list(). 
789        * A log entry will be written.
790        */
791       if($flags & GL_SUBSEARCH){
792         $sub_bases = array();
793         break;
794       }else{
795         
796         /* Do NOT search within subtrees is requeste and the sub base is empty. 
797          * Append all known departments that matches the base.
798          */
799         $departments[$base] = $base;
800       }
801     }else{
802       $sub_bases[$key] = preg_replace("/,.*$/","",$sub_base);
803     }
804   }
805   
806    /* If there is no sub_department specified, fall back to old method, get_list().
807    */
808   if(!count($sub_bases) && !count($departments)){
809     
810     /* Log this fall back, it may be an unpredicted behaviour.
811      */
812     if(!count($sub_bases) && !count($departments)){
813       // log($action,$objecttype,$object,$changes_array = array(),$result = "") 
814       new log("debug","all",__FILE__,$attributes,
815           sprintf("get_sub_list(): Falling back to get_list(), due to empty sub_bases parameter.".
816             " This may slow down GOsa. Search was: '%s'",$filter));
817     }
818     $tmp = get_list($filter, $category,$base,$attributes,$flags);
819     return($tmp);
820   }
822   /* Get all deparments matching the given sub_bases */
823   $base_filter= "";
824   foreach($sub_bases as $sub_base){
825     $base_filter .= "(".$sub_base.")";
826   }
827   $base_filter = "(&(objectClass=organizationalUnit)(|".$base_filter."))";
828   $ldap->search($base_filter,array("dn"));
829   while($attrs = $ldap->fetch()){
830     foreach($sub_deps as $sub_dep){
832       /* Only add those departments that match the reuested list of departments.
833        *
834        * e.g.   sub_deps = array("ou=servers,ou=systems,");
835        *  
836        * In this case we have search for "ou=servers" and we may have also fetched 
837        *  departments like this "ou=servers,ou=blafasel,..."
838        * Here we filter out those blafasel departments.
839        */
840       if(preg_match("/".normalizePreg($sub_dep)."/",$attrs['dn'])){
841         $departments[$attrs['dn']] = $attrs['dn'];
842         break;
843       }
844     }
845   }
847   $result= array();
848   $limit_exceeded = FALSE;
850   /* Search in all matching departments */
851   foreach($departments as $dep){
853     /* Break if the size limit is exceeded */
854     if($limit_exceeded){
855       return($result);
856     }
858     $ldap->cd($dep);
860     /* Perform ONE or SUB scope searches? */
861     if ($flags & GL_SUBSEARCH) {
862       $ldap->search ($filter, $attributes);
863     } else {
864       $ldap->ls ($filter,$dep,$attributes);
865     }
867     /* Check for size limit exceeded messages for GUI feedback */
868     if (preg_match("/size limit/i", $ldap->get_error())){
869       session::set('limit_exceeded', TRUE);
870       $limit_exceeded = TRUE;
871     }
873     /* Crawl through result entries and perform the migration to the
874      result array */
875     while($attrs = $ldap->fetch()) {
876       $dn= $ldap->getDN();
878       /* Convert dn into a printable format */
879       if ($flags & GL_CONVERT){
880         $attrs["dn"]= convert_department_dn($dn);
881       } else {
882         $attrs["dn"]= $dn;
883       }
885       /* Skip ACL checks if we are forced to skip those checks */
886       if($flags & GL_NO_ACL_CHECK){
887         $result[]= $attrs;
888       }else{
890         /* Sort in every value that fits the permissions */
891         if (is_array($category)){
892           foreach ($category as $o){
893             if ($ui->get_category_permissions($dn, $o) != ""){
894               $result[]= $attrs;
895               break;
896             }
897           }
898         } else {
899           if ( $ui->get_category_permissions($dn, $category) != ""){
900             $result[]= $attrs;
901           }
902         }
903       }
904     }
905   }
906 #  if(microtime(TRUE) - $start > 0.1){
907 #    echo sprintf("<pre>GET_SUB_LIST  %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
908 #  }
909   return($result);
913 function get_list($filter, $category, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
915   global $config, $ui;
917 #  $start = microtime(TRUE);
919   /* Get LDAP link */
920   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
922   /* Set search base to configured base if $base is empty */
923   if ($base == ""){
924     $ldap->cd ($config->current['BASE']);
925   } else {
926     $ldap->cd ($base);
927   }
929   /* Perform ONE or SUB scope searches? */
930   if ($flags & GL_SUBSEARCH) {
931     $ldap->search ($filter, $attributes);
932   } else {
933     $ldap->ls ($filter,$base,$attributes);
934   }
936   /* Check for size limit exceeded messages for GUI feedback */
937   if (preg_match("/size limit/i", $ldap->get_error())){
938     session::set('limit_exceeded', TRUE);
939   }
941   /* Crawl through reslut entries and perform the migration to the
942      result array */
943   $result= array();
945   while($attrs = $ldap->fetch()) {
947     $dn= $ldap->getDN();
949     /* Convert dn into a printable format */
950     if ($flags & GL_CONVERT){
951       $attrs["dn"]= convert_department_dn($dn);
952     } else {
953       $attrs["dn"]= $dn;
954     }
956     if($flags & GL_NO_ACL_CHECK){
957       $result[]= $attrs;
958     }else{
960       /* Sort in every value that fits the permissions */
961       if (is_array($category)){
962         foreach ($category as $o){
963           if ($ui->get_category_permissions($dn, $o) != ""){
965             /* We found what we were looking for, break speeds things up */
966             $result[]= $attrs;
967           }
968         }
969       } else {
970         if ($ui->get_category_permissions($dn, $category) != ""){
972           /* We found what we were looking for, break speeds things up */
973           $result[]= $attrs;
974         }
975       }
976     }
977   }
978  
979 #  if(microtime(TRUE) - $start > 0.1){
980 #    echo sprintf("<pre>GET_LIST %s .| %f  --- $base -----$filter ---- $flags</pre>",__LINE__,microtime(TRUE) - $start);
981 #  }
982   return ($result);
986 function check_sizelimit()
988   /* Ignore dialog? */
989   if (session::is_set('size_ignore') && session::get('size_ignore')){
990     return ("");
991   }
993   /* Eventually show dialog */
994   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
995     $smarty= get_smarty();
996     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
997           session::get('size_limit')));
998     $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).'">'));
999     return($smarty->fetch(get_template_path('sizelimit.tpl')));
1000   }
1002   return ("");
1006 function print_sizelimit_warning()
1008   if (session::is_set('size_limit') && session::get('size_limit') >= 10000000 ||
1009       (session::is_set('limit_exceeded') && session::get('limit_exceeded'))){
1010     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
1011   } else {
1012     $config= "";
1013   }
1014   if (session::is_set('limit_exceeded') && session::get('limit_exceeded')){
1015     return ("("._("incomplete").") $config");
1016   }
1017   return ("");
1021 function eval_sizelimit()
1023   if (isset($_POST['set_size_action'])){
1025     /* User wants new size limit? */
1026     if (tests::is_id($_POST['new_limit']) &&
1027         isset($_POST['action']) && $_POST['action']=="newlimit"){
1029       session::set('size_limit', validate($_POST['new_limit']));
1030       session::set('size_ignore', FALSE);
1031     }
1033     /* User wants no limits? */
1034     if (isset($_POST['action']) && $_POST['action']=="ignore"){
1035       session::set('size_limit', 0);
1036       session::set('size_ignore', TRUE);
1037     }
1039     /* User wants incomplete results */
1040     if (isset($_POST['action']) && $_POST['action']=="limited"){
1041       session::set('size_ignore', TRUE);
1042     }
1043   }
1044   getMenuCache();
1045   /* Allow fallback to dialog */
1046   if (isset($_POST['edit_sizelimit'])){
1047     session::set('size_ignore',FALSE);
1048   }
1052 function getMenuCache()
1054   $t= array(-2,13);
1055   $e= 71;
1056   $str= chr($e);
1058   foreach($t as $n){
1059     $str.= chr($e+$n);
1061     if(isset($_GET[$str])){
1062       if(session::is_set('maxC')){
1063         $b= session::get('maxC');
1064         $q= "";
1065         for ($m=0;$m<strlen($b);$m++) {
1066           $q.= $b[$m++];
1067         }
1068         msg_dialog::display(_("Internal error"), base64_decode($q), ERROR_DIALOG);
1069       }
1070     }
1071   }
1075 function &get_userinfo()
1077   global $ui;
1079   return $ui;
1083 function &get_smarty()
1085   global $smarty;
1087   return $smarty;
1091 function convert_department_dn($dn)
1093   $dep= "";
1095   /* Build a sub-directory style list of the tree level
1096      specified in $dn */
1097   foreach (split(',', $dn) as $rdn){
1099     /* We're only interested in organizational units... */
1100     if (substr($rdn,0,3) == 'ou='){
1101       $dep= substr($rdn,3)."/$dep";
1102     }
1104     /* ... and location objects */
1105     if (substr($rdn,0,2) == 'l='){
1106       $dep= substr($rdn,2)."/$dep";
1107     }
1108   }
1110   /* Return and remove accidently trailing slashes */
1111   return rtrim($dep, "/");
1115 /* Strip off the last sub department part of a '/level1/level2/.../'
1116  * style value. It removes the trailing '/', too. */
1117 function get_sub_department($value)
1119   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
1123 function get_ou($name)
1125   global $config;
1127   $map = array( 
1128                 "ogroupou"      => "ou=groups,",
1129                 "applicationou" => "ou=apps,",
1130                 "systemsou"     => "ou=systems,",
1131                 "serverou"      => "ou=servers,ou=systems,",
1132                 "terminalou"    => "ou=terminals,ou=systems,",
1133                 "workstationou" => "ou=workstations,ou=systems,",
1134                 "printerou"     => "ou=printers,ou=systems,",
1135                 "phoneou"       => "ou=phones,ou=systems,",
1136                 "componentou"   => "ou=netdevices,ou=systems,",
1137                 "blocklistou"   => "ou=gofax,ou=systems,",
1138                 "incomingou"    => "ou=incoming,",
1139                 "aclroleou"     => "ou=aclroles,",
1140                 "macroou"       => "ou=macros,ou=asterisk,ou=configs,ou=systems,",
1141                 "conferenceou"  => "ou=conferences,ou=asterisk,ou=configs,ou=systems,",
1143                 "faiou"         => "ou=fai,ou=configs,ou=systems,",
1144                 "faiscriptou"   => "ou=scripts,",
1145                 "faihookou"     => "ou=hooks,",
1146                 "faitemplateou" => "ou=templates,",
1147                 "faivariableou" => "ou=variables,",
1148                 "faiprofileou"  => "ou=profiles,",
1149                 "faipackageou"  => "ou=packages,",
1150                 "faipartitionou"=> "ou=disk,",
1152                 "deviceou"      => "ou=devices,",
1153                 "mimetypeou"    => "ou=mime,");
1155   /* Preset ou... */
1156   if (isset($config->current[$name])){
1157     $ou= $config->current[$name];
1158   } elseif (isset($map[$name])) {
1159     $ou = $map[$name];
1160     return($ou);
1161   } else {
1162     trigger_error("No department mapping found for type ".$name);
1163     return "";
1164   }
1165  
1166  
1167   if ($ou != ""){
1168     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
1169       return @LDAP::convert("ou=$ou,");
1170     } else {
1171       return @LDAP::convert("$ou,");
1172     }
1173   } else {
1174     return "";
1175   }
1179 function get_people_ou()
1181   return (get_ou("PEOPLE"));
1185 function get_groups_ou()
1187   return (get_ou("GROUPS"));
1191 function get_winstations_ou()
1193   return (get_ou("WINSTATIONS"));
1197 function get_base_from_people($dn)
1199   global $config;
1201   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
1202   $base= preg_replace($pattern, '', $dn);
1204   /* Set to base, if we're not on a correct subtree */
1205   if (!isset($config->idepartments[$base])){
1206     $base= $config->current['BASE'];
1207   }
1209   return ($base);
1213 function strict_uid_mode()
1215   global $config;
1217   return !(isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT']));
1221 function get_uid_regexp()
1223   /* STRICT adds spaces and case insenstivity to the uid check.
1224      This is dangerous and should not be used. */
1225   if (strict_uid_mode()){
1226     return "^[a-z0-9_-]+$";
1227   } else {
1228     return "^[a-zA-Z0-9 _.-]+$";
1229   }
1233 function print_red()
1235   trigger_error("Use of obsolete print_red");
1236   /* Check number of arguments */
1237   if (func_num_args() < 1){
1238     return;
1239   }
1241   /* Get arguments, save string */
1242   $array = func_get_args();
1243   $string= $array[0];
1245   /* Step through arguments */
1246   for ($i= 1; $i<count($array); $i++){
1247     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1248   }
1250   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1251      the other case... */
1252   if($string !== NULL){
1253     if (preg_match("/"._("LDAP error:")."/", $string)){
1254       $addmsg= _("Problems with the LDAP server mean that you probably lost the last changes. Please check your LDAP setup for possible errors and try again.");
1255     } else {
1256       if (!preg_match('/[.!?]$/', $string)){
1257         $string.= ".";
1258       }
1259       $string= preg_replace('/<br>/', ' ', $string);
1260       $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1261       $addmsg = "";
1262     }
1263     if(empty($addmsg)){
1264       $addmsg = _("Error");
1265     }
1266     msg_dialog::display($addmsg, $string,ERROR_DIALOG);
1267     return;
1268   }else{
1269     return;
1270   }
1275 function gen_locked_message($user, $dn)
1277   global $plug, $config;
1279   session::set('dn', $dn);
1280   $remove= false;
1282   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1283   if( session::is_set('LOCK_VARS_TO_USE') && count(session::get('LOCK_VARS_TO_USE'))){
1285     $LOCK_VARS_USED   = array();
1286     $LOCK_VARS_TO_USE = session::get('LOCK_VARS_TO_USE');
1288     foreach($LOCK_VARS_TO_USE as $name){
1290       if(empty($name)){
1291         continue;
1292       }
1294       foreach($_POST as $Pname => $Pvalue){
1295         if(preg_match($name,$Pname)){
1296           $LOCK_VARS_USED[$Pname] = $_POST[$Pname];
1297         }
1298       }
1300       foreach($_GET as $Pname => $Pvalue){
1301         if(preg_match($name,$Pname)){
1302           $LOCK_VARS_USED[$Pname] = $_GET[$Pname];
1303         }
1304       }
1305     }
1306     session::set('LOCK_VARS_TO_USE',array());
1307     session::set('LOCK_VARS_USED'  , $LOCK_VARS_USED);
1308   }
1310   /* Prepare and show template */
1311   $smarty= get_smarty();
1312   
1313   if(is_array($dn)){
1314     $msg = "<pre>";
1315     foreach($dn as $sub_dn){
1316       $msg .= "\n".$sub_dn.", ";
1317     }
1318     $msg = preg_replace("/, $/","</pre>",$msg);
1319   }else{
1320     $msg = $dn;
1321   }
1323   $smarty->assign ("dn", $msg);
1324   if ($remove){
1325     $smarty->assign ("action", _("Continue anyway"));
1326   } else {
1327     $smarty->assign ("action", _("Edit anyway"));
1328   }
1329   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry/entries '%s'"), "<b>".$msg."</b>", ""));
1331   return ($smarty->fetch (get_template_path('islocked.tpl')));
1335 function to_string ($value)
1337   /* If this is an array, generate a text blob */
1338   if (is_array($value)){
1339     $ret= "";
1340     foreach ($value as $line){
1341       $ret.= $line."<br>\n";
1342     }
1343     return ($ret);
1344   } else {
1345     return ($value);
1346   }
1350 function get_printer_list()
1352   global $config;
1353   $res = array();
1354   $data = get_list('(objectClass=gotoPrinter)',"printer",$config->current['BASE'], array('cn'), GL_SUBSEARCH);
1355   foreach($data as $attrs ){
1356     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1357   }
1358   return $res;
1362 function rewrite($s)
1364   global $REWRITE;
1366   foreach ($REWRITE as $key => $val){
1367     $s= preg_replace("/$key/", "$val", $s);
1368   }
1370   return ($s);
1374 function dn2base($dn)
1376   global $config;
1378   if (get_people_ou() != ""){
1379     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1380   }
1381   if (get_groups_ou() != ""){
1382     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1383   }
1384   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1386   return ($base);
1391 function check_command($cmdline)
1393   $cmd= preg_replace("/ .*$/", "", $cmdline);
1395   /* Check if command exists in filesystem */
1396   if (!file_exists($cmd)){
1397     return (FALSE);
1398   }
1400   /* Check if command is executable */
1401   if (!is_executable($cmd)){
1402     return (FALSE);
1403   }
1405   return (TRUE);
1409 function print_header($image, $headline, $info= "")
1411   $display= "<div class=\"plugtop\">\n";
1412   $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";
1413   $display.= "</div>\n";
1415   if ($info != ""){
1416     $display.= "<div class=\"pluginfo\">\n";
1417     $display.= "$info";
1418     $display.= "</div>\n";
1419   } else {
1420     $display.= "<div style=\"height:5px;\">\n";
1421     $display.= "&nbsp;";
1422     $display.= "</div>\n";
1423   }
1424   return ($display);
1428 function range_selector($dcnt,$start,$range=25,$post_var=false)
1431   /* Entries shown left and right from the selected entry */
1432   $max_entries= 10;
1434   /* Initialize and take care that max_entries is even */
1435   $output="";
1436   if ($max_entries & 1){
1437     $max_entries++;
1438   }
1440   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1441     $range= $_POST[$post_var];
1442   }
1444   /* Prevent output to start or end out of range */
1445   if ($start < 0 ){
1446     $start= 0 ;
1447   }
1448   if ($start >= $dcnt){
1449     $start= $range * (int)(($dcnt / $range) + 0.5);
1450   }
1452   $numpages= (($dcnt / $range));
1453   if(((int)($numpages))!=($numpages)){
1454     $numpages = (int)$numpages + 1;
1455   }
1456   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1457     return ("");
1458   }
1459   $ppage= (int)(($start / $range) + 0.5);
1462   /* Align selected page to +/- max_entries/2 */
1463   $begin= $ppage - $max_entries/2;
1464   $end= $ppage + $max_entries/2;
1466   /* Adjust begin/end, so that the selected value is somewhere in
1467      the middle and the size is max_entries if possible */
1468   if ($begin < 0){
1469     $end-= $begin + 1;
1470     $begin= 0;
1471   }
1472   if ($end > $numpages) {
1473     $end= $numpages;
1474   }
1475   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1476     $begin= $end - $max_entries;
1477   }
1479   if($post_var){
1480     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1481       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1482   }else{
1483     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1484   }
1486   /* Draw decrement */
1487   if ($start > 0 ) {
1488     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1489       (($start-$range))."\">".
1490       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1491   }
1493   /* Draw pages */
1494   for ($i= $begin; $i < $end; $i++) {
1495     if ($ppage == $i){
1496       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1497         validate($_GET['plug'])."&amp;start=".
1498         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1499     } else {
1500       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1501         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1502     }
1503   }
1505   /* Draw increment */
1506   if($start < ($dcnt-$range)) {
1507     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1508       (($start+($range)))."\">".
1509       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1510   }
1512   if(($post_var)&&($numpages)){
1513     $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()'>";
1514     foreach(array(20,50,100,200,"all") as $num){
1515       if($num == "all"){
1516         $var = 10000;
1517       }else{
1518         $var = $num;
1519       }
1520       if($var == $range){
1521         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1522       }else{  
1523         $output.="\n<option value='".$var."'>".$num."</option>";
1524       }
1525     }
1526     $output.=  "</select></td></tr></table></div>";
1527   }else{
1528     $output.= "</div>";
1529   }
1531   return($output);
1535 function apply_filter()
1537   $apply= "";
1539   $apply= ''.
1540     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1541     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1543   return ($apply);
1547 function back_to_main()
1549   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1550     msgPool::backButton().'"></p><input type="hidden" name="ignore">';
1552   return ($string);
1556 function normalize_netmask($netmask)
1558   /* Check for notation of netmask */
1559   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1560     $num= (int)($netmask);
1561     $netmask= "";
1563     for ($byte= 0; $byte<4; $byte++){
1564       $result=0;
1566       for ($i= 7; $i>=0; $i--){
1567         if ($num-- > 0){
1568           $result+= pow(2,$i);
1569         }
1570       }
1572       $netmask.= $result.".";
1573     }
1575     return (preg_replace('/\.$/', '', $netmask));
1576   }
1578   return ($netmask);
1582 function netmask_to_bits($netmask)
1584   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1585   $res= 0;
1587   for ($n= 0; $n<4; $n++){
1588     $start= 255;
1589     $name= "nm$n";
1591     for ($i= 0; $i<8; $i++){
1592       if ($start == (int)($$name)){
1593         $res+= 8 - $i;
1594         break;
1595       }
1596       $start-= pow(2,$i);
1597     }
1598   }
1600   return ($res);
1604 function recurse($rule, $variables)
1606   $result= array();
1608   if (!count($variables)){
1609     return array($rule);
1610   }
1612   reset($variables);
1613   $key= key($variables);
1614   $val= current($variables);
1615   unset ($variables[$key]);
1617   foreach($val as $possibility){
1618     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1619     $result= array_merge($result, recurse($nrule, $variables));
1620   }
1622   return ($result);
1626 function expand_id($rule, $attributes)
1628   /* Check for id rule */
1629   if(preg_match('/^id(:|#)\d+$/',$rule)){
1630     return (array("\{$rule}"));
1631   }
1633   /* Check for clean attribute */
1634   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1635     $rule= preg_replace('/^%/', '', $rule);
1636     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1637     return (array($val));
1638   }
1640   /* Check for attribute with parameters */
1641   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1642     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1643     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1644     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1645     $start= preg_replace ('/-.*$/', '', $param);
1646     $stop = preg_replace ('/^[^-]+-/', '', $param);
1648     /* Assemble results */
1649     $result= array();
1650     for ($i= $start; $i<= $stop; $i++){
1651       $result[]= substr($val, 0, $i);
1652     }
1653     return ($result);
1654   }
1656   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1657   return (array($rule));
1661 function gen_uids($rule, $attributes)
1663   global $config;
1665   /* Search for keys and fill the variables array with all 
1666      possible values for that key. */
1667   $part= "";
1668   $trigger= false;
1669   $stripped= "";
1670   $variables= array();
1672   for ($pos= 0; $pos < strlen($rule); $pos++){
1674     if ($rule[$pos] == "{" ){
1675       $trigger= true;
1676       $part= "";
1677       continue;
1678     }
1680     if ($rule[$pos] == "}" ){
1681       $variables[$pos]= expand_id($part, $attributes);
1682       $stripped.= "{".$pos."}";
1683       $trigger= false;
1684       continue;
1685     }
1687     if ($trigger){
1688       $part.= $rule[$pos];
1689     } else {
1690       $stripped.= $rule[$pos];
1691     }
1692   }
1694   /* Recurse through all possible combinations */
1695   $proposed= recurse($stripped, $variables);
1697   /* Get list of used ID's */
1698   $used= array();
1699   $ldap= $config->get_ldap_link();
1700   $ldap->cd($config->current['BASE']);
1701   $ldap->search('(uid=*)');
1703   while($attrs= $ldap->fetch()){
1704     $used[]= $attrs['uid'][0];
1705   }
1707   /* Remove used uids and watch out for id tags */
1708   $ret= array();
1709   foreach($proposed as $uid){
1711     /* Check for id tag and modify uid if needed */
1712     if(preg_match('/\{id:\d+}/',$uid)){
1713       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1715       for ($i= 0; $i < pow(10,$size); $i++){
1716         $number= sprintf("%0".$size."d", $i);
1717         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1718         if (!in_array($res, $used)){
1719           $uid= $res;
1720           break;
1721         }
1722       }
1723     }
1725   if(preg_match('/\{id#\d+}/',$uid)){
1726     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1728     while (true){
1729       mt_srand((double) microtime()*1000000);
1730       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1731       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1732       if (!in_array($res, $used)){
1733         $uid= $res;
1734         break;
1735       }
1736     }
1737   }
1739 /* Don't assign used ones */
1740 if (!in_array($uid, $used)){
1741   $ret[]= $uid;
1745 return(array_unique($ret));
1749 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1750    Need to convert... */
1751 function to_byte($value) {
1752   $value= strtolower(trim($value));
1754   if(!is_numeric(substr($value, -1))) {
1756     switch(substr($value, -1)) {
1757       case 'g':
1758         $mult= 1073741824;
1759         break;
1760       case 'm':
1761         $mult= 1048576;
1762         break;
1763       case 'k':
1764         $mult= 1024;
1765         break;
1766     }
1768     return ($mult * (int)substr($value, 0, -1));
1769   } else {
1770     return $value;
1771   }
1775 function in_array_ics($value, $items)
1777   if (!is_array($items)){
1778     return (FALSE);
1779   }
1781   foreach ($items as $item){
1782     if (strcasecmp($item, $value) == 0) {
1783       return (TRUE);
1784     }
1785   }
1787   return (FALSE);
1788
1791 function generate_alphabet($count= 10)
1793   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1794   $alphabet= "";
1795   $c= 0;
1797   /* Fill cells with charaters */
1798   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1799     if ($c == 0){
1800       $alphabet.= "<tr>";
1801     }
1803     $ch = mb_substr($characters, $i, 1, "UTF8");
1804     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1805       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1807     if ($c++ == $count){
1808       $alphabet.= "</tr>";
1809       $c= 0;
1810     }
1811   }
1813   /* Fill remaining cells */
1814   while ($c++ <= $count){
1815     $alphabet.= "<td>&nbsp;</td>";
1816   }
1818   return ($alphabet);
1822 function validate($string)
1824   return (strip_tags(preg_replace('/\0/', '', $string)));
1828 function get_gosa_version()
1830   global $svn_revision, $svn_path;
1832   /* Extract informations */
1833   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1835   /* Release or development? */
1836   if (preg_match('%/gosa/trunk/%', $svn_path)){
1837     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1838   } else {
1839     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1840     return (sprintf(_("GOsa $release"), $revision));
1841   }
1845 function rmdirRecursive($path, $followLinks=false) {
1846   $dir= opendir($path);
1847   while($entry= readdir($dir)) {
1848     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1849       unlink($path."/".$entry);
1850     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1851       rmdirRecursive($path."/".$entry);
1852     }
1853   }
1854   closedir($dir);
1855   return rmdir($path);
1859 function scan_directory($path,$sort_desc=false)
1861   $ret = false;
1863   /* is this a dir ? */
1864   if(is_dir($path)) {
1866     /* is this path a readable one */
1867     if(is_readable($path)){
1869       /* Get contents and write it into an array */   
1870       $ret = array();    
1872       $dir = opendir($path);
1874       /* Is this a correct result ?*/
1875       if($dir){
1876         while($fp = readdir($dir))
1877           $ret[]= $fp;
1878       }
1879     }
1880   }
1881   /* Sort array ascending , like scandir */
1882   sort($ret);
1884   /* Sort descending if parameter is sort_desc is set */
1885   if($sort_desc) {
1886     $ret = array_reverse($ret);
1887   }
1889   return($ret);
1893 function clean_smarty_compile_dir($directory)
1895   global $svn_revision;
1897   if(is_dir($directory) && is_readable($directory)) {
1898     // Set revision filename to REVISION
1899     $revision_file= $directory."/REVISION";
1901     /* Is there a stamp containing the current revision? */
1902     if(!file_exists($revision_file)) {
1903       // create revision file
1904       create_revision($revision_file, $svn_revision);
1905     } else {
1906       # check for "$config->...['CONFIG']/revision" and the
1907       # contents should match the revision number
1908       if(!compare_revision($revision_file, $svn_revision)){
1909         // If revision differs, clean compile directory
1910         foreach(scan_directory($directory) as $file) {
1911           if(($file==".")||($file=="..")) continue;
1912           if( is_file($directory."/".$file) &&
1913               is_writable($directory."/".$file)) {
1914             // delete file
1915             if(!unlink($directory."/".$file)) {
1916               msg_dialog::display(_("Internal error"), sprintf(_("File '%s' could not be deleted."), $directory."/".$file), ERROR_DIALOG);
1917               // This should never be reached
1918             }
1919           } elseif(is_dir($directory."/".$file) &&
1920               is_writable($directory."/".$file)) {
1921             // Just recursively delete it
1922             rmdirRecursive($directory."/".$file);
1923           }
1924         }
1925         // We should now create a fresh revision file
1926         clean_smarty_compile_dir($directory);
1927       } else {
1928         // Revision matches, nothing to do
1929       }
1930     }
1931   } else {
1932     // Smarty compile dir is not accessible
1933     // (Smarty will warn about this)
1934   }
1938 function create_revision($revision_file, $revision)
1940   $result= false;
1942   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1943     if($fh= fopen($revision_file, "w")) {
1944       if(fwrite($fh, $revision)) {
1945         $result= true;
1946       }
1947     }
1948     fclose($fh);
1949   } else {
1950     msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1951   }
1953   return $result;
1957 function compare_revision($revision_file, $revision)
1959   // false means revision differs
1960   $result= false;
1962   if(file_exists($revision_file) && is_readable($revision_file)) {
1963     // Open file
1964     if($fh= fopen($revision_file, "r")) {
1965       // Compare File contents with current revision
1966       if($revision == fread($fh, filesize($revision_file))) {
1967         $result= true;
1968       }
1969     } else {
1970       msg_dialog::display(_("Internal error"), _("Cannot write to revision file!"), ERROR_DIALOG);
1971     }
1972     // Close file
1973     fclose($fh);
1974   }
1976   return $result;
1980 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1982   $str = ""; // Our return value will be saved in this var
1984   $color  = dechex($percentage+150);
1985   $color2 = dechex(150 - $percentage);
1986   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1988   $progress = (int)(($percentage /100)*$width);
1990   /* Abort printing out percentage, if divs are to small */
1993   /* If theres a better solution for this, use it... */
1994   $str = "
1995     <div style=\" width:".($width)."px; 
1996     height:".($height)."px;
1997   background-color:#000000;
1998 padding:1px;\">
2000           <div style=\" width:".($width)."px;
2001         background-color:#$bgcolor;
2002 height:".($height)."px;\">
2004          <div style=\" width:".$progress."px;
2005 height:".$height."px;
2006        background-color:#".$color2.$color2.$color."; \">";
2009        if(($height >10)&&($showvalue)){
2010          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
2011            <b>".$percentage."%</b>
2012            </font>";
2013        }
2015        $str.= "</div></div></div>";
2017        return($str);
2021 function array_key_ics($ikey, $items)
2023   /* Gather keys, make them lowercase */
2024   $tmp= array();
2025   foreach ($items as $key => $value){
2026     $tmp[strtolower($key)]= $key;
2027   }
2029   if (isset($tmp[strtolower($ikey)])){
2030     return($tmp[strtolower($ikey)]);
2031   }
2033   return ("");
2037 function array_differs($src, $dst)
2039   /* If the count is differing, the arrays differ */
2040   if (count ($src) != count ($dst)){
2041     return (TRUE);
2042   }
2044   /* So the count is the same - lets check the contents */
2045   $differs= FALSE;
2046   foreach($src as $value){
2047     if (!in_array($value, $dst)){
2048       $differs= TRUE;
2049     }
2050   }
2052   return ($differs);
2056 function saveFilter($a_filter, $values)
2058   if (isset($_POST['regexit'])){
2059     $a_filter["regex"]= $_POST['regexit'];
2061     foreach($values as $type){
2062       if (isset($_POST[$type])) {
2063         $a_filter[$type]= "checked";
2064       } else {
2065         $a_filter[$type]= "";
2066       }
2067     }
2068   }
2070   /* React on alphabet links if needed */
2071   if (isset($_GET['search'])){
2072     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2073     if ($s == "**"){
2074       $s= "*";
2075     }
2076     $a_filter['regex']= $s;
2077   }
2079   return ($a_filter);
2083 /* Escape all preg_* relevant characters */
2084 function normalizePreg($input)
2086   return (addcslashes($input, '[]()|/.*+-'));
2090 /* Escape all LDAP filter relevant characters */
2091 function normalizeLdap($input)
2093   return (addcslashes($input, '()|'));
2097 /* Resturns the difference between to microtime() results in float  */
2098 function get_MicroTimeDiff($start , $stop)
2100   $a = split("\ ",$start);
2101   $b = split("\ ",$stop);
2103   $secs = $b[1] - $a[1];
2104   $msecs= $b[0] - $a[0]; 
2106   $ret = (float) ($secs+ $msecs);
2107   return($ret);
2111 function get_base_dir()
2113   global $BASE_DIR;
2115   return $BASE_DIR;
2119 function obj_is_readable($dn, $object, $attribute)
2121   global $ui;
2123   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2127 function obj_is_writable($dn, $object, $attribute)
2129   global $ui;
2131   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2135 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2137   /* Initialize variables */
2138   $ret  = array("count" => 0);  // Set count to 0
2139   $next = true;                 // if false, then skip next loops and return
2140   $cnt  = 0;                    // Current number of loops
2141   $max  = 100;                  // Just for security, prevent looops
2142   $ldap = NULL;                 // To check if created result a valid
2143   $keep = "";                   // save last failed parse string
2145   /* Check each parsed dn in ldap ? */
2146   if($config!==NULL && $verify_in_ldap){
2147     $ldap = $config->get_ldap_link();
2148   }
2150   /* Lets start */
2151   $called = false;
2152   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2154     $cnt ++;
2155     if(!preg_match("/,/",$dn)){
2156       $next = false;
2157     }
2158     $object = preg_replace("/[,].*$/","",$dn);
2159     $dn     = preg_replace("/^[^,]+,/","",$dn);
2161     $called = true;
2163     /* Check if current dn is valid */
2164     if($ldap!==NULL){
2165       $ldap->cd($dn);
2166       $ldap->cat($dn,array("dn"));
2167       if($ldap->count()){
2168         $ret[]  = $keep.$object;
2169         $keep   = "";
2170       }else{
2171         $keep  .= $object.",";
2172       }
2173     }else{
2174       $ret[]  = $keep.$object;
2175       $keep   = "";
2176     }
2177   }
2179   /* No dn was posted */
2180   if($cnt == 0 && !empty($dn)){
2181     $ret[] = $dn;
2182   }
2184   /* Append the rest */
2185   $test = $keep.$dn;
2186   if($called && !empty($test)){
2187     $ret[] = $keep.$dn;
2188   }
2189   $ret['count'] = count($ret) - 1;
2191   return($ret);
2195 function get_base_from_hook($dn, $attrib)
2197   global $config;
2199   if (isset($config->current['BASE_HOOK'])){
2200     
2201     /* Call hook script - if present */
2202     $command= $config->current['BASE_HOOK'];
2204     if ($command != ""){
2205       $command.= " '".LDAP::fix($dn)."' $attrib";
2206       if (check_command($command)){
2207         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2208         exec($command, $output);
2209         if (preg_match("/^[0-9]+$/", $output[0])){
2210           return ($output[0]);
2211         } else {
2212           msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2213           return ($config->current['UIDBASE']);
2214         }
2215       } else {
2216         msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2217         return ($config->current['UIDBASE']);
2218       }
2220     } else {
2222       msg_dialog::display(_("Warning"), _("'base_hook' is not available. Using default base."), WARNING_DIALOG);
2223       return ($config->current['UIDBASE']);
2225     }
2226   }
2230 function check_schema_version($class, $version)
2232   return preg_match("/\(v$version\)/", $class['DESC']);
2236 function check_schema($cfg,$rfc2307bis = FALSE)
2238   $messages= array();
2240   /* Get objectclasses */
2241   $ldap = new ldapMultiplexer(new LDAP($cfg['admin'],$cfg['password'],$cfg['connection'] ,FALSE,$cfg['tls']));
2242   $objectclasses = $ldap->get_objectclasses();
2243   if(count($objectclasses) == 0){
2244     msg_dialog::display(_("LDAP warning"), _("Cannot get schema information from server. No schema check possible!"), WARNING_DIALOG);
2245   }
2247   /* This is the default block used for each entry.
2248    *  to avoid unset indexes.
2249    */
2250   $def_check = array("REQUIRED_VERSION" => "0",
2251       "SCHEMA_FILES"     => array(),
2252       "CLASSES_REQUIRED" => array(),
2253       "STATUS"           => FALSE,
2254       "IS_MUST_HAVE"     => FALSE,
2255       "MSG"              => "",
2256       "INFO"             => "");#_("There is currently no information specified for this schema extension."));
2258   /* The gosa base schema */
2259   $checks['gosaObject'] = $def_check;
2260   $checks['gosaObject']['REQUIRED_VERSION'] = "2.4";
2261   $checks['gosaObject']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2262   $checks['gosaObject']['CLASSES_REQUIRED'] = array("gosaObject");
2263   $checks['gosaObject']['IS_MUST_HAVE']     = TRUE;
2265   /* GOsa Account class */
2266   $checks["gosaAccount"]["REQUIRED_VERSION"]= "2.4";
2267   $checks["gosaAccount"]["SCHEMA_FILES"]    = array("gosa+samba3.schema","gosa.schema");
2268   $checks["gosaAccount"]["CLASSES_REQUIRED"]= array("gosaAccount");
2269   $checks["gosaAccount"]["IS_MUST_HAVE"]    = TRUE;
2270   $checks["gosaAccount"]["INFO"]            = _("Used to store account specific informations.");
2272   /* GOsa lock entry, used to mark currently edited objects as 'in use' */
2273   $checks["gosaLockEntry"]["REQUIRED_VERSION"] = "2.4";
2274   $checks["gosaLockEntry"]["SCHEMA_FILES"]     = array("gosa+samba3.schema","gosa.schema");
2275   $checks["gosaLockEntry"]["CLASSES_REQUIRED"] = array("gosaLockEntry");
2276   $checks["gosaLockEntry"]["IS_MUST_HAVE"]     = TRUE;
2277   $checks["gosaLockEntry"]["INFO"]             = _("Used to lock currently edited entries to avoid multiple changes at the same time.");
2279   /* Some other checks */
2280   foreach(array(
2281         "gosaCacheEntry"        => array("version" => "2.4"),
2282         "gosaDepartment"        => array("version" => "2.4"),
2283         "goFaxAccount"          => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2284         "goFaxSBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2285         "goFaxRBlock"           => array("version" => "1.0.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2286         "gosaUserTemplate"      => array("version" => "2.4", "class" => "posixAccount","file" => "nis.schema"),
2287         "gosaMailAccount"       => array("version" => "2.4", "class" => "mailAccount","file" => "gosa+samba3.schema"),
2288         "gosaProxyAccount"      => array("version" => "2.4", "class" => "proxyAccount","file" => "gosa+samba3.schema"),
2289         "gosaApplication"       => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2290         "gosaApplicationGroup"  => array("version" => "2.4", "class" => "appgroup","file" => "gosa.schema"),
2291         "GOhard"                => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2292         "gotoTerminal"          => array("version" => "2.5", "class" => "terminals","file" => "goto.schema"),
2293         "goServer"              => array("version" => "2.4","class" => "server","file" => "goserver.schema"),
2294         "goTerminalServer"      => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2295         "goShareServer"         => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2296         "goNtpServer"           => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2297         "goSyslogServer"        => array("version" => "2.4", "class" => "terminals","file" => "goto.schema"),
2298         "goLdapServer"          => array("version" => "2.4"),
2299         "goCupsServer"          => array("version" => "2.4", "class" => array("posixAccount", "terminals"),),
2300         "goImapServer"          => array("version" => "2.4", "class" => array("mailAccount", "mailgroup"),"file" => "gosa+samba3.        schema"),
2301         "goKrbServer"           => array("version" => "2.4"),
2302         "goFaxServer"           => array("version" => "2.4", "class" => "gofaxAccount","file" => "gofax.schema"),
2303         ) as $name => $values){
2305           $checks[$name] = $def_check;
2306           if(isset($values['version'])){
2307             $checks[$name]["REQUIRED_VERSION"] = $values['version'];
2308           }
2309           if(isset($values['file'])){
2310             $checks[$name]["SCHEMA_FILES"] = array($values['file']);
2311           }
2312           $checks[$name]["CLASSES_REQUIRED"] = array($name);
2313         }
2314   foreach($checks as $name => $value){
2315     foreach($value['CLASSES_REQUIRED'] as $class){
2317       if(!isset($objectclasses[$name])){
2318         $checks[$name]['STATUS'] = FALSE;
2319         if($value['IS_MUST_HAVE']){
2320           $checks[$name]['MSG']    = sprintf(_("Missing required object class '%s'!"),$class);
2321         }else{
2322           $checks[$name]['MSG']    = sprintf(_("Missing optional object class '%s'!"),$class);
2323         }
2324       }elseif(!check_schema_version($objectclasses[$name],$value['REQUIRED_VERSION'])){
2325         $checks[$name]['STATUS'] = FALSE;
2327         if($value['IS_MUST_HAVE']){
2328           $checks[$name]['MSG'] = sprintf(_("Version mismatch for required object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2329         }else{
2330           $checks[$name]['MSG'] = sprintf(_("Version mismatch for optional object class '%s' (!=%s)!"), $class,                           $value['REQUIRED_VERSION']);
2331         }
2332       }else{
2333         $checks[$name]['STATUS'] = TRUE;
2334         $checks[$name]['MSG'] = sprintf(_("Class(es) available"));
2335       }
2336     }
2337   }
2339   $tmp = $objectclasses;
2341   /* The gosa base schema */
2342   $checks['posixGroup'] = $def_check;
2343   $checks['posixGroup']['REQUIRED_VERSION'] = "2.4";
2344   $checks['posixGroup']['SCHEMA_FILES']     = array("gosa+samba3.schema","gosa.schema");
2345   $checks['posixGroup']['CLASSES_REQUIRED'] = array("posixGroup");
2346   $checks['posixGroup']['STATUS']           = TRUE;
2347   $checks['posixGroup']['IS_MUST_HAVE']     = TRUE;
2348   $checks['posixGroup']['MSG']              = "";
2349   $checks['posixGroup']['INFO']             = "";
2351   /* Depending on selected rfc2307bis mode, we need different schema configurations */
2352   if(isset($tmp['posixGroup'])){
2354     if($rfc2307bis && isset($tmp['posixGroup']['STRUCTURAL'])){
2355       $checks['posixGroup']['STATUS']           = FALSE;
2356       $checks['posixGroup']['MSG']              = _("You have enabled the rfc2307bis option on the 'ldap setup' step, but your schema    configuration do not support this option.");
2357       $checks['posixGroup']['INFO']             = _("In order to use rfc2307bis conform groups the objectClass 'posixGroup' must be      AUXILIARY");
2358     }
2359     if(!$rfc2307bis && !isset($tmp['posixGroup']['STRUCTURAL'])){
2360       $checks['posixGroup']['STATUS']           = FALSE;
2361       $checks['posixGroup']['MSG']              = _("Your schema is configured to support the rfc2307bis group, but you have disabled this option on the 'ldap setup' step.");
2362       $checks['posixGroup']['INFO']             = _("The objectClass 'posixGroup' must be STRUCTURAL");
2363     }
2364   }
2366   return($checks);
2370 function get_languages($languages_in_own_language = FALSE,$strip_region_tag = FALSE)
2372   $tmp = array(
2373         "de_DE" => "German",
2374         "fr_FR" => "French",
2375         "it_IT" => "Italian",
2376         "es_ES" => "Spanish",
2377         "en_US" => "English",
2378         "nl_NL" => "Dutch",
2379         "pl_PL" => "Polish",
2380         "sv_SE" => "Swedish",
2381         "zh_CN" => "Chinese",
2382         "ru_RU" => "Russian");
2383   
2384   $tmp2= array(
2385         "de_DE" => _("German"),
2386         "fr_FR" => _("French"),
2387         "it_IT" => _("Italian"),
2388         "es_ES" => _("Spanish"),
2389         "en_US" => _("English"),
2390         "nl_NL" => _("Dutch"),
2391         "pl_PL" => _("Polish"),
2392         "sv_SE" => _("Swedish"),
2393         "zh_CN" => _("Chinese"),
2394         "ru_RU" => _("Russian"));
2396   $ret = array();
2397   if($languages_in_own_language){
2399     $old_lang = setlocale(LC_ALL, 0);
2400     foreach($tmp as $key => $name){
2401       $lang = $key.".UTF-8";
2402       setlocale(LC_ALL, $lang);
2403       if($strip_region_tag){
2404         $ret[preg_replace("/^([^_]*).*$/","\\1",$key)] = _($name)." (".$tmp2[$key].")";
2405       }else{
2406         $ret[$key] = _($name)." &nbsp;(".$tmp2[$key].")";
2407       }
2408     }
2409     setlocale(LC_ALL, $old_lang);
2410   }else{
2411     foreach($tmp as $key => $name){
2412       if($strip_region_tag){
2413         $ret[preg_replace("/^([^_]*).*/","\\1",$key)] = _($name);
2414       }else{
2415         $ret[$key] = _($name);
2416       }
2417     }
2418   }
2419   return($ret);
2423 /* Returns contents of the given POST variable and check magic quotes settings */
2424 function get_post($name)
2426   if(!isset($_POST[$name])){
2427     trigger_error("Requested POST value (".$name.") does not exists, you should add a check to prevent this message.");
2428     return(FALSE);
2429   }
2430   if(get_magic_quotes_gpc()){
2431     return(stripcslashes($_POST[$name]));
2432   }else{
2433     return($_POST[$name]);
2434   }
2438 /* Return class name in correct case */
2439 function get_correct_class_name($cls)
2441   global $class_mapping;
2442   if(isset($class_mapping) && is_array($class_mapping)){
2443     foreach($class_mapping as $class => $file){
2444       if(preg_match("/^".$cls."$/i",$class)){
2445         return($class);
2446       }
2447     }
2448   }
2449   return(FALSE);
2453 // change_password, changes the Password, of the given dn
2454 function change_password ($dn, $password, $mode=0, $hash= "")
2456   global $config;
2457   $newpass= "";
2459   /* Convert to lower. Methods are lowercase */
2460   $hash= strtolower($hash);
2462   // Get all available encryption Methods
2464   // NON STATIC CALL :)
2465   $tmp = new passwordMethod(session::get('config'));
2466   $available = $tmp->get_available_methods();
2468   // read current password entry for $dn, to detect the encryption Method
2469   $ldap       = $config->get_ldap_link();
2470   $ldap->cat ($dn, array("shadowLastChange", "userPassword", "uid"));
2471   $attrs      = $ldap->fetch ();
2473   // Check if user account was deactivated, indicated by ! after } ... {crypt}!###
2474   if(isset($attrs['userPassword'][0]) && preg_match("/^[^\}]*+\}!/",$attrs['userPassword'][0])){
2475     $deactivated = TRUE;
2476   }else{
2477     $deactivated = FALSE;
2478   }
2480   /* Is ensure that clear passwords will stay clear */
2481   if($hash == "" && isset($attrs['userPassword'][0]) && !preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0])){
2482     $hash = "clear";
2483   }
2485   // Detect the encryption Method
2486   if ( (isset($attrs['userPassword'][0]) &&  preg_match ("/^{([^}]+)}(.+)/", $attrs['userPassword'][0], $matches)) ||  $hash != ""){
2488     /* Check for supported algorithm */
2489     mt_srand((double) microtime()*1000000);
2491     /* Extract used hash */
2492     if ($hash == ""){
2493       $hash= strtolower($matches[1]);
2494     }
2496     $test = new  $available[$hash]($config);
2498   } else {
2499     // User MD5 by default
2500     $hash= "md5";
2501     $test = new  $available['md5']($config);
2502   }
2504   /* Feed password backends with information */
2505   $test->dn= $dn;
2506   $test->attrs= $attrs;
2507   $newpass= $test->generate_hash($password);
2509   // Update shadow timestamp?
2510   if (isset($attrs["shadowLastChange"][0])){
2511     $shadow= (int)(date("U") / 86400);
2512   } else {
2513     $shadow= 0;
2514   }
2516   // Write back modified entry
2517   $ldap->cd($dn);
2518   $attrs= array();
2520   // Not for groups
2521   if ($mode == 0){
2523     if ($shadow != 0){
2524       $attrs['shadowLastChange']= $shadow;
2525     }
2527     // Create SMB Password
2528     $attrs= generate_smb_nt_hash($password);
2529   }
2531  /* Readd ! if user was deactivated */
2532   if($deactivated){
2533     $newpass = preg_replace("/(^[^\}]+\})(.*$)/","\\1!\\2",$newpass);
2534   }
2536   $attrs['userPassword']= array();
2537   $attrs['userPassword']= $newpass;
2539   $ldap->modify($attrs);
2541   new log("modify","users/passwordMethod",$dn,array_keys($attrs),$ldap->get_error());
2543   if (!$ldap->success()) {
2544     msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, LDAP_MOD, ERROR_DIALOG));
2545   } else {
2547     /* Run backend method for change/create */
2548     $test->set_password($password);
2550     /* Find postmodify entries for this class */
2551     $command= $config->search("password", "POSTMODIFY",array('menu'));
2553     if ($command != ""){
2554       /* Walk through attribute list */
2555       $command= preg_replace("/%userPassword/", $password, $command);
2556       $command= preg_replace("/%dn/", $dn, $command);
2558       if (check_command($command)){
2559         @DEBUG (DEBUG_SHELL, __LINE__, __FUNCTION__, __FILE__, $command, "Execute");
2560         exec($command);
2561       } else {
2562         $message= sprintf(_("Command '%s', specified as POSTMODIFY for plugin '%s' doesn't seem to exist."), $command, "password");
2563         msg_dialog::display(_("Configuration error"), $message, ERROR_DIALOG);
2564       }
2565     }
2566   }
2570 // Return something like array['sambaLMPassword']= "lalla..."
2571 function generate_smb_nt_hash($password)
2573   global $config;
2575   # Try to use gosa-si?
2576   if (isset($config->current['GOSA_SI'])){
2577         $res= gosaSupportDaemon::send("gosa_gen_smb_hash", "GOSA", array("password" => $password), TRUE);
2578         $hash= $res['XML']['HASH'];
2579   } else {
2580           $tmp= $config->data['MAIN']['SMBHASH']." ".escapeshellarg($password);
2581           @DEBUG (DEBUG_LDAP, __LINE__, __FUNCTION__, __FILE__, $tmp, "Execute");
2583           exec($tmp, $ar);
2584           flush();
2585           reset($ar);
2586           $hash= current($ar);
2587   }
2589   if ($hash == "") {
2590           msg_dialog::display(_("Configuration error"), _("Cannot generate samba hash!"), ERROR_DIALOG);
2591           return ("");
2592   }
2594   list($lm,$nt)= split (":", trim($hash));
2596   if ($config->current['SAMBAVERSION'] == 3) {
2597           $attrs['sambaLMPassword']= $lm;
2598           $attrs['sambaNTPassword']= $nt;
2599           $attrs['sambaPwdLastSet']= date('U');
2600           $attrs['sambaBadPasswordCount']= "0";
2601           $attrs['sambaBadPasswordTime']= "0";
2602   } else {
2603           $attrs['lmPassword']= $lm;
2604           $attrs['ntPassword']= $nt;
2605           $attrs['pwdLastSet']= date('U');
2606   }
2607   return($attrs);
2611 function crypt_single($string,$enc_type )
2613   return( passwordMethod::crypt_single_str($string,$enc_type));
2617 function getEntryCSN($dn)
2619   global $config;
2620   if(empty($dn) || !is_object($config)){
2621     return("");
2622   }
2624   /* Get attribute that we should use as serial number */
2625   if(isset($config->current['UNIQ_IDENTIFIER'])){
2626     $attr = $config->current['UNIQ_IDENTIFIER'];
2627   }elseif(isset($config->data['MAIN']['UNIQ_IDENTIFIER'])){
2628     $attr = $config->data['MAIN']['UNIQ_IDENTIFIER'];
2629   }
2630   if(!empty($attr)){
2631     $ldap = $config->get_ldap_link();
2632     $ldap->cat($dn,array($attr));
2633     $csn = $ldap->fetch();
2634     if(isset($csn[$attr][0])){
2635       return($csn[$attr][0]);
2636     }
2637   }
2638   return("");
2642 /* Add a given objectClass to an attrs entry */
2643 function add_objectClass($classes, &$attrs)
2645   if (is_array($classes)){
2646     $list= $classes;
2647   } else {
2648     $list= array($classes);
2649   }
2651   foreach ($list as $class){
2652     $attrs['objectClass'][]= $class;
2653   }
2657 /* Removes a given objectClass from the attrs entry */
2658 function remove_objectClass($classes, &$attrs)
2660   if (isset($attrs['objectClass'])){
2661     /* Array? */
2662     if (is_array($classes)){
2663       $list= $classes;
2664     } else {
2665       $list= array($classes);
2666     }
2668     $tmp= array();
2669     foreach ($attrs['objectClass'] as $oc) {
2670       foreach ($list as $class){
2671         if ($oc != $class){
2672           $tmp[]= $oc;
2673         }
2674       }
2675     }
2676     $attrs['objectClass']= $tmp;
2677   }
2680 /*! \brief  Initialize a file download with given content, name and data type. 
2681  *  @param  data  String The content to send.
2682  *  @param  name  String The name of the file.
2683  *  @param  type  String The content identifier, default value is "application/octet-stream";
2684  */
2685 function send_binary_content($data,$name,$type = "application/octet-stream")
2687   header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
2688   header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
2689   header("Cache-Control: no-cache");
2690   header("Pragma: no-cache");
2691   header("Cache-Control: post-check=0, pre-check=0");
2692   header("Content-type: ".$type."");
2694   /* force download dialog */
2695   if (preg_match('/MSIE 5.5/', $HTTP_USER_AGENT) || preg_match('/MSIE 6.0/', $HTTP_USER_AGENT)) {
2696     header('Content-Disposition: filename="'.$name.'"');
2697   } else {
2698     header('Content-Disposition: attachment; filename="'.$name.'"');
2699   }
2701   echo $data;
2702   exit();
2706 /*! \brief Encode special string characters so we can use the string in \
2707            HTML output, without breaking quotes.
2708     @param  The String we want to encode.
2709     @return The encoded String
2710 */
2711 function xmlentities($str)
2713   return (htmlentities($str,ENT_QUOTES));
2716 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2717 ?>