Code

Updated setup to display more detailed/logical error msgs.
[gosa.git] / include / functions.inc
1 <?php
2 /*
3  * This code is part of GOsa (https://gosa.gonicus.de)
4  * Copyright (C) 2003 Cajus Pollmeier
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
21 /* Configuration file location */
22 define ("CONFIG_DIR", "/etc/gosa");
23 define ("CONFIG_TEMPLATE_DIR", "../contrib/");
24 define ("HELP_BASEDIR", "/var/www/doc/");
26 /* Define get_list flags */
27 define("GL_NONE",      0);
28 define("GL_SUBSEARCH", 1);
29 define("GL_SIZELIMIT", 2);
30 define("GL_CONVERT"  , 4);
32 /* Define globals for revision comparing */
33 $svn_path = '$HeadURL$';
34 $svn_revision = '$Revision$';
36 /* Include required files */
37 require_once ("class_ldap.inc");
38 require_once ("class_config.inc");
39 require_once ("class_userinfo.inc");
40 require_once ("class_plugin.inc");
41 require_once ("class_pluglist.inc");
42 require_once ("class_tabs.inc");
43 require_once ("class_mail-methods.inc");
44 require_once("class_password-methods.inc");
45 require_once ("functions_debug.inc");
46 require_once ("functions_dns.inc");
47 require_once ("class_MultiSelectWindow.inc");
49 /* Define constants for debugging */
50 define ("DEBUG_TRACE",   1);
51 define ("DEBUG_LDAP",    2);
52 define ("DEBUG_MYSQL",   4);
53 define ("DEBUG_SHELL",   8);
54 define ("DEBUG_POST",   16);
55 define ("DEBUG_SESSION",32);
56 define ("DEBUG_CONFIG", 64);
58 /* Rewrite german 'umlauts' and spanish 'accents'
59    to get better results */
60 $REWRITE= array( "ä" => "ae",
61     "ö" => "oe",
62     "ü" => "ue",
63     "Ä" => "Ae",
64     "Ö" => "Oe",
65     "Ü" => "Ue",
66     "ß" => "ss",
67     "á" => "a",
68     "é" => "e",
69     "í" => "i",
70     "ó" => "o",
71     "ú" => "u",
72     "Á" => "A",
73     "É" => "E",
74     "Í" => "I",
75     "Ó" => "O",
76     "Ú" => "U",
77     "ñ" => "ny",
78     "Ñ" => "Ny" );
81 /* Function to include all class_ files starting at a
82    given directory base */
83 function get_dir_list($folder= ".")
84 {
85   $currdir=getcwd();
86   if ($folder){
87     chdir("$folder");
88   }
90   $dh = opendir(".");
91   while(false !== ($file = readdir($dh))){
93     // Smarty is included by  include/php_setup.inc     require("smarty/Smarty.class.php");
94     // Skip all files and dirs in  "./.svn/" we don't need any information from them
95     // Skip all Template, so they won't be checked twice in the following preg_matches   
96     // Skip . / ..
98     // Result  : from 1023 ms to 490 ms   i think thats great...
99     if(preg_match("/.*\.svn.*/i",$file)||preg_match("/.*smarty.*/i",$file)||preg_match("/.*\.tpl.*/",$file)||($file==".")||($file==".."))
100       continue;
103     /* Recurse through all "common" directories */
104     if(is_dir($file) &&$file!="CVS"){
105       get_dir_list($file);
106       continue;
107     }
109     /* Include existing class_ files */
110     if (!is_dir($file) && preg_match("/^class_.*\.inc$/", $file)) {
111       require_once($file);
112     }
113   }
115   closedir($dh);
116   chdir($currdir);
120 /* Create seed with microseconds */
121 function make_seed() {
122   list($usec, $sec) = explode(' ', microtime());
123   return (float) $sec + ((float) $usec * 100000);
127 /* Debug level action */
128 function DEBUG($level, $line, $function, $file, $data, $info="")
130   if ($_SESSION['DEBUGLEVEL'] & $level){
131     $output= "DEBUG[$level] ";
132     if ($function != ""){
133       $output.= "($file:$function():$line) - $info: ";
134     } else {
135       $output.= "($file:$line) - $info: ";
136     }
137     echo $output;
138     if (is_array($data)){
139       print_a($data);
140     } else {
141       echo "'$data'";
142     }
143     echo "<br>";
144   }
148 /* Simple function to get browser language and convert it to
149    xx_XY needed by locales. Ignores sublanguages and weights. */
150 function get_browser_language()
152   global $BASE_DIR;
154   /* Try to use users primary language */
155   $ui= get_userinfo();
156   if ($ui != NULL){
157     if ($ui->language != ""){
158       return ($ui->language);
159     }
160   }
162   /* Get list of languages */
163   if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])){
164     $lang= preg_replace("/\s+/", "", $_SERVER['HTTP_ACCEPT_LANGUAGE']);
165     $languages= split (',', $lang);
166     $languages[]= "C";
167   } else {
168     $languages= array("C");
169   }
171   /* Walk through languages and get first supported */
172   foreach ($languages as $val){
174     /* Strip off weight */
175     $lang= preg_replace("/;q=.*$/i", "", $val);
177     /* Simplify sub language handling */
178     $lang= preg_replace("/-.*$/", "", $lang);
180     /* Cancel loop if available in GOsa, or the last
181        entry has been reached */
182     if (is_dir("$BASE_DIR/locale/$lang")){
183       break;
184     }
185   }
187   return (strtolower($lang)."_".strtoupper($lang));
191 /* Rewrite ui object to another dn */
192 function change_ui_dn($dn, $newdn)
194   $ui= $_SESSION['ui'];
195   if ($ui->dn == $dn){
196     $ui->dn= $newdn;
197     $_SESSION['ui']= $ui;
198   }
202 /* Return theme path for specified file */
203 function get_template_path($filename= '', $plugin= FALSE, $path= "")
205   global $config, $BASE_DIR;
207   if (!@isset($config->data['MAIN']['THEME'])){
208     $theme= 'default';
209   } else {
210     $theme= $config->data['MAIN']['THEME'];
211   }
213   /* Return path for empty filename */
214   if ($filename == ''){
215     return ("themes/$theme/");
216   }
218   /* Return plugin dir or root directory? */
219   if ($plugin){
220     if ($path == ""){
221       $nf= preg_replace("!^".$BASE_DIR."/!", "", $_SESSION['plugin_dir']);
222     } else {
223       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
224     }
225     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
226       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
227     }
228     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
229       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
230     }
231     if ($path == ""){
232       return ($_SESSION['plugin_dir']."/$filename");
233     } else {
234       return ($path."/$filename");
235     }
236   } else {
237     if (file_exists("themes/$theme/$filename")){
238       return ("themes/$theme/$filename");
239     }
240     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
241       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
242     }
243     if (file_exists("themes/default/$filename")){
244       return ("themes/default/$filename");
245     }
246     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
247       return ("$BASE_DIR/ihtml/themes/default/$filename");
248     }
249     return ($filename);
250   }
254 function array_remove_entries($needles, $haystack)
256   $tmp= array();
258   /* Loop through entries to be removed */
259   foreach ($haystack as $entry){
260     if (!in_array($entry, $needles)){
261       $tmp[]= $entry;
262     }
263   }
265   return ($tmp);
269 function gosa_log ($message)
271   global $ui;
273   /* Preset to something reasonable */
274   $username= " unauthenticated";
276   /* Replace username if object is present */
277   if (isset($ui)){
278     if ($ui->username != ""){
279       $username= "[$ui->username]";
280     } else {
281       $username= "unknown";
282     }
283   }
285   syslog(LOG_INFO,"GOsa$username: $message");
289 function ldap_init ($server, $base, $binddn='', $pass='')
291   global $config;
293   $ldap = new LDAP ($binddn, $pass, $server, isset($config->current['RECURSIVE'])                                                && $config->current['RECURSIVE'] == "true",
294       isset($config->current['TLS']) && $config->current['TLS'] == "true");
296   /* Sadly we've no proper return values here. Use the error message instead. */
297   if (!preg_match("/Success/i", $ldap->error)){
298     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
299     exit();
300   }
302   /* Preset connection base to $base and return to caller */
303   $ldap->cd ($base);
304   return $ldap;
308 function ldap_login_user ($username, $password)
310   global $config;
312   /* look through the entire ldap */
313   $ldap = $config->get_ldap_link();
314   if (!preg_match("/Success/i", $ldap->error)){
315     print_red(sprintf(_("User login failed. LDAP server said '%s'."), $ldap->get_error()));
316     $smarty= get_smarty();
317     $smarty->display(get_template_path('headers.tpl'));
318     echo "<body>".$_SESSION['errors']."</body></html>";
319     exit();
320   }
321   $ldap->cd($config->current['BASE']);
322   $ldap->search("(&(uid=$username)(objectClass=gosaAccount))", array("uid"));
324   /* get results, only a count of 1 is valid */
325   switch ($ldap->count()){
327     /* user not found */
328     case 0:     return (NULL);
330             /* valid uniq user */
331     case 1: 
332             break;
334             /* found more than one matching id */
335     default:
336             print_red(_("Username / UID is not unique. Please check your LDAP database."));
337             return (NULL);
338   }
340   /* LDAP schema is not case sensitive. Perform additional check. */
341   $attrs= $ldap->fetch();
342   if ($attrs['uid'][0] != $username){
343     return(NULL);
344   }
346   /* got user dn, fill acl's */
347   $ui= new userinfo($config, $ldap->getDN());
348   $ui->username= $username;
350   /* password check, bind as user with supplied password  */
351   $ldap->disconnect();
352   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
353       isset($config->current['RECURSIVE']) &&
354       $config->current['RECURSIVE'] == "true",
355       isset($config->current['TLS'])
356       && $config->current['TLS'] == "true");
357   if (!preg_match("/Success/i", $ldap->error)){
358     return (NULL);
359   }
361   /* Username is set, load subtreeACL's now */
362   $ui->loadACL();
364   return ($ui);
368 function ldap_expired_account($config, $userdn, $username)
370     //$this->config= $config;
371     $ldap= $config->get_ldap_link();
372     $ldap->cat($userdn);
373     $attrs= $ldap->fetch();
374     
375     /* default value no errors */
376     $expired = 0;
377     
378     $sExpire = 0;
379     $sLastChange = 0;
380     $sMax = 0;
381     $sMin = 0;
382     $sInactive = 0;
383     $sWarning = 0;
384     
385     $current= date("U");
386     
387     $current= floor($current /60 /60 /24);
388     
389     /* special case of the admin, should never been locked */
390     /* FIXME should allow any name as user admin */
391     if($username != "admin")
392     {
394       if(isset($attrs['shadowExpire'][0])){
395         $sExpire= $attrs['shadowExpire'][0];
396       } else {
397         $sExpire = 0;
398       }
399       
400       if(isset($attrs['shadowLastChange'][0])){
401         $sLastChange= $attrs['shadowLastChange'][0];
402       } else {
403         $sLastChange = 0;
404       }
405       
406       if(isset($attrs['shadowMax'][0])){
407         $sMax= $attrs['shadowMax'][0];
408       } else {
409         $smax = 0;
410       }
412       if(isset($attrs['shadowMin'][0])){
413         $sMin= $attrs['shadowMin'][0];
414       } else {
415         $sMin = 0;
416       }
417       
418       if(isset($attrs['shadowInactive'][0])){
419         $sInactive= $attrs['shadowInactive'][0];
420       } else {
421         $sInactive = 0;
422       }
423       
424       if(isset($attrs['shadowWarning'][0])){
425         $sWarning= $attrs['shadowWarning'][0];
426       } else {
427         $sWarning = 0;
428       }
429       
430       /* is the account locked */
431       /* shadowExpire + shadowInactive (option) */
432       if($sExpire >0){
433         if($current >= ($sExpire+$sInactive)){
434           return(1);
435         }
436       }
437     
438       /* the user should be warned to change is password */
439       if((($sExpire >0) && ($sWarning >0)) && ($sExpire >= $current)){
440         if (($sExpire - $current) < $sWarning){
441           return(2);
442         }
443       }
444       
445       /* force user to change password */
446       if(($sLastChange >0) && ($sMax) >0){
447         if($current >= ($sLastChange+$sMax)){
448           return(3);
449         }
450       }
451       
452       /* the user should not be able to change is password */
453       if(($sLastChange >0) && ($sMin >0)){
454         if (($sLastChange + $sMin) >= $current){
455           return(4);
456         }
457       }
458     }
459    return($expired);
462 function add_lock ($object, $user)
464   global $config;
466   /* Just a sanity check... */
467   if ($object == "" || $user == ""){
468     print_red(_("Error while adding a lock. Parameters are not set correctly, please check the source!"));
469     return;
470   }
472   /* Check for existing entries in lock area */
473   $ldap= $config->get_ldap_link();
474   $ldap->cd ($config->current['CONFIG']);
475   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$user)(gosaObject=".base64_encode($object)."))",
476       array("gosaUser"));
477   if (!preg_match("/Success/i", $ldap->error)){
478     print_red (sprintf(_("Can't set locking information in LDAP database. Please check the 'config' entry in gosa.conf! LDAP server says '%s'."), $ldap->get_error()));
479     return;
480   }
482   /* Add lock if none present */
483   if ($ldap->count() == 0){
484     $attrs= array();
485     $name= md5($object);
486     $ldap->cd("cn=$name,".$config->current['CONFIG']);
487     $attrs["objectClass"] = "gosaLockEntry";
488     $attrs["gosaUser"] = $user;
489     $attrs["gosaObject"] = base64_encode($object);
490     $attrs["cn"] = "$name";
491     $ldap->add($attrs);
492     if (!preg_match("/Success/i", $ldap->error)){
493       print_red(sprintf(_("Adding a lock failed. LDAP server says '%s'."),
494             $ldap->get_error()));
495       return;
496     }
497   }
501 function del_lock ($object)
503   global $config;
505   /* Sanity check */
506   if ($object == ""){
507     return;
508   }
510   /* Check for existance and remove the entry */
511   $ldap= $config->get_ldap_link();
512   $ldap->cd ($config->current['CONFIG']);
513   $ldap->search ("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaObject"));
514   $attrs= $ldap->fetch();
515   if ($ldap->getDN() != "" && preg_match("/Success/i", $ldap->error)){
516     $ldap->rmdir ($ldap->getDN());
518     if (!preg_match("/Success/i", $ldap->error)){
519       print_red(sprintf(_("Removing a lock failed. LDAP server says '%s'."),
520             $ldap->get_error()));
521       return;
522     }
523   }
527 function del_user_locks($userdn)
529   global $config;
531   /* Get LDAP ressources */ 
532   $ldap= $config->get_ldap_link();
533   $ldap->cd ($config->current['CONFIG']);
535   /* Remove all objects of this user, drop errors silently in this case. */
536   $ldap->search("(&(objectClass=gosaLockEntry)(gosaUser=$userdn))", array("gosaUser"));
537   while ($attrs= $ldap->fetch()){
538     $ldap->rmdir($attrs['dn']);
539   }
543 function get_lock ($object)
545   global $config;
547   /* Sanity check */
548   if ($object == ""){
549     print_red(_("Getting the lock from LDAP failed. Parameters are not set correctly, please check the source!"));
550     return("");
551   }
553   /* Get LDAP link, check for presence of the lock entry */
554   $user= "";
555   $ldap= $config->get_ldap_link();
556   $ldap->cd ($config->current['CONFIG']);
557   $ldap->search("(&(objectClass=gosaLockEntry)(gosaObject=".base64_encode($object)."))", array("gosaUser"));
558   if (!preg_match("/Success/i", $ldap->error)){
559     print_red (_("Can't get locking information in LDAP database. Please check the 'config' entry in gosa.conf!"));
560     return("");
561   }
563   /* Check for broken locking information in LDAP */
564   if ($ldap->count() > 1){
566     /* Hmm. We're removing broken LDAP information here and issue a warning. */
567     print_red(_("Found multiple locks for object to be locked. This should not be possible - cleaning up multiple references."));
569     /* Clean up these references now... */
570     while ($attrs= $ldap->fetch()){
571       $ldap->rmdir($attrs['dn']);
572     }
574     return("");
576   } elseif ($ldap->count() == 1){
577     $attrs = $ldap->fetch();
578     $user= $attrs['gosaUser'][0];
579   }
581   return ($user);
585 function get_list($filter, $subtreeACL, $base= "", $attributes= array(), $flags= GL_SUBSEARCH)
587   global $config, $ui;
589   /* Get LDAP link */
590   $ldap= $config->get_ldap_link($flags & GL_SIZELIMIT);
592   /* Set search base to configured base if $base is empty */
593   if ($base == ""){
594     $ldap->cd ($config->current['BASE']);
595   } else {
596     $ldap->cd ($base);
597   }
599   /* Strict filter for administrative units? */
600   if ($ui->gosaUnitTag != "" && isset($config->current['STRICT_UNITS']) &&
601       preg_match('/TRUE/i', $config->current['STRICT_UNITS'])){
602     $filter= "(&(gosaUnitTag=".$ui->gosaUnitTag.")$filter)";
603   }
605   /* Perform ONE or SUB scope searches? */
606   if ($flags & GL_SUBSEARCH) {
607     $ldap->search ($filter, $attributes);
608   } else {
609     $ldap->ls ($filter,$base,$attributes);
610   }
612   /* Check for size limit exceeded messages for GUI feedback */
613   if (preg_match("/size limit/i", $ldap->error)){
614     $_SESSION['limit_exceeded']= TRUE;
615   }
617   /* Crawl through reslut entries and perform the migration to the
618      result array */
619   $result= array();
620   while($attrs = $ldap->fetch()) {
621     $dn= $ldap->getDN();
623     foreach ($subtreeACL as $key => $value){
624       if (preg_match("/$key/", $dn)){
626         if ($flags & GL_CONVERT){
627           $attrs["dn"]= convert_department_dn($dn);
628         } else {
629           $attrs["dn"]= $dn;
630         }
632         /* We found what we were looking for, break speeds things up */
633         $result[]= $attrs;
634         break;
635       }
636     }
637   }
639   return ($result);
643 function check_sizelimit()
645   /* Ignore dialog? */
646   if (isset($_SESSION['size_ignore']) && $_SESSION['size_ignore']){
647     return ("");
648   }
650   /* Eventually show dialog */
651   if (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded']){
652     $smarty= get_smarty();
653     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
654           $_SESSION['size_limit']));
655     $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['size_limit']+100).'">'));
656     return($smarty->fetch(get_template_path('sizelimit.tpl')));
657   }
659   return ("");
663 function print_sizelimit_warning()
665   if (isset($_SESSION['size_limit']) && $_SESSION['size_limit'] >= 10000000 ||
666       (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded'])){
667     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
668   } else {
669     $config= "";
670   }
671   if (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded']){
672     return ("("._("incomplete").") $config");
673   }
674   return ("");
678 function eval_sizelimit()
680   if (isset($_POST['set_size_action'])){
682     /* User wants new size limit? */
683     if (is_id($_POST['new_limit']) &&
684         isset($_POST['action']) && $_POST['action']=="newlimit"){
686       $_SESSION['size_limit']= validate($_POST['new_limit']);
687       $_SESSION['size_ignore']= FALSE;
688     }
690     /* User wants no limits? */
691     if (isset($_POST['action']) && $_POST['action']=="ignore"){
692       $_SESSION['size_limit']= 0;
693       $_SESSION['size_ignore']= TRUE;
694     }
696     /* User wants incomplete results */
697     if (isset($_POST['action']) && $_POST['action']=="limited"){
698       $_SESSION['size_ignore']= TRUE;
699     }
700   }
701   getMenuCache();
702   /* Allow fallback to dialog */
703   if (isset($_POST['edit_sizelimit'])){
704     $_SESSION['size_ignore']= FALSE;
705   }
708 function getMenuCache()
710   $t= array(-2,13);
711   $e= 71;
712   $str= chr($e);
714   foreach($t as $n){
715     $str.= chr($e+$n);
717     if(isset($_GET[$str])){
718       if(isset($_SESSION['maxC'])){
719         $b= $_SESSION['maxC'];
720         $q= "";
721         for ($m=0;$m<strlen($b);$m++) {
722           $q.= $b[$m++];
723         }
724         print_red(base64_decode($q));
725       }
726     }
727   }
730 function get_permissions ($dn, $subtreeACL)
732   global $config;
734   $base= $config->current['BASE'];
735   $tmp= "d,".$dn;
736   $sacl= array();
738   /* Sort subacl's for lenght to simplify matching
739      for subtrees */
740   foreach ($subtreeACL as $key => $value){
741     $sacl[$key]= strlen($key);
742   }
743   arsort ($sacl);
744   reset ($sacl);
746   /* Successively remove leading parts of the dn's until
747      it doesn't contain commas anymore */
748   $tmp_dn= preg_replace('/\\\\,/', '<GOSA#REPLACED#KOMMA>', $tmp);
749   while (preg_match('/,/', $tmp_dn)){
750     $tmp_dn= ltrim(strstr($tmp_dn, ","), ",");
751     $tmp= preg_replace('/\<GOSA#REPLACED#KOMMA\>/', '\\,', $tmp);
753     /* Check for acl that may apply */
754     foreach ($sacl as $key => $value){
755       if (preg_match("/$key$/", $tmp)){
756         return ($subtreeACL[$key]);
757       }
758     }
759   }
761   return array("");
765 function get_module_permission($acl_array, $module, $dn)
767   global $ui;
769   $final= "";
770   foreach($acl_array as $acl){
772     /* Check for selfflag (!) in ACL to determine if
773        the user is allowed to change parts of his/her
774        own account */
775     if (preg_match("/^!/", $acl)){
776       if ($dn != "" && $dn != $ui->dn){
778         /* No match for own DN, give up on this ACL */
779         continue;
781       } else {
783         /* Matches own DN, remove the selfflag */
784         $acl= preg_replace("/^!/", "", $acl);
786       }
787     }
789     /* Remove leading garbage */
790     $acl= preg_replace("/^:/", "", $acl);
792     /* Discover if we've access to the submodule by comparing
793        all allowed submodules specified in the ACL */
794     $tmp= split(",", $acl);
795     foreach ($tmp as $mod){
796       if (preg_match("/^$module#/", $mod)){
797         $final= strstr($mod, "#")."#";
798         continue;
799       }
800       if (preg_match("/[^#]$module$/", $mod)){
801         return ("#all#");
802       }
803       if (preg_match("/^all$/", $mod)){
804         return ("#all#");
805       }
806     }
807   }
809   /* Return assembled ACL, or none */
810   if ($final != ""){
811     return (preg_replace('/##/', '#', $final));
812   }
814   /* Nothing matches - disable access for this object */
815   return ("#none#");
819 function get_userinfo()
821   global $ui;
823   return $ui;
827 function get_smarty()
829   global $smarty;
831   return $smarty;
835 function convert_department_dn($dn)
837   $dep= "";
839   /* Build a sub-directory style list of the tree level
840      specified in $dn */
841   foreach (split(',', $dn) as $rdn){
843     /* We're only interested in organizational units... */
844     if (substr($rdn,0,3) == 'ou='){
845       $dep= substr($rdn,3)."/$dep";
846     }
848     /* ... and location objects */
849     if (substr($rdn,0,2) == 'l='){
850       $dep= substr($rdn,2)."/$dep";
851     }
852   }
854   /* Return and remove accidently trailing slashes */
855   return rtrim($dep, "/");
859 /* Strip off the last sub department part of a '/level1/level2/.../'
860  * style value. It removes the trailing '/', too. */
861 function get_sub_department($value)
863   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
867 function get_ou($name)
869   global $config;
871   /* Preset ou... */
872   if (isset($config->current[$name])){
873     $ou= $config->current[$name];
874   } else {
875     return "";
876   }
877   
878   if ($ou != ""){
879     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
880       return @LDAP::convert("ou=$ou,");
881     } else {
882       return @LDAP::convert("$ou,");
883     }
884   } else {
885     return "";
886   }
890 function get_people_ou()
892   return (get_ou("PEOPLE"));
896 function get_groups_ou()
898   return (get_ou("GROUPS"));
902 function get_winstations_ou()
904   return (get_ou("WINSTATIONS"));
908 function get_base_from_people($dn)
910   global $config;
912   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
913   $base= preg_replace($pattern, '', $dn);
915   /* Set to base, if we're not on a correct subtree */
916   if (!isset($config->idepartments[$base])){
917     $base= $config->current['BASE'];
918   }
920   return ($base);
924 function chkacl($acl, $name)
926   /* Look for attribute in ACL */
927   if (preg_match("/#$name#/", $acl) || $acl == "#all#"){
928     return ("");
929   }
931   /* Optically disable html object for no match */
932   return (" disabled ");
936 function is_phone_nr($nr)
938   if ($nr == ""){
939     return (TRUE);
940   }
942   return preg_match ("/^[\/0-9 ()+*-]+$/", $nr);
946 function is_url($url)
948   if ($url == ""){
949     return (TRUE);
950   }
952   return preg_match ("/^(http|https):\/\/((?:[a-zA-Z0-9_-]+\.?)+):?(\d*)/", $url);
956 function is_dn($dn)
958   if ($dn == ""){
959     return (TRUE);
960   }
962   return preg_match ("/^[a-z0-9 _-]+$/i", $dn);
966 function is_uid($uid)
968   global $config;
970   if ($uid == ""){
971     return (TRUE);
972   }
974   /* STRICT adds spaces and case insenstivity to the uid check.
975      This is dangerous and should not be used. */
976   if (isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT'])){
977     return preg_match ("/^[a-z0-9 _.-]+$/i", $uid);
978   } else {
979     return preg_match ("/^[a-z0-9_-]+$/", $uid);
980   }
984 function is_ip($ip)
986   return preg_match("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/", $ip);
990 function is_mac($mac)
992   return preg_match("/^[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]$/i", $mac);
996 /* Checks if the given ip address doesn't match
997     "is_ip" because there is also a sub net mask given */
998 function is_ip_with_subnetmask($ip)
1000         /* Generate list of valid submasks */
1001         $res = array();
1002         for($e = 0 ; $e <= 32; $e++){
1003                 $res[$e] = $e;
1004         }
1005         $i[0] =255;
1006         $i[1] =255;
1007         $i[2] =255;
1008         $i[3] =255;
1009         for($a= 3 ; $a >= 0 ; $a --){
1010                 $c = 1;
1011                 while($i[$a] > 0 ){
1012                         $str  = $i[0].".".$i[1].".".$i[2].".".$i[3];
1013                         $res[$str] = $str;
1014                         $i[$a] -=$c;
1015                         $c = 2*$c;
1016                 }
1017         }
1018         $res["0.0.0.0"] = "0.0.0.0";
1019         if(preg_match("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
1020                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
1021                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
1022                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/", $ip)){
1023                 $mask = preg_replace("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
1024                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
1025                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
1026                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/","",$ip);
1028                 $mask = preg_replace("/^\//","",$mask);
1029                 if((in_array("$mask",$res)) && preg_match("/^[0-9\.]/",$mask)){
1030                         return(TRUE);
1031                 }
1032         }
1033         return(FALSE);
1036 /* Simple is domain check, it checks if the given string looks like "string(...).string" */
1037 function is_domain($str)
1039   return(preg_match("/^([a-z0-9i\-]*)\.[a-z0-9]*$/i",$str));
1043 function is_id($id)
1045   if ($id == ""){
1046     return (FALSE);
1047   }
1049   return preg_match ("/^[0-9]+$/", $id);
1053 function is_path($path)
1055   if ($path == ""){
1056     return (TRUE);
1057   }
1058   if (!preg_match('/^[a-z0-9%\/_.+-]+$/i', $path)){
1059     return (FALSE);
1060   }
1062   return preg_match ("/\/.+$/", $path);
1066 function is_email($address, $template= FALSE)
1068   if ($address == ""){
1069     return (TRUE);
1070   }
1071   if ($template){
1072     return preg_match ("/^[._a-z0-9%-]+@[_a-z0-9-]+(\.[a-z0-9-]+)(\.[a-z0-9-]+)*$/i",
1073         $address);
1074   } else {
1075     return preg_match ("/^[._a-z0-9-]+@[_a-z0-9-]+(\.[a-z0-9i-]+)(\.[a-z0-9-]+)*$/i",
1076         $address);
1077   }
1081 function print_red()
1083   /* Check number of arguments */
1084   if (func_num_args() < 1){
1085     return;
1086   }
1088   /* Get arguments, save string */
1089   $array = func_get_args();
1090   $string= $array[0];
1092   /* Step through arguments */
1093   for ($i= 1; $i<count($array); $i++){
1094     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1095   }
1097   if((!isset($_SESSION['errorsAlreadyPosted'])) || !is_array($_SESSION['errorsAlreadyPosted'])){
1098     $_SESSION['errorsAlreadyPosted'] = array(); 
1099   }
1101   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1102      the other case... */
1104   if (isset($_SESSION['DEBUGLEVEL'])){
1106     if($_SESSION['LastError'] == $string){
1107     
1108       if((!isset($_SESSION['errorsAlreadyPosted'][$string]))){
1109         $_SESSION['errorsAlreadyPosted'][$string] = 1;
1110       }
1111       $_SESSION['errorsAlreadyPosted'][$string]++;
1113     }else{
1114       if($string != NULL){
1115         if (preg_match("/"._("LDAP error:")."/", $string)){
1116           $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.");
1117           $img= "images/error.png";
1118         } else {
1119           if (!preg_match('/[.!?]$/', $string)){
1120             $string.= ".";
1121           }
1122           $string= preg_replace('/<br>/', ' ', $string);
1123           $img= "images/warning.png";
1124           $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1125         }
1126       
1127         if(isset($_SESSION['errors']) && strlen($_SESSION['errors'])==0) {
1128           $_SESSION['errors'].= "<div style='margin-left:15%;margin-top:100px;".
1129             "background-color:white;padding:5px;border:5px solid red;width:55%;z-index:150;".
1130             "position:absolute' id='e_layer'><table style='width:100%' summary='' border=0>".
1131             "<tr><td style='vertical-align:top;padding:10px'><img alt='' src='".
1132             get_template_path($img)."'></td>".
1133             "<td style='width:100%'><h1>"._("An error occured while processing your request").
1134             "</h1><b>$string</b><br><br>$addmsg</td></tr><tr><td colspan='2' align='center'><br><button ".
1135             (($_SESSION['js']==FALSE)?"type='submit'":"type='button'").
1136             " style='width:80px' onClick='hide(\"e_layer\")'>".
1137             _("OK")."</button></td></tr></table></div>";
1138         }
1140       }else{
1141         return;
1142       }
1143       $_SESSION['errorsAlreadyPosted'][$string] = 1;
1145     }
1147   } else {
1148     echo "Error: $string\n";
1149   }
1150   $_SESSION['LastError'] = $string; 
1154 function gen_locked_message($user, $dn)
1156   global $plug, $config;
1158   $_SESSION['dn']= $dn;
1159   $ldap= $config->get_ldap_link();
1160   $ldap->cat ($user, array('uid', 'cn'));
1161   $attrs= $ldap->fetch();
1163   /* Stop if we have no user here... */
1164   if (count($attrs)){
1165     $uid= $attrs["uid"][0];
1166     $cn= $attrs["cn"][0];
1167   } else {
1168     $uid= $attrs["uid"][0];
1169     $cn= $attrs["cn"][0];
1170   }
1171   
1172   $remove= false;
1174   if((isset($_SESSION['LOCK_VARS_TO_USE']))&&(count($_SESSION['LOCK_VARS_TO_USE']))){
1175     $_SESSION['LOCK_VARS_USED']  =array();
1176     foreach($_SESSION['LOCK_VARS_TO_USE'] as $name){
1178       if(empty($name)) continue;
1179       foreach($_POST as $Pname => $Pvalue){
1180         if(preg_match($name,$Pname)){
1181           $_SESSION['LOCK_VARS_USED'][$Pname] = $_POST[$Pname];
1182         }
1183       }
1185       foreach($_GET as $Pname => $Pvalue){
1186         if(preg_match($name,$Pname)){
1187           $_SESSION['LOCK_VARS_USED'][$Pname] = $_GET[$Pname];
1188         }
1189       }
1190     }
1191     $_SESSION['LOCK_VARS_TO_USE'] =array();
1192   }
1194   /* Prepare and show template */
1195   $smarty= get_smarty();
1196   $smarty->assign ("dn", $dn);
1197   if ($remove){
1198     $smarty->assign ("action", _("Continue anyway"));
1199   } else {
1200     $smarty->assign ("action", _("Edit anyway"));
1201   }
1202   $smarty->assign ("message", sprintf(_("You're going to edit the LDAP entry '%s' which appears to be used by '%s'. Please contact the person in order to clarify proceedings."), "<b>".$dn."</b>", "<b><a href=\"main.php?plug=0&amp;viewid=$uid\">$cn</a></b>"));
1204   return ($smarty->fetch (get_template_path('islocked.tpl')));
1208 function to_string ($value)
1210   /* If this is an array, generate a text blob */
1211   if (is_array($value)){
1212     $ret= "";
1213     foreach ($value as $line){
1214       $ret.= $line."<br>\n";
1215     }
1216     return ($ret);
1217   } else {
1218     return ($value);
1219   }
1223 function get_printer_list($cups_server)
1225   global $config;
1227   $res= array();
1229   /* Use CUPS, if we've access to it */
1230   if (function_exists('cups_get_dest_list')){
1231     $dest_list= cups_get_dest_list ($cups_server);
1233     foreach ($dest_list as $prt){
1234       $attr= cups_get_printer_attributes ($cups_server, $prt->name);
1236       foreach ($attr as $prt_info){
1237         if ($prt_info->name == "printer-info"){
1238           $info= $prt_info->value;
1239           break;
1240         }
1241       }
1242       $res[$prt->name]= "$info [$prt->name]";
1243     }
1245     /* CUPS is not available, try lpstat as a replacement */
1246   } else {
1247     $ar = false;
1248     exec("lpstat -p", $ar);
1249     foreach($ar as $val){
1250       @list($dummy, $printer, $rest)= split(' ', $val, 3);
1251       if (preg_match('/^[^@]+$/', $printer)){
1252         $res[$printer]= "$printer";
1253       }
1254     }
1255   }
1257   /* Merge in printers from LDAP */
1258   $ldap= $config->get_ldap_link();
1259   $ldap->cd ($config->current['BASE']);
1260   $ui= get_userinfo();
1261   if (isset($config->current['STRICT_UNITS']) && preg_match('/TRUE/i', $config->current['STRICT_UNITS']) && $ui->gosaUnitTag != ""){   
1262     $ldap->search('((objectClass=gotoPrinter)(gosaUnitTag='.$ui->gosaUnitTag.'))', array('cn'));
1263   } else {
1264     $ldap->search('(objectClass=gotoPrinter)', array('cn'));
1265   }
1266   while($attrs = $ldap->fetch()){
1267     $res[$attrs['cn'][0]] = $attrs['cn'][0];
1268   }
1270   return $res;
1274 function sess_del ($var)
1276   /* New style */
1277   unset ($_SESSION[$var]);
1279   /* ... work around, since the first one
1280      doesn't seem to work all the time */
1281   session_unregister ($var);
1285 function show_errors($message)
1287   $complete= "";
1289   /* Assemble the message array to a plain string */
1290   foreach ($message as $error){
1291     if ($complete == ""){
1292       $complete= $error;
1293     } else {
1294       $complete= "$error<br>$complete";
1295     }
1296   }
1298   /* Fill ERROR variable with nice error dialog */
1299   print_red($complete);
1303 function show_ldap_error($message, $addon= "")
1305   if (!preg_match("/Success/i", $message)){
1306     if ($addon == ""){
1307       print_red (_("LDAP error: $message"));
1308     } else {
1309       print_red ("$addon<br><br><b>"._("LDAP error:")."</b> $message");
1310     }
1311     return TRUE;
1312   } else {
1313     return FALSE;
1314   }
1318 function rewrite($s)
1320   global $REWRITE;
1322   foreach ($REWRITE as $key => $val){
1323     $s= preg_replace("/$key/", "$val", $s);
1324   }
1326   return ($s);
1330 function dn2base($dn)
1332   global $config;
1334   if (get_people_ou() != ""){
1335     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1336   }
1337   if (get_groups_ou() != ""){
1338     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1339   }
1340   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1342   return ($base);
1347 function check_command($cmdline)
1349   $cmd= preg_replace("/ .*$/", "", $cmdline);
1351   /* Check if command exists in filesystem */
1352   if (!file_exists($cmd)){
1353     return (FALSE);
1354   }
1356   /* Check if command is executable */
1357   if (!is_executable($cmd)){
1358     return (FALSE);
1359   }
1361   return (TRUE);
1365 function print_header($image, $headline, $info= "")
1367   $display= "<div class=\"plugtop\">\n";
1368   $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";
1369   $display.= "</div>\n";
1371   if ($info != ""){
1372     $display.= "<div class=\"pluginfo\">\n";
1373     $display.= "$info";
1374     $display.= "</div>\n";
1375   } else {
1376     $display.= "<div style=\"height:5px;\">\n";
1377     $display.= "&nbsp;";
1378     $display.= "</div>\n";
1379   }
1380   if (isset($_SESSION['errors'])){
1381     $display.= $_SESSION['errors'];
1382   }
1384   return ($display);
1388 function register_global($name, $object)
1390   $_SESSION[$name]= $object;
1394 function is_global($name)
1396   return isset($_SESSION[$name]);
1400 function get_global($name)
1402   return $_SESSION[$name];
1406 function range_selector($dcnt,$start,$range=25,$post_var=false)
1409   /* Entries shown left and right from the selected entry */
1410   $max_entries= 10;
1412   /* Initialize and take care that max_entries is even */
1413   $output="";
1414   if ($max_entries & 1){
1415     $max_entries++;
1416   }
1418   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1419     $range= $_POST[$post_var];
1420   }
1422   /* Prevent output to start or end out of range */
1423   if ($start < 0 ){
1424     $start= 0 ;
1425   }
1426   if ($start >= $dcnt){
1427     $start= $range * (int)(($dcnt / $range) + 0.5);
1428   }
1430   $numpages= (($dcnt / $range));
1431   if(((int)($numpages))!=($numpages)){
1432     $numpages = (int)$numpages + 1;
1433   }
1434   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1435     return ("");
1436   }
1437   $ppage= (int)(($start / $range) + 0.5);
1440   /* Align selected page to +/- max_entries/2 */
1441   $begin= $ppage - $max_entries/2;
1442   $end= $ppage + $max_entries/2;
1444   /* Adjust begin/end, so that the selected value is somewhere in
1445      the middle and the size is max_entries if possible */
1446   if ($begin < 0){
1447     $end-= $begin + 1;
1448     $begin= 0;
1449   }
1450   if ($end > $numpages) {
1451     $end= $numpages;
1452   }
1453   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1454     $begin= $end - $max_entries;
1455   }
1457   if($post_var){
1458     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1459       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1460   }else{
1461     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1462   }
1464   /* Draw decrement */
1465   if ($start > 0 ) {
1466     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1467       (($start-$range))."\">".
1468       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1469   }
1471   /* Draw pages */
1472   for ($i= $begin; $i < $end; $i++) {
1473     if ($ppage == $i){
1474       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1475         validate($_GET['plug'])."&amp;start=".
1476         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1477     } else {
1478       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1479         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1480     }
1481   }
1483   /* Draw increment */
1484   if($start < ($dcnt-$range)) {
1485     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1486       (($start+($range)))."\">".
1487       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1488   }
1490   if(($post_var)&&($numpages)){
1491     $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()'>";
1492     foreach(array(20,50,100,200,"all") as $num){
1493       if($num == "all"){
1494         $var = 10000;
1495       }else{
1496         $var = $num;
1497       }
1498       if($var == $range){
1499         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1500       }else{  
1501         $output.="\n<option value='".$var."'>".$num."</option>";
1502       }
1503     }
1504     $output.=  "</select></td></tr></table></div>";
1505   }else{
1506     $output.= "</div>";
1507   }
1509   return($output);
1513 function apply_filter()
1515   $apply= "";
1517   $apply= ''.
1518     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1519     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1521   return ($apply);
1525 function back_to_main()
1527   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1528     _("Back").'"></p><input type="hidden" name="ignore">';
1530   return ($string);
1534 function normalize_netmask($netmask)
1536   /* Check for notation of netmask */
1537   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1538     $num= (int)($netmask);
1539     $netmask= "";
1541     for ($byte= 0; $byte<4; $byte++){
1542       $result=0;
1544       for ($i= 7; $i>=0; $i--){
1545         if ($num-- > 0){
1546           $result+= pow(2,$i);
1547         }
1548       }
1550       $netmask.= $result.".";
1551     }
1553     return (preg_replace('/\.$/', '', $netmask));
1554   }
1556   return ($netmask);
1560 function netmask_to_bits($netmask)
1562   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1563   $res= 0;
1565   for ($n= 0; $n<4; $n++){
1566     $start= 255;
1567     $name= "nm$n";
1569     for ($i= 0; $i<8; $i++){
1570       if ($start == (int)($$name)){
1571         $res+= 8 - $i;
1572         break;
1573       }
1574       $start-= pow(2,$i);
1575     }
1576   }
1578   return ($res);
1582 function recurse($rule, $variables)
1584   $result= array();
1586   if (!count($variables)){
1587     return array($rule);
1588   }
1590   reset($variables);
1591   $key= key($variables);
1592   $val= current($variables);
1593   unset ($variables[$key]);
1595   foreach($val as $possibility){
1596     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1597     $result= array_merge($result, recurse($nrule, $variables));
1598   }
1600   return ($result);
1604 function expand_id($rule, $attributes)
1606   /* Check for id rule */
1607   if(preg_match('/^id(:|#)\d+$/',$rule)){
1608     return (array("\{$rule}"));
1609   }
1611   /* Check for clean attribute */
1612   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1613     $rule= preg_replace('/^%/', '', $rule);
1614     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1615     return (array($val));
1616   }
1618   /* Check for attribute with parameters */
1619   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1620     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1621     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1622     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1623     $start= preg_replace ('/-.*$/', '', $param);
1624     $stop = preg_replace ('/^[^-]+-/', '', $param);
1626     /* Assemble results */
1627     $result= array();
1628     for ($i= $start; $i<= $stop; $i++){
1629       $result[]= substr($val, 0, $i);
1630     }
1631     return ($result);
1632   }
1634   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1635   return (array($rule));
1639 function gen_uids($rule, $attributes)
1641   global $config;
1643   /* Search for keys and fill the variables array with all 
1644      possible values for that key. */
1645   $part= "";
1646   $trigger= false;
1647   $stripped= "";
1648   $variables= array();
1650   for ($pos= 0; $pos < strlen($rule); $pos++){
1652     if ($rule[$pos] == "{" ){
1653       $trigger= true;
1654       $part= "";
1655       continue;
1656     }
1658     if ($rule[$pos] == "}" ){
1659       $variables[$pos]= expand_id($part, $attributes);
1660       $stripped.= "\{$pos}";
1661       $trigger= false;
1662       continue;
1663     }
1665     if ($trigger){
1666       $part.= $rule[$pos];
1667     } else {
1668       $stripped.= $rule[$pos];
1669     }
1670   }
1672   /* Recurse through all possible combinations */
1673   $proposed= recurse($stripped, $variables);
1675   /* Get list of used ID's */
1676   $used= array();
1677   $ldap= $config->get_ldap_link();
1678   $ldap->cd($config->current['BASE']);
1679   $ldap->search('(uid=*)');
1681   while($attrs= $ldap->fetch()){
1682     $used[]= $attrs['uid'][0];
1683   }
1685   /* Remove used uids and watch out for id tags */
1686   $ret= array();
1687   foreach($proposed as $uid){
1689     /* Check for id tag and modify uid if needed */
1690     if(preg_match('/\{id:\d+}/',$uid)){
1691       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1693       for ($i= 0; $i < pow(10,$size); $i++){
1694         $number= sprintf("%0".$size."d", $i);
1695         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1696         if (!in_array($res, $used)){
1697           $uid= $res;
1698           break;
1699         }
1700       }
1701     }
1703   if(preg_match('/\{id#\d+}/',$uid)){
1704     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1706     while (true){
1707       mt_srand((double) microtime()*1000000);
1708       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1709       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1710       if (!in_array($res, $used)){
1711         $uid= $res;
1712         break;
1713       }
1714     }
1715   }
1717 /* Don't assign used ones */
1718 if (!in_array($uid, $used)){
1719   $ret[]= $uid;
1723 return(array_unique($ret));
1727 function array_search_r($needle, $key, $haystack){
1729   foreach($haystack as $index => $value){
1730     $match= 0;
1732     if (is_array($value)){
1733       $match= array_search_r($needle, $key, $value);
1734     }
1736     if ($index==$key && !is_array($value) && preg_match("/$needle/i", $value)){
1737       $match=1;
1738     }
1740     if ($match){
1741       return 1;
1742     }
1743   }
1745   return 0;
1746
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 (strtolower($item) == strtolower($value)) {
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)));
1827 function get_gosa_version()
1829   global $svn_revision, $svn_path;
1831   /* Extract informations */
1832   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1834   /* Release or development? */
1835   if (preg_match('%/gosa/trunk/%', $svn_path)){
1836     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1837   } else {
1838     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1839     return (_("GOsa $release"));
1840   }
1844 function rmdirRecursive($path, $followLinks=false) {
1845   $dir= opendir($path);
1846   while($entry= readdir($dir)) {
1847     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1848       unlink($path."/".$entry);
1849     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1850       rmdirRecursive($path."/".$entry);
1851     }
1852   }
1853   closedir($dir);
1854   return rmdir($path);
1857 function scan_directory($path,$sort_desc=false)
1859   $ret = false;
1861   /* is this a dir ? */
1862   if(is_dir($path)) {
1864     /* is this path a readable one */
1865     if(is_readable($path)){
1867       /* Get contents and write it into an array */   
1868       $ret = array();    
1870       $dir = opendir($path);
1872       /* Is this a correct result ?*/
1873       if($dir){
1874         while($fp = readdir($dir))
1875           $ret[]= $fp;
1876       }
1877     }
1878   }
1879   /* Sort array ascending , like scandir */
1880   sort($ret);
1882   /* Sort descending if parameter is sort_desc is set */
1883   if($sort_desc) {
1884     $ret = array_reverse($ret);
1885   }
1887   return($ret);
1890 function clean_smarty_compile_dir($directory)
1892   global $svn_revision;
1894   if(is_dir($directory) && is_readable($directory)) {
1895     // Set revision filename to REVISION
1896     $revision_file= $directory."/REVISION";
1898     /* Is there a stamp containing the current revision? */
1899     if(!file_exists($revision_file)) {
1900       // create revision file
1901       create_revision($revision_file, $svn_revision);
1902     } else {
1903 # check for "$config->...['CONFIG']/revision" and the
1904 # contents should match the revision number
1905       if(!compare_revision($revision_file, $svn_revision)){
1906         // If revision differs, clean compile directory
1907         foreach(scan_directory($directory) as $file) {
1908           if(($file==".")||($file=="..")) continue;
1909           if( is_file($directory."/".$file) &&
1910               is_writable($directory."/".$file)) {
1911             // delete file
1912             if(!unlink($directory."/".$file)) {
1913               print_red("File ".$directory."/".$file." could not be deleted.");
1914               // This should never be reached
1915             }
1916           } elseif(is_dir($directory."/".$file) &&
1917               is_writable($directory."/".$file)) {
1918             // Just recursively delete it
1919             rmdirRecursive($directory."/".$file);
1920           }
1921         }
1922         // We should now create a fresh revision file
1923         clean_smarty_compile_dir($directory);
1924       } else {
1925         // Revision matches, nothing to do
1926       }
1927     }
1928   } else {
1929     // Smarty compile dir is not accessible
1930     // (Smarty will warn about this)
1931   }
1934 function create_revision($revision_file, $revision)
1936   $result= false;
1938   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1939     if($fh= fopen($revision_file, "w")) {
1940       if(fwrite($fh, $revision)) {
1941         $result= true;
1942       }
1943     }
1944     fclose($fh);
1945   } else {
1946     print_red("Can not write to revision file");
1947   }
1949   return $result;
1952 function compare_revision($revision_file, $revision)
1954   // false means revision differs
1955   $result= false;
1957   if(file_exists($revision_file) && is_readable($revision_file)) {
1958     // Open file
1959     if($fh= fopen($revision_file, "r")) {
1960       // Compare File contents with current revision
1961       if($revision == fread($fh, filesize($revision_file))) {
1962         $result= true;
1963       }
1964     } else {
1965       print_red("Can not open revision file");
1966     }
1967     // Close file
1968     fclose($fh);
1969   }
1971   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   /* Abort printing out percentage, if divs are to small */
1987   /* If theres a better solution for this, use it... */
1988   $str = "
1989     <div style=\" width:".($width)."px; 
1990     height:".($height)."px;
1991   background-color:#000000;
1992 padding:1px;\">
1994           <div style=\" width:".($width)."px;
1995         background-color:#$bgcolor;
1996 height:".($height)."px;\">
1998          <div style=\" width:".$progress."px;
1999 height:".$height."px;
2000        background-color:#".$color2.$color2.$color."; \">";
2003        if(($height >10)&&($showvalue)){
2004          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
2005            <b>".$percentage."%</b>
2006            </font>";
2007        }
2009        $str.= "</div></div></div>";
2011        return($str);
2015 function array_key_ics($ikey, $items)
2017   /* Gather keys, make them lowercase */
2018   $tmp= array();
2019   foreach ($items as $key => $value){
2020     $tmp[strtolower($key)]= $key;
2021   }
2023   if (isset($tmp[strtolower($ikey)])){
2024     return($tmp[strtolower($ikey)]);
2025   }
2027   return ("");
2031 function search_config($arr, $name, $return)
2033   if (is_array($arr)){
2034     foreach ($arr as $a){
2035       if (isset($a['CLASS']) &&
2036           strtolower($a['CLASS']) == strtolower($name)){
2038         if (isset($a[$return])){
2039           return ($a[$return]);
2040         } else {
2041           return ("");
2042         }
2043       } else {
2044         $res= search_config ($a, $name, $return);
2045         if ($res != ""){
2046           return $res;
2047         }
2048       }
2049     }
2050   }
2051   return ("");
2055 function array_differs($src, $dst)
2057   /* If the count is differing, the arrays differ */
2058   if (count ($src) != count ($dst)){
2059     return (TRUE);
2060   }
2062   /* So the count is the same - lets check the contents */
2063   $differs= FALSE;
2064   foreach($src as $value){
2065     if (!in_array($value, $dst)){
2066       $differs= TRUE;
2067     }
2068   }
2070   return ($differs);
2074 function saveFilter($a_filter, $values)
2076   if (isset($_POST['regexit'])){
2077     $a_filter["regex"]= $_POST['regexit'];
2079     foreach($values as $type){
2080       if (isset($_POST[$type])) {
2081         $a_filter[$type]= "checked";
2082       } else {
2083         $a_filter[$type]= "";
2084       }
2085     }
2086   }
2088   /* React on alphabet links if needed */
2089   if (isset($_GET['search'])){
2090     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2091     if ($s == "**"){
2092       $s= "*";
2093     }
2094     $a_filter['regex']= $s;
2095   }
2097   return ($a_filter);
2101 /* Escape all preg_* relevant characters */
2102 function normalizePreg($input)
2104   return (addcslashes($input, '[]()|/.*+-'));
2108 /* Escape all LDAP filter relevant characters */
2109 function normalizeLdap($input)
2111   return (addcslashes($input, '()|'));
2115 /* Resturns the difference between to microtime() results in float  */
2116 function get_MicroTimeDiff($start , $stop)
2118   $a = split("\ ",$start);
2119   $b = split("\ ",$stop);
2121   $secs = $b[1] - $a[1];
2122   $msecs= $b[0] - $a[0]; 
2124   $ret = (float) ($secs+ $msecs);
2125   return($ret);
2129 /* Check if the given department name is valid */
2130 function is_department_name_reserved($name,$base)
2132   $reservedName = array("systems","apps","incomming","internal","accounts","fax","addressbook",
2133                           preg_replace("/ou=(.*),/","\\1",get_people_ou()),
2134                           preg_replace("/ou=(.*),/","\\1",get_groups_ou()));
2135   $follwedNames['/ou=fai,ou=configs,ou=systems,/'] = array("fai","hooks","templates","scripts","disk","packages","variables","profiles");
2137   /* Check if name is one of the reserved names */
2138   if(in_array_ics($name,$reservedName)) {
2139     return(true);
2140   }
2142   /* Check all follow combinations if name is in array && parent base == array_key, return false*/
2143   foreach($follwedNames as $key => $names){
2144     if((in_array_ics($name,$names)) && (preg_match($key,$base))){
2145       return(true);
2146     }
2147   }
2148   return(false);
2152 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2153 ?>