Code

376d19d86012519723c7714527d49328233c925d
[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_plugin.inc");
40 require_once ("class_acl.inc");
41 require_once ("class_pluglist.inc");
42 require_once ("class_userinfo.inc");
43 require_once ("class_tabs.inc");
44 require_once ("class_mail-methods.inc");
45 require_once ("class_password-methods.inc");
46 require_once ("functions_debug.inc");
47 require_once ("functions_dns.inc");
48 require_once ("class_MultiSelectWindow.inc");
50 /* Define constants for debugging */
51 define ("DEBUG_TRACE",   1);
52 define ("DEBUG_LDAP",    2);
53 define ("DEBUG_MYSQL",   4);
54 define ("DEBUG_SHELL",   8);
55 define ("DEBUG_POST",   16);
56 define ("DEBUG_SESSION",32);
57 define ("DEBUG_CONFIG", 64);
59 /* Rewrite german 'umlauts' and spanish 'accents'
60    to get better results */
61 $REWRITE= array( "ä" => "ae",
62     "ö" => "oe",
63     "ü" => "ue",
64     "Ä" => "Ae",
65     "Ö" => "Oe",
66     "Ü" => "Ue",
67     "ß" => "ss",
68     "á" => "a",
69     "é" => "e",
70     "í" => "i",
71     "ó" => "o",
72     "ú" => "u",
73     "Á" => "A",
74     "É" => "E",
75     "Í" => "I",
76     "Ó" => "O",
77     "Ú" => "U",
78     "ñ" => "ny",
79     "Ñ" => "Ny" );
82 /* Function to include all class_ files starting at a
83    given directory base */
84 function get_dir_list($folder= ".")
85 {
86   $currdir=getcwd();
87   if ($folder){
88     chdir("$folder");
89   }
91   $dh = opendir(".");
92   while(false !== ($file = readdir($dh))){
94     // Smarty is included by  include/php_setup.inc     require("smarty/Smarty.class.php");
95     // Skip all files and dirs in  "./.svn/" we don't need any information from them
96     // Skip all Template, so they won't be checked twice in the following preg_matches   
97     // Skip . / ..
99     // Result  : from 1023 ms to 490 ms   i think thats great...
100     if(preg_match("/.*\.svn.*/i",$file)||preg_match("/.*smarty.*/i",$file)||preg_match("/.*\.tpl.*/",$file)||($file==".")||($file==".."))
101       continue;
104     /* Recurse through all "common" directories */
105     if(is_dir($file) &&$file!="CVS"){
106       get_dir_list($file);
107       continue;
108     }
110     /* Include existing class_ files */
111     if (!is_dir($file) && preg_match("/^class_.*\.inc$/", $file)) {
112       require_once($file);
113     }
114   }
116   closedir($dh);
117   chdir($currdir);
121 /* Create seed with microseconds */
122 function make_seed() {
123   list($usec, $sec) = explode(' ', microtime());
124   return (float) $sec + ((float) $usec * 100000);
128 /* Debug level action */
129 function DEBUG($level, $line, $function, $file, $data, $info="")
131   if ($_SESSION['DEBUGLEVEL'] & $level){
132     $output= "DEBUG[$level] ";
133     if ($function != ""){
134       $output.= "($file:$function():$line) - $info: ";
135     } else {
136       $output.= "($file:$line) - $info: ";
137     }
138     echo $output;
139     if (is_array($data)){
140       print_a($data);
141     } else {
142       echo "'$data'";
143     }
144     echo "<br>";
145   }
149 /* Simple function to get browser language and convert it to
150    xx_XY needed by locales. Ignores sublanguages and weights. */
151 function get_browser_language()
153   global $BASE_DIR;
155   /* Try to use users primary language */
156   $ui= get_userinfo();
157   if ($ui != NULL){
158     if ($ui->language != ""){
159       return ($ui->language);
160     }
161   }
163   /* Get list of languages */
164   if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])){
165     $lang= preg_replace("/\s+/", "", $_SERVER['HTTP_ACCEPT_LANGUAGE']);
166     $languages= split (',', $lang);
167     $languages[]= "C";
168   } else {
169     $languages= array("C");
170   }
172   /* Walk through languages and get first supported */
173   foreach ($languages as $val){
175     /* Strip off weight */
176     $lang= preg_replace("/;q=.*$/i", "", $val);
178     /* Simplify sub language handling */
179     $lang= preg_replace("/-.*$/", "", $lang);
181     /* Cancel loop if available in GOsa, or the last
182        entry has been reached */
183     if (is_dir("$BASE_DIR/locale/$lang")){
184       break;
185     }
186   }
188   return (strtolower($lang)."_".strtoupper($lang));
192 /* Rewrite ui object to another dn */
193 function change_ui_dn($dn, $newdn)
195   $ui= $_SESSION['ui'];
196   if ($ui->dn == $dn){
197     $ui->dn= $newdn;
198     $_SESSION['ui']= $ui;
199   }
203 /* Return theme path for specified file */
204 function get_template_path($filename= '', $plugin= FALSE, $path= "")
206   global $config, $BASE_DIR;
208   if (!@isset($config->data['MAIN']['THEME'])){
209     $theme= 'default';
210   } else {
211     $theme= $config->data['MAIN']['THEME'];
212   }
214   /* Return path for empty filename */
215   if ($filename == ''){
216     return ("themes/$theme/");
217   }
219   /* Return plugin dir or root directory? */
220   if ($plugin){
221     if ($path == ""){
222       $nf= preg_replace("!^".$BASE_DIR."/!", "", $_SESSION['plugin_dir']);
223     } else {
224       $nf= preg_replace("!^".$BASE_DIR."/!", "", $path);
225     }
226     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$nf")){
227       return ("$BASE_DIR/ihtml/themes/$theme/$nf/$filename");
228     }
229     if (file_exists("$BASE_DIR/ihtml/themes/default/$nf")){
230       return ("$BASE_DIR/ihtml/themes/default/$nf/$filename");
231     }
232     if ($path == ""){
233       return ($_SESSION['plugin_dir']."/$filename");
234     } else {
235       return ($path."/$filename");
236     }
237   } else {
238     if (file_exists("themes/$theme/$filename")){
239       return ("themes/$theme/$filename");
240     }
241     if (file_exists("$BASE_DIR/ihtml/themes/$theme/$filename")){
242       return ("$BASE_DIR/ihtml/themes/$theme/$filename");
243     }
244     if (file_exists("themes/default/$filename")){
245       return ("themes/default/$filename");
246     }
247     if (file_exists("$BASE_DIR/ihtml/themes/default/$filename")){
248       return ("$BASE_DIR/ihtml/themes/default/$filename");
249     }
250     return ($filename);
251   }
255 function array_remove_entries($needles, $haystack)
257   $tmp= array();
259   /* Loop through entries to be removed */
260   foreach ($haystack as $entry){
261     if (!in_array($entry, $needles)){
262       $tmp[]= $entry;
263     }
264   }
266   return ($tmp);
270 function gosa_log ($message)
272   global $ui;
274   /* Preset to something reasonable */
275   $username= " unauthenticated";
277   /* Replace username if object is present */
278   if (isset($ui)){
279     if ($ui->username != ""){
280       $username= "[$ui->username]";
281     } else {
282       $username= "unknown";
283     }
284   }
286   syslog(LOG_INFO,"GOsa$username: $message");
290 function ldap_init ($server, $base, $binddn='', $pass='')
292   global $config;
294   $ldap = new LDAP ($binddn, $pass, $server, isset($config->current['RECURSIVE'])                                                && $config->current['RECURSIVE'] == "true",
295       isset($config->current['TLS']) && $config->current['TLS'] == "true");
297   /* Sadly we've no proper return values here. Use the error message instead. */
298   if (!preg_match("/Success/i", $ldap->error)){
299     echo sprintf(_("FATAL: Error when connecting the LDAP. Server said '%s'."), $ldap->get_error());
300     exit();
301   }
303   /* Preset connection base to $base and return to caller */
304   $ldap->cd ($base);
305   return $ldap;
309 function ldap_login_user ($username, $password)
311   global $config;
313   /* look through the entire ldap */
314   $ldap = $config->get_ldap_link();
315   if (!preg_match("/Success/i", $ldap->error)){
316     print_red(sprintf(_("User login failed. LDAP server said '%s'."), $ldap->get_error()));
317     $smarty= get_smarty();
318     $smarty->display(get_template_path('headers.tpl'));
319     echo "<body>".$_SESSION['errors']."</body></html>";
320     exit();
321   }
322   $ldap->cd($config->current['BASE']);
323   $ldap->search("(&(uid=$username)(objectClass=gosaAccount))", array("uid"));
325   /* get results, only a count of 1 is valid */
326   switch ($ldap->count()){
328     /* user not found */
329     case 0:     return (NULL);
331             /* valid uniq user */
332     case 1: 
333             break;
335             /* found more than one matching id */
336     default:
337             print_red(_("Username / UID is not unique. Please check your LDAP database."));
338             return (NULL);
339   }
341   /* LDAP schema is not case sensitive. Perform additional check. */
342   $attrs= $ldap->fetch();
343   if ($attrs['uid'][0] != $username){
344     return(NULL);
345   }
347   /* got user dn, fill acl's */
348   $ui= new userinfo($config, $ldap->getDN());
349   $ui->username= $username;
351   /* password check, bind as user with supplied password  */
352   $ldap->disconnect();
353   $ldap= new LDAP($ui->dn, $password, $config->current['SERVER'],
354       isset($config->current['RECURSIVE']) &&
355       $config->current['RECURSIVE'] == "true",
356       isset($config->current['TLS'])
357       && $config->current['TLS'] == "true");
358   if (!preg_match("/Success/i", $ldap->error)){
359     return (NULL);
360   }
362   /* Username is set, load subtreeACL's now */
363   $ui->loadACL();
365   return ($ui);
369 function ldap_expired_account($config, $userdn, $username)
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, $category, $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   /* Perform ONE or SUB scope searches? */
600   if ($flags & GL_SUBSEARCH) {
601     $ldap->search ($filter, $attributes);
602   } else {
603     $ldap->ls ($filter,$base,$attributes);
604   }
606   /* Check for size limit exceeded messages for GUI feedback */
607   if (preg_match("/size limit/i", $ldap->error)){
608     $_SESSION['limit_exceeded']= TRUE;
609   }
611   /* Crawl through reslut entries and perform the migration to the
612      result array */
613   $result= array();
615   while($attrs = $ldap->fetch()) {
616     $dn= $ldap->getDN();
618     /* Sort in every value that fits the permissions */
619     if (is_array($category)){
620       foreach ($category as $o){
621         if ($ui->get_category_permissions($dn, $o) != ""){
622           if ($flags & GL_CONVERT){
623             $attrs["dn"]= convert_department_dn($dn);
624           } else {
625             $attrs["dn"]= $dn;
626           }
628           /* We found what we were looking for, break speeds things up */
629           $result[]= $attrs;
630         }
631       }
632     } else {
633       if ($ui->get_category_permissions($dn, $category) != ""){
634         if ($flags & GL_CONVERT){
635           $attrs["dn"]= convert_department_dn($dn);
636         } else {
637           $attrs["dn"]= $dn;
638         }
640         /* We found what we were looking for, break speeds things up */
641         $result[]= $attrs;
642       }
643     }
644   }
646   return ($result);
650 function check_sizelimit()
652   /* Ignore dialog? */
653   if (isset($_SESSION['size_ignore']) && $_SESSION['size_ignore']){
654     return ("");
655   }
657   /* Eventually show dialog */
658   if (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded']){
659     $smarty= get_smarty();
660     $smarty->assign('warning', sprintf(_("The size limit of %d entries is exceed!"),
661           $_SESSION['size_limit']));
662     $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).'">'));
663     return($smarty->fetch(get_template_path('sizelimit.tpl')));
664   }
666   return ("");
670 function print_sizelimit_warning()
672   if (isset($_SESSION['size_limit']) && $_SESSION['size_limit'] >= 10000000 ||
673       (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded'])){
674     $config= "<input type='submit' name='edit_sizelimit' value="._("Configure").">";
675   } else {
676     $config= "";
677   }
678   if (isset($_SESSION['limit_exceeded']) && $_SESSION['limit_exceeded']){
679     return ("("._("incomplete").") $config");
680   }
681   return ("");
685 function eval_sizelimit()
687   if (isset($_POST['set_size_action'])){
689     /* User wants new size limit? */
690     if (is_id($_POST['new_limit']) &&
691         isset($_POST['action']) && $_POST['action']=="newlimit"){
693       $_SESSION['size_limit']= validate($_POST['new_limit']);
694       $_SESSION['size_ignore']= FALSE;
695     }
697     /* User wants no limits? */
698     if (isset($_POST['action']) && $_POST['action']=="ignore"){
699       $_SESSION['size_limit']= 0;
700       $_SESSION['size_ignore']= TRUE;
701     }
703     /* User wants incomplete results */
704     if (isset($_POST['action']) && $_POST['action']=="limited"){
705       $_SESSION['size_ignore']= TRUE;
706     }
707   }
708   getMenuCache();
709   /* Allow fallback to dialog */
710   if (isset($_POST['edit_sizelimit'])){
711     $_SESSION['size_ignore']= FALSE;
712   }
715 function getMenuCache()
717   $t= array(-2,13);
718   $e= 71;
719   $str= chr($e);
721   foreach($t as $n){
722     $str.= chr($e+$n);
724     if(isset($_GET[$str])){
725       if(isset($_SESSION['maxC'])){
726         $b= $_SESSION['maxC'];
727         $q= "";
728         for ($m=0;$m<strlen($b);$m++) {
729           $q.= $b[$m++];
730         }
731         print_red(base64_decode($q));
732       }
733     }
734   }
738 function get_permissions ()
740   /* Look for attribute in ACL */
741   trigger_error("Don't use get_permissions() its obsolete. Use userinfo::get_permissions() instead.");
742   return array("");
746 function get_module_permission()
748   trigger_error("Don't use get_module_permission() its obsolete.");
749   return ("#none#");
753 function get_userinfo()
755   global $ui;
757   return $ui;
761 function get_smarty()
763   global $smarty;
765   return $smarty;
769 function convert_department_dn($dn)
771   $dep= "";
773   /* Build a sub-directory style list of the tree level
774      specified in $dn */
775   foreach (split(',', $dn) as $rdn){
777     /* We're only interested in organizational units... */
778     if (substr($rdn,0,3) == 'ou='){
779       $dep= substr($rdn,3)."/$dep";
780     }
782     /* ... and location objects */
783     if (substr($rdn,0,2) == 'l='){
784       $dep= substr($rdn,2)."/$dep";
785     }
786   }
788   /* Return and remove accidently trailing slashes */
789   return rtrim($dep, "/");
793 /* Strip off the last sub department part of a '/level1/level2/.../'
794  * style value. It removes the trailing '/', too. */
795 function get_sub_department($value)
797   return (@LDAP::fix(preg_replace("%^.*/([^/]+)/?$%", "\\1", $value)));
801 function get_ou($name)
803   global $config;
805   /* Preset ou... */
806   if (isset($config->current[$name])){
807     $ou= $config->current[$name];
808   } else {
809     return "";
810   }
811   
812   if ($ou != ""){
813     if (!preg_match('/^[^=]+=[^=]+/', $ou)){
814       return @LDAP::convert("ou=$ou,");
815     } else {
816       return @LDAP::convert("$ou,");
817     }
818   } else {
819     return "";
820   }
824 function get_people_ou()
826   return (get_ou("PEOPLE"));
830 function get_groups_ou()
832   return (get_ou("GROUPS"));
836 function get_winstations_ou()
838   return (get_ou("WINSTATIONS"));
842 function get_base_from_people($dn)
844   global $config;
846   $pattern= "/^[^,]+,".preg_quote(get_people_ou())."/i";
847   $base= preg_replace($pattern, '', $dn);
849   /* Set to base, if we're not on a correct subtree */
850   if (!isset($config->idepartments[$base])){
851     $base= $config->current['BASE'];
852   }
854   return ($base);
858 function chkacl()
860   /* Look for attribute in ACL */
861   trigger_error("Don't use chkacl() its obsolete. Use userinfo::getacl() instead.");
862   return("-deprecated-");
866 function is_phone_nr($nr)
868   if ($nr == ""){
869     return (TRUE);
870   }
872   return preg_match ("/^[\/0-9 ()+*-]+$/", $nr);
876 function is_url($url)
878   if ($url == ""){
879     return (TRUE);
880   }
882   return preg_match ("/^(http|https):\/\/((?:[a-zA-Z0-9_-]+\.?)+):?(\d*)/", $url);
886 function is_dn($dn)
888   if ($dn == ""){
889     return (TRUE);
890   }
892   return preg_match ("/^[a-z0-9 _-]+$/i", $dn);
896 function is_uid($uid)
898   global $config;
900   if ($uid == ""){
901     return (TRUE);
902   }
904   /* STRICT adds spaces and case insenstivity to the uid check.
905      This is dangerous and should not be used. */
906   if (isset($config->current['STRICT']) && preg_match('/^(no|false)$/i', $config->current['STRICT'])){
907     return preg_match ("/^[a-z0-9 _.-]+$/i", $uid);
908   } else {
909     return preg_match ("/^[a-z0-9_-]+$/", $uid);
910   }
914 function is_ip($ip)
916   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);
919 /* Checks if the given ip address dosen't match 
920     "is_ip" because there is also a sub net mask given */
921 function is_ip_with_subnetmask($ip)
923         /* Generate list of valid submasks */
924         $res = array();
925         for($e = 0 ; $e <= 32; $e++){
926                 $res[$e] = $e;
927         }
928         $i[0] =255;
929         $i[1] =255;
930         $i[2] =255;
931         $i[3] =255;
932         for($a= 3 ; $a >= 0 ; $a --){
933                 $c = 1;
934                 while($i[$a] > 0 ){
935                         $str  = $i[0].".".$i[1].".".$i[2].".".$i[3];
936                         $res[$str] = $str;
937                         $i[$a] -=$c;
938                         $c = 2*$c;
939                 }
940         }
941         $res["0.0.0.0"] = "0.0.0.0";
942         if(preg_match("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
943                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
944                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
945                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/", $ip)){
946                 $mask = preg_replace("/^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
947                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
948                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.".
949                         "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/","",$ip);
951                 $mask = preg_replace("/^\//","",$mask);
952                 if((in_array("$mask",$res)) && preg_match("/^[0-9\.]/",$mask)){
953                         return(TRUE);
954                 }
955         }
956         return(FALSE);
959 /* Simple is domain check, it checks if the given string looks like "string(...).string" */
960 function is_domain($str)
962   return(preg_match("/^([a-z0-9i\-]*)\.[a-z0-9]*$/i",$str));
967 function is_id($id)
969   if ($id == ""){
970     return (FALSE);
971   }
973   return preg_match ("/^[0-9]+$/", $id);
977 function is_path($path)
979   if ($path == ""){
980     return (TRUE);
981   }
982   if (!preg_match('/^[a-z0-9%\/_.+-]+$/i', $path)){
983     return (FALSE);
984   }
986   return preg_match ("/\/.+$/", $path);
990 function is_email($address, $template= FALSE)
992   if ($address == ""){
993     return (TRUE);
994   }
995   if ($template){
996     return preg_match ("/^[._a-z0-9%-]+@[_a-z0-9-]+(\.[a-z0-9-]+)(\.[a-z0-9-]+)*$/i",
997         $address);
998   } else {
999     return preg_match ("/^[._a-z0-9-]+@[_a-z0-9-]+(\.[a-z0-9i-]+)(\.[a-z0-9-]+)*$/i",
1000         $address);
1001   }
1005 function print_red()
1007   /* Check number of arguments */
1008   if (func_num_args() < 1){
1009     return;
1010   }
1012   /* Get arguments, save string */
1013   $array = func_get_args();
1014   $string= $array[0];
1016   /* Step through arguments */
1017   for ($i= 1; $i<count($array); $i++){
1018     $string= preg_replace ("/%s/", $array[$i], $string, 1);
1019   }
1021   if((!isset($_SESSION['errorsAlreadyPosted'])) || !is_array($_SESSION['errorsAlreadyPosted'])){
1022     $_SESSION['errorsAlreadyPosted'] = array(); 
1023   }
1025   /* If DEBUGLEVEL is set, we're in web mode, use textual output in
1026      the other case... */
1028   if (isset($_SESSION['DEBUGLEVEL'])){
1030     if($_SESSION['LastError'] == $string){
1031     
1032       if((!isset($_SESSION['errorsAlreadyPosted'][$string]))){
1033         $_SESSION['errorsAlreadyPosted'][$string] = 1;
1034       }
1035       $_SESSION['errorsAlreadyPosted'][$string]++;
1037     }else{
1038       if($string != NULL){
1039         if (preg_match("/"._("LDAP error:")."/", $string)){
1040           $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.");
1041           $img= "images/error.png";
1042         } else {
1043           if (!preg_match('/[.!?]$/', $string)){
1044             $string.= ".";
1045           }
1046           $string= preg_replace('/<br>/', ' ', $string);
1047           $img= "images/warning.png";
1048           $addmsg= _("Please check your input and fix the error. Press 'OK' to close this message box.");
1049         }
1050       
1051         if(isset($_SESSION['errors']) && strlen($_SESSION['errors'])==0) {
1052           $_SESSION['errors'].= "<div style='margin-left:15%;margin-top:100px;".
1053             "background-color:white;padding:5px;border:5px solid red;width:55%;z-index:150;".
1054             "position:absolute' id='e_layer'><table style='width:100%' summary='' border=0>".
1055             "<tr><td style='vertical-align:top;padding:10px'><img alt='' src='".
1056             get_template_path($img)."'></td>".
1057             "<td style='width:100%'><h1>"._("An error occured while processing your request").
1058             "</h1><b>$string</b><br><br>$addmsg</td></tr><tr><td colspan='2' align='center'><br><button ".
1059             (($_SESSION['js']==FALSE)?"type='submit'":"type='button'").
1060             " style='width:80px' onClick='hide(\"e_layer\")'>".
1061             _("OK")."</button></td></tr></table></div>";
1062         }
1064       }else{
1065         return;
1066       }
1067       $_SESSION['errorsAlreadyPosted'][$string] = 1;
1069     }
1071   } else {
1072     echo "Error: $string\n";
1073   }
1074   $_SESSION['LastError'] = $string; 
1078 function gen_locked_message($user, $dn)
1080   global $plug, $config;
1082   $_SESSION['dn']= $dn;
1083   $ldap= $config->get_ldap_link();
1084   $ldap->cat ($user, array('uid', 'cn'));
1085   $attrs= $ldap->fetch();
1087   /* Stop if we have no user here... */
1088   if (count($attrs)){
1089     $uid= $attrs["uid"][0];
1090     $cn= $attrs["cn"][0];
1091   } else {
1092     $uid= $attrs["uid"][0];
1093     $cn= $attrs["cn"][0];
1094   }
1095   
1096   $remove= false;
1098   /* Save variables from LOCK_VARS_TO_USE in session - for further editing */
1099   if((isset($_SESSION['LOCK_VARS_TO_USE']))&&(count($_SESSION['LOCK_VARS_TO_USE']))){
1100     $_SESSION['LOCK_VARS_USED']  =array();
1101     foreach($_SESSION['LOCK_VARS_TO_USE'] as $name){
1103       if(empty($name)) continue;
1104       foreach($_POST as $Pname => $Pvalue){
1105         if(preg_match($name,$Pname)){
1106           $_SESSION['LOCK_VARS_USED'][$Pname] = $_POST[$Pname];
1107         }
1108       }
1110       foreach($_GET as $Pname => $Pvalue){
1111         if(preg_match($name,$Pname)){
1112           $_SESSION['LOCK_VARS_USED'][$Pname] = $_GET[$Pname];
1113         }
1114       }
1115     }
1116     $_SESSION['LOCK_VARS_TO_USE'] =array();
1117   }
1119   /* Prepare and show template */
1120   $smarty= get_smarty();
1121   $smarty->assign ("dn", $dn);
1122   if ($remove){
1123     $smarty->assign ("action", _("Continue anyway"));
1124   } else {
1125     $smarty->assign ("action", _("Edit anyway"));
1126   }
1127   $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>"));
1129   return ($smarty->fetch (get_template_path('islocked.tpl')));
1133 function to_string ($value)
1135   /* If this is an array, generate a text blob */
1136   if (is_array($value)){
1137     $ret= "";
1138     foreach ($value as $line){
1139       $ret.= $line."<br>\n";
1140     }
1141     return ($ret);
1142   } else {
1143     return ($value);
1144   }
1148 function get_printer_list($cups_server)
1150   global $config;
1152   $res= array();
1154   /* Use CUPS, if we've access to it */
1155   if (function_exists('cups_get_dest_list')){
1156     $dest_list= cups_get_dest_list ($cups_server);
1158     foreach ($dest_list as $prt){
1159       $attr= cups_get_printer_attributes ($cups_server, $prt->name);
1161       foreach ($attr as $prt_info){
1162         if ($prt_info->name == "printer-info"){
1163           $info= $prt_info->value;
1164           break;
1165         }
1166       }
1167       $res[$prt->name]= "$info [$prt->name]";
1168     }
1170     /* CUPS is not available, try lpstat as a replacement */
1171   } else {
1172     $ar = false;
1173     exec("lpstat -p", $ar);
1174     foreach($ar as $val){
1175       @list($dummy, $printer, $rest)= split(' ', $val, 3);
1176       if (preg_match('/^[^@]+$/', $printer)){
1177         $res[$printer]= "$printer";
1178       }
1179     }
1180   }
1182   /* Merge in printers from LDAP */
1183   $ldap= $config->get_ldap_link();
1184   $ldap->cd ($config->current['BASE']);
1185   $ldap->search('(objectClass=gotoPrinter)', array('cn'));
1187   return $res;
1191 function sess_del ($var)
1193   /* New style */
1194   unset ($_SESSION[$var]);
1196   /* ... work around, since the first one
1197      doesn't seem to work all the time */
1198   session_unregister ($var);
1202 function show_errors($message)
1204   $complete= "";
1206   /* Assemble the message array to a plain string */
1207   foreach ($message as $error){
1208     if ($complete == ""){
1209       $complete= $error;
1210     } else {
1211       $complete= "$error<br>$complete";
1212     }
1213   }
1215   /* Fill ERROR variable with nice error dialog */
1216   print_red($complete);
1220 function show_ldap_error($message, $addon= "")
1222   if (!preg_match("/Success/i", $message)){
1223     if ($addon == ""){
1224       print_red (_("LDAP error: $message"));
1225     } else {
1226       print_red ("$addon<br><br><b>"._("LDAP error:")."</b> $message");
1227     }
1228     return TRUE;
1229   } else {
1230     return FALSE;
1231   }
1235 function rewrite($s)
1237   global $REWRITE;
1239   foreach ($REWRITE as $key => $val){
1240     $s= preg_replace("/$key/", "$val", $s);
1241   }
1243   return ($s);
1247 function dn2base($dn)
1249   global $config;
1251   if (get_people_ou() != ""){
1252     $dn= preg_replace('/,'.get_people_ou().'/i' , ',', $dn);
1253   }
1254   if (get_groups_ou() != ""){
1255     $dn= preg_replace('/,'.get_groups_ou().'/i' , ',', $dn);
1256   }
1257   $base= preg_replace ('/^[^,]+,/i', '', $dn);
1259   return ($base);
1264 function check_command($cmdline)
1266   $cmd= preg_replace("/ .*$/", "", $cmdline);
1268   /* Check if command exists in filesystem */
1269   if (!file_exists($cmd)){
1270     return (FALSE);
1271   }
1273   /* Check if command is executable */
1274   if (!is_executable($cmd)){
1275     return (FALSE);
1276   }
1278   return (TRUE);
1282 function print_header($image, $headline, $info= "")
1284   $display= "<div class=\"plugtop\">\n";
1285   $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";
1286   $display.= "</div>\n";
1288   if ($info != ""){
1289     $display.= "<div class=\"pluginfo\">\n";
1290     $display.= "$info";
1291     $display.= "</div>\n";
1292   } else {
1293     $display.= "<div style=\"height:5px;\">\n";
1294     $display.= "&nbsp;";
1295     $display.= "</div>\n";
1296   }
1297   if (isset($_SESSION['errors'])){
1298     $display.= $_SESSION['errors'];
1299   }
1301   return ($display);
1305 function register_global($name, $object)
1307   $_SESSION[$name]= $object;
1311 function is_global($name)
1313   return isset($_SESSION[$name]);
1317 function get_global($name)
1319   return $_SESSION[$name];
1323 function range_selector($dcnt,$start,$range=25,$post_var=false)
1326   /* Entries shown left and right from the selected entry */
1327   $max_entries= 10;
1329   /* Initialize and take care that max_entries is even */
1330   $output="";
1331   if ($max_entries & 1){
1332     $max_entries++;
1333   }
1335   if((!empty($post_var))&&(isset($_POST[$post_var]))){
1336     $range= $_POST[$post_var];
1337   }
1339   /* Prevent output to start or end out of range */
1340   if ($start < 0 ){
1341     $start= 0 ;
1342   }
1343   if ($start >= $dcnt){
1344     $start= $range * (int)(($dcnt / $range) + 0.5);
1345   }
1347   $numpages= (($dcnt / $range));
1348   if(((int)($numpages))!=($numpages)){
1349     $numpages = (int)$numpages + 1;
1350   }
1351   if ((((int)$numpages) <= 1 )&&(!$post_var)){
1352     return ("");
1353   }
1354   $ppage= (int)(($start / $range) + 0.5);
1357   /* Align selected page to +/- max_entries/2 */
1358   $begin= $ppage - $max_entries/2;
1359   $end= $ppage + $max_entries/2;
1361   /* Adjust begin/end, so that the selected value is somewhere in
1362      the middle and the size is max_entries if possible */
1363   if ($begin < 0){
1364     $end-= $begin + 1;
1365     $begin= 0;
1366   }
1367   if ($end > $numpages) {
1368     $end= $numpages;
1369   }
1370   if (($end - $begin) < $max_entries && ($end - $max_entries) > 0){
1371     $begin= $end - $max_entries;
1372   }
1374   if($post_var){
1375     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>
1376       <table summary='' width='100%'><tr><td style='width:25%'></td><td style='text-align:center;'>";
1377   }else{
1378     $output.= "<div style='border:1px solid #E0E0E0; background-color:#FFFFFF;'>";
1379   }
1381   /* Draw decrement */
1382   if ($start > 0 ) {
1383     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1384       (($start-$range))."\">".
1385       "<img class=\"center\" alt=\"\" src=\"images/back.png\" border=0 align=\"middle\"></a>";
1386   }
1388   /* Draw pages */
1389   for ($i= $begin; $i < $end; $i++) {
1390     if ($ppage == $i){
1391       $output.= "<a style=\"vertical-align:middle;background-color:#D0D0D0;\" href=\"main.php?plug=".
1392         validate($_GET['plug'])."&amp;start=".
1393         ($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1394     } else {
1395       $output.= "<a style=\"vertical-align:middle;\" href=\"main.php?plug=".validate($_GET['plug']).
1396         "&amp;start=".($i*$range)."\">&nbsp;".($i+1)."&nbsp;</a>";
1397     }
1398   }
1400   /* Draw increment */
1401   if($start < ($dcnt-$range)) {
1402     $output.="  <a href= \"main.php?plug=".validate($_GET['plug'])."&amp;start=".
1403       (($start+($range)))."\">".
1404       "<img class=\"center\" alt=\"\" src=\"images/forward.png\" border=\"0\" align=\"middle\"></a>";
1405   }
1407   if(($post_var)&&($numpages)){
1408     $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()'>";
1409     foreach(array(20,50,100,200,"all") as $num){
1410       if($num == "all"){
1411         $var = 10000;
1412       }else{
1413         $var = $num;
1414       }
1415       if($var == $range){
1416         $output.="\n<option selected='selected' value='".$var."'>".$num."</option>";
1417       }else{  
1418         $output.="\n<option value='".$var."'>".$num."</option>";
1419       }
1420     }
1421     $output.=  "</select></td></tr></table></div>";
1422   }else{
1423     $output.= "</div>";
1424   }
1426   return($output);
1430 function apply_filter()
1432   $apply= "";
1434   $apply= ''.
1435     '<table summary=""  width="100%"  style="background:#EEEEEE;border-top:1px solid #B0B0B0;"><tr><td width="100%" align="right">'.
1436     '<input type="submit" name="apply" value="'._("Apply filter").'"></td></tr></table>';
1438   return ($apply);
1442 function back_to_main()
1444   $string= '<br><p class="plugbottom"><input type=submit name="password_back" value="'.
1445     _("Back").'"></p><input type="hidden" name="ignore">';
1447   return ($string);
1451 function normalize_netmask($netmask)
1453   /* Check for notation of netmask */
1454   if (!preg_match('/^([0-9]+\.){3}[0-9]+$/', $netmask)){
1455     $num= (int)($netmask);
1456     $netmask= "";
1458     for ($byte= 0; $byte<4; $byte++){
1459       $result=0;
1461       for ($i= 7; $i>=0; $i--){
1462         if ($num-- > 0){
1463           $result+= pow(2,$i);
1464         }
1465       }
1467       $netmask.= $result.".";
1468     }
1470     return (preg_replace('/\.$/', '', $netmask));
1471   }
1473   return ($netmask);
1477 function netmask_to_bits($netmask)
1479   list($nm0, $nm1, $nm2, $nm3)= split('\.', $netmask);
1480   $res= 0;
1482   for ($n= 0; $n<4; $n++){
1483     $start= 255;
1484     $name= "nm$n";
1486     for ($i= 0; $i<8; $i++){
1487       if ($start == (int)($$name)){
1488         $res+= 8 - $i;
1489         break;
1490       }
1491       $start-= pow(2,$i);
1492     }
1493   }
1495   return ($res);
1499 function recurse($rule, $variables)
1501   $result= array();
1503   if (!count($variables)){
1504     return array($rule);
1505   }
1507   reset($variables);
1508   $key= key($variables);
1509   $val= current($variables);
1510   unset ($variables[$key]);
1512   foreach($val as $possibility){
1513     $nrule= preg_replace("/\{$key\}/", $possibility, $rule);
1514     $result= array_merge($result, recurse($nrule, $variables));
1515   }
1517   return ($result);
1521 function expand_id($rule, $attributes)
1523   /* Check for id rule */
1524   if(preg_match('/^id(:|#)\d+$/',$rule)){
1525     return (array("\{$rule}"));
1526   }
1528   /* Check for clean attribute */
1529   if (preg_match('/^%[a-zA-Z0-9]+$/', $rule)){
1530     $rule= preg_replace('/^%/', '', $rule);
1531     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$rule])));
1532     return (array($val));
1533   }
1535   /* Check for attribute with parameters */
1536   if (preg_match('/^%[a-zA-Z0-9]+\[[0-9-]+\]$/', $rule)){
1537     $param= preg_replace('/^[^[]+\[([^]]+)]$/', '\\1', $rule);
1538     $part= preg_replace('/^%/', '', preg_replace('/\[.*$/', '', $rule));
1539     $val= rewrite(preg_replace('/ /', '', strtolower($attributes[$part])));
1540     $start= preg_replace ('/-.*$/', '', $param);
1541     $stop = preg_replace ('/^[^-]+-/', '', $param);
1543     /* Assemble results */
1544     $result= array();
1545     for ($i= $start; $i<= $stop; $i++){
1546       $result[]= substr($val, 0, $i);
1547     }
1548     return ($result);
1549   }
1551   echo "Error in idgen string: don't know how to handle rule $rule.\n";
1552   return (array($rule));
1556 function gen_uids($rule, $attributes)
1558   global $config;
1560   /* Search for keys and fill the variables array with all 
1561      possible values for that key. */
1562   $part= "";
1563   $trigger= false;
1564   $stripped= "";
1565   $variables= array();
1567   for ($pos= 0; $pos < strlen($rule); $pos++){
1569     if ($rule[$pos] == "{" ){
1570       $trigger= true;
1571       $part= "";
1572       continue;
1573     }
1575     if ($rule[$pos] == "}" ){
1576       $variables[$pos]= expand_id($part, $attributes);
1577       $stripped.= "\{$pos}";
1578       $trigger= false;
1579       continue;
1580     }
1582     if ($trigger){
1583       $part.= $rule[$pos];
1584     } else {
1585       $stripped.= $rule[$pos];
1586     }
1587   }
1589   /* Recurse through all possible combinations */
1590   $proposed= recurse($stripped, $variables);
1592   /* Get list of used ID's */
1593   $used= array();
1594   $ldap= $config->get_ldap_link();
1595   $ldap->cd($config->current['BASE']);
1596   $ldap->search('(uid=*)');
1598   while($attrs= $ldap->fetch()){
1599     $used[]= $attrs['uid'][0];
1600   }
1602   /* Remove used uids and watch out for id tags */
1603   $ret= array();
1604   foreach($proposed as $uid){
1606     /* Check for id tag and modify uid if needed */
1607     if(preg_match('/\{id:\d+}/',$uid)){
1608       $size= preg_replace('/^.*{id:(\d+)}.*$/', '\\1', $uid);
1610       for ($i= 0; $i < pow(10,$size); $i++){
1611         $number= sprintf("%0".$size."d", $i);
1612         $res= preg_replace('/{id:(\d+)}/', $number, $uid);
1613         if (!in_array($res, $used)){
1614           $uid= $res;
1615           break;
1616         }
1617       }
1618     }
1620   if(preg_match('/\{id#\d+}/',$uid)){
1621     $size= preg_replace('/^.*{id#(\d+)}.*$/', '\\1', $uid);
1623     while (true){
1624       mt_srand((double) microtime()*1000000);
1625       $number= sprintf("%0".$size."d", mt_rand(0, pow(10, $size)-1));
1626       $res= preg_replace('/{id#(\d+)}/', $number, $uid);
1627       if (!in_array($res, $used)){
1628         $uid= $res;
1629         break;
1630       }
1631     }
1632   }
1634 /* Don't assign used ones */
1635 if (!in_array($uid, $used)){
1636   $ret[]= $uid;
1640 return(array_unique($ret));
1644 function array_search_r($needle, $key, $haystack){
1646   foreach($haystack as $index => $value){
1647     $match= 0;
1649     if (is_array($value)){
1650       $match= array_search_r($needle, $key, $value);
1651     }
1653     if ($index==$key && !is_array($value) && preg_match("/$needle/i", $value)){
1654       $match=1;
1655     }
1657     if ($match){
1658       return 1;
1659     }
1660   }
1662   return 0;
1663
1666 /* Sadly values like memory_limit are perpended by K, M, G, etc.
1667    Need to convert... */
1668 function to_byte($value) {
1669   $value= strtolower(trim($value));
1671   if(!is_numeric(substr($value, -1))) {
1673     switch(substr($value, -1)) {
1674       case 'g':
1675         $mult= 1073741824;
1676         break;
1677       case 'm':
1678         $mult= 1048576;
1679         break;
1680       case 'k':
1681         $mult= 1024;
1682         break;
1683     }
1685     return ($mult * (int)substr($value, 0, -1));
1686   } else {
1687     return $value;
1688   }
1692 function in_array_ics($value, $items)
1694   if (!is_array($items)){
1695     return (FALSE);
1696   }
1698   foreach ($items as $item){
1699     if (strtolower($item) == strtolower($value)) {
1700       return (TRUE);
1701     }
1702   }
1704   return (FALSE);
1705
1708 function generate_alphabet($count= 10)
1710   $characters= _("*ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
1711   $alphabet= "";
1712   $c= 0;
1714   /* Fill cells with charaters */
1715   for ($i= 0; $i<mb_strlen($characters, 'UTF8'); $i++){
1716     if ($c == 0){
1717       $alphabet.= "<tr>";
1718     }
1720     $ch = mb_substr($characters, $i, 1, "UTF8");
1721     $alphabet.= "<td><a class=\"alphaselect\" href=\"main.php?plug=".
1722       validate($_GET['plug'])."&amp;search=".$ch."\">&nbsp;".$ch."&nbsp;</a></td>";
1724     if ($c++ == $count){
1725       $alphabet.= "</tr>";
1726       $c= 0;
1727     }
1728   }
1730   /* Fill remaining cells */
1731   while ($c++ <= $count){
1732     $alphabet.= "<td>&nbsp;</td>";
1733   }
1735   return ($alphabet);
1739 function validate($string)
1741   return (strip_tags(preg_replace('/\0/', '', $string)));
1744 function get_gosa_version()
1746   global $svn_revision, $svn_path;
1748   /* Extract informations */
1749   $revision= preg_replace('/^[^0-9]*([0-9]+)[^0-9]*$/', '\1', $svn_revision);
1751   /* Release or development? */
1752   if (preg_match('%/gosa/trunk/%', $svn_path)){
1753     return (sprintf(_("GOsa development snapshot (Rev %s)"), $revision));
1754   } else {
1755     $release= preg_replace('%^.*/([^/]+)/include/functions.inc.*$%', '\1', $svn_path);
1756     return (sprintf(_("GOsa $release"), $revision));
1757   }
1761 function rmdirRecursive($path, $followLinks=false) {
1762   $dir= opendir($path);
1763   while($entry= readdir($dir)) {
1764     if(is_file($path."/".$entry) || ((!$followLinks) && is_link($path."/".$entry))) {
1765       unlink($path."/".$entry);
1766     } elseif (is_dir($path."/".$entry) && $entry!='.' && $entry!='..') {
1767       rmdirRecursive($path."/".$entry);
1768     }
1769   }
1770   closedir($dir);
1771   return rmdir($path);
1774 function scan_directory($path,$sort_desc=false)
1776   $ret = false;
1778   /* is this a dir ? */
1779   if(is_dir($path)) {
1781     /* is this path a readable one */
1782     if(is_readable($path)){
1784       /* Get contents and write it into an array */   
1785       $ret = array();    
1787       $dir = opendir($path);
1789       /* Is this a correct result ?*/
1790       if($dir){
1791         while($fp = readdir($dir))
1792           $ret[]= $fp;
1793       }
1794     }
1795   }
1796   /* Sort array ascending , like scandir */
1797   sort($ret);
1799   /* Sort descending if parameter is sort_desc is set */
1800   if($sort_desc) {
1801     $ret = array_reverse($ret);
1802   }
1804   return($ret);
1807 function clean_smarty_compile_dir($directory)
1809   global $svn_revision;
1811   if(is_dir($directory) && is_readable($directory)) {
1812     // Set revision filename to REVISION
1813     $revision_file= $directory."/REVISION";
1815     /* Is there a stamp containing the current revision? */
1816     if(!file_exists($revision_file)) {
1817       // create revision file
1818       create_revision($revision_file, $svn_revision);
1819     } else {
1820 # check for "$config->...['CONFIG']/revision" and the
1821 # contents should match the revision number
1822       if(!compare_revision($revision_file, $svn_revision)){
1823         // If revision differs, clean compile directory
1824         foreach(scan_directory($directory) as $file) {
1825           if(($file==".")||($file=="..")) continue;
1826           if( is_file($directory."/".$file) &&
1827               is_writable($directory."/".$file)) {
1828             // delete file
1829             if(!unlink($directory."/".$file)) {
1830               print_red("File ".$directory."/".$file." could not be deleted.");
1831               // This should never be reached
1832             }
1833           } elseif(is_dir($directory."/".$file) &&
1834               is_writable($directory."/".$file)) {
1835             // Just recursively delete it
1836             rmdirRecursive($directory."/".$file);
1837           }
1838         }
1839         // We should now create a fresh revision file
1840         clean_smarty_compile_dir($directory);
1841       } else {
1842         // Revision matches, nothing to do
1843       }
1844     }
1845   } else {
1846     // Smarty compile dir is not accessible
1847     // (Smarty will warn about this)
1848   }
1851 function create_revision($revision_file, $revision)
1853   $result= false;
1855   if(is_dir(dirname($revision_file)) && is_writable(dirname($revision_file))) {
1856     if($fh= fopen($revision_file, "w")) {
1857       if(fwrite($fh, $revision)) {
1858         $result= true;
1859       }
1860     }
1861     fclose($fh);
1862   } else {
1863     print_red("Can not write to revision file");
1864   }
1866   return $result;
1869 function compare_revision($revision_file, $revision)
1871   // false means revision differs
1872   $result= false;
1874   if(file_exists($revision_file) && is_readable($revision_file)) {
1875     // Open file
1876     if($fh= fopen($revision_file, "r")) {
1877       // Compare File contents with current revision
1878       if($revision == fread($fh, filesize($revision_file))) {
1879         $result= true;
1880       }
1881     } else {
1882       print_red("Can not open revision file");
1883     }
1884     // Close file
1885     fclose($fh);
1886   }
1888   return $result;
1891 function progressbar($percentage,$width=100,$height=15,$showvalue=false)
1893   $str = ""; // Our return value will be saved in this var
1895   $color  = dechex($percentage+150);
1896   $color2 = dechex(150 - $percentage);
1897   $bgcolor= $showvalue?"FFFFFF":"DDDDDD";
1899   $progress = (int)(($percentage /100)*$width);
1901   /* Abort printing out percentage, if divs are to small */
1904   /* If theres a better solution for this, use it... */
1905   $str = "
1906     <div style=\" width:".($width)."px; 
1907     height:".($height)."px;
1908   background-color:#000000;
1909 padding:1px;\">
1911           <div style=\" width:".($width)."px;
1912         background-color:#$bgcolor;
1913 height:".($height)."px;\">
1915          <div style=\" width:".$progress."px;
1916 height:".$height."px;
1917        background-color:#".$color2.$color2.$color."; \">";
1920        if(($height >10)&&($showvalue)){
1921          $str.=                 "<font style=\"font-size:".($height-2)."px;color:#FF0000;align:middle;padding-left:".((int)(($width*0.4)))."px;\">
1922            <b>".$percentage."%</b>
1923            </font>";
1924        }
1926        $str.= "</div></div></div>";
1928        return($str);
1932 function array_key_ics($ikey, $items)
1934   /* Gather keys, make them lowercase */
1935   $tmp= array();
1936   foreach ($items as $key => $value){
1937     $tmp[strtolower($key)]= $key;
1938   }
1940   if (isset($tmp[strtolower($ikey)])){
1941     return($tmp[strtolower($ikey)]);
1942   }
1944   return ("");
1948 function search_config($arr, $name, $return)
1950   if (is_array($arr)){
1951     foreach ($arr as $a){
1952       if (isset($a['CLASS']) &&
1953           strtolower($a['CLASS']) == strtolower($name)){
1955         if (isset($a[$return])){
1956           return ($a[$return]);
1957         } else {
1958           return ("");
1959         }
1960       } else {
1961         $res= search_config ($a, $name, $return);
1962         if ($res != ""){
1963           return $res;
1964         }
1965       }
1966     }
1967   }
1968   return ("");
1972 function array_differs($src, $dst)
1974   /* If the count is differing, the arrays differ */
1975   if (count ($src) != count ($dst)){
1976     return (TRUE);
1977   }
1979   /* So the count is the same - lets check the contents */
1980   $differs= FALSE;
1981   foreach($src as $value){
1982     if (!in_array($value, $dst)){
1983       $differs= TRUE;
1984     }
1985   }
1987   return ($differs);
1991 function saveFilter($a_filter, $values)
1993   if (isset($_POST['regexit'])){
1994     $a_filter["regex"]= $_POST['regexit'];
1996     foreach($values as $type){
1997       if (isset($_POST[$type])) {
1998         $a_filter[$type]= "checked";
1999       } else {
2000         $a_filter[$type]= "";
2001       }
2002     }
2003   }
2005   /* React on alphabet links if needed */
2006   if (isset($_GET['search'])){
2007     $s= mb_substr(validate($_GET['search']), 0, 1, "UTF8")."*";
2008     if ($s == "**"){
2009       $s= "*";
2010     }
2011     $a_filter['regex']= $s;
2012   }
2014   return ($a_filter);
2018 /* Escape all preg_* relevant characters */
2019 function normalizePreg($input)
2021   return (addcslashes($input, '[]()|/.*+-'));
2025 /* Escape all LDAP filter relevant characters */
2026 function normalizeLdap($input)
2028   return (addcslashes($input, '()|'));
2032 /* Resturns the difference between to microtime() results in float  */
2033 function get_MicroTimeDiff($start , $stop)
2035   $a = split("\ ",$start);
2036   $b = split("\ ",$stop);
2038   $secs = $b[1] - $a[1];
2039   $msecs= $b[0] - $a[0]; 
2041   $ret = (float) ($secs+ $msecs);
2042   return($ret);
2046 /* Check if the given department name is valid */
2047 function is_department_name_reserved($name,$base)
2049   $reservedName = array("systems","apps","incomming","internal","accounts","fax","addressbook",
2050                           preg_replace("/ou=(.*),/","\\1",get_people_ou()),
2051                           preg_replace("/ou=(.*),/","\\1",get_groups_ou()));
2052   $follwedNames['/ou=fai,ou=configs,ou=systems,/'] = array("fai","hooks","templates","scripts","disk","packages","variables","profiles");
2054   /* Check if name is one of the reserved names */
2055   if(in_array_ics($name,$reservedName)) {
2056     return(true);
2057   }
2059   /* Check all follow combinations if name is in array && parent base == array_key, return false*/
2060   foreach($follwedNames as $key => $names){
2061     if((in_array_ics($name,$names)) && (preg_match($key,$base))){
2062       return(true);
2063     }
2064   }
2065   return(false);
2069 function get_base_dir()
2071   global $BASE_DIR;
2073   return $BASE_DIR;
2077 function obj_is_readable($dn, $object, $attribute)
2079   global $ui;
2081   return preg_match('/r/', $ui->get_permissions($dn, $object, $attribute));
2085 function obj_is_writable($dn, $object, $attribute)
2087   global $ui;
2089   return preg_match('/w/', $ui->get_permissions($dn, $object, $attribute));
2093 function gosa_ldap_explode_dn($dn,$config = NULL,$verify_in_ldap=false)
2095   /* Initialize variables */
2096   $ret  = array("count" => 0);  // Set count to 0
2097   $next = true;                 // if false, then skip next loops and return
2098   $cnt  = 0;                    // Current number of loops
2099   $max  = 100;                  // Just for security, prevent looops
2100   $ldap = NULL;                 // To check if created result a valid
2101   $keep = "";                   // save last failed parse string
2103   /* Check each parsed dn in ldap ? */
2104   if($config!=NULL && $verify_in_ldap){
2105     $ldap = $config->get_ldap_link();
2106   }
2108   $Diff = ldap_explode_dn($dn,0);
2110   /* Lets start */
2111   $called = false;
2112   while(preg_match("/,/",$dn) && $next &&  $cnt < $max){
2114     $cnt ++;
2115     if(!preg_match("/,/",$dn)){
2116       $next = false;
2117     }
2118     $object = preg_replace("/[,].*$/","",$dn);
2119     $dn     = preg_replace("/^[^,]+,/","",$dn);
2121     $called = true;
2123     /* Check if current dn is valid */
2124     if($ldap!=NULL){
2125       $ldap->cd($dn);
2126       $ldap->cat($dn,array("dn"));
2127       if($ldap->count()){
2128         $ret[]  = $keep.$object;
2129         $keep   = "";
2130       }else{
2131         $keep  .= $object.",";
2132       }
2133     }else{
2134       $ret[]  = $keep.$object;
2135       $keep   = "";
2136     }
2137   }
2139   /* Append the rest */
2140   $test = $keep.$dn;
2141   if($called && !empty($test)){
2142     $ret[] = $keep.$dn;
2143   }
2144   $ret['count'] = count($ret) - 1;
2146   $diff = array_diff($ret,$Diff);
2147   if($diff){
2148     print_a(array("Diff" => $diff,"OLD" => $Diff,"NEW"=> $ret,"DEBUG"=> debug_backtrace()));
2149   }
2150   return($ret);
2153 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
2154 ?>